diff --git a/.speakeasy/logs/changes/changes.html b/.speakeasy/logs/changes/changes.html
new file mode 100644
index 00000000..8fde455e
--- /dev/null
+++ b/.speakeasy/logs/changes/changes.html
@@ -0,0 +1,1861 @@
+
+
+
+
+
+
+ SDK Changelog - java
+
+
+Java SDK Changes:
+
+
+gustoembedded.contractorPaymentGroups.patchV1ContractorPaymentGroupsIdPartnerDisbursements(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employeeAddresses.delete(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.peopleBatches.getV1PeopleBatchesPeopleBatchUuid():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20250615) Added
+enum(20251115) Removed (Breaking ⚠️)
+
+response Changed
+
+
+idempotencyKey Changed
+status Changed
+uuid Changed
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.peopleBatches.postV1CompaniesCompanyIdPeopleBatches():
+
+
+request Changed (Breaking ⚠️)
+
+
+requestBody.batch[].compensation.effectiveDate Removed (Breaking ⚠️)
+xGustoApiVersion.enum(20250615) Added
+xGustoApiVersion.enum(20251115) Removed (Breaking ⚠️)
+
+response Changed (Breaking ⚠️)
+
+
+batchAction Changed
+idempotencyKey Changed
+status.enum(partialSuccess) Added (Breaking ⚠️)
+uuid Changed
+
+error Changed (Breaking ⚠️)
+
+
+errors[].errors Removed (Breaking ⚠️)
+errors[].metadata Removed (Breaking ⚠️)
+rawResponse Removed (Breaking ⚠️)
+
+
+gustoembedded.reimbursements.deleteV1RecurringReimbursements():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.reimbursements.putV1RecurringReimbursements():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.introspection.oauthAccessToken(): request Changed (Breaking ⚠️)
+
+
+requestBody.union(1) Removed (Breaking ⚠️)
+requestBody.union(2) Removed (Breaking ⚠️)
+requestBody.union(Refresh Token Request) Added
+requestBody.union(System Access Token Request) Added
+xGustoApiVersion.enum(20240401) Removed (Breaking ⚠️)
+xGustoApiVersion.enum(20250615) Added
+
+gustoembedded.reimbursements.getV1RecurringReimbursements():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.reimbursements.postV1EmployeesEmployeeIdRecurringReimbursements():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.reimbursements.getV1EmployeesEmployeeIdRecurringReimbursements():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.salaryEstimates.getV1SalaryEstimatesOccupations(): request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+gustoembedded.companies.suspensions.get(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.salaryEstimates.postV1SalaryEstimatesUuidAccept():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.industrySelection.update():
+
+
+request Changed (Breaking ⚠️)
+
+
+companyIndustrySelectionRequiredBody Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+error.status[404] Added
+
+gustoembedded.signatories.create():
+
+
+request Changed (Breaking ⚠️)
+
+
+requestBody Removed (Breaking ⚠️)
+signatoryCreateRequest Added (Breaking ⚠️)
+xGustoApiVersion Changed
+
+error.status[404] Added
+
+gustoembedded.salaryEstimates.putV1SalaryEstimatesId():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.signatories.invite():
+
+
+request Changed (Breaking ⚠️)
+
+
+requestBody Removed (Breaking ⚠️)
+signatoryInviteRequest Added (Breaking ⚠️)
+xGustoApiVersion Changed
+
+error.status[404] Added
+
+gustoembedded.signatories.update():
+
+
+request Changed (Breaking ⚠️)
+
+
+requestBody Removed (Breaking ⚠️)
+signatoryUpdateRequest Added (Breaking ⚠️)
+xGustoApiVersion Changed
+
+error Changed
+
+
+- ” Added
+status[409] Added
+
+
+gustoembedded.salaryEstimates.getV1SalaryEstimatesId():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.flows.create():
+
+
+request Changed (Breaking ⚠️)
+
+
+createFlowRequest Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+error.status[404] Added
+
+gustoembedded.locations.create():
+
+
+request Changed (Breaking ⚠️)
+
+
+companyLocationRequest Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+error.status[404] Added
+
+gustoembedded.salaryEstimates.postV1EmployeesEmployeeIdSalaryEstimates():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.locations.retrieve(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.locations.update(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.locations.getMinimumWages(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.bankAccounts.get(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.bankAccounts.create():
+
+
+response.status[200] Added (Breaking ⚠️)
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.bankAccounts.verify():
+
+
+request Changed (Breaking ⚠️)
+
+
+companyBankAccountVerifyRequest Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+error.status[404] Added
+
+gustoembedded.bankAccounts.deleteV1CompaniesCompanyIdBankAccountsBankAccountId(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.wireInRequests.list(): response.[].paymentType.enum(contractorPaymentGroup) Added (Breaking ⚠️)
+gustoembedded.wireInRequests.submit(): response.paymentType.enum(contractorPaymentGroup) Added (Breaking ⚠️)
+gustoembedded.externalPayrolls.listTaxLiabilities(): response.[] Changed (Breaking ⚠️)
+gustoembedded.externalPayrolls.updateTaxLiabilities(): response.[] Changed (Breaking ⚠️)
+gustoembedded.paymentConfigs.get():
+
+
+request.xGustoApiVersion Changed
+response.paymentSpeed Changed (Breaking ⚠️)
+error.status[404] Added
+
+gustoembedded.paymentConfigs.update():
+
+
+request Changed (Breaking ⚠️)
+
+
+paymentConfigsUpdateRequest Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+response.paymentSpeed Changed (Breaking ⚠️)
+error.status[404] Added
+
+gustoembedded.paySchedules.create():
+
+
+request Changed (Breaking ⚠️)
+
+
+payScheduleCreateRequest Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+response Changed (Breaking ⚠️)
+
+
+anchorEndOfPayPeriod Changed (Breaking ⚠️)
+anchorPayDate Changed (Breaking ⚠️)
+autoPayrollEnablementBlockers Added
+autoPayroll Added
+frequency.enum(annually) Added (Breaking ⚠️)
+frequency.enum(quarterly) Added (Breaking ⚠️)
+version Added
+
+error.status[404] Added
+
+gustoembedded.paySchedules.getAll():
+
+
+request.xGustoApiVersion Changed
+response.[] Changed (Breaking ⚠️)
+
+
+anchorEndOfPayPeriod Changed (Breaking ⚠️)
+anchorPayDate Changed (Breaking ⚠️)
+autoPayrollEnablementBlockers Added
+autoPayroll Added
+version Changed
+
+error.status[404] Added
+
+gustoembedded.paySchedules.getPreview():
+
+
+request Changed (Breaking ⚠️)
+
+
+anchorEndOfPayPeriod Changed (Breaking ⚠️)
+anchorPayDate Changed (Breaking ⚠️)
+endDate Added
+xGustoApiVersion Changed
+
+response Changed (Breaking ⚠️)
+
+
+holidays[] Changed (Breaking ⚠️)
+payPeriods[].checkDate Changed (Breaking ⚠️)
+payPeriods[].endDate Changed (Breaking ⚠️)
+payPeriods[].runPayrollBy Changed (Breaking ⚠️)
+payPeriods[].startDate Changed (Breaking ⚠️)
+
+error Changed
+
+
+status[404] Added
+status[422] Added
+
+
+gustoembedded.paySchedules.get():
+
+
+request.xGustoApiVersion Changed
+response Changed (Breaking ⚠️)
+
+
+anchorEndOfPayPeriod Changed (Breaking ⚠️)
+anchorPayDate Changed (Breaking ⚠️)
+autoPayrollEnablementBlockers Added
+autoPayroll Added
+version Changed
+
+error.status[404] Added
+
+gustoembedded.paySchedules.update():
+
+
+request Changed (Breaking ⚠️)
+
+
+payScheduleUpdateRequest Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+response Changed (Breaking ⚠️)
+
+
+anchorEndOfPayPeriod Changed (Breaking ⚠️)
+anchorPayDate Changed (Breaking ⚠️)
+autoPayrollEnablementBlockers Added
+autoPayroll Added
+frequency.enum(annually) Added (Breaking ⚠️)
+frequency.enum(quarterly) Added (Breaking ⚠️)
+version Added
+
+error Changed
+
+
+- ” Added
+status[409] Added
+
+
+gustoembedded.paySchedules.getPayPeriods():
+
+
+request Changed (Breaking ⚠️)
+
+
+endDate Changed (Breaking ⚠️)
+payrollTypes Changed (Breaking ⚠️)
+startDate Changed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+error Changed
+
+
+- ” Added
+status[422] Added
+
+
+gustoembedded.employees.list():
+
+
+response.[].jobs[].compensations[].title Added
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.contractorPaymentMethod.get(): response.type.enum(null) Removed (Breaking ⚠️)
+gustoembedded.wireInRequests.get(): response.paymentType.enum(contractorPaymentGroup) Added (Breaking ⚠️)
+gustoembedded.employees.get():
+
+
+response.jobs[].compensations[].title Added
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.employees.update():
+
+
+response.jobs[].compensations[].title Added
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.employees.delete(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employees.updateOnboardingDocumentsConfig():
+
+
+request Changed (Breaking ⚠️)
+
+
+employeeOnboardingDocumentsConfigRequest Added
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+response Changed (Breaking ⚠️)
+
+
+i9Document Changed (Breaking ⚠️)
+uuid Added
+
+error.status[404] Added
+
+gustoembedded.recoveryCases.get(): response.[] Changed (Breaking ⚠️)
+
+
+latestErrorCode Changed (Breaking ⚠️)
+originalDebitDate Changed (Breaking ⚠️)
+
+gustoembedded.employees.updateOnboardingStatus(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.informationRequests.submit(): response.requiredQuestions[].responseType.enum(radioButton) Added (Breaking ⚠️)
+gustoembedded.informationRequests.getInformationRequests(): response.[].requiredQuestions[].responseType.enum(radioButton) Added (Breaking ⚠️)
+gustoembedded.holidayPayPolicies.removeEmployees():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.employeeEmployments.getHistory(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employeeAddresses.get(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employeeAddresses.create(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employeeAddresses.retrieveHomeAddress(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employeeAddresses.update(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.contractors.getV1CompaniesCompanyIdContractorsPaymentDetails(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employeeAddresses.getWorkAddresses(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employeeAddresses.createWorkAddress(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employeeAddresses.retrieveWorkAddress(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employeeAddresses.updateWorkAddress(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employeeAddresses.deleteWorkAddress(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.holidayPayPolicies.addEmployees():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.employeeTaxSetup.updateFederalTaxes():
+
+
+request Changed (Breaking ⚠️)
+
+
+requestBody.additionalWithholding Changed (Breaking ⚠️)
+requestBody.deductions Changed (Breaking ⚠️)
+requestBody.dependentsAmount Changed (Breaking ⚠️)
+requestBody.extraWithholding Changed (Breaking ⚠️)
+requestBody.filingStatus Changed (Breaking ⚠️)
+requestBody.otherIncome Changed (Breaking ⚠️)
+requestBody.w4DataType Changed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+response Changed
+
+
+union(pre_2020_w4).companyId Added
+union(pre_2020_w4).employeeId Added
+union(rev_2020_w4).companyId Added
+union(rev_2020_w4).employeeId Added
+
+error Changed
+
+
+- ” Added
+status[409] Added
+
+
+gustoembedded.employeeTaxSetup.getStateTaxes(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employeeTaxSetup.updateStateTaxes(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.holidayPayPolicies.delete():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.holidayPayPolicies.update():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.employeePaymentMethod.update():
+
+
+request Changed (Breaking ⚠️)
+
+
+requestBody.splitBy Changed
+requestBody.splits[].splitAmount Changed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+error Changed
+
+
+- ” Added
+status[409] Added
+
+
+gustoembedded.holidayPayPolicies.create():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.holidayPayPolicies.get():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.i9Verification.employerSign():
+
+
+request Changed (Breaking ⚠️)
+
+
+i9AuthorizationEmployerSignRequestBody Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+response Changed (Breaking ⚠️)
+
+
+additionalInfo Changed (Breaking ⚠️)
+altProcedure Changed (Breaking ⚠️)
+country Changed (Breaking ⚠️)
+documentType Changed (Breaking ⚠️)
+expirationDate Changed (Breaking ⚠️)
+formUuid Changed (Breaking ⚠️)
+hasDocumentNumber Changed (Breaking ⚠️)
+
+error.status[404] Added
+
+gustoembedded.i9Verification.createDocuments():
+
+
+request Changed (Breaking ⚠️)
+
+
+i9AuthorizationDocumentsRequestBody Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+response Changed (Breaking ⚠️)
+
+
+status[200] Removed (Breaking ⚠️)
+status[201] Added (Breaking ⚠️)
+
+error.status[404] Added
+
+gustoembedded.i9Verification.getDocuments():
+
+
+request.xGustoApiVersion Changed
+response.[].expirationDate Changed (Breaking ⚠️)
+error.status[404] Added
+
+gustoembedded.i9Verification.update():
+
+
+request Changed (Breaking ⚠️)
+
+
+i9AuthorizationRequestBody Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+response Changed (Breaking ⚠️)
+
+
+additionalInfo Changed (Breaking ⚠️)
+altProcedure Changed (Breaking ⚠️)
+country Changed (Breaking ⚠️)
+documentType Changed (Breaking ⚠️)
+expirationDate Changed (Breaking ⚠️)
+formUuid Changed (Breaking ⚠️)
+hasDocumentNumber Changed (Breaking ⚠️)
+
+error.status[404] Added
+
+gustoembedded.jobsAndCompensations.createCompensation():
+
+
+request Changed (Breaking ⚠️)
+
+
+compensationsRequestBody Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+response.title Added
+error.status[404] Added
+
+gustoembedded.i9Verification.getAuthorization():
+
+
+request.xGustoApiVersion Changed
+response Changed (Breaking ⚠️)
+
+
+additionalInfo Changed (Breaking ⚠️)
+altProcedure Changed (Breaking ⚠️)
+country Changed (Breaking ⚠️)
+documentType Changed (Breaking ⚠️)
+expirationDate Changed (Breaking ⚠️)
+formUuid Changed (Breaking ⚠️)
+hasDocumentNumber Changed (Breaking ⚠️)
+
+error.status[404] Added
+
+gustoembedded.jobsAndCompensations.updateCompensation():
+
+
+request Changed (Breaking ⚠️)
+
+
+compensationsUpdateRequestBody Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+response.title Added
+error.status[404] Added
+
+gustoembedded.employeeBenefits.patchV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYear():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.contractors.create():
+
+
+request Changed (Breaking ⚠️)
+
+
+contractorCreateRequestBody Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+response Changed (Breaking ⚠️)
+
+
+departmentTitle Added
+dismissalCancellationEligible Added
+paymentMethod.enum(null) Removed (Breaking ⚠️)
+rehireCancellationEligible Added
+upcomingEmployment Added
+
+error.status[404] Added
+
+gustoembedded.contractors.list():
+
+
+request Changed (Breaking ⚠️)
+
+
+onboardedActive Added
+onboarded Added
+sortBy Changed (Breaking ⚠️)
+terminatedToday Added
+terminated Added
+xGustoApiVersion Changed
+
+response.[] Changed (Breaking ⚠️)
+
+
+departmentTitle Added
+dismissalCancellationEligible Added
+paymentMethod.enum(null) Removed (Breaking ⚠️)
+rehireCancellationEligible Added
+upcomingEmployment Added
+
+error.status[404] Added
+
+gustoembedded.contractors.get():
+
+
+request.xGustoApiVersion Changed
+response Changed (Breaking ⚠️)
+
+
+departmentTitle Added
+dismissalCancellationEligible Added
+paymentMethod.enum(null) Removed (Breaking ⚠️)
+rehireCancellationEligible Added
+upcomingEmployment Added
+
+error.status[404] Added
+
+gustoembedded.contractors.update():
+
+
+request Changed (Breaking ⚠️)
+
+
+contractorUpdateRequestBody Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+response Changed (Breaking ⚠️)
+
+
+departmentTitle Added
+dismissalCancellationEligible Added
+paymentMethod.enum(null) Removed (Breaking ⚠️)
+rehireCancellationEligible Added
+upcomingEmployment Added
+
+error.status[404] Added
+
+gustoembedded.employeeBenefits.getV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYear():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.employees.getOnboardingStatus(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.employeeBenefits.postV1EmployeesEmployeeUuidSection603HighEarnerStatuses():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.employees.create():
+
+
+requestBody.email Changed
+response.jobs[].compensations[].title Added
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.contractorPaymentMethod.update(): response.type.enum(null) Removed (Breaking ⚠️)
+gustoembedded.webhooks.createSubscription(): response.subscriptionTypes[].enum(payrollSync) Added (Breaking ⚠️)
+gustoembedded.webhooks.listSubscriptions(): response.[].subscriptionTypes[].enum(payrollSync) Added (Breaking ⚠️)
+gustoembedded.webhooks.updateSubscription(): response.subscriptionTypes[].enum(payrollSync) Added (Breaking ⚠️)
+gustoembedded.webhooks.getSubscription(): response.subscriptionTypes[].enum(payrollSync) Added (Breaking ⚠️)
+gustoembedded.webhooks.verify(): response.subscriptionTypes[].enum(payrollSync) Added (Breaking ⚠️)
+gustoembedded.payrolls.list():
+
+
+response.[].creditBlockers[].unblockOptions[] Changed
+
+
+union(submit_bank_screenshot).metadata.bankAccountLastFourDigits Added
+union(wait_for_reverse_wire).metadata.bankAccountLastFourDigits Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.payrolls.createOffCycle():
+
+
+requestBody.employeeUuids Changed
+response.employeeCompensations[] Changed (Breaking ⚠️)
+
+
+deductions Removed (Breaking ⚠️)
+paidTimeOff[].finalPayoutUnusedHoursInput Changed (Breaking ⚠️)
+version Changed (Breaking ⚠️)
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.payrolls.get():
+
+
+response Changed (Breaking ⚠️)
+
+
+creditBlockers[].unblockOptions[].union(submit_bank_screenshot).metadata.bankAccountLastFourDigits Added
+creditBlockers[].unblockOptions[].union(wait_for_reverse_wire).metadata.bankAccountLastFourDigits Added
+employeeCompensations[].additionalProperties Added
+employeeCompensations[].paidTimeOff[].finalPayoutUnusedHoursInput Changed (Breaking ⚠️)
+employeeCompensations[].version Changed (Breaking ⚠️)
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.payrolls.update():
+
+
+request.payrollUpdate.employeeCompensations[].paidTimeOff[].finalPayoutUnusedHoursInput Changed
+response.employeeCompensations[] Changed (Breaking ⚠️)
+
+
+paidTimeOff[].finalPayoutUnusedHoursInput Changed (Breaking ⚠️)
+version Changed (Breaking ⚠️)
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.payrolls.delete(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.payrolls.prepare():
+
+
+request Changed
+
+
+requestBody.employeeUuids Changed
+sortBy Changed
+xGustoApiVersion Changed
+
+response.employeeCompensations[] Changed (Breaking ⚠️)
+
+
+paidTimeOff[].finalPayoutUnusedHoursInput Changed (Breaking ⚠️)
+version Changed (Breaking ⚠️)
+
+error Changed
+
+
+- ” Added
+status[422] Added
+
+
+gustoembedded.payrolls.getReceipt(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.payrolls.getBlockers():
+
+
+request.xGustoApiVersion Changed
+response.[] Changed (Breaking ⚠️)
+
+
+key Changed (Breaking ⚠️)
+message Changed
+
+error.status[404] Added
+
+gustoembedded.payrolls.cancel():
+
+
+request.xGustoApiVersion Changed
+response Changed (Breaking ⚠️)
+
+
+companyTaxes Removed (Breaking ⚠️)
+creditBlockers Removed (Breaking ⚠️)
+finalTerminationPayroll Removed (Breaking ⚠️)
+fixedWithholdingRate Removed (Breaking ⚠️)
+paymentSpeedChanged Removed (Breaking ⚠️)
+payrollStatusMeta Removed (Breaking ⚠️)
+payrollTaxes Removed (Breaking ⚠️)
+processingRequest Removed (Breaking ⚠️)
+skipRegularDeductions Removed (Breaking ⚠️)
+submissionBlockers Removed (Breaking ⚠️)
+totals Removed (Breaking ⚠️)
+withholdingPayPeriod Removed (Breaking ⚠️)
+
+error.status[404] Added
+
+gustoembedded.payrolls.getPayStub(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.payrolls.getPayStubs(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.payrolls.generatePrintableChecks(): response.startingCheckNumber Changed (Breaking ⚠️)
+gustoembedded.payrolls.getV1CompaniesCompanyIdPayrollsIdPartnerDisbursements(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.payrolls.patchV1CompaniesCompanyIdPayrollsIdPartnerDisbursements(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.timeOffPolicies.calculateAccruingTimeOffHours():
+
+
+request Changed (Breaking ⚠️)
+
+
+payrollCalculateAccruingTimeOffHoursRequest Added
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+error.status[404] Added
+
+gustoembedded.timeOffPolicies.get():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.timeOffPolicies.update():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.timeOffPolicies.getAll():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.timeOffPolicies.create():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.timeOffPolicies.addEmployees():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.timeOffPolicies.removeEmployees():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.timeOffPolicies.updateBalance():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.timeOffPolicies.deactivate():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.contractorPayments.create():
+
+
+request Changed (Breaking ⚠️)
+
+
+contractorPaymentBody Added (Breaking ⚠️)
+requestBody Removed (Breaking ⚠️)
+xGustoApiVersion Changed
+
+error.status[404] Added
+
+gustoembedded.employeeBenefits.getV1EmployeesEmployeeUuidSection603HighEarnerStatuses():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.companyBenefits.getRequirements(): response.employeeDeduction.choices Changed (Breaking ⚠️)
+gustoembedded.companyBenefits.delete(): error Changed (Breaking ⚠️)
+
+
+errors Changed (Breaking ⚠️)
+rawResponse Removed (Breaking ⚠️)
+
+gustoembedded.contractorPaymentGroups.getList():
+
+
+response.[] Changed (Breaking ⚠️)
+
+
+creditBlockers[] Changed (Breaking ⚠️)
+submissionBlockers[] Changed (Breaking ⚠️)
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.contractorPaymentGroups.create():
+
+
+requestBody Changed (Breaking ⚠️)
+
+
+contractorPayments[].bonus Changed (Breaking ⚠️)
+contractorPayments[].hours Changed (Breaking ⚠️)
+contractorPayments[].reimbursement Changed (Breaking ⚠️)
+contractorPayments[].wage Changed (Breaking ⚠️)
+submissionBlockers Added
+
+response Changed (Breaking ⚠️)
+
+
+creditBlockers[] Changed (Breaking ⚠️)
+submissionBlockers[] Changed (Breaking ⚠️)
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.contractorPaymentGroups.preview():
+
+
+requestBody.contractorPayments[] Changed (Breaking ⚠️)
+
+
+bonus Changed (Breaking ⚠️)
+hours Changed (Breaking ⚠️)
+reimbursement Changed (Breaking ⚠️)
+wage Changed (Breaking ⚠️)
+
+response Changed (Breaking ⚠️)
+
+
+creditBlockers[] Changed (Breaking ⚠️)
+submissionBlockers[] Changed (Breaking ⚠️)
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.contractorPaymentGroups.get():
+
+
+response Changed (Breaking ⚠️)
+
+
+creditBlockers[] Changed (Breaking ⚠️)
+submissionBlockers[] Changed (Breaking ⚠️)
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.contractorPaymentGroups.delete(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.contractorPaymentGroups.fund():
+
+
+response Changed (Breaking ⚠️)
+
+
+creditBlockers[] Changed (Breaking ⚠️)
+submissionBlockers[] Changed (Breaking ⚠️)
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.contractorPaymentGroups.getV1ContractorPaymentGroupsIdPartnerDisbursements(): errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+gustoembedded.companyBenefits.get(): response.employeeBenefits[] Changed (Breaking ⚠️)
+
+
+action Removed (Breaking ⚠️)
+uuid Removed (Breaking ⚠️)
+
+gustoembedded.companyForms.getAll(): request.sortBy Changed (Breaking ⚠️)
+gustoembedded.reports.postV1CompaniesCompanyIdReportsEmployeesAnnualFicaWage():
+
+
+request.xGustoApiVersion Changed (Breaking ⚠️)
+
+
+enum(20240401) Removed (Breaking ⚠️)
+enum(20250615) Added
+
+errors[] Changed (Breaking ⚠️)
+
+
+errors Removed (Breaking ⚠️)
+metadata Removed (Breaking ⚠️)
+
+
+gustoembedded.reports.createCustom():
+
+
+requestBody.employeeUuids Changed
+
+gustoembedded.employeeTaxSetup.getFederalTaxes():
+
+
+request.xGustoApiVersion Changed
+response Changed
+
+
+union(pre_2020_w4).companyId Added
+union(pre_2020_w4).employeeId Added
+union(rev_2020_w4).companyId Added
+union(rev_2020_w4).employeeId Added
+
+error.status[404] Added
+
+gustoembedded.companyBenefits.update(): requestBody Changed
+
+
+responsibleForEmployeeW2 Added
+responsibleForEmployerTaxes Added
+
+gustoembedded.contractorPayments.delete():
+
+
+request.xGustoApiVersion Changed
+error.status[404] Added
+
+gustoembedded.companyBenefits.updateEmployeeBenefits():
+
+
+requestBody.employeeBenefits[] Changed
+
+
+action Added
+uuid Added
+
+
+gustoembedded.contractorPayments.get():
+
+
+request.xGustoApiVersion Changed
+error.status[404] Added
+
+gustoembedded.employeeBenefits.delete(): error.status[422] Added
+gustoembedded.contractorPayments.list():
+
+
+request.xGustoApiVersion Changed
+error.status[404] Added
+
+gustoembedded.payrolls.calculateGrossUp(): Added
+gustoembedded.contractors.delete():
+
+
+request.xGustoApiVersion Changed
+error Changed
+
+
+- ” Added
+status[422] Added
+
+
+gustoembedded.jobsAndCompensations.deleteCompensation():
+
+
+request.xGustoApiVersion Changed
+error Changed
+
+
+- ” Added
+status[422] Added
+
+
+gustoembedded.jobsAndCompensations.getCompensation():
+
+
+request.xGustoApiVersion Changed
+response.title Added
+error.status[404] Added
+
+gustoembedded.jobsAndCompensations.getCompensations():
+
+
+request.xGustoApiVersion Changed
+response.[].title Added
+error.status[404] Added
+
+gustoembedded.i9Verification.getDocumentOptions():
+
+
+request.xGustoApiVersion Changed
+error.status[404] Added
+
+gustoembedded.jobsAndCompensations.delete(): error.status[422] Added
+gustoembedded.jobsAndCompensations.update(): response.compensations[].title Added
+gustoembedded.i9Verification.deleteDocument():
+
+
+request.xGustoApiVersion Changed
+error Changed
+
+
+- ” Added
+status[422] Added
+
+
+gustoembedded.employeePaymentMethod.get():
+
+
+request.xGustoApiVersion Changed
+error.status[404] Added
+
+gustoembedded.jobsAndCompensations.getJobs(): response.[].compensations[].title Added
+gustoembedded.employeePaymentMethod.deleteBankAccount(): error.status[422] Added
+gustoembedded.companies.getV1PartnerManagedCompaniesCompanyUuidMigrationReadiness(): Added
+gustoembedded.jobsAndCompensations.createJob(): response.compensations[].title Added
+gustoembedded.jobsAndCompensations.getJob(): response.compensations[].title Added
+gustoembedded.employeeEmployments.deleteRehire(): error.status[422] Added
+gustoembedded.events.get():
+
+
+request Changed
+
+
+sortOrder Changed
+xGustoApiVersion Changed
+
+error.status[422] Added
+
+gustoembedded.employeeEmployments.deleteTermination(): error.status[422] Added
+gustoembedded.historicalEmployees.update(): response.jobs[].compensations[].title Added
+gustoembedded.contractors.updateOnboardingStatus():
+
+
+requestBody.onboardingStatus Changed
+
+
+enum(adminOnboardingIncomplete) Added
+enum(adminOnboardingReview) Added
+enum(selfOnboardingInvited) Added
+enum(selfOnboardingNotInvited) Added
+enum(selfOnboardingReview) Added
+enum(selfOnboardingStarted) Added
+
+
+gustoembedded.employees.createHistorical(): response.jobs[].compensations[].title Added
+gustoembedded.externalPayrolls.calculateTaxes(): error.status[422] Added
+gustoembedded.externalPayrolls.delete(): error.status[422] Added
+gustoembedded.locations.get():
+
+
+request.xGustoApiVersion Changed
+error.status[404] Added
+
+gustoembedded.signatories.delete():
+
+
+request.xGustoApiVersion Changed
+error.status[404] Added
+
+gustoembedded.signatories.list():
+
+
+request.xGustoApiVersion Changed
+error.status[404] Added
+
+gustoembedded.industrySelection.get():
+
+
+request.xGustoApiVersion Changed
+error.status[404] Added
+
+gustoembedded.companies.finishOnboarding():
+
+
+request.xGustoApiVersion Changed
+error.status[404] Added
+
+gustoembedded.companies.getOnboardingStatus():
+
+
+request.xGustoApiVersion Changed
+error.status[404] Added
+
+gustoembedded.companies.update():
+
+
+request.xGustoApiVersion Changed
+response.locations[].active Added
+error.status[404] Added
+
+gustoembedded.companies.get():
+
+
+request.xGustoApiVersion Changed
+response.locations[].active Added
+error.status[404] Added
+
+gustoembedded.introspection.getInfo():
+
+
+request.xGustoApiVersion Changed
+response Changed
+
+
+resource.type Changed
+resource.uuid Changed
+resourceOwner.type Changed
+resourceOwner.uuid Changed
+scope Changed
+
+
+gustoembedded.companies.migrate(): Removed (Breaking ⚠️)
+gustoembedded.payrolls.submit(): Added
+gustoembedded.payrolls.calculate(): Added
+
+
+
\ No newline at end of file
diff --git a/.speakeasy/logs/changes/changes.md b/.speakeasy/logs/changes/changes.md
new file mode 100644
index 00000000..3373d5a0
--- /dev/null
+++ b/.speakeasy/logs/changes/changes.md
@@ -0,0 +1,901 @@
+## Java SDK Changes:
+* `gustoembedded.contractorPaymentGroups.patchV1ContractorPaymentGroupsIdPartnerDisbursements()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeAddresses.delete()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.peopleBatches.getV1PeopleBatchesPeopleBatchUuid()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ - `enum(20251115)` **Removed** (Breaking ⚠️)
+ * `response` **Changed**
+ - `idempotencyKey` **Changed**
+ - `status` **Changed**
+ - `uuid` **Changed**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.peopleBatches.postV1CompaniesCompanyIdPeopleBatches()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `requestBody.batch[].compensation.effectiveDate` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion.enum(20250615)` **Added**
+ - `xGustoApiVersion.enum(20251115)` **Removed** (Breaking ⚠️)
+ * `response` **Changed** (Breaking ⚠️)
+ - `batchAction` **Changed**
+ - `idempotencyKey` **Changed**
+ - `status.enum(partialSuccess)` **Added** (Breaking ⚠️)
+ - `uuid` **Changed**
+ * `error` **Changed** (Breaking ⚠️)
+ - `errors[].errors` **Removed** (Breaking ⚠️)
+ - `errors[].metadata` **Removed** (Breaking ⚠️)
+ - `rawResponse` **Removed** (Breaking ⚠️)
+* `gustoembedded.reimbursements.deleteV1RecurringReimbursements()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.reimbursements.putV1RecurringReimbursements()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.introspection.oauthAccessToken()`: `request` **Changed** (Breaking ⚠️)
+ - `requestBody.union(1)` **Removed** (Breaking ⚠️)
+ - `requestBody.union(2)` **Removed** (Breaking ⚠️)
+ - `requestBody.union(Refresh Token Request)` **Added**
+ - `requestBody.union(System Access Token Request)` **Added**
+ - `xGustoApiVersion.enum(20240401)` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion.enum(20250615)` **Added**
+* `gustoembedded.reimbursements.getV1RecurringReimbursements()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.reimbursements.postV1EmployeesEmployeeIdRecurringReimbursements()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.reimbursements.getV1EmployeesEmployeeIdRecurringReimbursements()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.salaryEstimates.getV1SalaryEstimatesOccupations()`: `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+* `gustoembedded.companies.suspensions.get()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.salaryEstimates.postV1SalaryEstimatesUuidAccept()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.industrySelection.update()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `companyIndustrySelectionRequiredBody` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.signatories.create()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `signatoryCreateRequest` **Added** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.salaryEstimates.putV1SalaryEstimatesId()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.signatories.invite()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `signatoryInviteRequest` **Added** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.signatories.update()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `signatoryUpdateRequest` **Added** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `error` **Changed**
+ - `` **Added**
+ - `status[409]` **Added**
+* `gustoembedded.salaryEstimates.getV1SalaryEstimatesId()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.flows.create()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `createFlowRequest` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.locations.create()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `companyLocationRequest` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.salaryEstimates.postV1EmployeesEmployeeIdSalaryEstimates()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.locations.retrieve()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.locations.update()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.locations.getMinimumWages()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.bankAccounts.get()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.bankAccounts.create()`:
+ * `response.status[200]` **Added** (Breaking ⚠️)
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.bankAccounts.verify()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `companyBankAccountVerifyRequest` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.bankAccounts.deleteV1CompaniesCompanyIdBankAccountsBankAccountId()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.wireInRequests.list()`: `response.[].paymentType.enum(contractorPaymentGroup)` **Added** (Breaking ⚠️)
+* `gustoembedded.wireInRequests.submit()`: `response.paymentType.enum(contractorPaymentGroup)` **Added** (Breaking ⚠️)
+* `gustoembedded.externalPayrolls.listTaxLiabilities()`: `response.[]` **Changed** (Breaking ⚠️)
+* `gustoembedded.externalPayrolls.updateTaxLiabilities()`: `response.[]` **Changed** (Breaking ⚠️)
+* `gustoembedded.paymentConfigs.get()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response.paymentSpeed` **Changed** (Breaking ⚠️)
+ * `error.status[404]` **Added**
+* `gustoembedded.paymentConfigs.update()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `paymentConfigsUpdateRequest` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `response.paymentSpeed` **Changed** (Breaking ⚠️)
+ * `error.status[404]` **Added**
+* `gustoembedded.paySchedules.create()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `payScheduleCreateRequest` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `anchorEndOfPayPeriod` **Changed** (Breaking ⚠️)
+ - `anchorPayDate` **Changed** (Breaking ⚠️)
+ - `autoPayrollEnablementBlockers` **Added**
+ - `autoPayroll` **Added**
+ - `frequency.enum(annually)` **Added** (Breaking ⚠️)
+ - `frequency.enum(quarterly)` **Added** (Breaking ⚠️)
+ - `version` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.paySchedules.getAll()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response.[]` **Changed** (Breaking ⚠️)
+ - `anchorEndOfPayPeriod` **Changed** (Breaking ⚠️)
+ - `anchorPayDate` **Changed** (Breaking ⚠️)
+ - `autoPayrollEnablementBlockers` **Added**
+ - `autoPayroll` **Added**
+ - `version` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.paySchedules.getPreview()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `anchorEndOfPayPeriod` **Changed** (Breaking ⚠️)
+ - `anchorPayDate` **Changed** (Breaking ⚠️)
+ - `endDate` **Added**
+ - `xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `holidays[]` **Changed** (Breaking ⚠️)
+ - `payPeriods[].checkDate` **Changed** (Breaking ⚠️)
+ - `payPeriods[].endDate` **Changed** (Breaking ⚠️)
+ - `payPeriods[].runPayrollBy` **Changed** (Breaking ⚠️)
+ - `payPeriods[].startDate` **Changed** (Breaking ⚠️)
+ * `error` **Changed**
+ - `status[404]` **Added**
+ - `status[422]` **Added**
+* `gustoembedded.paySchedules.get()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `anchorEndOfPayPeriod` **Changed** (Breaking ⚠️)
+ - `anchorPayDate` **Changed** (Breaking ⚠️)
+ - `autoPayrollEnablementBlockers` **Added**
+ - `autoPayroll` **Added**
+ - `version` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.paySchedules.update()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `payScheduleUpdateRequest` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `anchorEndOfPayPeriod` **Changed** (Breaking ⚠️)
+ - `anchorPayDate` **Changed** (Breaking ⚠️)
+ - `autoPayrollEnablementBlockers` **Added**
+ - `autoPayroll` **Added**
+ - `frequency.enum(annually)` **Added** (Breaking ⚠️)
+ - `frequency.enum(quarterly)` **Added** (Breaking ⚠️)
+ - `version` **Added**
+ * `error` **Changed**
+ - `` **Added**
+ - `status[409]` **Added**
+* `gustoembedded.paySchedules.getPayPeriods()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `endDate` **Changed** (Breaking ⚠️)
+ - `payrollTypes` **Changed** (Breaking ⚠️)
+ - `startDate` **Changed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `error` **Changed**
+ - `` **Added**
+ - `status[422]` **Added**
+* `gustoembedded.employees.list()`:
+ * `response.[].jobs[].compensations[].title` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.contractorPaymentMethod.get()`: `response.type.enum(null)` **Removed** (Breaking ⚠️)
+* `gustoembedded.wireInRequests.get()`: `response.paymentType.enum(contractorPaymentGroup)` **Added** (Breaking ⚠️)
+* `gustoembedded.employees.get()`:
+ * `response.jobs[].compensations[].title` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employees.update()`:
+ * `response.jobs[].compensations[].title` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employees.delete()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employees.updateOnboardingDocumentsConfig()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `employeeOnboardingDocumentsConfigRequest` **Added**
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `i9Document` **Changed** (Breaking ⚠️)
+ - `uuid` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.recoveryCases.get()`: `response.[]` **Changed** (Breaking ⚠️)
+ - `latestErrorCode` **Changed** (Breaking ⚠️)
+ - `originalDebitDate` **Changed** (Breaking ⚠️)
+* `gustoembedded.employees.updateOnboardingStatus()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.informationRequests.submit()`: `response.requiredQuestions[].responseType.enum(radioButton)` **Added** (Breaking ⚠️)
+* `gustoembedded.informationRequests.getInformationRequests()`: `response.[].requiredQuestions[].responseType.enum(radioButton)` **Added** (Breaking ⚠️)
+* `gustoembedded.holidayPayPolicies.removeEmployees()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeEmployments.getHistory()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeAddresses.get()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeAddresses.create()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeAddresses.retrieveHomeAddress()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeAddresses.update()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.contractors.getV1CompaniesCompanyIdContractorsPaymentDetails()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeAddresses.getWorkAddresses()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeAddresses.createWorkAddress()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeAddresses.retrieveWorkAddress()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeAddresses.updateWorkAddress()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeAddresses.deleteWorkAddress()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.holidayPayPolicies.addEmployees()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeTaxSetup.updateFederalTaxes()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `requestBody.additionalWithholding` **Changed** (Breaking ⚠️)
+ - `requestBody.deductions` **Changed** (Breaking ⚠️)
+ - `requestBody.dependentsAmount` **Changed** (Breaking ⚠️)
+ - `requestBody.extraWithholding` **Changed** (Breaking ⚠️)
+ - `requestBody.filingStatus` **Changed** (Breaking ⚠️)
+ - `requestBody.otherIncome` **Changed** (Breaking ⚠️)
+ - `requestBody.w4DataType` **Changed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `response` **Changed**
+ - `union(pre_2020_w4).companyId` **Added**
+ - `union(pre_2020_w4).employeeId` **Added**
+ - `union(rev_2020_w4).companyId` **Added**
+ - `union(rev_2020_w4).employeeId` **Added**
+ * `error` **Changed**
+ - `` **Added**
+ - `status[409]` **Added**
+* `gustoembedded.employeeTaxSetup.getStateTaxes()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeTaxSetup.updateStateTaxes()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.holidayPayPolicies.delete()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.holidayPayPolicies.update()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeePaymentMethod.update()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `requestBody.splitBy` **Changed**
+ - `requestBody.splits[].splitAmount` **Changed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `error` **Changed**
+ - `` **Added**
+ - `status[409]` **Added**
+* `gustoembedded.holidayPayPolicies.create()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.holidayPayPolicies.get()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.i9Verification.employerSign()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `i9AuthorizationEmployerSignRequestBody` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `additionalInfo` **Changed** (Breaking ⚠️)
+ - `altProcedure` **Changed** (Breaking ⚠️)
+ - `country` **Changed** (Breaking ⚠️)
+ - `documentType` **Changed** (Breaking ⚠️)
+ - `expirationDate` **Changed** (Breaking ⚠️)
+ - `formUuid` **Changed** (Breaking ⚠️)
+ - `hasDocumentNumber` **Changed** (Breaking ⚠️)
+ * `error.status[404]` **Added**
+* `gustoembedded.i9Verification.createDocuments()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `i9AuthorizationDocumentsRequestBody` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `status[200]` **Removed** (Breaking ⚠️)
+ - `status[201]` **Added** (Breaking ⚠️)
+ * `error.status[404]` **Added**
+* `gustoembedded.i9Verification.getDocuments()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response.[].expirationDate` **Changed** (Breaking ⚠️)
+ * `error.status[404]` **Added**
+* `gustoembedded.i9Verification.update()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `i9AuthorizationRequestBody` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `additionalInfo` **Changed** (Breaking ⚠️)
+ - `altProcedure` **Changed** (Breaking ⚠️)
+ - `country` **Changed** (Breaking ⚠️)
+ - `documentType` **Changed** (Breaking ⚠️)
+ - `expirationDate` **Changed** (Breaking ⚠️)
+ - `formUuid` **Changed** (Breaking ⚠️)
+ - `hasDocumentNumber` **Changed** (Breaking ⚠️)
+ * `error.status[404]` **Added**
+* `gustoembedded.jobsAndCompensations.createCompensation()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `compensationsRequestBody` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `response.title` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.i9Verification.getAuthorization()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `additionalInfo` **Changed** (Breaking ⚠️)
+ - `altProcedure` **Changed** (Breaking ⚠️)
+ - `country` **Changed** (Breaking ⚠️)
+ - `documentType` **Changed** (Breaking ⚠️)
+ - `expirationDate` **Changed** (Breaking ⚠️)
+ - `formUuid` **Changed** (Breaking ⚠️)
+ - `hasDocumentNumber` **Changed** (Breaking ⚠️)
+ * `error.status[404]` **Added**
+* `gustoembedded.jobsAndCompensations.updateCompensation()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `compensationsUpdateRequestBody` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `response.title` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.employeeBenefits.patchV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYear()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.contractors.create()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `contractorCreateRequestBody` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `departmentTitle` **Added**
+ - `dismissalCancellationEligible` **Added**
+ - `paymentMethod.enum(null)` **Removed** (Breaking ⚠️)
+ - `rehireCancellationEligible` **Added**
+ - `upcomingEmployment` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.contractors.list()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `onboardedActive` **Added**
+ - `onboarded` **Added**
+ - `sortBy` **Changed** (Breaking ⚠️)
+ - `terminatedToday` **Added**
+ - `terminated` **Added**
+ - `xGustoApiVersion` **Changed**
+ * `response.[]` **Changed** (Breaking ⚠️)
+ - `departmentTitle` **Added**
+ - `dismissalCancellationEligible` **Added**
+ - `paymentMethod.enum(null)` **Removed** (Breaking ⚠️)
+ - `rehireCancellationEligible` **Added**
+ - `upcomingEmployment` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.contractors.get()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `departmentTitle` **Added**
+ - `dismissalCancellationEligible` **Added**
+ - `paymentMethod.enum(null)` **Removed** (Breaking ⚠️)
+ - `rehireCancellationEligible` **Added**
+ - `upcomingEmployment` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.contractors.update()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `contractorUpdateRequestBody` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `departmentTitle` **Added**
+ - `dismissalCancellationEligible` **Added**
+ - `paymentMethod.enum(null)` **Removed** (Breaking ⚠️)
+ - `rehireCancellationEligible` **Added**
+ - `upcomingEmployment` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.employeeBenefits.getV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYear()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employees.getOnboardingStatus()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employeeBenefits.postV1EmployeesEmployeeUuidSection603HighEarnerStatuses()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.employees.create()`:
+ * `requestBody.email` **Changed**
+ * `response.jobs[].compensations[].title` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.contractorPaymentMethod.update()`: `response.type.enum(null)` **Removed** (Breaking ⚠️)
+* `gustoembedded.webhooks.createSubscription()`: `response.subscriptionTypes[].enum(payrollSync)` **Added** (Breaking ⚠️)
+* `gustoembedded.webhooks.listSubscriptions()`: `response.[].subscriptionTypes[].enum(payrollSync)` **Added** (Breaking ⚠️)
+* `gustoembedded.webhooks.updateSubscription()`: `response.subscriptionTypes[].enum(payrollSync)` **Added** (Breaking ⚠️)
+* `gustoembedded.webhooks.getSubscription()`: `response.subscriptionTypes[].enum(payrollSync)` **Added** (Breaking ⚠️)
+* `gustoembedded.webhooks.verify()`: `response.subscriptionTypes[].enum(payrollSync)` **Added** (Breaking ⚠️)
+* `gustoembedded.payrolls.list()`:
+ * `response.[].creditBlockers[].unblockOptions[]` **Changed**
+ - `union(submit_bank_screenshot).metadata.bankAccountLastFourDigits` **Added**
+ - `union(wait_for_reverse_wire).metadata.bankAccountLastFourDigits` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.payrolls.createOffCycle()`:
+ * `requestBody.employeeUuids` **Changed**
+ * `response.employeeCompensations[]` **Changed** (Breaking ⚠️)
+ - `deductions` **Removed** (Breaking ⚠️)
+ - `paidTimeOff[].finalPayoutUnusedHoursInput` **Changed** (Breaking ⚠️)
+ - `version` **Changed** (Breaking ⚠️)
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.payrolls.get()`:
+ * `response` **Changed** (Breaking ⚠️)
+ - `creditBlockers[].unblockOptions[].union(submit_bank_screenshot).metadata.bankAccountLastFourDigits` **Added**
+ - `creditBlockers[].unblockOptions[].union(wait_for_reverse_wire).metadata.bankAccountLastFourDigits` **Added**
+ - `employeeCompensations[].additionalProperties` **Added**
+ - `employeeCompensations[].paidTimeOff[].finalPayoutUnusedHoursInput` **Changed** (Breaking ⚠️)
+ - `employeeCompensations[].version` **Changed** (Breaking ⚠️)
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.payrolls.update()`:
+ * `request.payrollUpdate.employeeCompensations[].paidTimeOff[].finalPayoutUnusedHoursInput` **Changed**
+ * `response.employeeCompensations[]` **Changed** (Breaking ⚠️)
+ - `paidTimeOff[].finalPayoutUnusedHoursInput` **Changed** (Breaking ⚠️)
+ - `version` **Changed** (Breaking ⚠️)
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.payrolls.delete()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.payrolls.prepare()`:
+ * `request` **Changed**
+ - `requestBody.employeeUuids` **Changed**
+ - `sortBy` **Changed**
+ - `xGustoApiVersion` **Changed**
+ * `response.employeeCompensations[]` **Changed** (Breaking ⚠️)
+ - `paidTimeOff[].finalPayoutUnusedHoursInput` **Changed** (Breaking ⚠️)
+ - `version` **Changed** (Breaking ⚠️)
+ * `error` **Changed**
+ - `` **Added**
+ - `status[422]` **Added**
+* `gustoembedded.payrolls.getReceipt()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.payrolls.getBlockers()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response.[]` **Changed** (Breaking ⚠️)
+ - `key` **Changed** (Breaking ⚠️)
+ - `message` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.payrolls.cancel()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response` **Changed** (Breaking ⚠️)
+ - `companyTaxes` **Removed** (Breaking ⚠️)
+ - `creditBlockers` **Removed** (Breaking ⚠️)
+ - `finalTerminationPayroll` **Removed** (Breaking ⚠️)
+ - `fixedWithholdingRate` **Removed** (Breaking ⚠️)
+ - `paymentSpeedChanged` **Removed** (Breaking ⚠️)
+ - `payrollStatusMeta` **Removed** (Breaking ⚠️)
+ - `payrollTaxes` **Removed** (Breaking ⚠️)
+ - `processingRequest` **Removed** (Breaking ⚠️)
+ - `skipRegularDeductions` **Removed** (Breaking ⚠️)
+ - `submissionBlockers` **Removed** (Breaking ⚠️)
+ - `totals` **Removed** (Breaking ⚠️)
+ - `withholdingPayPeriod` **Removed** (Breaking ⚠️)
+ * `error.status[404]` **Added**
+* `gustoembedded.payrolls.getPayStub()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.payrolls.getPayStubs()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.payrolls.generatePrintableChecks()`: `response.startingCheckNumber` **Changed** (Breaking ⚠️)
+* `gustoembedded.payrolls.getV1CompaniesCompanyIdPayrollsIdPartnerDisbursements()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.payrolls.patchV1CompaniesCompanyIdPayrollsIdPartnerDisbursements()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.timeOffPolicies.calculateAccruingTimeOffHours()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `payrollCalculateAccruingTimeOffHoursRequest` **Added**
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.timeOffPolicies.get()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.timeOffPolicies.update()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.timeOffPolicies.getAll()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.timeOffPolicies.create()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.timeOffPolicies.addEmployees()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.timeOffPolicies.removeEmployees()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.timeOffPolicies.updateBalance()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.timeOffPolicies.deactivate()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.contractorPayments.create()`:
+ * `request` **Changed** (Breaking ⚠️)
+ - `contractorPaymentBody` **Added** (Breaking ⚠️)
+ - `requestBody` **Removed** (Breaking ⚠️)
+ - `xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.employeeBenefits.getV1EmployeesEmployeeUuidSection603HighEarnerStatuses()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.companyBenefits.getRequirements()`: `response.employeeDeduction.choices` **Changed** (Breaking ⚠️)
+* `gustoembedded.companyBenefits.delete()`: `error` **Changed** (Breaking ⚠️)
+ - `errors` **Changed** (Breaking ⚠️)
+ - `rawResponse` **Removed** (Breaking ⚠️)
+* `gustoembedded.contractorPaymentGroups.getList()`:
+ * `response.[]` **Changed** (Breaking ⚠️)
+ - `creditBlockers[]` **Changed** (Breaking ⚠️)
+ - `submissionBlockers[]` **Changed** (Breaking ⚠️)
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.contractorPaymentGroups.create()`:
+ * `requestBody` **Changed** (Breaking ⚠️)
+ - `contractorPayments[].bonus` **Changed** (Breaking ⚠️)
+ - `contractorPayments[].hours` **Changed** (Breaking ⚠️)
+ - `contractorPayments[].reimbursement` **Changed** (Breaking ⚠️)
+ - `contractorPayments[].wage` **Changed** (Breaking ⚠️)
+ - `submissionBlockers` **Added**
+ * `response` **Changed** (Breaking ⚠️)
+ - `creditBlockers[]` **Changed** (Breaking ⚠️)
+ - `submissionBlockers[]` **Changed** (Breaking ⚠️)
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.contractorPaymentGroups.preview()`:
+ * `requestBody.contractorPayments[]` **Changed** (Breaking ⚠️)
+ - `bonus` **Changed** (Breaking ⚠️)
+ - `hours` **Changed** (Breaking ⚠️)
+ - `reimbursement` **Changed** (Breaking ⚠️)
+ - `wage` **Changed** (Breaking ⚠️)
+ * `response` **Changed** (Breaking ⚠️)
+ - `creditBlockers[]` **Changed** (Breaking ⚠️)
+ - `submissionBlockers[]` **Changed** (Breaking ⚠️)
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.contractorPaymentGroups.get()`:
+ * `response` **Changed** (Breaking ⚠️)
+ - `creditBlockers[]` **Changed** (Breaking ⚠️)
+ - `submissionBlockers[]` **Changed** (Breaking ⚠️)
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.contractorPaymentGroups.delete()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.contractorPaymentGroups.fund()`:
+ * `response` **Changed** (Breaking ⚠️)
+ - `creditBlockers[]` **Changed** (Breaking ⚠️)
+ - `submissionBlockers[]` **Changed** (Breaking ⚠️)
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.contractorPaymentGroups.getV1ContractorPaymentGroupsIdPartnerDisbursements()`: `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.companyBenefits.get()`: `response.employeeBenefits[]` **Changed** (Breaking ⚠️)
+ - `action` **Removed** (Breaking ⚠️)
+ - `uuid` **Removed** (Breaking ⚠️)
+* `gustoembedded.companyForms.getAll()`: `request.sortBy` **Changed** (Breaking ⚠️)
+* `gustoembedded.reports.postV1CompaniesCompanyIdReportsEmployeesAnnualFicaWage()`:
+ * `request.xGustoApiVersion` **Changed** (Breaking ⚠️)
+ - `enum(20240401)` **Removed** (Breaking ⚠️)
+ - `enum(20250615)` **Added**
+ * `errors[]` **Changed** (Breaking ⚠️)
+ - `errors` **Removed** (Breaking ⚠️)
+ - `metadata` **Removed** (Breaking ⚠️)
+* `gustoembedded.reports.createCustom()`:
+ * `requestBody.employeeUuids` **Changed**
+* `gustoembedded.employeeTaxSetup.getFederalTaxes()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response` **Changed**
+ - `union(pre_2020_w4).companyId` **Added**
+ - `union(pre_2020_w4).employeeId` **Added**
+ - `union(rev_2020_w4).companyId` **Added**
+ - `union(rev_2020_w4).employeeId` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.companyBenefits.update()`: `requestBody` **Changed**
+ - `responsibleForEmployeeW2` **Added**
+ - `responsibleForEmployerTaxes` **Added**
+* `gustoembedded.contractorPayments.delete()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.companyBenefits.updateEmployeeBenefits()`:
+ * `requestBody.employeeBenefits[]` **Changed**
+ - `action` **Added**
+ - `uuid` **Added**
+* `gustoembedded.contractorPayments.get()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.employeeBenefits.delete()`: `error.status[422]` **Added**
+* `gustoembedded.contractorPayments.list()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.payrolls.calculateGrossUp()`: **Added**
+* `gustoembedded.contractors.delete()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error` **Changed**
+ - `` **Added**
+ - `status[422]` **Added**
+* `gustoembedded.jobsAndCompensations.deleteCompensation()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error` **Changed**
+ - `` **Added**
+ - `status[422]` **Added**
+* `gustoembedded.jobsAndCompensations.getCompensation()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response.title` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.jobsAndCompensations.getCompensations()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response.[].title` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.i9Verification.getDocumentOptions()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.jobsAndCompensations.delete()`: `error.status[422]` **Added**
+* `gustoembedded.jobsAndCompensations.update()`: `response.compensations[].title` **Added**
+* `gustoembedded.i9Verification.deleteDocument()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error` **Changed**
+ - `` **Added**
+ - `status[422]` **Added**
+* `gustoembedded.employeePaymentMethod.get()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.jobsAndCompensations.getJobs()`: `response.[].compensations[].title` **Added**
+* `gustoembedded.employeePaymentMethod.deleteBankAccount()`: `error.status[422]` **Added**
+* `gustoembedded.companies.getV1PartnerManagedCompaniesCompanyUuidMigrationReadiness()`: **Added**
+* `gustoembedded.jobsAndCompensations.createJob()`: `response.compensations[].title` **Added**
+* `gustoembedded.jobsAndCompensations.getJob()`: `response.compensations[].title` **Added**
+* `gustoembedded.employeeEmployments.deleteRehire()`: `error.status[422]` **Added**
+* `gustoembedded.events.get()`:
+ * `request` **Changed**
+ - `sortOrder` **Changed**
+ - `xGustoApiVersion` **Changed**
+ * `error.status[422]` **Added**
+* `gustoembedded.employeeEmployments.deleteTermination()`: `error.status[422]` **Added**
+* `gustoembedded.historicalEmployees.update()`: `response.jobs[].compensations[].title` **Added**
+* `gustoembedded.contractors.updateOnboardingStatus()`:
+ * `requestBody.onboardingStatus` **Changed**
+ - `enum(adminOnboardingIncomplete)` **Added**
+ - `enum(adminOnboardingReview)` **Added**
+ - `enum(selfOnboardingInvited)` **Added**
+ - `enum(selfOnboardingNotInvited)` **Added**
+ - `enum(selfOnboardingReview)` **Added**
+ - `enum(selfOnboardingStarted)` **Added**
+* `gustoembedded.employees.createHistorical()`: `response.jobs[].compensations[].title` **Added**
+* `gustoembedded.externalPayrolls.calculateTaxes()`: `error.status[422]` **Added**
+* `gustoembedded.externalPayrolls.delete()`: `error.status[422]` **Added**
+* `gustoembedded.locations.get()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.signatories.delete()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.signatories.list()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.industrySelection.get()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.companies.finishOnboarding()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.companies.getOnboardingStatus()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `error.status[404]` **Added**
+* `gustoembedded.companies.update()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response.locations[].active` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.companies.get()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response.locations[].active` **Added**
+ * `error.status[404]` **Added**
+* `gustoembedded.introspection.getInfo()`:
+ * `request.xGustoApiVersion` **Changed**
+ * `response` **Changed**
+ - `resource.type` **Changed**
+ - `resource.uuid` **Changed**
+ - `resourceOwner.type` **Changed**
+ - `resourceOwner.uuid` **Changed**
+ - `scope` **Changed**
+* `gustoembedded.companies.migrate()`: **Removed** (Breaking ⚠️)
+* `gustoembedded.payrolls.submit()`: **Added**
+* `gustoembedded.payrolls.calculate()`: **Added**
diff --git a/.speakeasy/logs/changes/new.openapi.yaml b/.speakeasy/logs/changes/new.openapi.yaml
new file mode 100644
index 00000000..4d956eef
--- /dev/null
+++ b/.speakeasy/logs/changes/new.openapi.yaml
@@ -0,0 +1,34988 @@
+openapi: 3.1.0
+tags:
+ - name: Introspection
+ - name: Companies
+ - name: Flows
+ - name: Locations
+ - name: Bank Accounts
+ - name: Payment Configs
+ - name: Pay Schedules
+ - name: Employees
+ - name: Employee Tax Setup
+ - name: Employee Payment Method
+ - name: Employee Employments
+ - name: Employee Addresses
+ - name: Jobs and Compensations
+ - name: Earning Types
+ - name: I-9 Verification
+ - name: Contractor Payment Groups
+ - name: Contractor Payment Method
+ - name: Contractor Payments
+ - name: Contractors
+ - name: Payrolls
+ - name: Company Forms
+ - name: Contractor Documents
+ - name: Employee Forms
+ - name: Company Benefits
+ - name: Employee Benefits
+ - name: Garnishments
+ - name: Federal Tax Details
+ - name: Industry Selection
+ - name: Signatories
+ - name: External Payrolls
+ - name: Tax Requirements
+ - name: Contractor Forms
+ - name: Time Off Policies
+ - name: Holiday Pay Policies
+ - name: Departments
+ - name: Reports
+ - name: Generated Documents
+ - name: Notifications
+ - name: Webhooks
+ - name: Events
+ - name: Invoices
+ - name: Recovery Cases
+ - name: Company Attachment
+ - name: Wire In Requests
+ - name: ACH Transactions
+ - name: Information Requests
+ - name: Time Tracking
+ - name: Time Off Requests
+ - name: Salary Estimates
+ - name: Reimbursements
+ - name: People Batches
+info:
+ title: Gusto API
+ version: '2025-06-15'
+ termsOfService: https://gusto.com/about/terms/developer-terms-of-service
+ description: Welcome to Gusto's Embedded Payroll API documentation!
+ contact:
+ name: Developer Relations
+ email: developer@gusto.com
+servers:
+ - url: https://api.gusto-demo.com
+ description: Demo
+ x-speakeasy-server-id: demo
+ - url: https://api.gusto.com
+ description: Prod
+ x-speakeasy-server-id: prod
+paths:
+ "/v1/token_info":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get info about the current access token
+ tags:
+ - Introspection
+ 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.
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Token-Info"
+ operationId: get-v1-token-info
+ x-speakeasy-name-override: getInfo
+ "/oauth/token":
+ post:
+ summary: Create a System Access Token or Refresh an Access Token
+ operationId: oauth-access-token
+ security: []
+ description: Creates a system access token or refreshes an oauth access token
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ x-gusto-rswag: true
+ requestBody:
+ 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
+ tags:
+ - Introspection
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Authentication"
+ "/v1/partner_managed_companies":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ operationId: post-v1-partner-managed-companies
+ summary: Create a partner managed company
+ tags:
+ - Companies
+ description: "Create a partner managed company. When you successfully call the API, it does the following:\n* Creates a new company in Gusto\n* Creates a new user using the provided email if the user does not already exist.\n* Makes the user the primary payroll administrator of the new company.\n\nIn response, you will receive oauth access tokens for the created company.\n\nIMPORTANT: 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.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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)"
+ requestBody:
+ 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
+ security:
+ - SystemAccessAuth: []
+ 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
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '401':
+ description: Authorization information is missing or invalid.
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: createPartnerManaged
+ "/v1/companies/{company_id}":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a company
+ operationId: get-v1-companies
+ 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.
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ tags:
+ - Companies
+ x-speakeasy-name-override: get
+ put:
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a company
+ operationId: put-v1-companies
+ description: |-
+ Update a company.
+
+ scope: `companies:write`
+ 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.
+ x-gusto-rswag: true
+ requestBody:
+ 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
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ tags:
+ - Companies
+ x-speakeasy-name-override: update
+ "/v1/partner_managed_companies/{company_uuid}/migrate":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Migrate company to embedded payroll
+ operationId: put-v1-partner-managed-companies-company-uuid-migrate
+ tags:
+ - Companies
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ 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
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ - "$ref": "#/components/schemas/Migration-Blocker"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-name-override: migrate
+ "/v1/partner_managed_companies/{company_uuid}/migration_readiness":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Check company migration readiness
+ operationId: get-v1-partner-managed-companies-company-uuid-migration_readiness
+ tags:
+ - Companies
+ 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.
+
+ scope: `partner_managed_companies:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ 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
+ - "$ref": "#/components/schemas/Migration-Blocker"
+ - "$ref": "#/components/schemas/Migration-Warning"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ "/v1/partner_managed_companies/{company_uuid}/accept_terms_of_service":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Accept terms of service for a company user
+ operationId: post-partner-managed-companies-company_uuid-accept_terms_of_service
+ tags:
+ - Companies
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ 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.
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: acceptTermsOfService
+ "/v1/partner_managed_companies/{company_uuid}/retrieve_terms_of_service":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Retrieve terms of service status for a company user
+ operationId: post-partner-managed-companies-company_uuid-retrieve_terms_of_service
+ tags:
+ - Companies
+ description: |-
+ Retrieve the user acceptance status of the Gusto Embedded Payroll's [Terms of Service](https://flows.gusto.com/terms).
+
+ scope: `terms_of_services:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ 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
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: retrieveTermsOfService
+ "/v1/invoices/{invoice_period}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Retrieve invoicing data for companies
+ operationId: get-invoices-invoice-period
+ tags:
+ - Invoices
+ 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) \n\n> \U0001F4D8 System Access Authentication\n>\n> 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)\n\nscope: `invoices:read`"
+ security:
+ - SystemAccessAuth: []
+ parameters:
+ - "$ref": "#/components/parameters/invoice_period"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - 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`
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Invoice-Data-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: get
+ "/v1/companies/{company_id}/attachments/{company_attachment_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get Company Attachment Details
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Attachment-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-attachment
+ description: |-
+ Retrieve the detail of an attachment uploaded by the company.
+
+ scope: `company_attachments:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/company_attachment_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Attachment
+ x-speakeasy-group: companyAttachments
+ x-speakeasy-name-override: getDetails
+ "/v1/companies/{company_id}/attachments/{company_attachment_uuid}/download_url":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a temporary url to download the Company Attachment file
+ 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':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-attachment-url
+ description: |-
+ Retrieve a temporary url to download a attachment file uploaded
+ by the company.
+
+ scope: `company_attachments:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/company_attachment_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Attachment
+ x-speakeasy-group: companyAttachment
+ x-speakeasy-name-override: getDownloadUrl
+ "/v1/companies/{company_id}/attachments":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get List of Company Attachments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Attachment-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-attachments
+ description: |-
+ Retrieve a list of all the attachments uploaded by the company.
+
+ scope: `company_attachments:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Attachment
+ x-speakeasy-group: companyAttachments
+ x-speakeasy-name-override: getList
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create Company Attachment and Upload File
+ responses:
+ '201':
+ "$ref": "#/components/responses/Company-Attachment-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ operationId: post-v1-companies-attachment
+ description: "Upload a file and create a company attachment. We recommend uploading\nPDF files for optimal compatibility. However, the following file types are\nallowed: .qbb, .qbm, .gif, .jpg, .png, .pdf, .xls, .xlsx, .doc and .docx. \n\nscope: `company_attachments:write`"
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Attachment
+ requestBody:
+ 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
+ x-speakeasy-group: companyAttachments
+ x-speakeasy-name-override: create
+ "/v1/companies/{company_id}/federal_tax_details":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get Federal Tax Details
+ responses:
+ '200':
+ "$ref": "#/components/responses/Federal-Tax-Details-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-federal_tax_details
+ description: |-
+ Fetches attributes relevant for a company's federal taxes.
+
+ scope: `company_federal_taxes:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Federal Tax Details
+ x-speakeasy-group: federalTaxDetails
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update Federal Tax Details
+ responses:
+ '200':
+ "$ref": "#/components/responses/Federal-Tax-Details-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_id-federal_tax_details
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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:
+ - 941 (Quarterly federal tax return)
+ - 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:'
+ description: |-
+ 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`
+ tags:
+ - Federal Tax Details
+ x-speakeasy-group: federalTaxDetails
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_id}/industry_selection":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Returns the industry classification for a company, including NAICS code, SIC codes, and industry title.
+
+ scope: `companies:read`
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a company industry selection
+ tags:
+ - Industry Selection
+ operationId: get-v1-company-industry
+ 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.
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Industry"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-group: industrySelection
+ x-speakeasy-name-override: get
+ put:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a company industry selection
+ tags:
+ - Industry Selection
+ operationId: put-v1-company-industry
+ 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.
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: Created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Industry"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Industry-Selection-Required-Body"
+ x-speakeasy-group: industrySelection
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_id}/admins":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create an admin for the company
+ tags:
+ - Companies
+ operationId: post-v1-companies-company_id-admins
+ responses:
+ '200':
+ "$ref": "#/components/responses/Admin-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ x-speakeasy-name-override: createAdmin
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all the admins at a company
+ tags:
+ - Companies
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ operationId: get-v1-companies-company_id-admins
+ responses:
+ '200':
+ "$ref": "#/components/responses/Admin-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ Returns a list of all the admins at a company
+
+ scope: `company_admin:read`
+ x-speakeasy-name-override: listAdmins
+ "/v1/companies/{company_uuid}/signatories":
+ post:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a signatory
+ tags:
+ - Signatories
+ operationId: post-v1-company-signatories
+ 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.
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Signatory"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Signatory-Create-Request"
+ x-speakeasy-name-override: create
+ get:
+ summary: Get the signatories for a company
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Returns the signatories for a company. A company has at most one signatory.
+
+ ## Related guides
+ - [Signatory Events](doc:signatory-events)
+
+ scope: `signatories:read`
+ x-gusto-integration-type:
+ - embedded
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Signatory"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_uuid-signatories
+ 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.
+ tags:
+ - Signatories
+ x-speakeasy-name-override: list
+ "/v1/companies/{company_uuid}/signatories/invite":
+ post:
+ security:
+ - CompanyAccessAuth: []
+ 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.
+
+ ## Related guides
+ - [Signatory Events](doc:signatory-events)
+
+ scope: `signatories:manage`
+ x-gusto-integration-type:
+ - embedded
+ summary: Invite a signatory
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Signatory"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_uuid-signatories-invite
+ 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.
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Signatory-Invite-Request"
+ tags:
+ - Signatories
+ x-speakeasy-name-override: invite
+ "/v1/companies/{company_uuid}/signatories/{signatory_uuid}":
+ put:
+ security:
+ - CompanyAccessAuth: []
+ 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.
+
+ ## Related guides
+ - [Signatory Events](doc:signatory-events)
+
+ scope: `signatories:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a signatory
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Signatory"
+ '409':
+ description: Conflict
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_uuid-signatories-signatory_uuid
+ 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.
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Signatory-Update-Request"
+ tags:
+ - Signatories
+ x-speakeasy-name-override: update
+ delete:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Deletes a company signatory.
+
+ ## Related guides
+ - [Signatory Events](doc:signatory-events)
+
+ scope: `signatories:manage`
+ x-gusto-integration-type:
+ - embedded
+ summary: Delete a signatory
+ operationId: delete-v1-companies-company_uuid-signatories-signatory_uuid
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: No Content
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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.
+ tags:
+ - Signatories
+ x-speakeasy-name-override: delete
+ "/v1/companies/{company_uuid}/onboarding_status":
+ get:
+ summary: Get company onboarding status
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ operationId: get-v1-company-onboarding-status
+ 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.
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Onboarding-Status"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ tags:
+ - Companies
+ x-speakeasy-name-override: getOnboardingStatus
+ "/v1/companies/{company_uuid}/finish_onboarding":
+ put:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ summary: Finish company onboarding
+ operationId: get-v1-company-finish-onboarding
+ 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.
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Onboarding-Status"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ tags:
+ - Companies
+ x-speakeasy-name-override: finishOnboarding
+ "/v1/companies/{company_id}/custom_fields":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: 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
+
+ scope: `companies:read`
+ operationId: get-v1-companies-company_id-custom_fields
+ tags:
+ - Companies
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Custom-Field-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getCustomFields
+ "/v1/companies/{company_uuid}/flows":
+ post:
+ security:
+ - CompanyAccessAuth: []
+ 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.
+
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a flow
+ tags:
+ - Flows
+ operationId: post-v1-company-flows
+ 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
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: Created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Flow"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Create-Flow-Request"
+ x-speakeasy-name-override: create
+ "/v1/companies/{company_id}/locations":
+ post:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a company location
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: Created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Location"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-locations
+ 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Location-Request"
+ tags:
+ - Locations
+ x-speakeasy-name-override: create
+ get:
+ summary: Get all company locations
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Locations-List"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-locations
+ tags:
+ - Locations
+ x-speakeasy-name-override: get
+ "/v1/locations/{location_id}":
+ get:
+ summary: Get a location
+ operationId: get-v1-locations-location_id
+ description: |-
+ Get a location.
+
+ scope: `companies:read`
+ tags:
+ - Locations
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Location"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: retrieve
+ put:
+ summary: Update a location
+ operationId: put-v1-locations-location_id
+ description: |-
+ Update a location.
+
+ scope: `companies:write`
+ tags:
+ - Locations
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Location"
+ '422':
+ description: Invalid state
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '409':
+ description: Invalid version param
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ x-speakeasy-name-override: update
+ "/v1/locations/{location_uuid}/minimum_wages":
+ get:
+ summary: Get minimum wages for a location
+ operationId: get-v1-locations-location_uuid-minimum_wages
+ description: |-
+ Get minimum wages for a location
+
+ scope: `companies:read`
+ tags:
+ - Locations
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Minimum-Wage-List"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: getMinimumWages
+ "/v1/companies/{company_id}/bank_accounts":
+ get:
+ summary: Get all company bank accounts
+ operationId: get-v1-companies-company_id-bank-accounts
+ description: |-
+ Returns company bank accounts. Currently, we only support a single default bank account per company.
+
+ scope: `company_bank_accounts:read`
+ tags:
+ - Bank Accounts
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Company-Bank-Account"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-group: bankAccounts
+ x-speakeasy-name-override: get
+ post:
+ summary: Create a company bank account
+ operationId: post-v1-companies-company_id-bank-accounts
+ description: "This endpoint creates a new company bank account.\n\nUpon being created, two verification deposits are automatically sent to the bank account, and the bank account's verification_status is 'awaiting_deposits'.\n\nWhen 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.\nAfter successful verification, the bank account's verification_status is 'verified'.\n\n\n>\U0001F6A7 Warning\n>\n> 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.\n\nscope: `company_bank_accounts:write`"
+ tags:
+ - Bank Accounts
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Bank account unchanged
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Bank-Account"
+ '201':
+ description: created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Bank-Account"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: Invalid Attribute
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Bank-Account-Request"
+ required: true
+ x-speakeasy-group: bankAccounts
+ x-speakeasy-name-override: create
+ "/v1/companies/{company_id}/bank_accounts/{bank_account_uuid}/verify":
+ put:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ summary: Verify a company bank account
+ operationId: put-v1-companies-company_id-bank-accounts-verify
+ tags:
+ - Bank Accounts
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Bank-Account"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Bank-Account-Verify-Request"
+ x-speakeasy-group: bankAccounts
+ x-speakeasy-name-override: verify
+ "/v1/companies/{company_uuid}/external_payrolls":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a new external payroll for a company
+ tags:
+ - External Payrolls
+ responses:
+ '200':
+ "$ref": "#/components/responses/External-Payroll-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-external-payroll
+ description: |-
+ Creates a new external payroll for the company.
+
+ scope: `external_payrolls:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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'
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get external payrolls for a company
+ tags:
+ - External Payrolls
+ operationId: get-v1-company-external-payrolls
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get an external payroll for a given company.
+
+ scope: `external_payrolls:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/External-Payroll-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: get
+ "/v1/companies/{company_uuid}/external_payrolls/{external_payroll_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get an external payroll
+ tags:
+ - External Payrolls
+ operationId: get-v1-external-payroll
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/external_payroll_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get an external payroll for a given company.
+
+ scope: `external_payrolls:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/External-Payroll-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: retrieve
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ summary: Delete an external payroll
+ tags:
+ - External Payrolls
+ operationId: delete-v1-external-payroll
+ description: |-
+ Delete an external payroll.
+
+ scope: `external_payrolls:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/external_payroll_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: delete
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update an external payroll
+ tags:
+ - External Payrolls
+ operationId: put-v1-external-payroll
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/external_payroll_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/External-Payroll-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ Update an external payroll with a list of external payroll items
+
+ scope: `external_payrolls:write`
+ requestBody:
+ 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
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_uuid}/external_payrolls/{external_payroll_id}/calculate_taxes":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get tax suggestions for an external payroll
+ tags:
+ - External Payrolls
+ operationId: get-v1-external-payroll-calculate-taxes
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/external_payroll_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ 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`
+ responses:
+ '200':
+ "$ref": "#/components/responses/External-Payroll-Tax-Suggestions-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: calculateTaxes
+ "/v1/companies/{company_uuid}/external_payrolls/tax_liabilities":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get tax liabilities
+ tags:
+ - External Payrolls
+ operationId: get-v1-tax-liabilities
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get tax liabilities from aggregate external payrolls for a company.
+
+ scope: `external_payrolls:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Tax-Liabilities-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: listTaxLiabilities
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update tax liabilities
+ tags:
+ - External Payrolls
+ operationId: put-v1-tax-liabilities
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Tax-Liabilities-List"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ Update tax liabilities for a company.
+
+ scope: `external_payrolls:write`
+ requestBody:
+ 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.0
+ - tax_id: 2
+ last_unpaid_external_payroll_uuid: 5ed14dbb-958f-47c8-b16e-c4fed82dc486
+ unpaid_liability_amount: 400.0
+ - tax_id: 8
+ last_unpaid_external_payroll_uuid:
+ unpaid_liability_amount: 0.0
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: updateTaxLiabilities
+ "/v1/companies/{company_uuid}/external_payrolls/tax_liabilities/finish":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Finalize tax liabilities options and convert into processed payrolls
+ tags:
+ - External Payrolls
+ operationId: put-v1-tax-liabilities-finish
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '202':
+ description: Accepted
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ Finalizes tax liabilities for a company. All external payrolls edit action will be disabled.
+
+ scope: `external_payrolls:write`
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: finalizeTaxLiabilities
+ "/v1/companies/{company_uuid}/payment_configs":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ 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.
+
+ ### Related guides
+ - [Payroll Processing Speeds](doc:2-day-vs-4-day)
+
+ scope: `company_payment_configs:read`
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a company's payment configs
+ tags:
+ - Payment Configs
+ operationId: get-v1-company-payment-configs
+ 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
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payment-Configs"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: get
+ x-speakeasy-group: paymentConfigs
+ put:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a company's payment configs
+ tags:
+ - Payment Configs
+ operationId: put-v1-company-payment-configs
+ 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
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payment-Configs"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payment-Configs-Update-Request"
+ x-speakeasy-group: paymentConfigs
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_id}/pay_schedules":
+ post:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ If a company does not have any pay schedules, this endpoint creates a single pay schedule and assigns it to all employees (common during company onboarding).
+
+ If a company already has an active pay schedule and wants multiple pay schedules, this endpoint creates 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. If an onboarded company misses their first pay date, the pay schedule may be automatically adjusted.
+
+ ### Webhooks
+ - `pay_schedule.created`: Fires when a pay schedule is successfully created.
+
+ ### Related guides
+ - [Create a pay schedule](doc:create-a-pay-schedule)
+ - [Pay Schedules](doc:pay-schedule-info)
+ - [Manage Pay Schedules via API](doc:manage-pay-schedules-api)
+
+ scope: `pay_schedules:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a new pay schedule
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: Created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Pay-Schedule"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-pay_schedules
+ 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
+ tags:
+ - Pay Schedules
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Pay-Schedule-Create-Request"
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: create
+ get:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Returns all pay schedules for a company. The pay schedule object captures the details of when employees work and when they should be paid. A company can have multiple pay schedules.
+
+ scope: `pay_schedules:read`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get the pay schedules for a company
+ 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: 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
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Pay-Schedule"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-pay_schedules
+ tags:
+ - Pay Schedules
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: getAll
+ "/v1/companies/{company_id}/pay_schedules/preview":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Returns a preview of pay period dates and holidays for the given parameters (e.g. frequency, anchor pay date) for the next 18 months. Use this before creating or updating a pay schedule to show expected check dates and payroll deadlines.
+
+ ### Related guides
+ - [Create a pay schedule](doc:create-a-pay-schedule)
+ - [Manage Pay Schedules via API](doc:manage-pay-schedules-api)
+
+ scope: `pay_schedules:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Preview pay schedule dates
+ 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: frequency
+ in: query
+ description: The frequency that employees on this pay schedule are paid.
+ 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.
+ schema:
+ format: date
+ type: string
+ 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
+ format: date
+ required: true
+ - name: day_1
+ in: query
+ description: |-
+ First pay day of the month (1-31).
+ - **Twice per month, Monthly:** required.
+ - **Every week, Every other week:** omit or null.
+ schema:
+ type: integer
+ required: false
+ - name: day_2
+ in: query
+ description: |-
+ Second pay day of the month (1-31); only for **Twice per month**.
+ - Use 31 for last day of month (shorter months use the actual last day).
+ - **Other frequencies:** omit or null.
+ schema:
+ type: integer
+ required: false
+ - name: end_date
+ in: query
+ required: false
+ schema:
+ type: string
+ format: date
+ description: End date for the preview range. When unspecified, defaults to 18 months from today.
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Pay-Schedule-Preview"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ operationId: get-v1-companies-company_id-pay_schedules-preview
+ tags:
+ - Pay Schedules
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: getPreview
+ "/v1/companies/{company_id}/pay_schedules/{pay_schedule_id}":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Returns a single pay schedule by UUID. The pay schedule object captures the details of when employees work and when they should be paid. A company can have multiple pay schedules.
+
+ scope: `pay_schedules:read`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a pay schedule
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Pay-Schedule"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-pay_schedules-pay_schedule_id
+ 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: pay_schedule_id
+ in: path
+ description: The UUID of the pay schedule
+ required: true
+ schema:
+ type: string
+ tags:
+ - Pay Schedules
+ x-speakeasy-name-override: get
+ x-speakeasy-group: paySchedules
+ put:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Updates a pay schedule. The `version` parameter from the GET response is required for [optimistic concurrency](doc:api-fundamentals); a mismatch returns 409 Conflict.
+
+ ### Pay schedules may be automatically adjusted
+ If an onboarded company misses their first pay date, the pay schedule may be automatically adjusted.
+
+ ### Webhooks
+ - `pay_schedule.updated`: Fires when a pay schedule is successfully updated.
+
+ ### Related guides
+ - [Create a pay schedule](doc:create-a-pay-schedule)
+ - [Manage Pay Schedules via API](doc:manage-pay-schedules-api)
+
+ scope: `pay_schedules:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a pay schedule
+ tags:
+ - Pay Schedules
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Pay-Schedule"
+ '409':
+ description: Conflict
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_id-pay_schedules-pay_schedule_id
+ 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: pay_schedule_id
+ in: path
+ description: The UUID of the pay schedule
+ required: true
+ schema:
+ type: string
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Pay-Schedule-Update-Request"
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_id}/pay_periods":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get pay periods for a company
+ tags:
+ - Payrolls
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Pay-Period"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ operationId: get-v1-companies-company_id-pay_periods
+ 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.
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: getPayPeriods
+ "/v1/companies/{company_id}/pay_periods/unprocessed_termination_pay_periods":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get termination pay periods for a company
+ tags:
+ - Pay Schedules
+ responses:
+ '200':
+ "$ref": "#/components/responses/Unprocessed-Termination-Pay-Period-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-unprocessed_termination_pay_periods
+ 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.
+
+ This endpoint returns the unprocessed pay periods for past and future terminated employees in a given company.
+
+ scope: `payrolls:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: getUnprocessedTerminationPeriods
+ "/v1/companies/{company_id}/pay_schedules/assignments":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get pay schedule assignments for a company
+ responses:
+ '200':
+ "$ref": "#/components/responses/Pay-Schedule-Assignment-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-pay_schedules-assignments
+ 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.
+
+ scope: `pay_schedules:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Pay Schedules
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: getAssignments
+ "/v1/companies/{company_id}/pay_schedules/assignment_preview":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Preview pay schedule assignments for a company
+ responses:
+ '200':
+ "$ref": "#/components/responses/Pay-Schedule-Assignment-Preview-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-pay_schedules-assignment_preview
+ description: |-
+ This endpoint returns the employee changes, including pay period and transition pay periods, for changing the pay schedule.
+
+ scope: `pay_schedules:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Pay Schedules
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: previewAssignment
+ "/v1/companies/{company_id}/pay_schedules/assign":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Assign pay schedules for a company
+ responses:
+ '200':
+ description: No Content
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-pay_schedules-assign
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Pay Schedules
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: assign
+ "/v1/companies/{company_id}/employees":
+ get:
+ summary: Get employees of a company
+ operationId: get-v1-companies-company_id-employees
+ description: |-
+ 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`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Show-Employees"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: list
+ post:
+ summary: Create an employee
+ operationId: post-v1-employees
+ description: |-
+ Create an employee.
+
+ scope: `employees:manage`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: invalid attributes
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-name-override: create
+ "/v1/companies/{company_id}/employees/payment_details":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get employee payment details for a company
+ operationId: get-v1-companies-company_id-employees-payment_details
+ tags:
+ - Employees
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - 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.
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ description: A list of employee payment details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/EmployeePaymentDetailsList"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ "/v1/companies/{company_uuid}/historical_employees":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a historical employee
+ operationId: post-v1-historical_employees
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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:
+ 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.
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Create a historical employee, an employee that was previously dismissed from the company in the current year.
+
+ scope: `employees:manage`
+ responses:
+ '201':
+ "$ref": "#/components/responses/Historical-Employee-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ tags:
+ - Employees
+ x-speakeasy-name-override: createHistorical
+ "/v1/companies/{company_uuid}/historical_employees/{historical_employee_uuid}":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a historical employee
+ operationId: put-v1-historical_employees
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - "$ref": "#/components/schemas/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:
+ 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.
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/historical_employee_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Update a historical employee, an employee that was previously dismissed from the company in the current year.
+
+ scope: `employees:manage`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Historical-Employee-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ tags:
+ - Employees
+ x-speakeasy-group: historicalEmployees
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_uuid}/departments":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: post-departments
+ summary: Create a department
+ tags:
+ - Departments
+ description: |-
+ Create a department
+
+ scope: `departments:write`
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ title:
+ type: string
+ examples:
+ Example:
+ value:
+ title: Stage Hand
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '201':
+ "$ref": "#/components/responses/Department-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all departments of a company
+ operationId: get-companies-departments
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get all of the departments for a given company with the employees and contractors assigned to that department.
+
+ scope: `departments:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Department-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ tags:
+ - Departments
+ x-speakeasy-name-override: getAll
+ "/v1/departments/{department_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: get-department
+ summary: Get a department
+ tags:
+ - Departments
+ description: |
+ Get a department given the UUID
+
+ scope: `departments:read`
+ parameters:
+ - "$ref": "#/components/parameters/department_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Department-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: put-departments
+ summary: Update a department
+ tags:
+ - Departments
+ description: |-
+ Update a department
+
+ scope: `departments:write`
+ parameters:
+ - "$ref": "#/components/parameters/department_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ responses:
+ '200':
+ "$ref": "#/components/responses/Department-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: update
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: delete-department
+ summary: Delete a department
+ tags:
+ - Departments
+ description: |
+ Delete a department. You cannot delete a department until all employees and contractors have been removed.
+
+ scope: `departments:write`
+ parameters:
+ - "$ref": "#/components/parameters/department_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: delete
+ "/v1/departments/{department_uuid}/add":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: put-add-people-to-department
+ summary: Add people to a department
+ tags:
+ - Departments
+ description: |
+ Add employees and contractors to a department
+
+ scope: `departments:write`
+ parameters:
+ - "$ref": "#/components/parameters/department_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ responses:
+ '200':
+ "$ref": "#/components/responses/Department-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: addPeople
+ "/v1/departments/{department_uuid}/remove":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: put-remove-people-from-department
+ summary: Remove people from a department
+ tags:
+ - Departments
+ description: |
+ Remove employees and contractors from a department
+
+ scope: `departments:write`
+ parameters:
+ - "$ref": "#/components/parameters/department_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ responses:
+ '200':
+ "$ref": "#/components/responses/Department-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: removePeople
+ "/v1/employees/{employee_id}":
+ get:
+ summary: Get an employee
+ operationId: get-v1-employees
+ description: |-
+ 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`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: get
+ put:
+ summary: Update an employee.
+ operationId: put-v1-employees
+ description: |-
+ Update an employee.
+
+ scope: `employees:write`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee"
+ '409':
+ description: invalid version
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: invalid attributes
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ x-speakeasy-name-override: update
+ delete:
+ summary: Delete an onboarding employee
+ operationId: delete-v1-employee
+ description: |-
+ 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`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: successful
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: cannot delete onboarded employee
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: delete
+ "/v1/employees/{employee_id}/terminations":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create an employee termination
+ tags:
+ - Employee Employments
+ responses:
+ '201':
+ "$ref": "#/components/responses/Termination-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-employees-employee_id-terminations
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ x-speakeasy-name-override: createTermination
+ x-speakeasy-group: employeeEmployments
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get terminations for an employee
+ tags:
+ - Employee Employments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Termination-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-terminations
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: getTerminations
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete an employee termination
+ operationId: delete-v1-employees-employee_id-terminations
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Employment-Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ description: |-
+ Delete an employee termination.
+
+ scope: `employments:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Employee Employments
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: deleteTermination
+ "/v1/terminations/{employee_id}":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update an employee termination
+ tags:
+ - Employee Employments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Termination-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Employment-Not-Found-Error-Object"
+ operationId: put-v1-terminations-employee_id
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: updateTermination
+ "/v1/employees/{employee_id}/rehire":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create an employee rehire
+ tags:
+ - Employee Employments
+ responses:
+ '201':
+ "$ref": "#/components/responses/Rehire-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-employees-employee_id-rehire
+ description: |-
+ Rehire is created whenever an employee is scheduled to return to the company.
+
+ scope: `employments:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Rehire-Body"
+ examples:
+ Example:
+ value:
+ effective_date: '2023-06-30'
+ work_location_uuid: b6ae9d93-d4b8-4119-8c96-dba595dd8c30
+ file_new_hire_report: true
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: createRehire
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update an employee rehire
+ tags:
+ - Employee Employments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Rehire-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Employment-Not-Found-Error-Object"
+ operationId: put-v1-employees-employee_id-rehire
+ description: |-
+ Update an employee's rehire.
+
+ scope: `employments:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - "$ref": "#/components/schemas/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
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: rehire
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get an employee rehire
+ tags:
+ - Employee Employments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Rehire-Object"
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Employment-Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-rehire
+ description: |-
+ Retrieve an employee's rehire, which contains information on when the employee returns to work.
+
+ scope: `employments:read`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: getRehire
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete an employee rehire
+ description: |-
+ Delete an employee rehire. An employee rehire cannot be deleted if it's active (past effective date).
+
+ scope: `employments:write`
+ operationId: delete-v1-employees-employee_id-rehire
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Employment-Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Employee Employments
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: deleteRehire
+ "/v1/employees/{employee_id}/employment_history":
+ get:
+ summary: Get employment history for an employee
+ operationId: get-v1-employees-employee_id-employment_history
+ description: |-
+ Retrieve the employment history for a given employee, which includes termination and rehire.
+
+ scope: `employments:read`
+ tags:
+ - Employee Employments
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employment-History-List"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: getHistory
+ "/v1/employees/{employee_id}/home_addresses":
+ get:
+ summary: Get an employee's home addresses
+ operationId: get-v1-employees-employee_id-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.
+
+ Supports home address effective dating and courtesy withholding.
+
+ scope: `employees:read`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Address-List"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: get
+ post:
+ summary: Create an employee's home address
+ operationId: post-v1-employees-employee_id-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.
+
+ Supports home address effective dating and courtesy withholding.
+
+ scope: `employees:write`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Address"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: create
+ "/v1/home_addresses/{home_address_uuid}":
+ get:
+ summary: Get an employee's home address
+ operationId: get-v1-home_addresses-home_address_uuid
+ 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.
+
+ Supports home address effective dating and courtesy withholding.
+
+ scope: `employees:read`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Address"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: retrieveHomeAddress
+ put:
+ summary: Update an employee's home address
+ operationId: put-v1-home_addresses-home_address_uuid
+ 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.
+
+ Supports home address effective dating and courtesy withholding.
+
+ scope: `employees:write`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Address"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: update
+ delete:
+ summary: Delete an employee's home address
+ operationId: delete-v1-home_addresses-home_address_uuid
+ description: |-
+ Used for deleting an employee's home address. Cannot delete the employee's active home address.
+
+ scope: `employees:write`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: successful
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: delete
+ "/v1/employees/{employee_id}/work_addresses":
+ get:
+ summary: Get an employee's work addresses
+ operationId: get-v1-employees-employee_id-work_addresses
+ description: |-
+ 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`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: List of employee work addresses
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Work-Addresses-List"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: getWorkAddresses
+ post:
+ summary: Create an employee work address
+ operationId: post-v1-employees-employee_id-work_addresses
+ description: |-
+ The work address of an employee describes when an employee began working at an associated company location.
+
+ scope: `employees:manage`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Work-Address"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: unprocessable entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: createWorkAddress
+ "/v1/work_addresses/{work_address_uuid}":
+ get:
+ summary: Get an employee work address
+ operationId: get-v1-work_addresses-work_address_uuid
+ description: |-
+ The work address of an employee is used for payroll tax purposes.
+
+ scope: `employees:read`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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.
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Work-Address"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: retrieveWorkAddress
+ put:
+ summary: Update an employee work address
+ operationId: put-v1-work_addresses-work_address_uuid
+ description: |-
+ The work address of an employee is used for payroll tax purposes.
+
+ scope: `employees:manage`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Work-Address"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: unprocessable entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: updateWorkAddress
+ delete:
+ summary: Delete an employee's work address
+ operationId: delete-v1-work_addresses-work_address_uuid
+ description: |-
+ Used for deleting an employee's work address. Cannot delete the employee's active work address.
+
+ scope: `employees:manage`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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.
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: no content
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: unprocessable entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: deleteWorkAddress
+ "/v1/employees/{employee_id}/custom_fields":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get an employee's custom fields
+ tags:
+ - Employees
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ custom_fields:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-Custom-Field"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-custom_fields
+ description: |-
+ Returns a list of the employee's custom fields.
+
+ scope: `employees:read`
+ x-speakeasy-name-override: getCustomFields
+ "/v1/employees/{employee_id}/onboarding_documents_config":
+ put:
+ summary: Update employee onboarding documents config
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ tags:
+ - Employees
+ 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
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Onboarding-Document"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: put-v1-employees-employee_id-onboarding_documents_config
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Onboarding-Documents-Config-Request"
+ x-speakeasy-name-override: updateOnboardingDocumentsConfig
+ "/v1/employees/{employee_id}/onboarding_status":
+ get:
+ summary: Get the employee's onboarding status
+ operationId: get-v1-employees-employee_id-onboarding_status
+ description: |-
+ # 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`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Onboarding-Status"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: getOnboardingStatus
+ put:
+ summary: Update the employee's onboarding status
+ operationId: put-v1-employees-employee_id-onboarding_status
+ description: |-
+ 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`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ security:
+ - CompanyAccessAuth: []
+ 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
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Onboarding-Status"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: invalid status transition
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-name-override: updateOnboardingStatus
+ "/v1/employees/{employee_uuid}/federal_taxes":
+ get:
+ summary: Get federal taxes for an employee
+ security:
+ - CompanyAccessAuth: []
+ 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).
+
+ scope: `employee_federal_taxes:read`
+ x-gusto-integration-type:
+ - embedded
+ tags:
+ - Employee Tax Setup
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Federal-Tax"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-federal_taxes
+ 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
+ x-speakeasy-group: employeeTaxSetup
+ x-speakeasy-name-override: getFederalTaxes
+ put:
+ summary: Update federal taxes for an employee
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Updates federal tax (W4) information for an employee. Only rev_2020_w4 format is accepted for updates.
+
+ scope: `employee_federal_taxes:write`
+ x-gusto-integration-type:
+ - embedded
+ tags:
+ - Employee Tax Setup
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Federal-Tax"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '409':
+ description: Conflict
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ operationId: put-v1-employees-employee_id-federal_taxes
+ 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
+ requestBody:
+ 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
+ x-speakeasy-group: employeeTaxSetup
+ x-speakeasy-name-override: updateFederalTaxes
+ "/v1/employees/{employee_uuid}/state_taxes":
+ get:
+ summary: Get an employee's state taxes
+ operationId: get-v1-employees-employee_id-state_taxes
+ description: |-
+ 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`
+ tags:
+ - Employee Tax Setup
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-State-Taxes-List"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-group: employeeTaxSetup
+ x-speakeasy-name-override: getStateTaxes
+ put:
+ summary: Update an employee's state taxes
+ operationId: put-v1-employees-employee_id-state_taxes
+ description: |-
+ 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`
+ tags:
+ - Employee Tax Setup
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-State-Taxes-List"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-State-Taxes-Request"
+ required: true
+ x-speakeasy-group: employeeTaxSetup
+ x-speakeasy-name-override: updateStateTaxes
+ "/v1/employees/{employee_id}/bank_accounts":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create an employee bank account
+ operationId: post-v1-employees-employee_id-bank_accounts
+ responses:
+ '201':
+ "$ref": "#/components/responses/Employee-Bank-Account-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ tags:
+ - Employee Payment Method
+ x-speakeasy-group: employeePaymentMethod
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all employee bank accounts
+ tags:
+ - Employee Payment Method
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ operationId: get-v1-employees-employee_id-bank_accounts
+ description: |-
+ Returns all employee bank accounts.
+
+ scope: `employee_payment_methods:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Bank-Account-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: employeePaymentMethods
+ x-speakeasy-name-override: getBankAccounts
+ "/v1/employees/{employee_id}/bank_accounts/{bank_account_uuid}":
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ summary: Delete an employee bank account
+ operationId: delete-v1-employees-employee_id-bank_accounts-bank_account_id
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/bank_account_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Employee Payment Method
+ x-speakeasy-group: employeePaymentMethod
+ x-speakeasy-name-override: deleteBankAccount
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update an employee bank account
+ operationId: put-v1-employees-employee_id-bank_accounts
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Bank-Account-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ Updates an employee bank account.
+
+ scope: `employee_payment_methods:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/bank_account_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ tags:
+ - Employee Payment Method
+ x-speakeasy-group: employeePaymentMethod
+ x-speakeasy-name-override: updateBankAccount
+ "/v1/employees/{employee_id}/payment_method":
+ get:
+ summary: Get payment method for an employee
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Returns the payment method for an employee (e.g. Check or Direct Deposit with split configuration).
+
+ scope: `employee_payment_methods:read`
+ x-gusto-integration-type:
+ - embedded
+ tags:
+ - Employee Payment Method
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Payment-Method"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-payment_method
+ 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
+ x-speakeasy-group: employeePaymentMethod
+ x-speakeasy-name-override: get
+ put:
+ summary: Update payment method for an employee
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Updates the payment method for an employee. Can set to Check or Direct Deposit with split configuration.
+
+ scope: `employee_payment_methods:write`
+ x-gusto-integration-type:
+ - embedded
+ tags:
+ - Employee Payment Method
+ operationId: put-v1-employees-employee_id-payment_method
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Payment-Method"
+ '409':
+ description: Conflict
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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
+ requestBody:
+ 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
+ x-speakeasy-group: employeePaymentMethod
+ x-speakeasy-name-override: update
+ "/v1/employees/{employee_id}/jobs":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a job
+ responses:
+ '201':
+ "$ref": "#/components/responses/Job-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-jobs-job_id
+ description: |-
+ Create a job.
+
+ scope: `jobs:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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.
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: createJob
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get jobs for an employee
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - in: query
+ name: include
+ schema:
+ type: string
+ enum:
+ - all_compensations
+ description: |-
+ Available options:
+ - all_compensations: Include all effective dated compensations for each job instead of only the current compensation
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Job-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-jobs
+ description: |-
+ Get all of the jobs that an employee holds.
+
+ scope: `jobs:read`
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-name-override: getJobs
+ x-speakeasy-group: jobsAndCompensations
+ "/v1/employees/{employee_uuid}/time_off_activities":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get employee time off activities
+ responses:
+ '200':
+ "$ref": "#/components/responses/Time-Off-Activity-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-version-employees-time_off_activities
+ parameters:
+ - "$ref": "#/components/parameters/employee_uuid"
+ - "$ref": "#/components/parameters/time_off_type"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get employee time off activities.
+
+ scope: `employee_time_off_activities:read`
+ tags:
+ - Employees
+ x-speakeasy-name-override: getTimeOffActivities
+ "/v1/jobs/{job_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a job
+ responses:
+ '200':
+ "$ref": "#/components/responses/Job-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-jobs-job_id
+ parameters:
+ - "$ref": "#/components/parameters/job_id"
+ - in: query
+ name: include
+ schema:
+ type: string
+ enum:
+ - all_compensations
+ description: |-
+ Available options:
+ - all_compensations: Include all effective dated compensations for the job instead of only the current compensation
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get a job.
+
+ scope: `jobs:read`
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: getJob
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a job
+ responses:
+ '200':
+ "$ref": "#/components/responses/Job-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-jobs-job_id
+ description: |-
+ Update a job.
+
+ scope: `jobs:write`
+ parameters:
+ - "$ref": "#/components/parameters/job_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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.
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-name-override: update
+ x-speakeasy-group: jobsAndCompensations
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete an individual job
+ tags:
+ - Jobs and Compensations
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ operationId: delete-v1-jobs-job_id
+ description: |-
+ Deletes a specific job that an employee holds.
+
+ scope: `jobs:write`
+ parameters:
+ - "$ref": "#/components/parameters/job_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: delete
+ "/v1/jobs/{job_id}/compensations":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ 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`.
+
+ *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`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get compensations for a job
+ 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:
+ - all_compensations: Include all effective dated compensations for each job instead of only the current compensation
+ schema:
+ type: string
+ enum:
+ - all_compensations
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Compensation"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-jobs-job_id-compensations
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-name-override: getCompensations
+ x-speakeasy-group: jobsAndCompensations
+ post:
+ security:
+ - CompanyAccessAuth: []
+ 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`.
+
+ ### 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`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a compensation
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Compensation"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: post-v1-compensations-compensation_id
+ 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Compensations-Request-Body"
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: createCompensation
+ "/v1/compensations/{compensation_id}":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ 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`.
+
+ scope: `compensations:read`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a compensation
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Compensation"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-compensations-compensation_id
+ 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
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: getCompensation
+ put:
+ security:
+ - CompanyAccessAuth: []
+ 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`.
+
+ ### Webhooks
+ - `employee_job_compensation.updated`: Fires when a compensation is successfully updated
+
+ scope: `compensations:write`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a compensation
+ tags:
+ - Jobs and Compensations
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Compensation"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: put-v1-compensations-compensation_id
+ 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Compensations-Update-Request-Body"
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: updateCompensation
+ delete:
+ security:
+ - CompanyAccessAuth: []
+ 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.
+
+ ### Webhooks
+ - `employee_job_compensation.destroyed`: Fires when a compensation is successfully deleted
+
+ scope: `compensations:write`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete a compensation
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: No Content
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ operationId: delete-v1-compensations-compensation_id
+ 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
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: deleteCompensation
+ "/v1/companies/{company_id}/earning_types":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a custom earning type
+ tags:
+ - Earning Types
+ responses:
+ '201':
+ "$ref": "#/components/responses/Earning-Type-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-earning_types
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ x-speakeasy-group: earningTypes
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all earning types for a company
+ tags:
+ - Earning Types
+ responses:
+ '200':
+ "$ref": "#/components/responses/Earning-Type-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-earning_types
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: earningTypes
+ x-speakeasy-name-override: list
+ "/v1/companies/{company_id}/earning_types/{earning_type_uuid}":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update an earning type
+ tags:
+ - Earning Types
+ responses:
+ '200':
+ "$ref": "#/components/responses/Earning-Type-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_id-earning_types-earning_type_uuid
+ description: |-
+ Update an earning type.
+
+ scope: `payrolls:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/earning_type_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ x-speakeasy-group: earningTypes
+ x-speakeasy-name-override: update
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Deactivate an earning type
+ tags:
+ - Earning Types
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: delete-v1-companies-company_id-earning_types-earning_type_uuid
+ description: |-
+ Deactivate an earning type.
+
+ scope: `payrolls:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/earning_type_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: earningTypes
+ x-speakeasy-name-override: delete
+ "/v1/companies/{company_uuid}/contractors":
+ post:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Create an individual or business contractor.
+
+ scope: `contractors:manage`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a contractor
+ tags:
+ - Contractors
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_uuid-contractors
+ 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Create-Request-Body"
+ x-speakeasy-name-override: create
+ get:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Get all contractors, active and inactive, individual and business, for a company.
+
+ scope: `contractors:read`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get contractors of a company
+ tags:
+ - Contractors
+ 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
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Contractor"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_uuid-contractors
+ x-speakeasy-name-override: list
+ "/v1/contractors/{contractor_uuid}":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Get a contractor.
+
+ scope: `contractors:read`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a contractor
+ tags:
+ - Contractors
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-contractors-contractor_uuid
+ 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
+ x-speakeasy-name-override: get
+ put:
+ security:
+ - CompanyAccessAuth: []
+ description: "Update a contractor.\n\n> \U0001F6A7 Warning\n>\n> 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\n\nscope: `contractors:write`"
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a contractor
+ tags:
+ - Contractors
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: put-v1-contractors-contractor_uuid
+ 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Update-Request-Body"
+ x-speakeasy-name-override: update
+ delete:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ A contractor can only be deleted when there are no contractor payments.
+
+ scope: `contractors:manage`
+ x-gusto-integration-type:
+ - embedded
+ summary: Delete a contractor
+ operationId: delete-v1-contractors-contractor_uuid
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: No Content
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ tags:
+ - Contractors
+ 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
+ x-speakeasy-name-override: delete
+ "/v1/contractors/{contractor_uuid}/bank_accounts":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a contractor bank account
+ operationId: post-v1-contractors-contractor_uuid-bank_accounts
+ responses:
+ '201':
+ "$ref": "#/components/responses/Contractor-Bank-Account-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ tags:
+ - Contractor Payment Method
+ x-speakeasy-group: contractorPaymentMethods
+ x-speakeasy-name-override: createBankAccount
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all contractor bank accounts
+ tags:
+ - Contractor Payment Method
+ operationId: get-v1-contractors-contractor_uuid-bank_accounts
+ description: |-
+ Returns all contractor bank accounts.
+
+ scope: `contractor_payment_methods:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Bank-Account-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: getBankAccounts
+ x-speakeasy-group: contractorPaymentMethod
+ "/v1/webhook_subscriptions":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a webhook subscription
+ responses:
+ '201':
+ "$ref": "#/components/responses/Webhook-Subscription-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-webhook-subscription
+ description: "Create a webhook subscription to receive events of the specified subscription_types whenever there is a state change.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:write`"
+ security:
+ - SystemAccessAuth: []
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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: ''
+ tags:
+ - Webhooks
+ x-speakeasy-name-override: createSubscription
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: List webhook subscriptions
+ tags:
+ - Webhooks
+ responses:
+ '200':
+ "$ref": "#/components/responses/Webhook-Subscriptions-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-webhook-subscriptions
+ description: "Returns all webhook subscriptions associated with the provided Partner API token.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:read`"
+ security:
+ - SystemAccessAuth: []
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: listSubscriptions
+ "/v1/webhook_subscriptions/{webhook_subscription_uuid}":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a webhook subscription
+ responses:
+ '200':
+ "$ref": "#/components/responses/Webhook-Subscription-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-webhook-subscription-uuid
+ description: "Updates the Webhook Subscription associated with the provided UUID.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:write`\n"
+ parameters:
+ - "$ref": "#/components/parameters/webhook_subscription_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ security:
+ - SystemAccessAuth: []
+ requestBody:
+ 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: ''
+ tags:
+ - Webhooks
+ x-speakeasy-name-override: updateSubscription
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a webhook subscription
+ responses:
+ '200':
+ "$ref": "#/components/responses/Webhook-Subscription-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-webhook-subscription-uuid
+ description: "Returns the Webhook Subscription associated with the provided UUID.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:read`\n"
+ parameters:
+ - "$ref": "#/components/parameters/webhook_subscription_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ security:
+ - SystemAccessAuth: []
+ tags:
+ - Webhooks
+ x-speakeasy-name-override: getSubscription
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete a webhook subscription
+ responses:
+ '204':
+ description: The resource was deleted successfully.
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: delete-v1-webhook-subscription-uuid
+ description: "Deletes the Webhook Subscription associated with the provided UUID.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:write`\n"
+ parameters:
+ - "$ref": "#/components/parameters/webhook_subscription_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ security:
+ - SystemAccessAuth: []
+ tags:
+ - Webhooks
+ x-speakeasy-name-override: deleteSubscription
+ "/v1/webhook_subscriptions/{webhook_subscription_uuid}/verify":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Verify the webhook subscription
+ responses:
+ '200':
+ "$ref": "#/components/responses/Webhook-Subscription-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-verify-webhook-subscription-uuid
+ 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.\n\nUse the /v1/webhook_subscriptions/{webhook_subscription_uuid}/request_verification_token API to resend the `verification_token` to the Subscriber.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:write`\n"
+ parameters:
+ - "$ref": "#/components/parameters/webhook_subscription_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ security:
+ - SystemAccessAuth: []
+ requestBody:
+ 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: ''
+ tags:
+ - Webhooks
+ x-speakeasy-name-override: verify
+ "/v1/webhook_subscriptions/{webhook_subscription_uuid}/request_verification_token":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Request the webhook subscription verification_token
+ responses:
+ '200':
+ description: No Content. The `verification_token` is POSTed to the Subscription URL.
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-webhook-subscription-verification-token-uuid
+ description: "Request that the webhook subscription `verification_token` be POSTed to the Subscription URL.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:read`\n"
+ parameters:
+ - "$ref": "#/components/parameters/webhook_subscription_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ security:
+ - SystemAccessAuth: []
+ tags:
+ - Webhooks
+ x-speakeasy-name-override: requestVerificationToken
+ "/v1/contractors/{contractor_uuid}/forms":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all contractor forms
+ tags:
+ - Contractor Forms
+ operationId: get-v1-contractor-forms
+ description: |-
+ Get a list of all contractor's forms
+
+ scope: `contractor_forms:read`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Form_1099"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: contractorForms
+ x-speakeasy-name-override: list
+ "/v1/contractors/{contractor_uuid}/forms/{form_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a contractor form
+ tags:
+ - Contractor Forms
+ operationId: get-v1-contractor-form
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get a contractor form
+
+ scope: `contractor_forms:read`
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Form_1099"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: contractorForms
+ x-speakeasy-name-override: get
+ "/v1/contractors/{contractor_uuid}/forms/{form_id}/pdf":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get the contractor form pdf
+ tags:
+ - Contractor Forms
+ operationId: get-v1-contractor-form-pdf
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get the link to the form PDF
+
+ scope: `contractor_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object-Pdf"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: contractorForms
+ x-speakeasy-name-override: getPdf
+ "/v1/contractors/{contractor_uuid}/documents":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all contractor documents
+ tags:
+ - Contractor Documents
+ operationId: get-v1-contractor-documents
+ description: |-
+ Get a list of all contractor's documents
+
+ scope: `contractor_documents:read`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Document"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: contractorDocuments
+ x-speakeasy-name-override: getAll
+ "/v1/documents/{document_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a contractor document
+ tags:
+ - Contractor Documents
+ operationId: get-v1-contractor-document
+ parameters:
+ - "$ref": "#/components/parameters/document_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get a contractor document.
+
+ scope: `contractor_documents:read`
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Document"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: get
+ x-speakeasy-group: contractorDocuments
+ "/v1/documents/{document_uuid}/pdf":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get the contractor document pdf
+ tags:
+ - Contractor Documents
+ operationId: get-v1-contractor-document-pdf
+ parameters:
+ - "$ref": "#/components/parameters/document_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get the contractor document pdf.
+
+ scope: `contractor_documents:read`
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Document-Pdf"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: contractorDocuments
+ x-speakeasy-name-override: getPdf
+ "/v1/documents/{document_uuid}/sign":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Sign a contractor document
+ tags:
+ - Contractor Documents
+ operationId: put-v1-contractor-document-sign
+ parameters:
+ - "$ref": "#/components/parameters/document_uuid"
+ - "$ref": "#/components/parameters/IpAddressHeader"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ description: |-
+ Sign a contractor document.
+
+ scope: `contractor_documents:write`
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Document-Signed"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: contractorDocuments
+ x-speakeasy-name-override: sign
+ "/v1/sandbox/generate_1099":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Generate a 1099 form [DEMO]
+ tags:
+ - Contractor Forms
+ operationId: post-v1-sandbox-generate_1099
+ description: "> \U0001F6A7 Demo action\n>\n> This action is only available in the Demo environment\n\nGenerates a 1099 document for testing purposes.\n\nscope: `contractors:write`"
+ requestBody:
+ 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.
+
+'
+ required:
+ - contractor_id
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Form_1099"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: contractorForms
+ x-speakeasy-name-override: generate1099
+ "/v1/sandbox/generate_w2":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Generate a W2 form [DEMO]
+ tags:
+ - Employee Forms
+ operationId: post-v1-sandbox-generate_w2
+ description: "> \U0001F6A7 Demo action\n>\n> This action is only available in the Demo environment\n\nGenerates a W2 document for testing purposes.\n\nscope: `employees:write`"
+ requestBody:
+ 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.
+
+'
+ required:
+ - employee_id
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ allOf:
+ - properties:
+ employee_uuid:
+ type: string
+ description: The UUID of the employee
+ readOnly: true
+ - "$ref": "#/components/schemas/Form"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: employeeForms
+ x-speakeasy-name-override: generateW2
+ "/v1/contractors/{contractor_uuid}/payment_method":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a contractor's payment method
+ tags:
+ - Contractor Payment Method
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Payment-Method-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-contractors-contractor_uuid-payment_method
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: contractorPaymentMethod
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a contractor's payment method
+ tags:
+ - Contractor Payment Method
+ operationId: put-v1-contractors-contractor_id-payment_method
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Payment-Method-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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.
+ see [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: ''
+ x-speakeasy-group: contractorPaymentMethod
+ x-speakeasy-name-override: update
+ "/v1/contractors/{contractor_uuid}/onboarding_status":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get the contractor's onboarding status
+ tags:
+ - Contractors
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Onboarding-Status-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-contractors-contractor_uuid-onboarding_status
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ 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. |
+ x-speakeasy-name-override: getOnboardingStatus
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Change the contractor's onboarding status
+ tags:
+ - Contractors
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Onboarding-Status-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-contractors-contractor_uuid-onboarding_status
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ 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` |
+ requestBody:
+ 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
+ x-speakeasy-name-override: updateOnboardingStatus
+ "/v1/contractors/{contractor_uuid}/address":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ operationId: get-v1-contractors-contractor_uuid-address
+ summary: Get a contractor address
+ tags:
+ - Contractors
+ 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.
+
+ scope: `contractors:read`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Address-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getAddress
+ put:
+ x-gusto-integration-type:
+ - embedded
+ operationId: put-v1-contractors-contractor_uuid-address
+ summary: Create or update a contractor's address
+ tags:
+ - Contractors
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Address-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ 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.\n\nscope: `contractors:write`\n\n> \U0001F6A7 Contractors can only have one address.\n> \n> When a contractor is created, an address is created for them by default. Updating the address will replace the existing address."
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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:
+ city: San Francisco
+ state: CA
+ zip: '94107'
+ x-speakeasy-name-override: updateAddress
+ "/v1/companies/{company_id}/payrolls":
+ get:
+ summary: Get all payrolls for a company
+ operationId: get-v1-companies-company_id-payrolls
+ 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.
+
+ 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`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-List"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: list
+ post:
+ summary: Create an off-cycle payroll
+ operationId: post-v1-companies-company_id-payrolls
+ description: |-
+ 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`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Unprocessed"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-name-override: createOffCycle
+ "/v1/companies/{company_id}/payroll_reversals":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get approved payroll reversals
+ tags:
+ - Payrolls
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Payroll-Reversal-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-payroll_reversals
+ description: |-
+ Returns all approved Payroll Reversals for a Company.
+
+ scope: `payrolls:read`
+ x-speakeasy-name-override: getApprovedReversals
+ "/v1/companies/{company_id}/payrolls/{payroll_id}":
+ get:
+ summary: Get a single payroll
+ operationId: get-v1-companies-company_id-payrolls-payroll_id
+ 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.
+
+ 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`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful with wait_for_reverse_wire credit blocker
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Show"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: get
+ put:
+ summary: Update a payroll by ID
+ operationId: put-v1-companies-company_id-payrolls
+ description: |
+ 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`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Prepared"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Update"
+ required: true
+ x-speakeasy-name-override: update
+ delete:
+ summary: Delete a payroll
+ operationId: delete-v1-companies-company_id-payrolls
+ description: |-
+ 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`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: no content
+ '202':
+ description: Accepted
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: delete
+ "/v1/companies/{company_id}/payrolls/{payroll_id}/prepare":
+ put:
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Prepare a payroll for update
+ tags:
+ - Payrolls
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Prepared"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_id-payrolls-payroll_id-prepare
+ 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.
+ 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`
+ 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
+ requestBody:
+ 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
+ x-speakeasy-name-override: prepare
+ "/v1/payrolls/{payroll_uuid}/receipt":
+ get:
+ summary: Get a single payroll receipt
+ operationId: get-v1-payment-receipts-payrolls-payroll_uuid
+ description: |-
+ 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`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Receipt"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: getReceipt
+ "/v1/payrolls/{payroll_id}/employees/{employee_id}/calculate_accruing_time_off_hours":
+ post:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Calculate accruing time off hours
+ tags:
+ - Time Off Policies
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Calculate-Accruing-Time-Off-Hours-Response"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ operationId: post-v1-payrolls-payroll_id-calculate_accruing_time_off_hours
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Calculate-Accruing-Time-Off-Hours-Request"
+ 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
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: calculateAccruingTimeOffHours
+ "/v1/companies/{company_uuid}/payrolls/blockers":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ 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.
+
+ scope: `payrolls:run`
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all payroll blockers for a company
+ tags:
+ - Payrolls
+ operationId: get-v1-companies-payroll-blockers-company_uuid
+ 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
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Payroll-Blocker"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: getBlockers
+ "/v1/companies/{company_uuid}/payrolls/skip":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Skip a payroll
+ tags:
+ - Payrolls
+ operationId: post-companies-payroll-skip-company_uuid
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ responses:
+ '202':
+ description: Accepted
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema:
+ anyOf:
+ - "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ - "$ref": "#/components/schemas/Payroll-Blockers-Error"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: skip
+ "/v1/payrolls/{payroll_uuid}/gross_up":
+ post:
+ summary: Calculate gross up for a payroll
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-integration-type:
+ - embedded
+ tags:
+ - Payrolls
+ operationId: post-payrolls-gross-up-payroll_uuid
+ description: |-
+ 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`
+ 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
+ x-gusto-rswag: true
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Gross-Up-Request"
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Gross-Up-Response"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: calculateGrossUp
+ "/v1/contractor_payments/{contractor_payment_uuid}/receipt":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a single contractor payment receipt
+ tags:
+ - Contractor Payments
+ operationId: get-v1-contractor_payments-contractor_payment_uuid-receipt
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_payment_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Payment-Receipt"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getReceipt
+ x-speakeasy-group: contractorPayments
+ "/v1/contractor_payments/{contractor_payment_uuid}/fund":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Fund a contractor payment [DEMO]
+ tags:
+ - Contractor Payments
+ operationId: get-v1-contractor_payments-contractor_payment_uuid-fund
+ description: "> \U0001F6A7 Demo action\n>\n> This action is only available in the Demo environment\n\nSimulate 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.\n\nscope: `payrolls:run`"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Payment-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ parameters:
+ - "$ref": "#/components/parameters/contractor_payment_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: contractorPayments
+ x-speakeasy-name-override: fund
+ "/v1/companies/{company_id}/payrolls/{payroll_id}/calculate":
+ put:
+ security:
+ - CompanyAccessAuth: []
+ 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.
+
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ summary: Calculate a payroll
+ tags:
+ - Payrolls
+ x-gusto-rswag: true
+ responses:
+ '202':
+ description: Accepted
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_id-payrolls-payroll_id-calculate
+ 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
+ x-speakeasy-name-override: calculate
+ "/v1/companies/{company_id}/payrolls/{payroll_id}/submit":
+ put:
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-integration-type:
+ - embedded
+ summary: Submit payroll
+ tags:
+ - Payrolls
+ x-gusto-rswag: true
+ responses:
+ '202':
+ description: Accepted
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_id-payrolls-payroll_id-submit
+ 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.
+
+ 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`
+ 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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ submission_blockers:
+ type: array
+ description: An array of submission_blockers, each with a selected unblock option.
+ items:
+ "$ref": "#/components/schemas/Payroll-Submission-Blocker-Request-Type"
+ x-speakeasy-name-override: submit
+ "/v1/companies/{company_id}/payrolls/{payroll_id}/cancel":
+ put:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ 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`
+ x-gusto-integration-type:
+ - embedded
+ summary: Cancel a payroll
+ tags:
+ - Payrolls
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessed-Payroll"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: put-api-v1-companies-company_id-payrolls-payroll_id-cancel
+ 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
+ x-speakeasy-name-override: cancel
+ "/v1/companies/{company_id}/contractor_payments":
+ post:
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a contractor payment
+ tags:
+ - Contractor Payments
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided ID/UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-contractor_payments
+ description: |-
+ Pay a contractor. Information needed depends on the contractor's wage type (hourly vs fixed)
+
+ scope: `payrolls:run`
+ 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Body"
+ x-speakeasy-group: contractorPayments
+ x-speakeasy-name-override: create
+ get:
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get contractor payments for a company
+ tags:
+ - Contractor Payments
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: A JSON object containing contractor payments information
+ content:
+ application/json:
+ schema:
+ anyOf:
+ - "$ref": "#/components/schemas/Contractor-Payment-Summary"
+ - "$ref": "#/components/schemas/Contractor-Payment-Summary-By-Dates"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided ID/UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-contractor_payments
+ description: |-
+ Returns an object containing individual contractor payments, within a given time period, including totals.
+
+ scope: `payrolls:read`
+ 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
+ x-speakeasy-group: contractorPayments
+ x-speakeasy-name-override: list
+ "/v1/companies/{company_id}/contractor_payments/{contractor_payment_id}":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ Returns a single contractor payment.
+
+ scope: `payrolls:read`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a single contractor payment
+ tags:
+ - Contractor Payments
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided ID/UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-contractor_payment-contractor-payment
+ 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
+ x-speakeasy-name-override: get
+ x-speakeasy-group: contractorPayments
+ delete:
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-integration-type:
+ - embedded
+ summary: Cancel a contractor payment
+ tags:
+ - Contractor Payments
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: No Content
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided ID/UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: delete-v1-companies-company_id-contractor_payment-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.
+
+ scope: `payrolls:run`
+ 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
+ x-speakeasy-group: contractorPayments
+ x-speakeasy-name-override: delete
+ "/v1/companies/{company_id}/contractor_payment_groups":
+ get:
+ summary: Get contractor payment groups for a company
+ operationId: get-v1-companies-company_id-contractor_payment_groups
+ description: |-
+ Returns a list of minimal contractor payment groups within a given time period, including totals but not associated contractor payments.
+
+ scope: `payrolls:read`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: List of Contractor Payment Groups
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Contractor-Payment-Group-With-Blockers"
+ '404':
+ description: |
+ Not Found
+
+ The requested company does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: getList
+ x-speakeasy-group: contractorPaymentGroups
+ post:
+ summary: Create a contractor payment group
+ operationId: post-v1-companies-company_id-contractor_payment_groups
+ description: |-
+ Pay a group of contractors. Information needed depends on the contractor's wage type (hourly vs fixed)
+
+ scope: `payrolls:run`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: Full contractor payment group object
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested company does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-group: contractorPaymentGroups
+ x-speakeasy-name-override: create
+ "/v1/companies/{company_id}/contractor_payment_groups/preview":
+ post:
+ summary: Preview a contractor payment group
+ operationId: post-v1-companies-company_id-contractor_payment_groups-preview
+ 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.
+ The returned creation_token is a required parameter in order to create the contractor payment group.
+
+ scope: `payrolls:read`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Full contractor payment group object with null uuid
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group-Preview"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided ID/UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-group: contractorPaymentGroups
+ x-speakeasy-name-override: preview
+ "/v1/contractor_payment_groups/{contractor_payment_group_uuid}":
+ get:
+ summary: Get a contractor payment group
+ operationId: get-v1-contractor_payment_groups-contractor_payment_group_id
+ description: |-
+ Returns a contractor payment group with all associated contractor payments.
+
+ scope: `payrolls:read`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group"
+ '404':
+ description: |
+ Not Found
+
+ The requested contractor payment group does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-group: contractorPaymentGroups
+ x-speakeasy-name-override: get
+ delete:
+ summary: Cancel a contractor payment group
+ operationId: delete-v1-contractor_payment_groups-contractor_payment_group_id
+ description: |-
+ Cancels a contractor payment group and all associated contractor payments. All contractor payments must be cancellable, unfunded.
+
+ scope: `payrolls:run`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: Successfully cancelled
+ '404':
+ description: |
+ Not Found
+
+ The requested contractor payment group does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This 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.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: delete
+ x-speakeasy-group: contractorPaymentGroups
+ "/v1/contractor_payment_groups/{contractor_payment_group_uuid}/fund":
+ put:
+ summary: Fund a contractor payment group [DEMO]
+ operationId: put-v1-contractor_payment_groups-contractor_payment_group_id-fund
+ description: "> \U0001F6A7 Demo action\n> This action is only available in the Demo environment\n\nSimulate 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.\n\nscope: `payrolls:run`"
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Full contractor payment group object
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group"
+ '404':
+ description: |
+ Not Found
+
+ The requested contractor payment group does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: fund
+ x-speakeasy-group: contractorPaymentGroups
+ "/v1/companies/{company_id}/forms":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all company forms
+ tags:
+ - Company Forms
+ operationId: get-v1-company-forms
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/company_forms_sort_by"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get a list of all company's forms
+
+ scope: `company_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getAll
+ x-speakeasy-group: companyForms
+ "/v1/forms/{form_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a company form
+ tags:
+ - Company Forms
+ operationId: get-v1-company-form
+ parameters:
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get a company form
+
+ scope: `company_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: companyForms
+ x-speakeasy-name-override: get
+ "/v1/forms/{form_id}/pdf":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a company form pdf
+ tags:
+ - Company Forms
+ operationId: get-v1-company-form-pdf
+ parameters:
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get the link to the form PDF
+
+ scope: `company_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object-Pdf"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getPdf
+ x-speakeasy-group: companyForms
+ "/v1/forms/{form_id}/sign":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Sign a company form
+ tags:
+ - Company Forms
+ operationId: put-v1-company-form-sign
+ parameters:
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/IpAddressHeader"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Sign a company form. Company forms must be signed by the company signatory.
+
+ scope: `company_forms:sign`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-group: companyForms
+ x-speakeasy-name-override: sign
+ "/v1/employees/{employee_id}/forms":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all employee forms
+ tags:
+ - Employee Forms
+ operationId: get-v1-employee-forms
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get a list of all employee's forms
+
+ scope: `employee_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: list
+ x-speakeasy-group: employeeForms
+ "/v1/employees/{employee_id}/forms/{form_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get an employee form
+ tags:
+ - Employee Forms
+ operationId: get-v1-employee-form
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get an employee form
+
+ scope: `employee_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: employeeForms
+ x-speakeasy-name-override: get
+ "/v1/employees/{employee_id}/forms/{form_id}/pdf":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get the employee form pdf
+ tags:
+ - Employee Forms
+ operationId: get-v1-employee-form-pdf
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get the link to the employee form PDF
+
+ scope: `employee_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object-Pdf"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: employeeForms
+ x-speakeasy-name-override: getPdf
+ "/v1/employees/{employee_id}/forms/{form_id}/sign":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Sign an employee form
+ tags:
+ - Employee Forms
+ operationId: put-v1-employee-form-sign
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/IpAddressHeader"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ 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`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-group: employeeForms
+ x-speakeasy-name-override: sign
+ "/v1/payrolls/{payroll_id}/employees/{employee_id}/pay_stub":
+ get:
+ summary: Get an employee pay stub (pdf)
+ operationId: get-v1-payrolls-payroll_uuid-employees-employee_uuid-pay_stub
+ 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.
+
+ scope: `pay_stubs:read`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/pdf:
+ schema:
+ type: string
+ format: binary
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: getPayStub
+ "/v1/employees/{employee_id}/pay_stubs":
+ get:
+ summary: Get an employee's pay stubs
+ operationId: get-v1-employees-employee_uuid-pay_stubs
+ description: |-
+ Get an employee's pay stubs
+
+ scope: `pay_stubs:read`
+ x-gusto-integration-type:
+ - embedded
+ tags:
+ - Payrolls
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Pay-Stubs-List"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-name-override: getPayStubs
+ "/v1/generated_documents/{document_type}/{request_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a generated document
+ tags:
+ - Generated Documents
+ operationId: get-v1-generated_documents-document_type-request_uuid
+ 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.
+
+ scope: `generated_documents:read`
+ parameters:
+ - "$ref": "#/components/parameters/document_type"
+ - "$ref": "#/components/parameters/request_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Generated-Document"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: generatedDocuments
+ x-speakeasy-name-override: get
+ "/v1/payrolls/{payroll_uuid}/generated_documents/printable_payroll_checks":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Generate printable payroll checks (pdf)
+ tags:
+ - Payrolls
+ operationId: post-v1-payrolls-payroll_uuid-generated_documents-printable_payroll_checks
+ 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.
+
+ scope: `generated_documents:write`
+ parameters:
+ - "$ref": "#/components/parameters/payroll_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Payroll-Check"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-name-override: generatePrintableChecks
+ "/v1/companies/{company_uuid}/reports":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a custom report
+ operationId: post-companies-company_uuid-reports
+ responses:
+ '200':
+ "$ref": "#/components/responses/Create-Report"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ 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
+ 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.
+
+ scope: `company_reports:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Reports
+ x-speakeasy-name-override: createCustom
+ "/v1/payrolls/{payroll_uuid}/reports/general_ledger":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a general ledger report
+ operationId: post-payrolls-payroll_uuid-reports-general_ledger
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/payroll_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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'.
+ responses:
+ '200':
+ "$ref": "#/components/responses/General-Ledger-Report"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ tags:
+ - Reports
+ "/v1/reports/{request_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a report
+ operationId: get-reports-request_uuid
+ responses:
+ '200':
+ "$ref": "#/components/responses/Report"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ 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.
+
+ Reports containing PHI are inaccessible with `company_reports:read:tier_2_only` data scope
+
+ scope: `company_reports:read`
+ parameters:
+ - "$ref": "#/components/parameters/request_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Reports
+ "/v1/companies/{company_uuid}/report_templates/{report_type}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a report template
+ operationId: get-companies-company_uuid-report-templates-report_type
+ responses:
+ '200':
+ "$ref": "#/components/responses/Report-Template"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ 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.
+
+ scope: `company_reports:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/report_type"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Reports
+ x-speakeasy-name-override: getTemplate
+ "/v1/companies/{company_id}/company_benefits":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a company benefit
+ tags:
+ - Company Benefits
+ responses:
+ '201':
+ "$ref": "#/components/responses/Company-Benefit-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-company_benefits
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get benefits for a company
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Benefit-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-company_benefits
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - 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`
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: list
+ "/v1/company_benefits/{company_benefit_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a company benefit
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Benefit-With-Employee-Benefits-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-company_benefits-company_benefit_id
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - 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:
+ - all_benefits: If with_employee_benefits=true, include all effective dated benefits for each employee instead of only the current benefits.
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a company benefit
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Benefit-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-company_benefits-company_benefit_id
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: update
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete a company benefit
+ tags:
+ - Company Benefits
+ operationId: delete-v1-company_benefits-company_benefit_id
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '204':
+ description: No content
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: delete
+ x-speakeasy-group: companyBenefits
+ "/v1/benefits":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all benefits supported by Gusto
+ responses:
+ '200':
+ "$ref": "#/components/responses/Supported-Benefit-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-benefits
+ description: |-
+ 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`
+ tags:
+ - Company Benefits
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: getAll
+ "/v1/benefits/{benefit_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: get-v1-benefits-benefit_id
+ summary: Get a supported benefit by ID
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Supported-Benefit-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: getSupported
+ "/v1/company_benefits/{company_benefit_id}/summary":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: get-v1-benefits-company_benefit_id-summary
+ summary: Get company benefit summary by company benefit id.
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - 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
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Benefit-Summary-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: getSummary
+ "/v1/company_benefits/{company_benefit_id}/employee_benefits":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all employee benefits for a company benefit
+ operationId: get-v1-company_benefits-company_benefit_id-employee_benefits
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - in: query
+ name: include
+ schema:
+ type: string
+ enum:
+ - all_benefits
+ description: |-
+ Available options:
+ - all_benefits: Include all effective dated benefits for each employee instead of only the current benefits.
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Benefit-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getEmployeeBenefits
+ x-speakeasy-group: companyBenefits
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Bulk update employee benefits for a company benefit
+ operationId: put-v1-company_benefits-company_benefit_id-employee_benefits
+ description: |-
+ 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`
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Benefit-List"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ employee_benefits:
+ type: array
+ description: The list of employee benefits to create or update
+ items:
+ "$ref": "#/components/schemas/Employee-Benefit-For-Company-Benefit"
+ required:
+ - employee_benefits
+ examples:
+ Example:
+ value:
+ employee_benefits:
+ - version: '09j3d29jqdpj92109j9j2d90dq'
+ employee_uuid: 8f9f3f68-8fd3-499d-ade7-4a052e56494e
+ active: true
+ employee_deduction: '250.00'
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: updateEmployeeBenefits
+ "/v1/company_benefits/{company_benefit_id}/contribution_exclusions":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get contribution exclusions for a company benefit
+ operationId: get-v1-company_benefits-company_benefit_id-contribution_exclusions
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contribution-Exclusion-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update contribution exclusions for a company benefit
+ operationId: put-v1-company_benefits-company_benefit_id-contribution_exclusions
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contribution-Exclusion-List"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ contribution_exclusions:
+ type: array
+ description: The list of contribution exclusions to update
+ items:
+ "$ref": "#/components/schemas/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
+ "/v1/benefits/{benefit_id}/requirements":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: get-v1-benefits-benefits_id-requirements
+ summary: Get benefit fields requirements by ID
+ description: |-
+ Returns field requirements for the requested benefit type.
+
+ scope: `benefits:read`
+ parameters:
+ - "$ref": "#/components/parameters/benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Benefit-Type-Requirements-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: getRequirements
+ "/v1/employees/{employee_id}/employee_benefits":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create an employee benefit
+ tags:
+ - Employee Benefits
+ responses:
+ '201':
+ "$ref": "#/components/responses/Employee-Benefit-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-employees-employee_id-employee_benefits
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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.
+
+ `amount`: The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ `percentage`: The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ `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.
+
+ For 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.
+
+ Use threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.
+
+ For example:
+
+ If 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.
+
+ If 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
+ their limit.
+
+ `Family` or `Individual`: Applicable to HSA benefit.
+
+ `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:
+ 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: ''
+ x-speakeasy-name-override: create
+ x-speakeasy-group: employeeBenefits
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all benefits for an employee
+ tags:
+ - Employee Benefits
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - in: query
+ name: include
+ schema:
+ type: string
+ enum:
+ - all_benefits
+ description: |-
+ Available options:
+ - all_benefits: Include all effective dated benefits for each employee instead of only the current benefits.
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Benefit-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-employee_benefits
+ description: |-
+ 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`
+ x-speakeasy-group: employeeBenefits
+ x-speakeasy-name-override: get
+ "/v1/employee_benefits/{employee_benefit_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get an employee benefit
+ tags:
+ - Employee Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Benefit-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employee_benefits-employee_benefit_id
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: retrieve
+ x-speakeasy-group: employeeBenefits
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update an employee benefit
+ tags:
+ - Employee Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Benefit-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-employee_benefits-employee_benefit_id
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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.
+
+ `amount`: The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ `percentage`: The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ `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.
+
+ For 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.
+
+ Use threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.
+
+ For example:
+
+ If 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.
+
+ If 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
+ their limit.
+
+ `Family` or `Individual`: Applicable to HSA benefit.
+
+ `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'
+ x-speakeasy-group: employeeBenefits
+ x-speakeasy-name-override: update
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete an employee benefit
+ tags:
+ - Employee Benefits
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ operationId: delete-v1-employee_benefits-employee_benefit_id
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: employeeBenefits
+ x-speakeasy-name-override: delete
+ "/v1/employees/{employee_id}/ytd_benefit_amounts_from_different_company":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get year-to-date benefit amounts from a different company
+ tags:
+ - Employee Benefits
+ operationId: get-employee-ytd-benefit-amounts-from-different-company
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - 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.
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Ytd-Benefit-Amounts-From-Different-Company-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: employeeBenefits
+ x-speakeasy-name-override: getYtdBenefitAmountsFromDifferentCompany
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create year-to-date benefit amounts from a different company
+ tags:
+ - Employee Benefits
+ operationId: post-employee-ytd-benefit-amounts-from-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.
+
+ This endpoint only supports passing outside contributions for 401(k) benefits.
+
+ scope: `employee_benefits:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ "$ref": "#/components/requestBodies/post-employee-ytd-benefit-amounts-from-different-company"
+ responses:
+ '204':
+ description: No Content
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: employeeBenefits
+ x-speakeasy-name-override: createYtdBenefitAmountsFromDifferentCompany
+ "/v1/employees/{employee_id}/garnishments":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a garnishment
+ tags:
+ - Garnishments
+ responses:
+ '201':
+ "$ref": "#/components/responses/Garnishment-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-employees-employee_id-garnishments
+ 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.
+
+ scope: `garnishments:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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:
+ 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:
+ 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:
+ 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:
+ "$ref": "#/components/schemas/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
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get garnishments for an employee
+ tags:
+ - Garnishments
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Garnishment-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-garnishments
+ 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.
+
+ scope: `garnishments:read`
+ x-speakeasy-name-override: list
+ "/v1/garnishments/{garnishment_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a garnishment
+ tags:
+ - Garnishments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Garnishment-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-garnishments-garnishment_id
+ 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.
+
+ scope: `garnishments:read`
+ parameters:
+ - "$ref": "#/components/parameters/garnishment_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a garnishment
+ tags:
+ - Garnishments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Garnishment-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-garnishments-garnishment_id
+ 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.
+
+ scope: `garnishments:write`
+ parameters:
+ - "$ref": "#/components/parameters/garnishment_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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:
+ 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:
+ 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:
+ 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:
+ "$ref": "#/components/schemas/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
+ x-speakeasy-name-override: update
+ "/v1/garnishments/child_support":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get child support garnishment data
+ responses:
+ '200':
+ "$ref": "#/components/responses/Child-Support-Data-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ tags:
+ - Garnishments
+ operationId: get-v1-garnishments-child_support
+ description: |-
+ Agency data and requirements to be used for creating child support garnishments
+
+ scope: `garnishments:read`
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: getChildSupportData
+ "/v1/employees/{employee_id}/i9_authorization":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ description: |-
+ An employee's I-9 authorization stores information about an employee's authorization status and I-9 signatures, information required to fill 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.
+
+ ### Related guides
+ - [I-9 employment verification](doc:i-9-employment-verification)
+
+ scope: `i9_authorizations:read`
+ x-gusto-integration-type:
+ - embedded
+ summary: Get an employee's I-9 authorization
+ tags:
+ - I-9 Verification
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/I9-Authorization"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-i9_authorization
+ 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
+ x-speakeasy-group: i9Verification
+ x-speakeasy-name-override: getAuthorization
+ put:
+ security:
+ - CompanyAccessAuth: []
+ 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.
+
+ 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
+
+ ### Related guides
+ - [I-9 employment verification](doc:i-9-employment-verification)
+
+ scope: `i9_authorizations:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Create or update an employee's I-9 authorization
+ tags:
+ - I-9 Verification
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/I9-Authorization"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: put-v1-employees-employee_id-i9_authorization
+ 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/I9-Authorization-Request-Body"
+ x-speakeasy-name-override: update
+ x-speakeasy-group: i9Verification
+ "/v1/employees/{employee_id}/i9_authorization/document_options":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ 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.
+
+ ### Related guides
+ - [I-9 employment verification](doc:i-9-employment-verification)
+
+ scope: `i9_authorizations:read`
+ x-gusto-integration-type:
+ - embedded
+ summary: Get an employee's I-9 verification document options
+ tags:
+ - I-9 Verification
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/I9-Authorization-Document-Option"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-i9_authorization-document_options
+ 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
+ x-speakeasy-group: i9Verification
+ x-speakeasy-name-override: getDocumentOptions
+ "/v1/employees/{employee_id}/i9_authorization/documents":
+ get:
+ security:
+ - CompanyAccessAuth: []
+ 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.
+
+ ### Related guides
+ - [I-9 employment verification](doc:i-9-employment-verification)
+
+ scope: `i9_authorizations:read`
+ x-gusto-integration-type:
+ - embedded
+ summary: Get an employee's I-9 verification documents
+ tags:
+ - I-9 Verification
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/I9-Authorization-Document"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-i9_authorization-documents
+ 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
+ x-speakeasy-group: i9Verification
+ x-speakeasy-name-override: getDocuments
+ put:
+ security:
+ - CompanyAccessAuth: []
+ 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.\n\nUse the [document options endpoint](ref:get-v1-employees-employee_id-i9_authorization-document_options) to get the possible document types and titles, which can vary depending on the employee's authorization status.\n\n> \U0001F6A7 Every request must contain the complete list of documents for the Employee.\n>\n> Every request to this endpoint removes any previous verification document records for the employee.\n\n### Related guides\n- [I-9 employment verification](doc:i-9-employment-verification)\n\nscope: `i9_authorizations:manage`"
+ x-gusto-integration-type:
+ - embedded
+ summary: Create an employee's I-9 authorization verification documents
+ tags:
+ - I-9 Verification
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: Created
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/I9-Authorization-Document"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: put-v1-employees-employee_id-i9_authorization-documents
+ 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/I9-Authorization-Documents-Request-Body"
+ x-speakeasy-group: i9Verification
+ x-speakeasy-name-override: createDocuments
+ "/v1/employees/{employee_id}/i9_authorization/documents/{document_id}":
+ delete:
+ security:
+ - CompanyAccessAuth: []
+ 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.
+
+ ### Related guides
+ - [I-9 employment verification](doc:i-9-employment-verification)
+
+ scope: `i9_authorizations:manage`
+ x-gusto-integration-type:
+ - embedded
+ summary: Delete an employee's I-9 verification document
+ tags:
+ - I-9 Verification
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: No Content
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ operationId: delete-v1-employees-employee_id-i9_authorization-documents-document_id
+ 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: document_id
+ in: path
+ description: The UUID of the document
+ required: true
+ schema:
+ type: string
+ x-speakeasy-group: i9Verification
+ x-speakeasy-name-override: deleteDocument
+ "/v1/employees/{employee_id}/i9_authorization/employer_sign":
+ put:
+ security:
+ - CompanyAccessAuth: []
+ 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.
+
+ ### Prerequisites
+ Before calling this endpoint:
+ 1. The employee must have a completed [I-9 authorization](ref:put-v1-employees-employee_id-i9_authorization)
+ 2. The employee must have signed the Form I-9
+ 3. [I-9 verification documents](ref:put-v1-employees-employee_id-i9_authorization-documents) must be submitted
+
+ ### Related guides
+ - [I-9 employment verification](doc:i-9-employment-verification)
+
+ scope: `i9_authorizations:manage`
+ x-gusto-integration-type:
+ - embedded
+ summary: Employer sign an employee's Form I-9
+ tags:
+ - I-9 Verification
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/I9-Authorization"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ operationId: put-v1-employees-employee_id-i9_authorization-employer_sign
+ 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: x-gusto-client-ip
+ in: header
+ required: false
+ schema:
+ type: string
+ 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.
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/I9-Authorization-Employer-Sign-Request-Body"
+ x-speakeasy-group: i9Verification
+ x-speakeasy-name-override: employerSign
+ "/v1/plaid/processor_token":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a bank account from a plaid processor token
+ operationId: post-v1-plaid-processor_token
+ tags:
+ - Bank Accounts
+ responses:
+ '201':
+ description: A JSON object containing bank information
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - "$ref": "#/components/schemas/Company-Bank-Account"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: "This endpoint creates a new **verified** bank account by using a plaid processor token to retrieve its information.\n\nscope: `plaid_processor:write`\n\n> \U0001F4D8\n> To create a token please use the [plaid api](https://plaid.com/docs/api/processors/#processortokencreate) and select \"gusto\" as processor.\n\n> \U0001F6A7 Warning - Company Bank Accounts\n>\n> 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."
+ requestBody:
+ 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
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: bankAccounts
+ x-speakeasy-name-override: createFromPlaidToken
+ "/v1/companies/{company_uuid}/tax_requirements/{state}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get State Tax Requirements
+ description: |
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - 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.
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Tax Requirements
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Tax-Requirements-State"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_uuid-tax_requirements-state
+ x-speakeasy-group: taxRequirements
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update State Tax Requirements
+ description: |-
+ Update State Tax Requirements
+
+ scope: `company_tax_requirements:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - schema:
+ type: string
+ name: state
+ in: path
+ required: true
+ description: 2-letter US state abbreviation
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Tax Requirements
+ operationId: put-v1-companies-company_uuid-tax_requirements-state
+ responses:
+ '200':
+ description: OK
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ x-examples:
+ example-1:
+ requirement_sets:
+ - key: registrations
+ effective_from:
+ 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:
+ "$ref": "#/components/schemas/Tax-Requirement-Set-Key"
+ effective_from:
+ "$ref": "#/components/schemas/Tax-Requirement-Effective-From"
+ state:
+ "$ref": "#/components/schemas/State"
+ requirements:
+ type: array
+ items:
+ type: object
+ properties:
+ key:
+ "$ref": "#/components/schemas/Tax-Requirement-Key"
+ value:
+ type:
+ - string
+ - 'null'
+ examples:
+ Example:
+ value:
+ requirement_sets:
+ - key: registrations
+ effective_from:
+ 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
+ x-speakeasy-group: taxRequirements
+ x-speakeasy-name-override: updateState
+ "/v1/companies/{company_uuid}/tax_requirements":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get All Tax Requirement States
+ description: |-
+ Returns objects describing the states that have tax requirements for the company
+
+ scope: `company_tax_requirements:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Tax Requirements
+ 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:
+ "$ref": "#/components/schemas/State"
+ setup_complete:
+ type: boolean
+ description: |-
+ If all requirements for the state have been satisfied such that the company can complete
+ onboarding, the company is `setup_complete` in the state. A company must be `setup_complete` in
+ all relevant states to complete the `state_setup` company onboarding step.
+ required:
+ - state
+ - setup_complete
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_uuid-tax_requirements
+ x-speakeasy-group: taxRequirements
+ x-speakeasy-name-override: getAll
+ "/v1/companies/{company_uuid}/contractor_payments/preview":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Preview contractor payment debit date
+ tags:
+ - Contractor Payments
+ 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'
+ '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.
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-companies-company_uuid-contractor_payments-preview
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ 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`
+ requestBody:
+ 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.
+ x-speakeasy-name-override: preview
+ x-speakeasy-group: contractorPayments
+ "/v1/time_off_policies/{time_off_policy_uuid}":
+ get:
+ operationId: get-v1-time_off_policies-time_off_policy_uuid
+ description: |-
+ Get a time off policy
+
+ scope: `time_off_policies:read`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a time off policy
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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
+ tags:
+ - Time Off Policies
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: get
+ put:
+ operationId: put-v1-time_off_policies-time_off_policy_uuid
+ description: |-
+ Update a time off policy
+
+ scope: `time_off_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a time off policy
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '422':
+ description: Unlimited Policy updated with accrual rate
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - "$ref": "#/components/schemas/Time-Off-Policy-Update-Request"
+ tags:
+ - Time Off Policies
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_uuid}/time_off_policies":
+ get:
+ summary: Get all time off policies for a company
+ operationId: get-v1-companies-company_uuid-time_off_policies
+ description: |-
+ Get all time off policies for a company
+
+ scope: `time_off_policies:read`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ tags:
+ - Time Off Policies
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: getAll
+ post:
+ operationId: post-v1-companies-company_uuid-time_off_policies
+ description: |-
+ Create a time off policy
+
+ scope: `time_off_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a time off policy
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '422':
+ description: Policy name required
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy-Request"
+ tags:
+ - Time Off Policies
+ x-speakeasy-name-override: create
+ x-speakeasy-group: timeOffPolicies
+ "/v1/time_off_policies/{time_off_policy_uuid}/add_employees":
+ put:
+ operationId: put-v1-time_off_policies-time_off_policy_uuid-add_employees
+ 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
+
+ scope: `time_off_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Add employees to a time off policy
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '422':
+ description: Add employees with no employees
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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
+ tags:
+ - Time Off Policies
+ requestBody:
+ 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
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: addEmployees
+ "/v1/time_off_policies/{time_off_policy_uuid}/remove_employees":
+ put:
+ description: |-
+ Remove employees from a time off policy
+
+ scope: `time_off_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Remove employees from a time off policy
+ operationId: put-v1-time_off_policies-time_off_policy_uuid-remove_employees
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '422':
+ description: Remove employees with no employees
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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
+ requestBody:
+ 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
+ tags:
+ - Time Off Policies
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: removeEmployees
+ "/v1/companies/{company_uuid}/suspensions":
+ get:
+ summary: Get suspensions for this company
+ operationId: get-companies-company_uuid-suspensions
+ 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.\n\n>\U0001F4D8 To check if company is already suspended\n>\n> 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.\n\nscope: `company_suspensions:read`"
+ tags:
+ - Companies
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Suspension-List"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-group: companies.suspensions
+ x-speakeasy-name-override: get
+ post:
+ summary: Suspend a company's account
+ operationId: post-companies-company_uuid-suspensions
+ 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.
+
+ scope: `company_suspensions:write`
+ tags:
+ - Companies
+ x-gusto-integration-type:
+ - embedded
+ security:
+ - CompanyAccessAuth: []
+ 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
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Suspension"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Suspension-Creation-Errors"
+ requestBody:
+ 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> \U0001F6A7 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> \U0001F6A7 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
+ x-speakeasy-group: companies.suspensions
+ x-speakeasy-name-override: suspend
+ "/v1/companies/{company_uuid}/holiday_pay_policy":
+ get:
+ operationId: get-v1-companies-company_uuid-holiday_pay_policy
+ description: |-
+ Get a company's holiday pay policy
+
+ scope: `holiday_pay_policies:read`
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a company's holiday pay policy
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy"
+ '204':
+ description: no policy exists
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: get
+ post:
+ operationId: post-v1-companies-company_uuid-holiday_pay_policy
+ description: |-
+ Create a holiday pay policy for a company
+
+ scope: `holiday_pay_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a holiday pay policy for a company
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy"
+ '422':
+ description: company already has a policy
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy-Request"
+ 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
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: create
+ put:
+ operationId: put-v1-companies-company_uuid-holiday_pay_policy
+ description: |-
+ Update a company's holiday pay policy
+
+ scope: `holiday_pay_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a company's holiday pay policy
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy"
+ '422':
+ description: no policy exists
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - "$ref": "#/components/schemas/Holiday-Pay-Policy-Request"
+ 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
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: update
+ delete:
+ operationId: delete-v1-companies-company_uuid-holiday_pay_policy
+ description: |-
+ Delete a company's holiday pay policy
+
+ scope: `holiday_pay_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Delete a company's holiday pay policy
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: successful
+ '422':
+ description: no policy exists
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: delete
+ "/v1/companies/{company_uuid}/holiday_pay_policy/add":
+ put:
+ operationId: put-v1-companies-company_uuid-holiday_pay_policy-add
+ description: |-
+ Add employees to a company's holiday pay policy
+
+ scope: `holiday_pay_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Add employees to a company's holiday pay policy
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy"
+ '422':
+ description: no policy exists
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ 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
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: addEmployees
+ "/v1/companies/{company_uuid}/holiday_pay_policy/remove":
+ put:
+ operationId: put-v1-companies-company_uuid-holiday_pay_policy-remove
+ description: |-
+ Remove employees from a company's holiday pay policy
+
+ scope: `holiday_pay_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Remove employees from a company's holiday pay policy
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy"
+ '422':
+ description: no policy exists
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ 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
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: removeEmployees
+ "/v1/companies/{company_uuid}/paid_holidays":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Preview a company's paid holidays
+ operationId: get-companies-company_uuid-paid_holidays
+ responses:
+ '200':
+ "$ref": "#/components/responses/Paid-Holidays-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ 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'
+ description: |-
+ Preview a company's paid holidays
+
+ scope: `holiday_pay_policies:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: previewPaidHolidays
+ "/v1/time_off_policies/{time_off_policy_uuid}/balance":
+ put:
+ summary: Update employee time off balances
+ operationId: put-v1-time_off_policies-time_off_policy_uuid-balance
+ description: |-
+ Updates time off hours balances for employees for a time off policy.
+
+ scope: `time_off_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '422':
+ description: Unlimited policy balance update
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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
+ tags:
+ - Time Off Policies
+ requestBody:
+ 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
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: updateBalance
+ "/v1/time_off_policies/{time_off_policy_uuid}/deactivate":
+ put:
+ description: |-
+ Deactivate a time off policy
+
+ scope: `time_off_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Deactivate a time off policy
+ operationId: put-v1-time_off_policies-time_off_policy_uuid-deactivate
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '422':
+ description: Policy has pending time off requests
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ 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
+ tags:
+ - Time Off Policies
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: deactivate
+ "/v1/notifications/{notification_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a notification's details
+ tags:
+ - Notifications
+ operationId: get-notifications-notification_uuid
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/notification_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Notification"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getDetails
+ "/v1/events":
+ get:
+ 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.\n\n\U0001F4D8 System Access Authentication\n\nThis 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)\n\nscope: `events:read`"
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all events
+ tags:
+ - Events
+ operationId: get-events
+ security:
+ - SystemAccessAuth: []
+ 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.
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: Successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Event-List"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: get
+ "/v1/companies/{company_uuid}/information_requests":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all information requests for a company
+ tags:
+ - Information Requests
+ operationId: get-information-requests
+ description: |-
+ Fetch all information requests for a company.
+
+ scope: `information_requests:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Information-Request-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ "/v1/companies/{company_uuid}/recovery_cases":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all recovery cases for a company
+ tags:
+ - Recovery Cases
+ operationId: get-recovery-cases
+ description: |-
+ Fetch all recovery cases for a company.
+
+ scope: `recovery_cases:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Recovery-Case-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: recoveryCases
+ x-speakeasy-name-override: get
+ "/v1/recovery_cases/{recovery_case_uuid}/redebit":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Initiate a redebit for a recovery case
+ tags:
+ - Recovery Cases
+ operationId: redebit-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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/recovery_case_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '202':
+ description: Accepted
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: recoveryCases
+ x-speakeasy-name-override: redebit
+ "/v1/companies/{company_uuid}/ach_transactions":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all ACH transactions for a company
+ tags:
+ - ACH Transactions
+ operationId: get-ach-transactions
+ description: |-
+ Fetches all ACH transactions for a company.
+
+ scope: `ach_transactions:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/contractor_payment_uuid_query"
+ - "$ref": "#/components/parameters/payroll_uuid_query"
+ - "$ref": "#/components/parameters/transaction_type"
+ - "$ref": "#/components/parameters/payment_direction"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Ach-Transaction-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: achTransactions
+ x-speakeasy-name-override: getAll
+ "/v1/wire_in_requests/{wire_in_request_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a single Wire In Request
+ tags:
+ - Wire In Requests
+ operationId: get-wire_in_requests-wire_in_request_uuid
+ description: |-
+ Fetch a Wire In Request.
+
+ scope: `payrolls:read`
+ parameters:
+ - "$ref": "#/components/parameters/wire_in_request_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Wire-In-Request-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: wireInRequests
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Submit a wire in request
+ operationId: put-wire_in_requests-wire_in_request_uuid
+ responses:
+ '200':
+ "$ref": "#/components/responses/Wire-In-Request-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ 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.0
+ additional_notes: Wire for 2024-06-15 payroll.
+ description: |-
+ Submit a wire in request for a payment
+
+ scope: `payrolls:run`
+ parameters:
+ - "$ref": "#/components/parameters/wire_in_request_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Wire In Requests
+ x-speakeasy-group: wireInRequests
+ x-speakeasy-name-override: submit
+ "/v1/companies/{company_uuid}/wire_in_requests":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all Wire In Requests for a company
+ tags:
+ - Wire In Requests
+ operationId: get-companies-company_uuid-wire_in_request_uuid
+ description: |-
+ Fetches all Wire In Requests for a company.
+
+ scope: `payrolls:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Wire-In-Request-List"
+ x-speakeasy-group: wireInRequests
+ x-speakeasy-name-override: list
+ "/v1/companies/{company_uuid}/notifications":
+ get:
+ summary: Get notifications for company
+ operationId: get-company-notifications
+ description: |-
+ Returns all notifications relevant for the given company.
+
+ scope: `notifications:read`
+ tags:
+ - Notifications
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Notifications-List"
+ "/v1/companies/{company_id}/contractors/payment_details":
+ get:
+ summary: List contractor payment details
+ operationId: get-v1-companies-company_id-contractors-payment_details
+ description: |-
+ 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`
+ tags:
+ - Contractors
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Details-List"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ "/v1/contractor_payment_groups/{id}/partner_disbursements":
+ get:
+ summary: Get partner disbursements for a contractor payment group
+ operationId: get-v1-contractor_payment_groups-id-partner_disbursements
+ description: |-
+ Get partner disbursements for a specific contractor payment group.
+
+ scope: `partner_disbursements:read`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group-Partner-Disbursements"
+ '404':
+ description: |
+ Not Found
+
+ The requested contractor payment group does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ patch:
+ summary: Update partner disbursements for a contractor payment group
+ operationId: patch-v1-contractor_payment_groups-id-partner_disbursements
+ description: |-
+ Update partner disbursements for a specific contractor payment group.
+
+ scope: `partner_disbursements:write`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group-Partner-Disbursements"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ "/v1/companies/{company_id}/payrolls/{id}/partner_disbursements":
+ get:
+ summary: Get partner disbursements for a payroll
+ operationId: get-v1-companies-company_id-payrolls-id-partner_disbursements
+ description: |-
+ Get partner disbursements for a specific payroll.
+
+ scope: `partner_disbursements:read`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Partner-Disbursements"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ patch:
+ summary: Update partner disbursements for a payroll
+ operationId: patch-v1-companies-company_id-payrolls-id-partner_disbursements
+ description: |-
+ Update partner disbursements for a specific payroll.
+
+ scope: `partner_disbursements:write`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Partner-Disbursements"
+ '422':
+ description: mixed single and multiple errors example
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ 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
+ "/v1/companies/{company_id}/bank_accounts/{bank_account_id}":
+ delete:
+ summary: Delete a company bank account
+ operationId: delete-v1-companies-company_id-bank-accounts-bank_account_id
+ description: |-
+ 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`
+ tags:
+ - Bank Accounts
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: successful
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: Cannot delete bank account with unfunded payments
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ "/v1/webhooks/health_check":
+ get:
+ summary: Get the webhooks health status
+ operationId: get-v1-webhooks-health_check
+ description: "Returns the health status (`healthy`, `unhealthy`, or `unknown`) of the webhooks system based on the last ten minutes of activity.\n\n\U0001F4D8 System Access Authentication\n\nThis 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)\n\nscope: `webhook_subscriptions:read`"
+ tags:
+ - Webhooks
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - SystemAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Webhooks-Health-Check-Status"
+ "/v1/employees/{employee_id}/salary_estimates":
+ post:
+ summary: Create a salary estimate for an employee
+ operationId: post-v1-employees-employee_id-salary_estimates
+ 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.
+
+ 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`
+ tags:
+ - Salary Estimates
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: successfully created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Salary-Estimate"
+ '422':
+ description: unprocessable entity - invalid parameters
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ 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.0
+ primary:
+ type: boolean
+ description: Whether this is the primary occupation
+ example: true
+ required: true
+ "/v1/salary_estimates/{uuid}":
+ get:
+ summary: Get a salary estimate
+ operationId: get-v1-salary_estimates-id
+ description: |-
+ 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`
+ tags:
+ - Salary Estimates
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Salary-Estimate"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ put:
+ summary: Update a salary estimate
+ operationId: put-v1-salary_estimates-id
+ description: |-
+ 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`
+ tags:
+ - Salary Estimates
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Salary-Estimate"
+ '422':
+ description: unprocessable entity - already finalized
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ 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
+ "/v1/salary_estimates/{uuid}/accept":
+ post:
+ summary: Accept a salary estimate
+ operationId: post-v1-salary_estimates-uuid-accept
+ description: |-
+ 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`
+ tags:
+ - Salary Estimates
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Salary-Estimate"
+ '422':
+ description: unprocessable entity - invalid employee job
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ 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
+ "/v1/salary_estimates/occupations":
+ get:
+ summary: Search for BLS occupations
+ operationId: get-v1-salary_estimates-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.\n\nReturns a list of matching occupations with their codes, titles, and descriptions.\n\n\U0001F4D8 System Access Authentication\n\nThis 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)\n\nscope: `salary_estimates:read`"
+ tags:
+ - Salary Estimates
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - SystemAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/BLS-Occupation"
+ '422':
+ description: unprocessable entity - search term too short
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ "/v1/employees/{employee_id}/recurring_reimbursements":
+ get:
+ summary: Get recurring reimbursements for an employee
+ operationId: get-v1-employees-employee_id-recurring_reimbursements
+ description: |-
+ Get all active recurring reimbursements for an employee.
+
+ scope: `reimbursements:read`
+ tags:
+ - Reimbursements
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Recurring-Reimbursement-List"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ post:
+ summary: Create a recurring reimbursement
+ operationId: post-v1-employees-employee_id-recurring_reimbursements
+ description: |-
+ Create a recurring reimbursement for an employee.
+
+ scope: `reimbursements:write`
+ tags:
+ - Reimbursements
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Recurring-Reimbursement"
+ '422':
+ description: invalid attributes
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ 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
+ "/v1/recurring_reimbursements/{id}":
+ get:
+ summary: Get a recurring reimbursement
+ operationId: get-v1-recurring_reimbursements
+ description: |-
+ Get a specific recurring reimbursement.
+
+ scope: `reimbursements:read`
+ tags:
+ - Reimbursements
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Recurring-Reimbursement"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ put:
+ summary: Update a recurring reimbursement
+ operationId: put-v1-recurring_reimbursements
+ description: |-
+ Update a recurring reimbursement.
+
+ scope: `reimbursements:write`
+ tags:
+ - Reimbursements
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Recurring-Reimbursement"
+ '409':
+ description: invalid version
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: invalid attributes
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ delete:
+ summary: Delete a recurring reimbursement
+ operationId: delete-v1-recurring_reimbursements
+ description: |-
+ Delete (soft delete) a recurring reimbursement for an employee.
+
+ scope: `reimbursements:write`
+ tags:
+ - Reimbursements
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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
+ x-gusto-rswag: true
+ responses:
+ '204':
+ description: successful
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ "/v1/employees/{employee_uuid}/section603_high_earner_statuses":
+ get:
+ summary: Get all Section 603 high earner statuses for an employee
+ operationId: get-v1-employees-employee_uuid-section603_high_earner_statuses
+ description: |-
+ 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`
+ tags:
+ - Employee Benefits
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful - with records
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status-List"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ post:
+ summary: Create a Section 603 high earner status
+ operationId: post-v1-employees-employee_uuid-section603_high_earner_statuses
+ description: |-
+ 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`
+ tags:
+ - Employee Benefits
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '409':
+ description: conflict - record already exists
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: unprocessable entity - invalid is_high_earner
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status-Create-Request"
+ required: true
+ "/v1/employees/{employee_uuid}/section603_high_earner_statuses/{effective_year}":
+ get:
+ summary: Get a Section 603 high earner status for a specific year
+ operationId: get-v1-employees-employee_uuid-section603_high_earner_statuses-effective_year
+ description: |-
+ 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`
+ tags:
+ - Employee Benefits
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status"
+ '404':
+ description: Not Found - employee does not exist
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: unprocessable entity - invalid effective_year
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ patch:
+ summary: Update a Section 603 high earner status
+ operationId: patch-v1-employees-employee_uuid-section603_high_earner_statuses-effective_year
+ description: |-
+ 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`
+ tags:
+ - Employee Benefits
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status"
+ '404':
+ description: Not Found - employee does not exist
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: unprocessable entity - invalid is_high_earner
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status-Update-Request"
+ required: true
+ "/v1/companies/{company_id}/people_batches":
+ post:
+ summary: Create a people batch
+ operationId: post-v1-companies-company_id-people_batches
+ description: |-
+ 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`
+ tags:
+ - People Batches
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '201':
+ description: created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/People-Batch"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '409':
+ description: conflict - idempotency key already used
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/People-Batch-Conflict-Error"
+ '422':
+ description: unprocessable entity - validation errors
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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`.
+ If 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
+ "/v1/people_batches/{people_batch_uuid}":
+ get:
+ summary: Get a people batch
+ operationId: get-v1-people_batches-people_batch_uuid
+ description: |-
+ 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`
+ tags:
+ - People Batches
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/People-Batch-Results"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ "/v1/companies/{company_id}/reports/employees_annual_fica_wage":
+ post:
+ summary: Create an employees annual FICA wage report
+ operationId: post-v1-companies-company_id-reports-employees_annual_fica_wage
+ description: |-
+ 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`
+ tags:
+ - Reports
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ x-gusto-rswag: true
+ 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
+ '422':
+ description: unprocessable entity - start year before minimum
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ requestBody:
+ 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
+ "/v1/information_requests/{information_request_uuid}/submit":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Submit information request responses
+ tags:
+ - Information Requests
+ operationId: submit-information-request
+ x-speakeasy-group: informationRequests
+ x-speakeasy-name-override: submit
+ description: |-
+ Submit responses to an information request.
+ Supports both text responses and file uploads (multipart/form-data).
+ Maximum file size: 120MB.
+
+ scope: `information_requests:write`
+ parameters:
+ - "$ref": "#/components/parameters/information_request_uuid"
+ requestBody:
+ 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.
+ responses:
+ '200':
+ description: Information request successfully submitted
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Information-Request"
+ '422':
+ description: Validation error - invalid responses or missing required answers
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+components:
+ parameters:
+ search_term:
+ name: search_term
+ in: query
+ schema:
+ type: string
+ description: A string to search for in the object's names
+ pageParam:
+ schema:
+ type: integer
+ in: query
+ name: page
+ description: The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
+ perParam:
+ schema:
+ type: integer
+ in: query
+ name: per
+ description: Number of objects per page. For majority of endpoints will default to 25
+ start_date:
+ in: query
+ name: start_date
+ schema:
+ type: string
+ example: '2020-01-01'
+ end_date:
+ in: query
+ name: end_date
+ description: If left empty, defaults to today's date.
+ schema:
+ type: string
+ example: '2020-01-31'
+ bank_account_uuid:
+ name: bank_account_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the bank account
+ benefit_id:
+ schema:
+ type: string
+ name: benefit_id
+ in: path
+ required: true
+ description: The benefit type in Gusto.
+ compensation_id:
+ schema:
+ type: string
+ name: compensation_id
+ in: path
+ required: true
+ description: The UUID of the compensation
+ company_attachment_uuid:
+ schema:
+ type: string
+ name: company_attachment_uuid
+ in: path
+ required: true
+ description: The UUID of the company attachment
+ company_benefit_id:
+ schema:
+ type: string
+ name: company_benefit_id
+ in: path
+ required: true
+ description: The UUID of the company benefit
+ company_forms_sort_by:
+ 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))?$"
+ company_id:
+ name: company_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the company
+ company_uuid:
+ name: company_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the company
+ contractor_uuid:
+ name: contractor_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the contractor
+ contractor_payment_id:
+ name: contractor_payment_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the contractor payment
+ contractor_payment_uuid:
+ name: contractor_payment_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the contractor payment
+ contractor_payment_group_uuid:
+ name: contractor_payment_group_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the contractor payment group
+ contractors_sort_by:
+ name: sort_by
+ in: query
+ required: false
+ description: 'Sort contractors. Options: type, onboarding_status, name, created_at (optionally with :asc or :desc suffix)'
+ schema:
+ type: string
+ pattern: "^(type|onboarding_status|name|created_at)(:(asc|desc))?$"
+ department_uuid:
+ name: department_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the department
+ document_id:
+ name: document_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the document
+ earning_type_uuid:
+ schema:
+ type: string
+ name: earning_type_uuid
+ in: path
+ required: true
+ description: The UUID of the earning type
+ effective_date:
+ in: query
+ name: effective_date
+ required: false
+ schema:
+ type: string
+ example: '2020-01-31'
+ employee_benefit_id:
+ name: employee_benefit_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the employee benefit.
+ employee_id:
+ name: employee_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the employee
+ employee_uuid:
+ name: employee_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the employee
+ sort_order:
+ name: sort_order
+ in: query
+ required: false
+ schema:
+ type: string
+ example: asc
+ 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.
+ event_type:
+ name: event_type
+ in: query
+ required: false
+ schema:
+ type: string
+ 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.)
+ external_payroll_id:
+ name: external_payroll_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the external payroll
+ form_id:
+ name: form_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the form
+ document_uuid:
+ name: document_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the document
+ garnishment_id:
+ name: garnishment_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the garnishment
+ historical_employee_uuid:
+ name: historical_employee_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the historical employee
+ home_address_uuid:
+ name: home_address_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the home address
+ work_address_uuid:
+ name: work_address_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the work address
+ job_id:
+ schema:
+ type: string
+ name: job_id
+ in: path
+ required: true
+ description: The UUID of the job
+ limit:
+ name: limit
+ in: query
+ required: false
+ schema:
+ type: string
+ description: Limits the number of objects returned in a single response, between 1 and 100. The default is 25
+ location_id:
+ name: location_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the location
+ location_uuid:
+ name: location_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the location
+ payroll_id:
+ name: payroll_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the payroll
+ payroll_uuid:
+ name: payroll_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the payroll
+ pay_schedule_id:
+ name: pay_schedule_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the pay schedule
+ payroll_types:
+ name: payroll_types
+ in: query
+ required: false
+ schema:
+ type: string
+ description: regular and/or transition. Multiple options are comma separated. The default is regular pay periods if nothing is passed in.
+ payroll_prepare_sort_by:
+ name: sort_by
+ in: query
+ required: false
+ description: 'Sort employee compenstations by name. Options: first_name, last_name'
+ schema:
+ type: string
+ enum:
+ - first_name
+ - last_name
+ document_type:
+ name: document_type
+ in: path
+ required: true
+ schema:
+ type: string
+ enum:
+ - printable_payroll_checks
+ description: The type of document being generated
+ report_type:
+ schema:
+ type: string
+ name: report_type
+ in: path
+ required: true
+ description: The report type
+ report_uuid:
+ schema:
+ type: string
+ name: report_uuid
+ in: path
+ required: true
+ description: The UUID of the report request
+ request_uuid:
+ 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.
+ signatory_uuid:
+ name: signatory_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the signatory
+ starting_after_uuid:
+ name: starting_after_uuid
+ in: query
+ required: false
+ schema:
+ type: string
+ description: A cursor for pagination. Returns all events occuring after the specified UUID (exclusive). Events are sorted according to the provided sort_order param.
+ resource_uuid:
+ name: resource_uuid
+ in: query
+ required: false
+ schema:
+ type: string
+ description: The UUID of the company. If not specified, will return all events for all companies.
+ time_off_type:
+ 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'''
+ time_off_policy_uuid:
+ name: time_off_policy_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the company time off policy
+ webhook_subscription_uuid:
+ name: webhook_subscription_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The webhook subscription UUID.
+ VersionHeader:
+ 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'
+ IpAddressHeader:
+ 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
+ notification_uuid:
+ name: notification_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The notification entity_uuid
+ invoice_period:
+ 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
+ recovery_case_uuid:
+ name: recovery_case_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the recovery case
+ contractor_payment_uuid_query:
+ name: contractor_payment_uuid
+ in: query
+ required: false
+ schema:
+ type: string
+ description: The UUID of the contractor payment
+ payroll_uuid_query:
+ name: payroll_uuid
+ in: query
+ required: false
+ schema:
+ type: string
+ description: The UUID of the payroll
+ transaction_type:
+ 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".
+ payment_direction:
+ 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".
+ wire_in_request_uuid:
+ name: wire_in_request_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the Wire In Request
+ time_sheet_uuid:
+ name: time_sheet_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: UUID of the time sheet
+ entity_uuids:
+ name: entity_uuids
+ required: false
+ in: query
+ schema:
+ type: array
+ items:
+ type: string
+ description: Entity UUIDs that reported time sheets
+ entity_type:
+ name: entity_type
+ required: false
+ in: query
+ schema:
+ type: string
+ enum:
+ - Employee
+ - Contractor
+ description: 'Type of entities to filter. One of: "Employee", "Contractor"'
+ status:
+ name: status
+ required: false
+ in: query
+ schema:
+ type: string
+ enum:
+ - approved
+ - pending
+ - rejected
+ description: 'Status of time sheets. One of: "approved", "pending", "rejected"'
+ time_sheet_before:
+ name: before
+ required: false
+ in: query
+ schema:
+ type: string
+ description: time sheets that were created before ISO 8601 timestamp. Filtering by "created_at"
+ time_sheet_after:
+ name: after
+ required: false
+ in: query
+ schema:
+ type: string
+ description: time sheets that were created before ISO 8601 timestamp. Filtering by "created_at"
+ time_sheet_sort_by:
+ name: sort_by
+ required: false
+ in: query
+ schema:
+ type: string
+ enum:
+ - created_at
+ - updated_at
+ - shift_started_at
+ - shift_ended_at
+ description: 'Field to sort by. One of: "created_at", "updated_at", "shift_started_at", "shift_ended_at"'
+ time_sheet_sort_order:
+ name: sort_order
+ required: false
+ in: query
+ schema:
+ type: string
+ enum:
+ - asc
+ - desc
+ description: 'Sorting order. One of: "asc", "desc"'
+ resource_version:
+ name: version
+ required: true
+ in: query
+ schema:
+ 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.
+ information_request_uuid:
+ name: information_request_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the information request
+ schemas:
+ Versionable-Required:
+ 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
+ Versionable:
+ 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.
+ Employee-Address:
+ 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
+ Employee-Work-Address:
+ 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
+ Contractor-Address:
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/Address"
+ - type: object
+ properties:
+ contractor_uuid:
+ type: string
+ description: The UUID of the contractor
+ Address:
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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
+ Employee-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'
+ Department:
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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
+ Employee:
+ 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:
+ last_name: Koss
+ email: keena.feest@kiehn.co.uk
+ company_uuid: e904cc79-818a-4da8-9d37-0be0a86fdda8
+ manager_uuid:
+ version: a5cec1f1c0135feb3e76ca6ea3c46176
+ current_employment_status: full_time
+ onboarding_status: onboarding_completed
+ preferred_first_name:
+ department_uuid:
+ employee_code: 46f036
+ payment_method: Direct Deposit
+ department:
+ terminated: false
+ two_percent_shareholder: false
+ onboarded: true
+ historical: false
+ has_ssn: true
+ onboarding_documents_config:
+ uuid:
+ 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:
+ state_wc_class_code:
+ 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:
+ work_email:
+ member_portal_invitation_status:
+ status: sent
+ token_expired: false
+ welcome_email_sent_at: '2024-01-15T14:30:00Z'
+ last_password_resent_at:
+ 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:
+ "$ref": "#/components/schemas/Job"
+ eligible_paid_time_off:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Paid-Time-Off"
+ terminations:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Termination"
+ garnishments:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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:
+ "$ref": "#/components/schemas/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:
+ "$ref": "#/components/schemas/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
+ Employee-Onboarding-Status:
+ 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
+ Company-Address:
+ 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
+ Location:
+ description: The representation of an address in Gusto.
+ type: object
+ title: ''
+ 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
+ Paid-Time-Off:
+ 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
+ Child-Support-Data:
+ 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
+ Garnishment-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.
+ 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.
+ 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:
+ 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:
+ 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:
+ 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:
+ 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:
+ "$ref": "#/components/schemas/Garnishment-Child-Support"
+ required:
+ - uuid
+ Employee-Onboarding-Document:
+ 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.
+ When true, the employee will be prompted to complete Form I-9 as part of their onboarding.
+ 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:
+ i9_document: false
+ I9-Authorization:
+ 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:
+ oneOf:
+ - type: string
+ enum:
+ - uscis_alien_registration_number
+ - form_i94
+ - foreign_passport
+ - type: 'null'
+ description: The document's document type
+ 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
+ x-examples:
+ alien_with_foreign_passport:
+ uuid: 7f2337f9-9b78-44b9-aeed-be4777b833a8
+ version: 6ae7ff720107b356bf13b1606f60b24f
+ form_uuid: c54046f7-1be4-4c54-8194-f4842c30c86d
+ authorization_status: alien
+ document_type: foreign_passport
+ has_document_number: true
+ expiration_date: '2028-01-01'
+ country: Canada
+ employer_signed: false
+ employee_signed: false
+ additional_info:
+ alt_procedure:
+ citizen_authorization:
+ uuid: a12bc345-6789-4def-abcd-ef0123456789
+ version: 52b7c567242cb7393b2a206ed6a86afcb
+ form_uuid:
+ authorization_status: citizen
+ document_type:
+ has_document_number: false
+ expiration_date:
+ country:
+ employer_signed: false
+ employee_signed: false
+ additional_info:
+ alt_procedure:
+ employer_signed_authorization:
+ uuid: 7f2337f9-9b78-44b9-aeed-be4777b833a8
+ version: 8bc7393b2a206ed6a86afcb4d00c1785
+ form_uuid: c54046f7-1be4-4c54-8194-f4842c30c86d
+ authorization_status: citizen
+ document_type:
+ has_document_number: false
+ expiration_date:
+ country:
+ employer_signed: true
+ employee_signed: true
+ additional_info: Additional info
+ alt_procedure: false
+ I9-Authorization-Document:
+ 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
+ - 'null'
+ 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
+ x-examples:
+ driver_license:
+ uuid: 7f2337f9-9b78-44b9-aeed-be4777b833a8
+ document_type: driver_license
+ issuing_authority: USA
+ expiration_date: '2027-01-01'
+ document_title: Driver's license
+ ssn_card:
+ uuid: 9p2337f9-9b78-44b9-aeed-be4777b833a8
+ document_type: ssn_card
+ issuing_authority: USA
+ document_title: Social Security card
+ I9-Authorization-Document-Option:
+ 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
+ x-examples:
+ example_a:
+ section: A
+ description: Foreign passport
+ document_type: foreign_passport_w_i94
+ document_title:
+ - Foreign passport
+ common_choice: true
+ example_b:
+ 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
+ example_c:
+ section: C
+ description: Social Security card
+ document_type: ssn_card
+ document_title:
+ - Social Security card
+ common_choice: true
+ Termination:
+ 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
+ Rehire-Body:
+ 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
+ Fast-Payment-Limit-Param:
+ type: string
+ description: Fast payment limit. This limit is an aggregate of all fast payrolls amount. This limit is only relevant when payment speed is 1-day or 2-day.
+ Payment-Speed-Param:
+ type: string
+ description: Gusto Embedded supports three payment speeds (1-day, 2-day, and 4-day). For next-day payments, funds are deposited in your team's bank account by the end of the next business day. Most people will see the funds arrive the next afternoon, but payments may arrive as late as the end of the business day.
+ enum:
+ - 1-day
+ - 2-day
+ - 4-day
+ Fast-Payment-Limit-Required-Body:
+ type: object
+ properties:
+ fast_payment_limit:
+ "$ref": "#/components/schemas/Fast-Payment-Limit-Param"
+ payment_speed:
+ "$ref": "#/components/schemas/Payment-Speed-Param"
+ required:
+ - fast_payment_limit
+ Payment-Speed-Required-Body:
+ type: object
+ properties:
+ fast_payment_limit:
+ "$ref": "#/components/schemas/Fast-Payment-Limit-Param"
+ payment_speed:
+ "$ref": "#/components/schemas/Payment-Speed-Param"
+ required:
+ - payment_speed
+ Historical-Employee-Body:
+ 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
+ Pay-Schedule-Assignment-Body:
+ 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
+ Flsa-Status-Type:
+ 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. '
+ Compensation:
+ 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:
+ "$ref": "#/components/schemas/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'
+ Form-Document-Content-Type-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
+ Form:
+ 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:
+ "$ref": "#/components/schemas/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:
+ quarter:
+ requires_signing: true
+ document_content_type: application/pdf
+ x-tags:
+ - Forms
+ required:
+ - uuid
+ Form_1099:
+ 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:
+ "$ref": "#/components/schemas/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:
+ document_content_type: application/pdf
+ contractor_uuid: 123dd616-6dbc-4724-938a-403f6217a933
+ x-tags:
+ - Forms
+ required:
+ - uuid
+ Form-Pdf:
+ 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:
+ "$ref": "#/components/schemas/Form-Document-Content-Type-Type"
+ required:
+ - uuid
+ Document:
+ 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:
+ x: 69
+ "y": 94
+ width: 261
+ height: 13
+ page_number: 0
+ data_type: text
+ required: true
+ - key: optional_text1596141704672
+ value:
+ x: 69
+ "y": 118
+ width: 262
+ height: 13
+ page_number: 0
+ data_type: text
+ required: false
+ signed_at:
+ description: Form W-9, Request for Taxpayer Identification Number and Certification
+ requires_signing: true
+ draft: false
+ year:
+ quarter:
+ x-tags:
+ - Documents
+ Document-Signed:
+ 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:
+ quarter:
+ x-tags:
+ - Documents
+ Document-Pdf:
+ 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
+ Industry:
+ 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
+ Job:
+ 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:
+ 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:
+ "$ref": "#/components/schemas/Compensation"
+ readOnly: true
+ location_uuid:
+ type: string
+ nullable: false
+ description: The uuid of the employee's work location.
+ location:
+ "$ref": "#/components/schemas/Location"
+ description: The representation of a job in Gusto.
+ required:
+ - uuid
+ External-Payroll:
+ description: The representation of an external payroll.
+ type: object
+ x-tags:
+ - External Payrolls
+ title: ''
+ 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.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
+ required:
+ - uuid
+ Webhook-Subscription:
+ description: The representation of webhook subscription.
+ type: object
+ x-tags:
+ - Webhooks
+ title: ''
+ 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
+ - PayrollSync
+ - 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
+ - PayrollSync
+ - PaySchedule
+ - Signatory
+ required:
+ - uuid
+ External-Payroll-Basic:
+ description: The representation of an external payroll with minimal information.
+ type: object
+ x-tags:
+ - External Payrolls
+ title: ''
+ 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
+ External-Payroll-Tax-Suggestions:
+ description: The representation of an external payroll with minimal information.
+ type: object
+ x-tags:
+ - External Payrolls
+ title: ''
+ 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'
+ Tax-Liabilities-Selections:
+ description: The representation of tax liabilities selections.
+ type: object
+ x-tags:
+ - External Payrolls
+ title: ''
+ 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:
+ possible_liabilities:
+ - liability_amount: '0.0'
+ payroll_check_date:
+ external_payroll_uuid:
+ - liability_amount: '3000.0'
+ payroll_check_date: '2022-06-01'
+ external_payroll_uuid: 1bf1efe1-72d4-4e6e-a181-611f3ea66435
+ Admin:
+ 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
+ Company:
+ 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:
+ "$ref": "#/components/schemas/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
+ Company-Onboarding-Status:
+ description: The representation of a company's onboarding status
+ type: object
+ title: ''
+ 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:
+ skippable: false
+ requirements: []
+ - title: Sign Documents
+ id: sign_all_forms
+ required: true
+ completed: false
+ completed_at:
+ 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:
+ 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
+ Payment-Configs:
+ 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.
+ - `1-day`: Next-day ACH (only for partners that opt in).
+ - `2-day`: Two-day ACH.
+ - `4-day`: Standard ACH.
+ 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:
+ 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
+ Contractor-Body:
+ 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.
+
+'
+ enum:
+ - Fixed
+ - Hourly
+ start_date:
+ type: string
+ description: 'The day when the contractor will start working for the company.
+
+'
+ 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.
+ Self-onboarding is recommended so that contractors receive Gusto accounts.
+ If 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.
+ This attribute is required for `Individual` contractors and will be ignored for `Business` contractors.
+ last_name:
+ type: string
+ description: |-
+ The contractor’s last name.
+ This attribute is required for `Individual` contractors and will be ignored for `Business` contractors.
+ middle_initial:
+ type: string
+ description: |-
+ The contractor’s middle initial.
+ This 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.
+ This 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.
+ This value is used when generating the new hire report.
+ This 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.
+ Social 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.
+ This 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.
+ Contractor:
+ 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.
+ This 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:
+ ein:
+ 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:
+ upcoming_employment:
+ 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:
+ last_name:
+ middle_initial:
+ business_name: Labadie-Stroman
+ ein: XX-XXX0001
+ has_ein: true
+ has_ssn: false
+ email: jonatan@kerluke.info
+ file_new_hire_report: false
+ work_state:
+ 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:
+ department:
+ department_title:
+ dismissal_date:
+ upcoming_employment:
+ dismissal_cancellation_eligible: false
+ rehire_cancellation_eligible: false
+ Contractor-Onboarding-Status:
+ 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
+ Contractor-Payment:
+ 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
+ Contractor-Payment-Group:
+ description: The full contractor payment group, including associated contractor payments.
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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:
+ "$ref": "#/components/schemas/Payroll-Submission-Blocker-Type"
+ credit_blockers:
+ type: array
+ description: List of credit blockers for the contractor payment group.
+ readOnly: true
+ items:
+ "$ref": "#/components/schemas/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:
+ "$ref": "#/components/schemas/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
+ Contractor-Payment-Group-Minimal:
+ description: The summary of a contractor payment group.
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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
+ Contractor-Payment-For-Group:
+ 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
+ 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:
+ - 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:
+ "$ref": "#/components/schemas/Contractor-Payment"
+ readOnly: true
+ readOnly: true
+ x-tags:
+ - Contractor Payments
+ Contractor-Payment-Summary-By-Dates:
+ 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:
+ "$ref": "#/components/schemas/Contractor-Payment"
+ readOnly: true
+ readOnly: true
+ readOnly: true
+ x-tags:
+ - Contractor Payments
+ Contractor-Payment-Method:
+ 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:
+ "$ref": "#/components/schemas/Payment-Method-Bank-Account"
+ x-tags:
+ - Contractor Payment Method
+ Payment-Method-Bank-Account:
+ 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
+ Unprocessable-Entity-Error-Object:
+ description: "Unprocessable Entity\n \nThis may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request 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:
+ "$ref": "#/components/schemas/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.
+ payroll_sync_invalid_pay_schedule:
+ errors:
+ - error_key: pay_schedule_uuid
+ category: invalid_attribute_value
+ message: Pay schedule uuid could not be found.
+ payroll_sync_no_employees:
+ errors:
+ - error_key: base
+ category: invalid_operation
+ message: There are no employees to run payroll for in the selected pay period.
+ payroll_sync_empty_export:
+ errors:
+ - error_key: base
+ category: invalid_operation
+ message: There are no hours to sync to payroll for the selected pay period.
+ 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.
+ pay_schedule_missing_anchor_dates:
+ errors:
+ - error_key: anchor_pay_date
+ category: invalid_attribute_value
+ message: can't be blank
+ - error_key: anchor_end_of_pay_period
+ category: invalid_attribute_value
+ message: can't be blank
+ pay_schedule_invalid_frequency:
+ errors:
+ - error_key: frequency
+ category: invalid_attribute_value
+ message: is not included in the list
+ pay_schedule_malformed_dates:
+ errors:
+ - error_key: anchor_pay_date
+ category: invalid_attribute_value
+ message: is invalid
+ - error_key: anchor_end_of_pay_period
+ category: invalid_attribute_value
+ message: is invalid
+ 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.
+ i9_authorization_unneeded_document_params:
+ errors:
+ - error_key: expiration_date
+ category: invalid_attribute_value
+ message: For the submitted authorization status, expiration date is not allowed
+ - error_key: document_type
+ category: invalid_attribute_value
+ message: For the submitted authorization status, document type is not allowed
+ i9_authorization_not_self_onboarding:
+ errors:
+ - error_key: base
+ category: invalid_operation
+ message: Employee is not self-onboarding.
+ i9_authorization_employee_already_signed:
+ errors:
+ - error_key: base
+ category: invalid_operation
+ message: Employee has already signed the form.
+ i9_employer_sign_invalid_params:
+ errors:
+ - error_key: signed_by_ip_address
+ category: invalid_attribute_value
+ message: Signed by IP address is invalid
+ - error_key: signer_title
+ category: invalid_attribute_value
+ message: Signer title is required
+ - error_key: agree
+ category: invalid_attribute_value
+ message: You must agree to sign electronically
+ - error_key: signature_text
+ category: invalid_attribute_value
+ message: Signature text is required
+ i9_employer_sign_employee_not_signed:
+ errors:
+ - error_key: base
+ category: invalid_operation
+ message: Employee has not signed I-9
+ i9_employer_sign_already_signed:
+ errors:
+ - error_key: base
+ category: invalid_operation
+ message: I-9 has already been signed by the employer
+ i9_documents_already_signed:
+ errors:
+ - error_key: base
+ category: invalid_operation
+ message: I-9 cannot be updated as it has already been signed by the employer
+ i9_documents_invalid_params:
+ errors:
+ - error_key: documents
+ category: nested_errors
+ metadata:
+ document_type: invalid_type
+ errors:
+ - error_key: document_type
+ category: invalid_attribute_value
+ message: Document type's value is not included in the list
+ - error_key: document_title
+ category: invalid_attribute_value
+ message: Document title's value is not included in the list
+ i9_documents_not_array:
+ errors:
+ - error_key: base
+ category: invalid_operation
+ message: Parameter `documents` must be an array
+ Entity-Error-Object:
+ type: object
+ required:
+ - error_key
+ - category
+ properties:
+ error_key:
+ type: string
+ description: Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error.
+ category:
+ type: 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:
+ - "$ref": "#/components/schemas/Metadata-With-Multiple-Entities"
+ - "$ref": "#/components/schemas/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:
+ "$ref": "#/components/schemas/Entity-Error-Object"
+ Metadata-With-One-Entity:
+ type: object
+ description: single entity
+ additionalProperties: true
+ properties:
+ entity_type:
+ type: string
+ description: Name of the entity that the error corresponds to.
+ entity_uuid:
+ type: string
+ description: Unique identifier for the entity.
+ valid_from:
+ type:
+ - string
+ - 'null'
+ valid_up_to:
+ type:
+ - string
+ - 'null'
+ key:
+ type:
+ - string
+ - 'null'
+ state:
+ type:
+ - string
+ - 'null'
+ Metadata-With-Multiple-Entities:
+ type: object
+ description: multiple entities
+ required:
+ - entities
+ properties:
+ entities:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Metadata-With-One-Entity"
+ Payroll-Blockers-Error:
+ description: |-
+ Payroll Blockers Error
+
+ For 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"
+ Migration-Blocker:
+ 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"
+ Migration-Warning:
+ 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"
+ Authentication:
+ description: ''
+ type: object
+ oneOf:
+ - "$ref": "#/components/schemas/Create-Token-Authentication"
+ - "$ref": "#/components/schemas/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
+ Pay-Schedule:
+ 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
+ success_status:
+ uuid: f2a69c38-e2f9-4e31-b5c5-4754fc60a052
+ version: 68934a3e9455fa72420237eb05902327
+ frequency: Twice per month
+ anchor_pay_date: '2022-09-01'
+ anchor_end_of_pay_period: '2022-08-18'
+ day_1: 1
+ day_2: 15
+ name:
+ custom_name: every 1st and 15th of the month
+ auto_payroll: true
+ active: true
+ auto_payroll_enablement_blockers:
+ description: |
+ The pay schedule object captures the details of when employees work and when they should be paid. A company can have multiple pay schedules.
+
+ Response includes frequency, anchor dates, optional day_1/day_2 for monthly/semi-monthly, auto_pilot (or auto_payroll for API version 2025-11-15 and later), and auto_payroll_enablement_blockers when Autopayroll is disabled.
+
+ **Webhooks:** Subscribe to [Pay Schedule Events](https://docs.gusto.com/embedded-payroll/docs/pay-schedule-events) to receive `pay_schedule.created` and `pay_schedule.updated` when pay schedules are created or updated.
+ properties:
+ uuid:
+ "$ref": "#/components/schemas/Pay-Schedule-Uuid"
+ version:
+ "$ref": "#/components/schemas/Pay-Schedule-Version"
+ frequency:
+ "$ref": "#/components/schemas/Pay-Schedule-Frequency"
+ anchor_pay_date:
+ "$ref": "#/components/schemas/Pay-Schedule-Anchor-Pay-Date"
+ anchor_end_of_pay_period:
+ "$ref": "#/components/schemas/Pay-Schedule-Anchor-End-Of-Pay-Period"
+ day_1:
+ "$ref": "#/components/schemas/Pay-Schedule-Day-1"
+ day_2:
+ "$ref": "#/components/schemas/Pay-Schedule-Day-2"
+ name:
+ "$ref": "#/components/schemas/Pay-Schedule-Name"
+ custom_name:
+ "$ref": "#/components/schemas/Pay-Schedule-Custom-Name"
+ auto_pilot:
+ "$ref": "#/components/schemas/Pay-Schedule-Auto-Pilot"
+ auto_payroll:
+ "$ref": "#/components/schemas/Pay-Schedule-Auto-Payroll"
+ active:
+ "$ref": "#/components/schemas/Pay-Schedule-Active"
+ auto_payroll_enablement_blockers:
+ "$ref": "#/components/schemas/Pay-Schedule-Auto-Payroll-Enablement-Blockers"
+ x-tags:
+ - Pay Schedules
+ required:
+ - uuid
+ Pay-Schedule-Create-Update:
+ 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:
+ "$ref": "#/components/schemas/Pay-Schedule-Uuid"
+ frequency:
+ "$ref": "#/components/schemas/Pay-Schedule-Frequency-Create-Update"
+ anchor_pay_date:
+ "$ref": "#/components/schemas/Pay-Schedule-Anchor-Pay-Date"
+ anchor_end_of_pay_period:
+ "$ref": "#/components/schemas/Pay-Schedule-Anchor-End-Of-Pay-Period"
+ day_1:
+ "$ref": "#/components/schemas/Pay-Schedule-Day-1"
+ day_2:
+ "$ref": "#/components/schemas/Pay-Schedule-Day-2"
+ name:
+ "$ref": "#/components/schemas/Pay-Schedule-Name"
+ custom_name:
+ "$ref": "#/components/schemas/Pay-Schedule-Custom-Name"
+ auto_pilot:
+ "$ref": "#/components/schemas/Pay-Schedule-Auto-Pilot"
+ active:
+ "$ref": "#/components/schemas/Pay-Schedule-Active"
+ x-tags:
+ - Pay Schedules
+ required:
+ - uuid
+ Pay-Schedule-Uuid:
+ type: string
+ description: The unique identifier of the pay schedule.
+ readOnly: true
+ Pay-Schedule-Frequency:
+ type: string
+ description: |
+ Pay frequency for this schedule. READ-ONLY.
+
+ - `Every week`: Employees are paid weekly.
+ - `Every other week`: Employees are paid bi-weekly (every two weeks).
+ - `Twice per month`: Employees are paid on two fixed days each month (e.g. 1st and 15th); use day_1 and day_2.
+ - `Monthly`: Employees are paid once per month; use day_1 for the pay day.
+ - `Quarterly`: Employees are paid every three months.
+ - `Annually`: Employees are paid once per year.
+ enum:
+ - Every week
+ - Every other week
+ - Twice per month
+ - Monthly
+ - Quarterly
+ - Annually
+ readOnly: true
+ Pay-Schedule-Frequency-Create-Update:
+ type: string
+ description: |
+ Pay frequency when creating or updating a schedule. Only weekly, bi-weekly, twice per month, and monthly are supported via the API.
+
+ - `Every week`: Weekly pay.
+ - `Every other week`: Biweekly pay.
+ - `Twice per month`: Two pay dates per month; require day_1 and day_2 (use 31 for last day of month).
+ - `Monthly`: One pay date per month; require day_1 (1-31).
+ enum:
+ - Every week
+ - Every other week
+ - Twice per month
+ - Monthly
+ Pay-Schedule-Anchor-Pay-Date:
+ type: string
+ format: date
+ description: The first date that employees on this pay schedule are paid (ISO 8601 YYYY-MM-DD).
+ readOnly: true
+ Pay-Schedule-Anchor-End-Of-Pay-Period:
+ type: string
+ format: date
+ description: The last date of the first pay period. This can be the same date as the anchor pay date (ISO 8601 YYYY-MM-DD).
+ readOnly: true
+ Pay-Schedule-Day-1:
+ type:
+ - integer
+ - 'null'
+ description: |
+ First pay day of the month (1-31).
+ - **Twice per month, Monthly:** present (required on create/update).
+ - **Every week, Every other week:** null.
+ readOnly: true
+ Pay-Schedule-Day-2:
+ type:
+ - integer
+ - 'null'
+ description: |
+ Second pay day of the month (1-31); only for **Twice per month**.
+ - Use 31 for last day of month (shorter months use the actual last day).
+ - **Other frequencies:** null.
+ readOnly: true
+ Pay-Schedule-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
+ Pay-Schedule-Custom-Name:
+ type: string
+ description: 'Display name for the pay schedule. When the partner never set a custom name (or cleared it), this field contains the auto-generated description derived from frequency and pay days (e.g. "every 1st and 15th of the month", "every Friday"). When the partner set a custom name on create or update, this field contains that value.
+
+'
+ readOnly: true
+ Pay-Schedule-Auto-Pilot:
+ type: boolean
+ description: |
+ When true, autopilot is enabled and payroll runs automatically one day before payroll deadlines. When false, payroll does not run automatically.
+ For API version 2025-11-15 and later the response uses auto_payroll (Autopayroll) instead.
+ Pay-Schedule-Active:
+ type: boolean
+ description: Whether this pay schedule is associated with any employees. A pay schedule is inactive when it's unassigned.
+ readOnly: true
+ Ytd-Benefit-Amounts-From-Different-Company:
+ 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
+ Company-Attachment:
+ 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
+ Company-Bank-Account:
+ 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.
+
+ 'awaiting_deposits' means the bank account is just created and money is being transferred.
+ 'ready_for_verification' means the micro-deposits are completed and the verification process can begin by using the verify endpoint.
+ '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.
+
+ 'bank_deposits' means the bank account is connected by entering routing and accounting numbers and verifying through micro-deposits.
+ '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
+ Benefit-Type-Requirements:
+ 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
+ Benefit-Summary:
+ 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.
+ Supported-Benefit:
+ 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
+ Company-Benefit-With-Employee-Benefits:
+ 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.
+
+ "amount": The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ "percentage": The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ "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.
+
+ For 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.
+
+ Use threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.
+
+ For example:
+
+ If 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.
+
+ If 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
+ Company-Benefit:
+ 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
+ Earning-Type:
+ 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
+ Employee-Benefit-Base-Object:
+ description: ''
+ type: object
+ title: ''
+ 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.
+
+ "amount": The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ "percentage": The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ "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.
+
+ For 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.
+
+ Use threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.
+
+ For example:
+
+ If 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.
+
+ If 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.
+
+ `Family` and `Individual` are applicable to HSA benefit.
+
+ `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.
+ Employee-Benefit:
+ description: The representation of an employee benefit.
+ type: object
+ title: ''
+ 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:
+ retirement_loan_identifier:
+ deduct_as_percentage: false
+ contribute_as_percentage: false
+ catch_up: false
+ coverage_amount:
+ deduction_reduces_taxable_income:
+ coverage_salary_multiplier: '0.00'
+ contribution:
+ type: amount
+ value: '100.00'
+ elective: false
+ effective_date: '2025-01-01'
+ expiration_date:
+ 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:
+ deduct_as_percentage: false
+ catch_up: false
+ coverage_amount:
+ deduction_reduces_taxable_income:
+ 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:
+ allOf:
+ - "$ref": "#/components/schemas/Employee-Benefit-Base-Object"
+ - 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
+ Employee-Benefit-For-Company-Benefit:
+ description: The representation of an employee benefit for a company benefit.
+ type: object
+ title: ''
+ allOf:
+ - "$ref": "#/components/schemas/Employee-Benefit-Base-Object"
+ - 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
+ Employee-Pay-Stub:
+ 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
+ Pay-Period:
+ 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
+ Contribution-Exclusion:
+ 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
+ Created-At-Type:
+ type: string
+ format: date-time
+ description: Datetime for when the resource was created.
+ readOnly: true
+ Off-Cycle-Reason-Type:
+ 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
+ Auto-Pilot-Type:
+ type: boolean
+ description: Indicates whether the payroll is an auto pilot payroll
+ readOnly: true
+ Payroll-Employee-Compensations-Type:
+ allOf:
+ - "$ref": "#/components/schemas/Payroll-Employee-Compensations-Base-Type"
+ - "$ref": "#/components/schemas/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.
+ Payroll-Totals-Type:
+ 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
+ Payroll-Company-Taxes-Type:
+ 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
+ Payroll-Payment-Speed-Changed-Type:
+ 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
+ Payroll-Payroll-Status-Meta-Type:
+ 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
+ Payroll-Pay-Period-Type:
+ 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
+ Payroll-Withholding-Pay-Period-Type:
+ 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
+ Payroll-Deadline-Type:
+ 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
+ Payroll-Check-Date-Type:
+ type: string
+ description: The date on which employees will be paid for the payroll.
+ readOnly: true
+ Payroll-Processed-Type:
+ 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
+ Payroll-Processed-Date-Type:
+ type:
+ - string
+ - 'null'
+ description: The date at which the payroll was processed. Null if the payroll isn't processed yet.
+ readOnly: true
+ Payroll-Calculated-At-Type:
+ 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
+ Payroll-Payroll-Uuid-Type:
+ type: string
+ description: The UUID of the payroll.
+ readOnly: true
+ Payroll-Company-Uuid-Type:
+ type: string
+ description: The UUID of the company for the payroll.
+ readOnly: true
+ Payroll-Off-Cycle-Type:
+ type: boolean
+ description: Indicates whether the payroll is an off-cycle payroll
+ readOnly: true
+ Payroll-External-Type:
+ type: boolean
+ description: Indicates whether the payroll is an external payroll
+ readOnly: true
+ Payroll-Final-Termination-Payroll-Type:
+ type: boolean
+ description: Indicates whether the payroll is the final payroll for a terminated employee. Only included for off-cycle payrolls.
+ readOnly: true
+ Payroll-Skip-Regular-Deductions-Type:
+ type:
+ - boolean
+ - 'null'
+ description: Block regular deductions and contributions for this payroll. Only included for off-cycle payrolls.
+ readOnly: true
+ Payroll-Fixed-Withholding-Rate-Type:
+ 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
+ Payroll-Fixed-Compensation-Types-Type:
+ type: array
+ items:
+ type: object
+ readOnly: true
+ properties:
+ name:
+ description: The name of an available type of fixed compensation.
+ type: string
+ readOnly: true
+ Payroll-Submission-Blockers-Type:
+ type: array
+ description: Only included for processed or calculated payrolls
+ uniqueItems: true
+ items:
+ "$ref": "#/components/schemas/Payroll-Submission-Blocker-Type"
+ Payroll-Credit-Blockers-Type:
+ type: array
+ description: Only included for processed payrolls
+ uniqueItems: true
+ items:
+ "$ref": "#/components/schemas/Payroll-Credit-Blocker-Type"
+ Reversal-Payroll-Uuids-Type:
+ 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
+ Payroll-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:
+ "$ref": "#/components/schemas/Entity-Error-Object"
+ Payroll:
+ 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:
+ properties:
+ payroll_deadline:
+ "$ref": "#/components/schemas/Payroll-Deadline-Type"
+ check_date:
+ "$ref": "#/components/schemas/Payroll-Check-Date-Type"
+ processed:
+ "$ref": "#/components/schemas/Payroll-Processed-Type"
+ processed_date:
+ "$ref": "#/components/schemas/Payroll-Processed-Date-Type"
+ calculated_at:
+ "$ref": "#/components/schemas/Payroll-Calculated-At-Type"
+ uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ payroll_uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ company_uuid:
+ "$ref": "#/components/schemas/Payroll-Company-Uuid-Type"
+ off_cycle:
+ "$ref": "#/components/schemas/Payroll-Off-Cycle-Type"
+ off_cycle_reason:
+ "$ref": "#/components/schemas/Off-Cycle-Reason-Type"
+ auto_pilot:
+ "$ref": "#/components/schemas/Auto-Pilot-Type"
+ external:
+ "$ref": "#/components/schemas/Payroll-External-Type"
+ final_termination_payroll:
+ "$ref": "#/components/schemas/Payroll-Final-Termination-Payroll-Type"
+ withholding_pay_period:
+ "$ref": "#/components/schemas/Payroll-Withholding-Pay-Period-Type"
+ skip_regular_deductions:
+ "$ref": "#/components/schemas/Payroll-Skip-Regular-Deductions-Type"
+ fixed_withholding_rate:
+ "$ref": "#/components/schemas/Payroll-Fixed-Withholding-Rate-Type"
+ pay_period:
+ "$ref": "#/components/schemas/Payroll-Pay-Period-Type"
+ payroll_status_meta:
+ "$ref": "#/components/schemas/Payroll-Payroll-Status-Meta-Type"
+ totals:
+ "$ref": "#/components/schemas/Payroll-Totals-Type"
+ company_taxes:
+ "$ref": "#/components/schemas/Payroll-Company-Taxes-Type"
+ payroll_taxes:
+ "$ref": "#/components/schemas/Payroll-Taxes-Type"
+ payment_speed_changed:
+ "$ref": "#/components/schemas/Payroll-Payment-Speed-Changed-Type"
+ created_at:
+ "$ref": "#/components/schemas/Created-At-Type"
+ submission_blockers:
+ "$ref": "#/components/schemas/Payroll-Submission-Blockers-Type"
+ credit_blockers:
+ "$ref": "#/components/schemas/Payroll-Credit-Blockers-Type"
+ processing_request:
+ "$ref": "#/components/schemas/Payroll-Processing-Request"
+ partner_owned_disbursement:
+ "$ref": "#/components/schemas/Payroll-Partner-Owned-Disbursement-Type"
+ Payroll-Prepared:
+ 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:
+ calculated_at:
+ pay_period:
+ start_date: '2025-06-10'
+ end_date: '2025-06-16'
+ pay_schedule_uuid:
+ 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:
+ type: object
+ properties:
+ payroll_deadline:
+ "$ref": "#/components/schemas/Payroll-Deadline-Type"
+ check_date:
+ "$ref": "#/components/schemas/Payroll-Check-Date-Type"
+ processed:
+ "$ref": "#/components/schemas/Payroll-Processed-Type"
+ processed_date:
+ "$ref": "#/components/schemas/Payroll-Processed-Date-Type"
+ calculated_at:
+ "$ref": "#/components/schemas/Payroll-Calculated-At-Type"
+ uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ payroll_uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ company_uuid:
+ "$ref": "#/components/schemas/Payroll-Company-Uuid-Type"
+ off_cycle:
+ "$ref": "#/components/schemas/Payroll-Off-Cycle-Type"
+ off_cycle_reason:
+ "$ref": "#/components/schemas/Off-Cycle-Reason-Type"
+ auto_pilot:
+ "$ref": "#/components/schemas/Auto-Pilot-Type"
+ external:
+ "$ref": "#/components/schemas/Payroll-External-Type"
+ final_termination_payroll:
+ "$ref": "#/components/schemas/Payroll-Final-Termination-Payroll-Type"
+ withholding_pay_period:
+ "$ref": "#/components/schemas/Payroll-Withholding-Pay-Period-Type"
+ skip_regular_deductions:
+ "$ref": "#/components/schemas/Payroll-Skip-Regular-Deductions-Type"
+ fixed_withholding_rate:
+ "$ref": "#/components/schemas/Payroll-Fixed-Withholding-Rate-Type"
+ pay_period:
+ "$ref": "#/components/schemas/Payroll-Pay-Period-Type"
+ payroll_status_meta:
+ "$ref": "#/components/schemas/Payroll-Payroll-Status-Meta-Type"
+ employee_compensations:
+ type: array
+ uniqueItems: false
+ items:
+ "$ref": "#/components/schemas/Payroll-Employee-Compensations-Type"
+ payment_speed_changed:
+ "$ref": "#/components/schemas/Payroll-Payment-Speed-Changed-Type"
+ created_at:
+ "$ref": "#/components/schemas/Created-At-Type"
+ fixed_compensation_types:
+ "$ref": "#/components/schemas/Payroll-Fixed-Compensation-Types-Type"
+ processing_request:
+ "$ref": "#/components/schemas/Payroll-Processing-Request"
+ partner_owned_disbursement:
+ "$ref": "#/components/schemas/Payroll-Partner-Owned-Disbursement-Type"
+ Payroll-Minimal:
+ description: ''
+ type: object
+ x-tags:
+ - Payrolls
+ properties:
+ payroll_deadline:
+ "$ref": "#/components/schemas/Payroll-Deadline-Type"
+ check_date:
+ "$ref": "#/components/schemas/Payroll-Check-Date-Type"
+ processed:
+ "$ref": "#/components/schemas/Payroll-Processed-Type"
+ processed_date:
+ "$ref": "#/components/schemas/Payroll-Processed-Date-Type"
+ calculated_at:
+ "$ref": "#/components/schemas/Payroll-Calculated-At-Type"
+ uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ payroll_uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ company_uuid:
+ "$ref": "#/components/schemas/Payroll-Company-Uuid-Type"
+ off_cycle:
+ "$ref": "#/components/schemas/Payroll-Off-Cycle-Type"
+ off_cycle_reason:
+ "$ref": "#/components/schemas/Off-Cycle-Reason-Type"
+ auto_pilot:
+ "$ref": "#/components/schemas/Auto-Pilot-Type"
+ external:
+ "$ref": "#/components/schemas/Payroll-External-Type"
+ final_termination_payroll:
+ "$ref": "#/components/schemas/Payroll-Final-Termination-Payroll-Type"
+ withholding_pay_period:
+ "$ref": "#/components/schemas/Payroll-Withholding-Pay-Period-Type"
+ skip_regular_deductions:
+ "$ref": "#/components/schemas/Payroll-Skip-Regular-Deductions-Type"
+ fixed_withholding_rate:
+ "$ref": "#/components/schemas/Payroll-Fixed-Withholding-Rate-Type"
+ pay_period:
+ "$ref": "#/components/schemas/Payroll-Pay-Period-Type"
+ payroll_status_meta:
+ "$ref": "#/components/schemas/Payroll-Payroll-Status-Meta-Type"
+ totals:
+ "$ref": "#/components/schemas/Payroll-Totals-Type"
+ payment_speed_changed:
+ "$ref": "#/components/schemas/Payroll-Payment-Speed-Changed-Type"
+ created_at:
+ "$ref": "#/components/schemas/Created-At-Type"
+ submission_blockers:
+ "$ref": "#/components/schemas/Payroll-Submission-Blockers-Type"
+ credit_blockers:
+ "$ref": "#/components/schemas/Payroll-Credit-Blockers-Type"
+ reversal_payroll_uuids:
+ "$ref": "#/components/schemas/Reversal-Payroll-Uuids-Type"
+ required:
+ - company_uuid
+ - uuid
+ - payroll_uuid
+ - processed
+ Payroll-Blocker:
+ 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: []
+ Payroll-Check:
+ 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
+ Generated-Document:
+ 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
+ Report:
+ 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
+ Create-Report:
+ 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
+ Report-Template:
+ 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
+ Payroll-Receipt:
+ 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"
+ Payroll-Reversal:
+ 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
+ Gross-Up-Pay:
+ type: object
+ properties:
+ gross_up:
+ type: string
+ format: float
+ description: Gross up earnings.
+ Contractor-Payment-Receipt:
+ 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.
+
+ `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"
+ Custom-Field-Type:
+ type: string
+ description: Input type for the custom field.
+ enum:
+ - text
+ - currency
+ - number
+ - date
+ - radio
+ Employee-Custom-Field:
+ 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:
+ "$ref": "#/components/schemas/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
+ Company-Custom-Field:
+ 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:
+ "$ref": "#/components/schemas/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
+ Rehire:
+ 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
+ Signatory:
+ 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: |-
+ | | |
+ |---|---|
+ |__Status__| __Description__ |
+ | Pass | Signatory can sign all forms |
+ | Fail | Signatory cannot sign forms |
+ | Skipped | Signatory cannot sign Form 8655 until the form is manually uploaded as wet-signed |
+ | 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:
+ 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:
+ is_admin: false
+ has_ssn: false
+ version: def456
+ identity_verification_status:
+ home_address:
+ street_1: 525 20th Street
+ street_2: Apt. 1
+ city: San Francisco
+ state: CA
+ zip: '94107'
+ country: USA
+ Flow:
+ 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
+ Unprocessed-Termination-Pay-Period:
+ 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
+ Pay-Schedule-Assignment:
+ 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:
+ "$ref": "#/components/schemas/Pay-Schedule-Assignment-Employee"
+ departments:
+ type:
+ - array
+ - 'null'
+ description: List of departments and their pay schedules.
+ readOnly: true
+ items:
+ "$ref": "#/components/schemas/Pay-Schedule-Assignment-Department"
+ x-tags:
+ - Pay Schedules
+ Pay-Schedule-Assignment-Employee:
+ 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
+ Pay-Schedule-Assignment-Department:
+ 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
+ Pay-Schedule-Assignment-Preview:
+ 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:
+ "$ref": "#/components/schemas/Pay-Schedule-Assignment-Employee-Change"
+ x-tags:
+ - Pay Schedules
+ Pay-Schedule-Assignment-Employee-Change:
+ 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:
+ "$ref": "#/components/schemas/Pay-Schedule-Assignment-Pay-Period"
+ transition_pay_period:
+ "$ref": "#/components/schemas/Pay-Schedule-Assignment-Transition-Pay-Period"
+ x-tags:
+ - Pay Schedules
+ Pay-Schedule-Assignment-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
+ Pay-Schedule-Assignment-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
+ Accruing-Time-Off-Hour:
+ description: The representation of an unprocessed termination pay period.
+ type: object
+ properties:
+ time_off_policy_uuid:
+ type: string
+ description: A unique identifier of the time off policy.
+ hours:
+ type: string
+ description: Hours accrued during this pay period.
+ Employee-Federal-Tax:
+ 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:
+ - "$ref": "#/components/schemas/Employee-Federal-Tax-Pre2020"
+ - "$ref": "#/components/schemas/Employee-Federal-Tax-Rev2020"
+ discriminator:
+ propertyName: w4_data_type
+ mapping:
+ pre_2020_w4: "#/components/schemas/Employee-Federal-Tax-Pre2020"
+ rev_2020_w4: "#/components/schemas/Employee-Federal-Tax-Rev2020"
+ 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
+ Employee-State-Tax:
+ 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.
+
+'
+ 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:
+ - 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.
+
+'
+ key: withholding_allowance
+ input_question_format:
+ type: Number
+ answers:
+ - value: 1
+ valid_from: '2010-01-01'
+ valid_up_to:
+ - 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:
+ - 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:
+ 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:
+ "$ref": "#/components/schemas/Employee-State-Tax-Question"
+ required:
+ - employee_uuid
+ - state
+ - questions
+ Employee-State-Tax-Question:
+ 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:
+ "$ref": "#/components/schemas/Employee-State-Tax-Input-Question-Format"
+ answers:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-State-Tax-Answer"
+ required:
+ - label
+ - description
+ - key
+ - input_question_format
+ - answers
+ - is_question_for_admin_only
+ Employee-State-Tax-Answer:
+ 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.
+ Employee-State-Tax-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
+ Federal-Tax-Details:
+ 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:
+ - C-Corporation
+ - S-Corporation
+ - Sole proprietor
+ - LLC
+ - LLP
+ - Limited partnership
+ - Co-ownership
+ - Association
+ - Trusteeship
+ - General partnership
+ - Joint venture
+ - 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:
+ - S-Corporation
+ - C-Corporation
+ - LLC
+ filing_form:
+ type: string
+ description: |-
+ The form used by the company for federal tax filing. One of:
+ - 941 (Quarterly federal tax return form)
+ - 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:
+ - `pending`: The EIN verification process has not completed (or the company does not yet have an EIN).
+ - `verified`: The EIN has been successfully verified as a valid EIN with the IRS.
+ - `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:
+ - Semiweekly
+ - 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
+ Employee-Bank-Account:
+ 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
+ Contractor-Bank-Account:
+ 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
+ DetailedPaymentAccountSplit:
+ 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
+ EmployeePaymentDetail:
+ 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:
+ "$ref": "#/components/schemas/DetailedPaymentAccountSplit"
+ 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
+ EmployeePaymentDetailsList:
+ title: EmployeePaymentDetailsList
+ type: array
+ description: A list of employee payment details.
+ items:
+ "$ref": "#/components/schemas/EmployeePaymentDetail"
+ Employee-Payment-Method:
+ 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:
+ 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:
+ "$ref": "#/components/schemas/Payment-Method-Bank-Account"
+ x-tags:
+ - Employee Payment Method
+ Tax-Requirement:
+ 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:
+ properties:
+ key:
+ "$ref": "#/components/schemas/Tax-Requirement-Key"
+ 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:
+ "$ref": "#/components/schemas/Tax-Requirement-Key"
+ 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:
+ "$ref": "#/components/schemas/Tax-Requirement-Metadata"
+ Tax-Requirement-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:
+ 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.
+
+ - `text`: free-text input, no additional requirements
+ - `currency`: a value representing a dollar amount, e.g. `374.55` representing `$374.55`
+ - `radio`: choose one of options provided, see `options`
+ - `select`: choose one of options provided, see `options`
+ - `percent`: A decimal value representing a percentage, e.g. `0.034` representing `3.4%`
+ - `account_number`: An account number for a tax agency, more information provided by `mask` and `prefix`
+ - `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
+ - `workers_compensation_rate`: A decimal value representing a percentage, see `risk_class_code`, `risk_class_description`, and `rate_type`
+ 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:
+ - `percent`: A percentage formatted as a decimal, e.g. `0.01` for 1%
+ - `currency_per_hour`: A dollar amount per hour, e.g. `3.24` for $3.24/hr
+ enum:
+ - percent
+ - currency_per_hour
+ mask:
+ type:
+ - string
+ - 'null'
+ description: |
+ [for `account_number`] A pattern describing the format of the account number
+
+ The 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:
+ - `#`: a digit (`\d`)
+ - `@`: a upper or lower case letter (`[a-zA-Z]`)
+ - `^`: an uppercase letter (`[A-Z]`)
+ - `%`: a digit or uppercase letter (`[0-9A-Z]`)
+ - any other character represents the literal character
+
+ Examples:
+ - mask: `WHT-######` represents `WHT-` followed by 5 digits, e.g. `WHT-33421`
+ - mask: `%####-^^` supports values of `75544-AB` and `Z7654-HK`
+ 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.
+ - e.g. ["0.0", "0.001"] representing 0% and 0.1%
+ items:
+ type: string
+ required:
+ - type
+ required:
+ - type
+ description: ''
+ Tax-Requirement-Set:
+ type: object
+ x-examples:
+ tax-requirements-set-ga-registrations-example:
+ state: GA
+ key: registrations
+ label: Registrations
+ effective_from:
+ 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:
+ - 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:
+ description: ''
+ properties:
+ state:
+ "$ref": "#/components/schemas/State"
+ key:
+ "$ref": "#/components/schemas/Tax-Requirement-Set-Key"
+ label:
+ type: string
+ description: Customer facing label for the requirement set, e.g. "Registrations"
+ effective_from:
+ "$ref": "#/components/schemas/Tax-Requirement-Effective-From"
+ requirements:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Tax-Requirement"
+ Tax-Requirements-State:
+ 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:
+ 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:
+ - 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:
+ - 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:
+ "$ref": "#/components/schemas/State"
+ requirement_sets:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Tax-Requirement-Set"
+ Tax-Requirement-Set-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.
+ Tax-Requirement-Key:
+ title: Tax-Requirement-Key
+ type: string
+ description: An identifier for an individual requirement. Uniqueness is guaranteed within a requirement set.
+ Tax-Requirement-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)
+ Time-Off-Policy:
+ 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.0
+ accrual_rate_unit: 40.0
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 10
+ carryover_limit_hours: 100.0
+ max_accrual_hours_per_year: 100.0
+ max_hours: 100.0
+ 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.0
+ accrual_rate_unit: 40.0
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 10
+ carryover_limit_hours: 100.0
+ max_accrual_hours_per_year: 100.0
+ max_hours: 100.0
+ 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.0
+ accrual_rate_unit: 40.0
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 10
+ carryover_limit_hours: 100.0
+ max_accrual_hours_per_year: 100.0
+ max_hours: 100.0
+ complete: true
+ version:
+ 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
+ Time-Off-Activity:
+ 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
+ Holiday-Pay-Policy:
+ 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
+ Paid-Holidays:
+ 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)
+ Minimum-Wage:
+ 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
+ Notification:
+ 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
+ Event:
+ 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
+ Invoice-Data:
+ 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.
+ Information-Request:
+ 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
+ Recovery-Case:
+ 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:
+ 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
+ Ach-Transaction:
+ 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:
+ 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
+ Wire-In-Request:
+ 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
+ Time-Sheet:
+ type: object
+ x-examples:
+ example:
+ uuid: 123e4567-e89b-12d3-a456-426655440000
+ company_uuid: 123e4567-e89b-12d3-a456-426655440000
+ status: approved
+ time_zone: America/Los_Angeles
+ entity_type: Employee
+ version: 72deb67e16f7b92713c00d3582fa6c68
+ job_uuid: 123e4567-e89b-12d3-a456-426655440000
+ entity_uuid: 123e4567-e89b-12d3-a456-426655440000
+ shift_started_at: '2025-03-04T13:07:10Z'
+ shift_ended_at: '2025-03-04T16:07:10Z'
+ created_at: '2025-04-29T16:08:53Z'
+ updated_at: '2025-04-29T16:08:53Z'
+ metadata: {}
+ entries:
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Regular
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Overtime
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Double overtime
+ description: Record representing an employee/contractor's time sheet
+ properties:
+ uuid:
+ type: string
+ description: Unique identifier of the time sheet.
+ status:
+ type: string
+ description: Status of the time sheet.
+ enum:
+ - pending
+ - rejected
+ - approved
+ company_uuid:
+ type: string
+ description: Unique identifier of the company to which the time sheet belongs.
+ time_zone:
+ type: string
+ description: Time zone of where the time was tracked.
+ entity_type:
+ type: string
+ description: Type of entity associated with the time sheet.
+ enum:
+ - Employee
+ - Contractor
+ entity_uuid:
+ type: string
+ description: Unique identifier of the entity associated with the time sheet.
+ version:
+ type: string
+ description: The current version of the object. See the [versioning guide](https://docs.gusto.com/app-integrations/docs/idempotency) for information on how to use this field.
+ job_uuid:
+ type: string
+ description: Unique identifier of the job for which time was reported.
+ shift_started_at:
+ type: string
+ format: date-time
+ description: The start time of the shift.
+ shift_ended_at:
+ type: string
+ format: date-time
+ description: The end time of the shift. If the shift is still ongoing this field will be null.
+ created_at:
+ type: string
+ format: date-time
+ description: Datetime for when time sheet was created.
+ updated_at:
+ type: string
+ format: date-time
+ description: Datetime for when time sheet was updated.
+ metadata:
+ type: object
+ additionalProperties:
+ type: string
+ maxLength: 500
+ propertyNames:
+ type: string
+ maxLength: 40
+ maxProperties: 50
+ description: Metadata associated with the time sheet. Key-value pairs of arbitrary data. Both keys and values must be strings.
+ entries:
+ type: array
+ description: Entries associated with the time sheet.
+ items:
+ type: object
+ properties:
+ uuid:
+ type: string
+ description: Unique identifier of the entry.
+ hours_worked:
+ type: string
+ format: float
+ description: Hours worked for this pay classification. Represented as a string, e.g. "1.500".
+ pay_classification:
+ type: string
+ description: Pay classification for the entry.
+ enum:
+ - Regular
+ - Overtime
+ - Double overtime
+ Company-Suspension:
+ 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:
+ 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:
+ reconcile_tax_method: pay_taxes
+ file_yearly_forms: true
+ file_quarterly_forms: true
+ comments:
+ 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.
+
+'
+ 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.
+
+'
+ 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`.
+
+'
+ items:
+ type: object
+ properties:
+ amount:
+ type: string
+ description: Dollar amount.
+ description:
+ type: string
+ description: What kind of tax this is.
+ Minimum-Wage-List:
+ 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:
+ "$ref": "#/components/schemas/Minimum-Wage"
+ Employment-History-List:
+ 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
+ Employee-Pay-Stubs-List:
+ type: array
+ x-examples:
+ success_status:
+ - uuid: d2cec746-caee-464a-bcaf-00d93f7049c9
+ check_date: '2023-11-24'
+ gross_pay: 880.0
+ 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
+ Employee-Work-Addresses-List:
+ 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:
+ "$ref": "#/components/schemas/Employee-Work-Address"
+ Employee-Address-List:
+ 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:
+ "$ref": "#/components/schemas/Employee-Address"
+ Employee-State-Taxes-List:
+ 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.
+
+'
+ 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:
+ - 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.
+
+'
+ key: withholding_allowance
+ input_question_format:
+ type: Number
+ answers:
+ - value: 1
+ valid_from: '2010-01-01'
+ valid_up_to:
+ - 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:
+ - 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:
+ 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:
+ "$ref": "#/components/schemas/Employee-State-Tax-Question"
+ required:
+ - employee_uuid
+ - state
+ - questions
+ Employee-State-Taxes-Request:
+ 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
+ Notifications-List:
+ 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:
+ 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:
+ 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:
+ "$ref": "#/components/schemas/Notification"
+ Contractor-Payment-Details-List:
+ type: array
+ x-examples:
+ success_status:
+ - contractor_uuid: e3d9487a-4ecb-49a3-b6ff-cf03ba7278b6
+ first_name: Yael
+ last_name: Kuvalis
+ payment_method: Check
+ split_by:
+ splits:
+ - 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:
+ encrypted_account_number:
+ 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
+ Contractor-Payment-Group-Partner-Disbursements:
+ 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
+ Payroll-Partner-Disbursements:
+ 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
+ Payroll-Update:
+ 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
+ Show-Employees:
+ type: array
+ items:
+ allOf:
+ - "$ref": "#/components/schemas/Employee"
+ - type: object
+ additionalProperties: true
+ properties:
+ current_home_address:
+ "$ref": "#/components/schemas/Employee-Home-Address"
+ all_home_addresses:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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:
+ last_name: Koss
+ email: keena.feest@kiehn.co.uk
+ company_uuid: e904cc79-818a-4da8-9d37-0be0a86fdda8
+ manager_uuid:
+ version: a5cec1f1c0135feb3e76ca6ea3c46176
+ current_employment_status: full_time
+ onboarding_status: onboarding_completed
+ preferred_first_name:
+ department_uuid:
+ employee_code: 46f036
+ payment_method: Direct Deposit
+ department:
+ terminated: false
+ two_percent_shareholder: false
+ onboarded: true
+ historical: false
+ has_ssn: true
+ onboarding_documents_config:
+ uuid:
+ 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:
+ state_wc_class_code:
+ 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:
+ work_email:
+ 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:
+ 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:
+ partner_portal_invitation_sent: true
+ Payroll-Partner-Owned-Disbursement-Type:
+ type:
+ - boolean
+ - 'null'
+ description: Will money movement for the payroll be performed by the partner rather than by Gusto?
+ Payroll-Employee-Compensations-Included:
+ 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
+ Payroll-Show:
+ 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:
+ 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:
+ 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:
+ 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:
+ 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:
+ 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:
+ 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:
+ 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:
+ 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:
+ properties:
+ payroll_deadline:
+ "$ref": "#/components/schemas/Payroll-Deadline-Type"
+ check_date:
+ "$ref": "#/components/schemas/Payroll-Check-Date-Type"
+ processed:
+ "$ref": "#/components/schemas/Payroll-Processed-Type"
+ processed_date:
+ "$ref": "#/components/schemas/Payroll-Processed-Date-Type"
+ calculated_at:
+ "$ref": "#/components/schemas/Payroll-Calculated-At-Type"
+ uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ payroll_uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ company_uuid:
+ "$ref": "#/components/schemas/Payroll-Company-Uuid-Type"
+ off_cycle:
+ "$ref": "#/components/schemas/Payroll-Off-Cycle-Type"
+ off_cycle_reason:
+ "$ref": "#/components/schemas/Off-Cycle-Reason-Type"
+ auto_pilot:
+ "$ref": "#/components/schemas/Auto-Pilot-Type"
+ external:
+ "$ref": "#/components/schemas/Payroll-External-Type"
+ final_termination_payroll:
+ "$ref": "#/components/schemas/Payroll-Final-Termination-Payroll-Type"
+ withholding_pay_period:
+ "$ref": "#/components/schemas/Payroll-Withholding-Pay-Period-Type"
+ skip_regular_deductions:
+ "$ref": "#/components/schemas/Payroll-Skip-Regular-Deductions-Type"
+ fixed_withholding_rate:
+ "$ref": "#/components/schemas/Payroll-Fixed-Withholding-Rate-Type"
+ pay_period:
+ "$ref": "#/components/schemas/Payroll-Pay-Period-Type"
+ payroll_status_meta:
+ "$ref": "#/components/schemas/Payroll-Payroll-Status-Meta-Type"
+ totals:
+ "$ref": "#/components/schemas/Payroll-Totals-Type"
+ company_taxes:
+ "$ref": "#/components/schemas/Payroll-Company-Taxes-Type"
+ payroll_taxes:
+ "$ref": "#/components/schemas/Payroll-Taxes-Type"
+ payment_speed_changed:
+ "$ref": "#/components/schemas/Payroll-Payment-Speed-Changed-Type"
+ created_at:
+ "$ref": "#/components/schemas/Created-At-Type"
+ submission_blockers:
+ "$ref": "#/components/schemas/Payroll-Submission-Blockers-Type"
+ credit_blockers:
+ "$ref": "#/components/schemas/Payroll-Credit-Blockers-Type"
+ processing_request:
+ "$ref": "#/components/schemas/Payroll-Processing-Request"
+ partner_owned_disbursement:
+ "$ref": "#/components/schemas/Payroll-Partner-Owned-Disbursement-Type"
+ employee_compensations:
+ type: array
+ uniqueItems: false
+ items:
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/Payroll-Employee-Compensations-Type"
+ - "$ref": "#/components/schemas/Payroll-Employee-Compensations-Included"
+ Company-Bank-Account-Request:
+ 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
+ Company-Suspension-List:
+ type: array
+ description: List of suspension records for a company.
+ items:
+ "$ref": "#/components/schemas/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:
+ reconcile_tax_method: refund_taxes
+ file_yearly_forms: false
+ file_quarterly_forms: false
+ comments:
+ 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: []
+ Company-Suspension-Creation-Errors:
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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
+ Time-Off-Request:
+ type: object
+ description: The representation of a time off request.
+ properties:
+ uuid:
+ type: string
+ description: The UUID of the time off request.
+ readOnly: true
+ status:
+ type: string
+ description: The status of the time off request.
+ enum:
+ - pending
+ - approved
+ - denied
+ readOnly: true
+ employee_note:
+ type: string
+ description: A note about the time off request, from the employee to the employer.
+ readOnly: true
+ employer_note:
+ type: string
+ description: A note about the time off request, from the employer to the employee.
+ readOnly: true
+ request_type:
+ type: string
+ description: The type of time off request.
+ enum:
+ - vacation
+ - sick
+ readOnly: true
+ days:
+ description: An object that represents the days in the time off request. The keys of the object are the dates, formatted as a YYYY-MM-DD string. The values of the object are the number of hours requested off for each day, formatted as a string representation of a numeric decimal to the thousands place.
+ type: object
+ readOnly: true
+ employee:
+ type: object
+ description: ''
+ properties:
+ uuid:
+ type: string
+ description: The UUID of the employee the time off request is for.
+ readOnly: true
+ full_name:
+ type: string
+ description: The full name of the employee the time off request is for.
+ readOnly: true
+ readOnly: true
+ initiator:
+ type:
+ - object
+ - 'null'
+ description: ''
+ properties:
+ uuid:
+ type: string
+ description: The UUID of the employee who initiated the time off request.
+ readOnly: true
+ full_name:
+ type: string
+ description: The full name of the employee who initiated the time off request.
+ readOnly: true
+ readOnly: true
+ approver:
+ type:
+ - object
+ - 'null'
+ description: This value will be null if the request has not been approved.
+ properties:
+ uuid:
+ type: string
+ description: The UUID of the employee who approved the time off request.
+ readOnly: true
+ full_name:
+ type: string
+ description: The full name of the employee who approved the time off request.
+ readOnly: true
+ readOnly: true
+ Time-Off-Request-List:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Time-Off-Request"
+ x-examples:
+ success_status:
+ - uuid: 9145390f-0431-45ee-b8a0-6e7a8850d4cf
+ status: approved
+ employee_note: Vacation at Disney World!
+ employer_note: But Universal has Harry Potter World...
+ days:
+ '2019-06-01': '4.000'
+ '2019-06-02': '8.000'
+ '2019-06-03': '2.000'
+ request_type: vacation
+ employee:
+ uuid: 05f8663b-5944-4cfb-910e-1ee0a6df7b42
+ full_name: Jessica Gusto
+ approver:
+ uuid: 21d8dff4-ce09-4120-a274-3a5628bf6769
+ full_name: Karen Gusto
+ initiator:
+ uuid: 05f8663b-5944-4cfb-910e-1ee0a6df7b42
+ full_name: Jessica Gusto
+ - uuid: 944cbbf4-8b13-4c45-babd-11ff13e17581
+ status: pending
+ employee_note: Coming down with the flu
+ employer_note: ''
+ days:
+ '2019-02-01': '8.000'
+ request_type: sick
+ employee:
+ uuid: c2236d10-959a-4bb9-a21d-e14c6df447b6
+ full_name: James Gusto
+ approver:
+ initiator:
+ uuid: c2236d10-959a-4bb9-a21d-e14c6df447b6
+ full_name: James Gusto
+ Not-Found-Error-Object:
+ 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.
+ Contractor-Payment-For-Group-Preview:
+ 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
+ Contractor-Payment-Group-Preview:
+ 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:
+ "$ref": "#/components/schemas/Payroll-Submission-Blocker-Type"
+ credit_blockers:
+ type: array
+ description: List of credit blockers for the contractor payment group.
+ readOnly: true
+ items:
+ "$ref": "#/components/schemas/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:
+ "$ref": "#/components/schemas/Contractor-Payment-For-Group-Preview"
+ x-examples:
+ success:
+ uuid:
+ 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:
+ submission_blockers: []
+ credit_blockers: []
+ contractor_payments:
+ - uuid:
+ 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:
+ 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:
+ submission_blockers:
+ - blocker_type: fast_ach_threshold_exceeded
+ blocker_name: Fast ACH Threshold Exceeded
+ selected_option:
+ 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:
+ 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'
+ Webhooks-Health-Check-Status:
+ 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
+ Contractor-Payment-Group-Base:
+ 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
+ Contractor-Payment-Group-With-Blockers:
+ description: Contractor payment group with submission and credit blockers, but without individual contractor payments.
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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:
+ "$ref": "#/components/schemas/Payroll-Submission-Blocker-Type"
+ credit_blockers:
+ type: array
+ description: List of credit blockers for the contractor payment group.
+ readOnly: true
+ items:
+ "$ref": "#/components/schemas/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
+ Payroll-List:
+ 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:
+ items:
+ "$ref": "#/components/schemas/Payroll"
+ Payroll-Taxes-Type:
+ 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
+ Salary-Estimate:
+ 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:
+ annual_net_revenue: '500000'
+ zip_code: '94107'
+ result: 12000000
+ accepted_at:
+ 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
+ BLS-Occupation:
+ 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.
+ Payroll-Credit-Blocker-Unblock-Option-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
+ Payroll-Credit-Blocker-Unblock-Option-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
+ Payroll-Credit-Blocker-Unblock-Option-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
+ Payroll-Credit-Blocker-Unblock-Option-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
+ Employee-Section603-High-Earner-Status-List:
+ 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:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status"
+ Employee-Section603-High-Earner-Status:
+ 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
+ Employee-Section603-High-Earner-Status-Create-Request:
+ 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
+ Employee-Section603-High-Earner-Status-Update-Request:
+ 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
+ Employee-Federal-Tax-Pre2020:
+ 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:
+ - Single
+ - Married
+ - Head of Household
+ - Exempt from withholding
+ - 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
+ Employee-Federal-Tax-Rev2020:
+ 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:
+ - Single
+ - Married
+ - Head of Household
+ - 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
+ Time-Off-Policy-Request:
+ type: object
+ description: Request body for creating a time off policy
+ allOf:
+ - "$ref": "#/components/schemas/Time-Off-Policy-Request-Base"
+ - type: object
+ required:
+ - name
+ - policy_type
+ - accrual_method
+ Holiday-Pay-Policy-Request:
+ 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
+ Create-Token-Authentication:
+ 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.
+ Refresh-Token-Authentication:
+ description: ''
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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.
+ Time-Off-Policy-Request-Base:
+ 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
+ Time-Off-Policy-Update-Request:
+ type: object
+ description: Request body for updating a time off policy
+ allOf:
+ - "$ref": "#/components/schemas/Time-Off-Policy-Request-Base"
+ Payroll-Submission-Blocker-Type:
+ 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
+ Payroll-Credit-Blocker-Type:
+ 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:
+ - "$ref": "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Submit-Wire"
+ - "$ref": "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Submit-Bank-Screenshot"
+ - "$ref": "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Respond-To-High-Risk-Fraud-Rfi"
+ - "$ref": "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Wait-For-Reverse-Wire"
+ discriminator:
+ propertyName: unblock_type
+ mapping:
+ submit_wire: "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Submit-Wire"
+ submit_bank_screenshot: "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Submit-Bank-Screenshot"
+ respond_to_high_risk_fraud_rfi: "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Respond-To-High-Risk-Fraud-Rfi"
+ wait_for_reverse_wire: "#/components/schemas/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
+ Payroll-Gross-Up-Request:
+ 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
+ Payroll-Gross-Up-Response:
+ 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.
+ Payroll-Calculate-Accruing-Time-Off-Hours-Request:
+ 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
+ Payroll-Calculate-Accruing-Time-Off-Hours-Response:
+ 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
+ Unprocessed-Payroll:
+ 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:
+ calculated_at:
+ 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:
+ properties:
+ payroll_deadline:
+ "$ref": "#/components/schemas/Payroll-Deadline-Type"
+ check_date:
+ "$ref": "#/components/schemas/Payroll-Check-Date-Type"
+ processed:
+ "$ref": "#/components/schemas/Payroll-Processed-Type"
+ processed_date:
+ "$ref": "#/components/schemas/Payroll-Processed-Date-Type"
+ calculated_at:
+ "$ref": "#/components/schemas/Payroll-Calculated-At-Type"
+ uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ payroll_uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ company_uuid:
+ "$ref": "#/components/schemas/Payroll-Company-Uuid-Type"
+ off_cycle:
+ "$ref": "#/components/schemas/Payroll-Off-Cycle-Type"
+ off_cycle_reason:
+ "$ref": "#/components/schemas/Off-Cycle-Reason-Type"
+ auto_pilot:
+ "$ref": "#/components/schemas/Auto-Pilot-Type"
+ external:
+ "$ref": "#/components/schemas/Payroll-External-Type"
+ pay_period:
+ "$ref": "#/components/schemas/Payroll-Pay-Period-Type"
+ created_at:
+ "$ref": "#/components/schemas/Created-At-Type"
+ partner_owned_disbursement:
+ "$ref": "#/components/schemas/Payroll-Partner-Owned-Disbursement-Type"
+ Contractor-Payment-Body:
+ 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
+ Payroll-Submission-Blocker-Request-Type:
+ 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.
+ Company-Industry-Selection-Required-Body:
+ 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
+ Create-Flow-Request:
+ 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
+ Event-List:
+ 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:
+ "$ref": "#/components/schemas/Event"
+ Company-Location-Request:
+ 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
+ Company-Locations-List:
+ 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:
+ "$ref": "#/components/schemas/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:
+ "$ref": "#/components/schemas/Created-At-Type"
+ updated_at: '2023-09-12T16:42:25.000-07:00'
+ active: true
+ inactive: false
+ items:
+ "$ref": "#/components/schemas/Location"
+ Employee-Onboarding-Documents-Config-Request:
+ 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.
+ When true, the employee will be prompted to complete Form I-9 as part of their onboarding.
+ x-examples:
+ enable_i9:
+ i9_document: true
+ disable_i9:
+ i9_document: false
+ Contractor-Update-Request-Body:
+ description: Request body for updating a contractor.
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - "$ref": "#/components/schemas/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
+ Contractor-Create-Request-Body:
+ description: Request body for creating a contractor.
+ type: object
+ required:
+ - type
+ - wage_type
+ - start_date
+ allOf:
+ - "$ref": "#/components/schemas/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'
+ Compensations-Body:
+ 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:
+ "$ref": "#/components/schemas/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.
+ Compensations-Request-Body:
+ description: Request body for creating a compensation.
+ type: object
+ required:
+ - rate
+ - payment_unit
+ - flsa_status
+ allOf:
+ - "$ref": "#/components/schemas/Compensations-Body"
+ x-examples:
+ create_compensation:
+ rate: '70000.00'
+ payment_unit: Year
+ flsa_status: Exempt
+ effective_date: '2023-01-01'
+ title: Software Engineer
+ Compensations-Update-Request-Body:
+ description: Request body for updating a compensation.
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - "$ref": "#/components/schemas/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
+ Payroll-Employee-Compensations-Base-Type:
+ 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
+ Payroll-Unprocessed-Employee-Compensations-Type:
+ allOf:
+ - "$ref": "#/components/schemas/Payroll-Employee-Compensations-Base-Type"
+ - "$ref": "#/components/schemas/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.
+ Payroll-Unprocessed:
+ 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:
+ calculated_at:
+ pay_period:
+ start_date: '2025-06-10'
+ end_date: '2025-06-16'
+ pay_schedule_uuid:
+ 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:
+ type: object
+ properties:
+ payroll_deadline:
+ "$ref": "#/components/schemas/Payroll-Deadline-Type"
+ check_date:
+ "$ref": "#/components/schemas/Payroll-Check-Date-Type"
+ processed:
+ "$ref": "#/components/schemas/Payroll-Processed-Type"
+ processed_date:
+ "$ref": "#/components/schemas/Payroll-Processed-Date-Type"
+ calculated_at:
+ "$ref": "#/components/schemas/Payroll-Calculated-At-Type"
+ uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ payroll_uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ company_uuid:
+ "$ref": "#/components/schemas/Payroll-Company-Uuid-Type"
+ off_cycle:
+ "$ref": "#/components/schemas/Payroll-Off-Cycle-Type"
+ off_cycle_reason:
+ "$ref": "#/components/schemas/Off-Cycle-Reason-Type"
+ auto_pilot:
+ "$ref": "#/components/schemas/Auto-Pilot-Type"
+ external:
+ "$ref": "#/components/schemas/Payroll-External-Type"
+ final_termination_payroll:
+ "$ref": "#/components/schemas/Payroll-Final-Termination-Payroll-Type"
+ withholding_pay_period:
+ "$ref": "#/components/schemas/Payroll-Withholding-Pay-Period-Type"
+ skip_regular_deductions:
+ "$ref": "#/components/schemas/Payroll-Skip-Regular-Deductions-Type"
+ fixed_withholding_rate:
+ "$ref": "#/components/schemas/Payroll-Fixed-Withholding-Rate-Type"
+ pay_period:
+ "$ref": "#/components/schemas/Payroll-Pay-Period-Type"
+ payroll_status_meta:
+ "$ref": "#/components/schemas/Payroll-Payroll-Status-Meta-Type"
+ employee_compensations:
+ type: array
+ uniqueItems: false
+ items:
+ "$ref": "#/components/schemas/Payroll-Unprocessed-Employee-Compensations-Type"
+ payment_speed_changed:
+ "$ref": "#/components/schemas/Payroll-Payment-Speed-Changed-Type"
+ created_at:
+ "$ref": "#/components/schemas/Created-At-Type"
+ fixed_compensation_types:
+ "$ref": "#/components/schemas/Payroll-Fixed-Compensation-Types-Type"
+ processing_request:
+ "$ref": "#/components/schemas/Payroll-Processing-Request"
+ partner_owned_disbursement:
+ "$ref": "#/components/schemas/Payroll-Partner-Owned-Disbursement-Type"
+ Token-Info:
+ type: object
+ properties:
+ scope:
+ type: string
+ description: 'Space-separated list of OAuth scopes granted to this access token.
+
+'
+ example: companies:read public
+ resource:
+ type:
+ - object
+ - 'null'
+ description: |
+ The resource associated with this access token. Null when
+ the token has no associated resource.
+ 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.
+
+'
+ 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
+ system-level tokens or when the owner cannot be determined.
+ properties:
+ type:
+ type: string
+ enum:
+ - CompanyAdmin
+ - Employee
+ - Contractor
+ description: |
+ The type of resource owner:
+ - `CompanyAdmin`: A company administrator
+ - `Employee`: An employee
+ - `Contractor`: A contractor
+ 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:
+ People-Batch:
+ 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
+ People-Batch-Results:
+ 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:
+ submitted_items:
+ 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
+ People-Batch-Conflict-Error:
+ 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.
+ Recurring-Reimbursement-List:
+ 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:
+ "$ref": "#/components/schemas/Recurring-Reimbursement"
+ Recurring-Reimbursement:
+ 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
+ Signatory-Invite-Request:
+ 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
+ Signatory-Create-Request:
+ 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
+ Signatory-Update-Request:
+ 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
+ Payment-Configs-Update-Request:
+ 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
+ Company-Bank-Account-Verify-Request:
+ 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).
+ I9-Authorization-Request-Body:
+ description: Request body for creating or updating an employee's I-9 authorization.
+ 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. If supplied, this endpoint will update the existing I-9 authorization if it exists.
+ authorization_status:
+ type: string
+ description: |
+ The employee's authorization status.
+ - `citizen`: A citizen is someone who was born in the United States or is a naturalized citizen living in the United States.
+ - `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.
+ - `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.
+ - `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.
+ enum:
+ - citizen
+ - noncitizen
+ - permanent_resident
+ - alien
+ document_type:
+ type: string
+ description: |
+ The type of document an employee holds, based on their authorization status.
+ - This is unused for authorization status `citizen` or `noncitizen`.
+ - If the authorization status is `permanent_resident`, this must be `uscis_alien_registration_number`.
+ - If the authorization status is `alien`, this is required and may be any of the valid values.
+ 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.
+ - For `document_type:'uscis_alien_registration_number'`, this must be a USCIS Number/A-Number, which is 7 to 9 digits.
+ - For `document_type:'form_i94'`, this must be a Form I-94 Admission Number, which is 11 digits.
+ - For `document_type:'foreign_passport'`, this must be the passport number.
+
+ This is required when the document type is present.
+ country:
+ type: string
+ description: |
+ The document's country of issuance.
+
+ This is required when the document type is `foreign_passport`.
+ expiration_date:
+ type: string
+ description: |
+ The document's expiration date.
+
+ This may only be used when the authorization status is `alien`.
+ required:
+ - authorization_status
+ x-examples:
+ create_citizen:
+ authorization_status: citizen
+ update_alien_with_foreign_passport:
+ version: 52b7c567242cb7393b2a206ed6a86afcb
+ authorization_status: alien
+ document_type: foreign_passport
+ document_number: '01234567'
+ country: Canada
+ expiration_date: '2028-01-01'
+ I9-Authorization-Employer-Sign-Request-Body:
+ description: Request body for employer signing an employee's Form I-9.
+ 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
+ x-examples:
+ employer_sign:
+ signature_text: Jane Doe
+ signer_title: Admin
+ signed_by_ip_address: 192.168.0.1
+ agree: true
+ I9-Authorization-Documents-Request-Body:
+ description: Request body for creating an employee's I-9 authorization verification documents.
+ type: object
+ properties:
+ documents:
+ type: array
+ description: An array of I-9 verification documents. Every request must contain the complete list of documents for the employee, as previous records are replaced.
+ items:
+ type: object
+ properties:
+ document_type:
+ type: string
+ description: The document type. Use the document options endpoint to get the possible values.
+ example: us_passport
+ document_title:
+ type: string
+ description: The document title associated with the document type
+ example: US Passport
+ document_number:
+ type: string
+ description: The document's document number
+ example: F12345678
+ expiration_date:
+ type: string
+ description: The document's expiration date
+ example: '2026-01-01'
+ issuing_authority:
+ type: string
+ description: The document's issuing authority
+ example: USA
+ required:
+ - document_type
+ - document_title
+ - issuing_authority
+ required:
+ - documents
+ x-examples:
+ create_documents:
+ documents:
+ - document_type: us_passport
+ document_title: US passport
+ document_number: F12345678
+ expiration_date: '2035-04-01'
+ issuing_authority: US Department of State
+ Pay-Schedule-Version:
+ type: string
+ description: The current version of the pay schedule. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/api-fundamentals#optimistic-version-control) for information on how to use this field for optimistic concurrency.
+ readOnly: true
+ Pay-Schedule-Auto-Payroll:
+ type: boolean
+ description: |
+ When true, Autopayroll is enabled and payroll runs automatically one day before payroll deadlines. When false, payroll does not run automatically.
+ Returned for API version 2025-11-15 and later; for earlier versions the response uses auto_pilot instead.
+ Pay-Schedule-Auto-Payroll-Enablement-Blockers:
+ type:
+ - array
+ - 'null'
+ description: When auto_payroll is false, lists blockers that prevent enabling Autopayroll. When auto_payroll is true, this field is null.
+ items:
+ "$ref": "#/components/schemas/Pay-Schedule-Auto-Payroll-Enablement-Blocker"
+ Pay-Schedule-Auto-Payroll-Enablement-Blocker:
+ type: object
+ description: A single blocker preventing Autopayroll enablement.
+ properties:
+ key:
+ type: string
+ description: The blocker type (e.g. employees_not_on_direct_deposit, missing_funding_method, missing_state_tax_requirements, one_day_ach_speed_not_supported, company_suspended).
+ metadata:
+ type: object
+ description: Blocker-specific metadata (e.g. employee_uuids, states).
+ Pay-Schedule-List:
+ type: array
+ description: List of pay schedules for a company. The pay schedule object captures the details of when employees work and when they should be paid. A company can have multiple pay schedules.
+ items:
+ "$ref": "#/components/schemas/Pay-Schedule"
+ x-examples:
+ success_status:
+ - uuid: f2a69c38-e2f9-4e31-b5c5-4754fc60a052
+ version: 68934a3e9455fa72420237eb05902327
+ frequency: Monthly
+ anchor_pay_date: '2022-12-11'
+ anchor_end_of_pay_period: '2022-11-13'
+ day_1: 11
+ day_2:
+ name:
+ custom_name: every 11th of the month
+ auto_payroll: true
+ active: true
+ Pay-Schedule-Preview-Pay-Period:
+ type: object
+ description: A single pay period in a pay schedule preview, with check date, period boundaries, and payroll deadline.
+ required:
+ - check_date
+ - start_date
+ - run_payroll_by
+ - end_date
+ properties:
+ check_date:
+ type: string
+ format: date
+ description: The date employees will be paid (check date).
+ start_date:
+ type: string
+ format: date
+ description: The first day of the pay period.
+ run_payroll_by:
+ type: string
+ format: date
+ description: The deadline by which payroll must be run for this period to be paid on check_date.
+ end_date:
+ type: string
+ format: date
+ description: The last day of the pay period.
+ Pay-Schedule-Preview:
+ type: object
+ description: |
+ Preview of pay schedule dates for the next 18 months. Use this to show partners expected pay dates, pay period boundaries, and payroll deadlines before they create or change a pay schedule. See [Preview pay schedule dates](https://docs.gusto.com/embedded-payroll/reference/get-v1-companies-company_id-pay_schedules-preview) for usage.
+
+ - **pay_periods**: One entry per pay period in the range; each includes check_date, start_date, end_date, and run_payroll_by.
+ - **holidays**: Observed bank holidays (ISO date strings) that may affect payroll timing.
+ x-examples:
+ success_status:
+ pay_periods:
+ - check_date: '2022-01-15'
+ start_date: '2022-01-01'
+ run_payroll_by: '2022-01-14'
+ end_date: '2022-01-15'
+ - check_date: '2022-01-31'
+ start_date: '2022-01-16'
+ run_payroll_by: '2022-01-30'
+ end_date: '2022-01-31'
+ holidays:
+ - '2022-01-01'
+ - '2022-01-17'
+ properties:
+ pay_periods:
+ type: array
+ description: Pay periods in the preview range (default 18 months from today, or up to end_date if provided).
+ items:
+ "$ref": "#/components/schemas/Pay-Schedule-Preview-Pay-Period"
+ holidays:
+ type: array
+ description: Observed bank holidays (ISO date strings) in the preview range; may affect payroll processing.
+ items:
+ type: string
+ format: date
+ Pay-Schedule-Date-Input:
+ type: string
+ format: date
+ description: ISO 8601 date (YYYY-MM-DD). Required for anchor and period dates in create, update, and preview requests.
+ Pay-Schedule-Create-Request:
+ type: object
+ description: |
+ Request body for creating a pay schedule. Required when a company has no pay schedules (onboarding) or when adding an additional schedule. Be sure to [check state laws](https://www.dol.gov/agencies/whd/state/payday) to know what schedule is right for your customers.
+
+ - **anchor_pay_date**: The first date that employees on this pay schedule will be paid (first company payday).
+ - **anchor_end_of_pay_period**: The last date of the first pay period; can be the same as anchor_pay_date.
+ properties:
+ frequency:
+ "$ref": "#/components/schemas/Pay-Schedule-Frequency-Create-Update"
+ anchor_pay_date:
+ "$ref": "#/components/schemas/Pay-Schedule-Date-Input"
+ anchor_end_of_pay_period:
+ "$ref": "#/components/schemas/Pay-Schedule-Date-Input"
+ day_1:
+ type:
+ - integer
+ - 'null'
+ description: |
+ First pay day of the month (1-31).
+ - **Twice per month, Monthly:** required.
+ - **Every week, Every other week:** omit or null.
+ day_2:
+ type:
+ - integer
+ - 'null'
+ description: |
+ Second pay day of the month (1-31); only for **Twice per month**.
+ - Use 31 for last day of month (shorter months use the actual last day).
+ - **Other frequencies:** omit or null.
+ custom_name:
+ type:
+ - string
+ - 'null'
+ description: |
+ Optional display name for the pay schedule.
+
+ When null or omitted, the system generates a description from the pay frequency and pay days (e.g. "every 1st and 15th of the month" for twice-monthly, "every 11th of the month" for monthly, "every Friday" for weekly). The response returns this generated value in `custom_name` when no custom name was set. When provided, the value you set is stored and returned.
+ required:
+ - frequency
+ - anchor_pay_date
+ - anchor_end_of_pay_period
+ Pay-Schedule-Update-Request:
+ type: object
+ description: Request body for updating a pay schedule. Sent in the pay_schedule_update root key. Version is required for optimistic concurrency. Pay schedules may be automatically adjusted if an onboarded company misses their first pay date; see [Create a pay schedule](https://docs.gusto.com/embedded-payroll/docs/create-a-pay-schedule).
+ properties:
+ version:
+ type: string
+ description: Current version of the pay schedule from the GET response; required for optimistic concurrency. Mismatch returns 409 Conflict.
+ auto_payroll:
+ type: boolean
+ description: |
+ When true, Autopayroll is enabled and payroll runs automatically one day before payroll deadlines. When false, payroll does not run automatically and must be run manually.
+ For API versions before 2025-11-15 the request field is auto_pilot.
+ frequency:
+ "$ref": "#/components/schemas/Pay-Schedule-Frequency-Create-Update"
+ anchor_pay_date:
+ "$ref": "#/components/schemas/Pay-Schedule-Date-Input"
+ anchor_end_of_pay_period:
+ "$ref": "#/components/schemas/Pay-Schedule-Date-Input"
+ day_1:
+ type:
+ - integer
+ - 'null'
+ description: 'First pay day of the month (1–31). Required for Twice per month and Monthly; null for Every week and Every other week.
+
+'
+ day_2:
+ type:
+ - integer
+ - 'null'
+ description: 'Second pay day of the month (1–31); only for Twice per month. Use 31 for last day of month. Null for other frequencies.
+
+'
+ custom_name:
+ type:
+ - string
+ - 'null'
+ description: Custom name for the pay schedule; null clears it.
+ required:
+ - version
+ Payroll-Sync:
+ type: object
+ description: Record representing the sync of time sheet data to payroll.
+ properties:
+ uuid:
+ type: string
+ format: uuid
+ description: Unique identifier of the payroll sync.
+ example: 123e4567-e89b-12d3-a456-426655440000
+ company_uuid:
+ type: string
+ format: uuid
+ description: Unique identifier of the company to which the payroll sync belongs.
+ example: 123e4567-e89b-12d3-a456-426655440001
+ status:
+ type: string
+ readOnly: true
+ enum:
+ - pending
+ - in_progress
+ - success
+ - failure
+ - partial_success
+ description: |
+ The current status of the payroll sync. READ-ONLY.
+
+ ## State Transitions
+ ```
+ pending ──────► in_progress ──────► success
+ ├─────► failure
+ └─────► partial_success
+ ```
+
+ ### Valid Transitions
+ - `pending` → `in_progress`: Automatic when processing begins
+ - `in_progress` → `success`: All time sheet data synced successfully
+ - `in_progress` → `failure`: Sync failed entirely
+ - `in_progress` → `partial_success`: Some members failed to sync
+ example: pending
+ kind:
+ type: string
+ enum:
+ - regular
+ description: |
+ The kind of payroll sync.
+ - `regular`: A regular payroll sync
+ example: regular
+ pay_schedule_uuid:
+ type: string
+ format: uuid
+ description: Unique identifier of the pay schedule associated with this sync.
+ example: 123e4567-e89b-12d3-a456-426655440002
+ pay_period_start_date:
+ type: string
+ format: date
+ description: The start date of the pay period per ISO 8601 format.
+ example: '2025-01-01'
+ pay_period_end_date:
+ type: string
+ format: date
+ description: The end date of the pay period per ISO 8601 format.
+ example: '2025-01-15'
+ submitted_at:
+ type: string
+ format: date-time
+ description: Datetime for when the payroll sync was submitted.
+ example: '2025-01-16T12:00:00Z'
+ completed_at:
+ type:
+ - string
+ - 'null'
+ format: date-time
+ description: Datetime for when the payroll sync completed. Null if the sync is still in progress.
+ example: '2025-01-16T13:00:00Z'
+ errors:
+ type: array
+ description: Errors encountered during the sync, if any. Each error follows the standard entity error format.
+ items:
+ "$ref": "#/components/schemas/Entity-Error-Object"
+ warnings:
+ type: array
+ description: Warnings encountered during the sync, if any.
+ items:
+ type: string
+ x-examples:
+ pending_sync:
+ uuid: 123e4567-e89b-12d3-a456-426655440000
+ company_uuid: 123e4567-e89b-12d3-a456-426655440001
+ status: pending
+ kind: regular
+ pay_schedule_uuid: 123e4567-e89b-12d3-a456-426655440002
+ pay_period_start_date: '2025-01-01'
+ pay_period_end_date: '2025-01-15'
+ submitted_at: '2025-01-16T12:00:00Z'
+ completed_at:
+ completed_sync:
+ uuid: 123e4567-e89b-12d3-a456-426655440000
+ company_uuid: 123e4567-e89b-12d3-a456-426655440001
+ status: success
+ kind: regular
+ pay_schedule_uuid: 123e4567-e89b-12d3-a456-426655440002
+ pay_period_start_date: '2025-01-01'
+ pay_period_end_date: '2025-01-15'
+ submitted_at: '2025-01-16T12:00:00Z'
+ completed_at: '2025-01-16T13:00:00Z'
+ Payroll-Sync-Create-Request-Body:
+ type: object
+ required:
+ - kind
+ - pay_schedule_uuid
+ - pay_period_start_date
+ - pay_period_end_date
+ properties:
+ kind:
+ type: string
+ enum:
+ - regular
+ description: |
+ The kind of payroll sync.
+ - `regular`: A regular payroll sync
+ example: regular
+ pay_schedule_uuid:
+ type: string
+ format: uuid
+ description: Unique identifier of the pay schedule to sync time sheets for.
+ example: 123e4567-e89b-12d3-a456-426614174000
+ pay_period_start_date:
+ type: string
+ format: date
+ description: The start date of the pay period per ISO 8601 format.
+ example: '2025-01-01'
+ pay_period_end_date:
+ type: string
+ format: date
+ description: The end date of the pay period per ISO 8601 format.
+ example: '2025-01-15'
+ securitySchemes:
+ CompanyAccessAuth:
+ type: http
+ scheme: bearer
+ description: Company-level authentication
+ SystemAccessAuth:
+ type: http
+ scheme: bearer
+ description: System-level authentication
+ responses:
+ Unprocessable-Entity-Error-Object:
+ description: "Unprocessable Entity \n \nThis may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request 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:
+ "$ref": "#/components/schemas/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
+ Not-Found-Error-Object:
+ description: "Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"
+ Employment-Not-Found-Error-Object:
+ description: |-
+ Not Found
+
+ * The requested resource does not exist. Make sure the provided UUID is valid.
+ * The employee's employment is not in the right state.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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.
+ Authentication-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Authentication"
+ examples:
+ Example:
+ value:
+ access_token: 737HdeXfIqgx-NfaUFRuhV7JDe6ns6ptanJSMuQzjlc
+ token_type: bearer
+ expires_in: 7200
+ refresh_token: iEjL96L9Pndwmi-xVX3Q-xbrvvhnjHYGX87sopgGJ8E
+ scope: ach_transactions:read benefits:read companies:read
+ created_at: 1732033824
+ Holiday-Pay-Policy-Object:
+ description: Holiday Pay Policy Object Example
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy"
+ examples:
+ Example:
+ value:
+ version: 1b37938b017c7fd7116bada007072290
+ company_uuid: b7845189-f12b-4378-918a-d2b9de3dc4ea
+ federal_holidays:
+ new_years_day:
+ selected: false
+ 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
+ Paid-Holidays-Object:
+ description: Paid Holidays Object Example
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Paid-Holidays"
+ examples:
+ Example:
+ value:
+ holiday_key: veterans_day
+ holiday_name: Veterans Day
+ start_date: '2023-11-11'
+ end_date: '2023-11-11'
+ Department-Object:
+ description: Department Object Example
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Ytd-Benefit-Amounts-From-Different-Company-List:
+ description: List of Ytd Benefit Amounts From Different Company List
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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'
+ Department-List:
+ description: List of departments
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Employee-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee"
+ examples:
+ Create-Employee-Example:
+ value:
+ uuid: 4b3f930f-82cd-48a8-b797-798686e12e5e
+ first_name: Isom
+ middle_initial:
+ last_name: Jaskolski
+ email: dane7757869450111550@botsford.net
+ company_uuid: a007e1ab-3595-43c2-ab4b-af7a5af2e365
+ manager_uuid: 5e53e257-c8d6-45aa-aa8a-ec99283a3acd
+ employee_code: fesa3w
+ version: 1c7ba9d62c8bafbfff998ffccad5d296
+ department: Stage Hand
+ department_uuid: 56260b3d-c375-415c-b77a-75d99f717193
+ terminated: false
+ two_percent_shareholder: false
+ onboarded: true
+ onboarding_status: onboarding_completed
+ onboarding_documents_config:
+ uuid:
+ i9_document: false
+ jobs:
+ - uuid: 428a653a-0745-4db4-9c80-558288d416fa
+ version: 6c0ed1521e8b86eb36bd4455a63a2dac
+ employee_uuid: f0689739-1985-49f3-b9ba-84562e71e85f
+ current_compensation_uuid: c9fd719b-8b07-48f3-8a4c-f447d2c59669
+ 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: '2021-01-20'
+ rate: '70000.00'
+ adjust_for_minimum_wage: false
+ minimum_wages: []
+ rate: '70000.00'
+ hire_date: '2020-01-20'
+ eligible_paid_time_off:
+ - name: Sick Hours
+ policy_name: Sick Policy
+ policy_uuid: 9940d205-9904-4e55-9fec-652628e84af7
+ accrual_unit: Hour
+ accrual_rate: '208.0'
+ accrual_method: per_hour_worked
+ accrual_period: Year
+ accrual_balance: '31.8'
+ maximum_accrual_balance: '240.0'
+ paid_at_termination: false
+ - name: Vacation Hours
+ policy_name: Vacation Policy
+ policy_uuid: ab59de61-239f-4805-933b-0e3360ed291c
+ accrual_unit: Hour
+ accrual_rate: '208.0'
+ accrual_period: Year
+ accrual_balance: '77.8'
+ maximum_accrual_balance: '240.0'
+ paid_at_termination: true
+ terminations: []
+ custom_fields:
+ - id: ee515986-f3ca-49da-b576-2691b95262f9
+ company_custom_field_id: ea7e5d57-6abb-47d7-b654-347c142886c0
+ name: employee_level
+ description: Employee Level
+ type: text
+ value: '2'
+ selection_options:
+ - id: 3796e08d-c2e3-434c-b4de-4ce1893e7b59
+ company_custom_field_id: 299650e4-e970-4acf-9bf0-6f05585d20ba
+ name: t-shirt size
+ description: What is your t-shirt size?
+ type: text
+ value: md
+ selection_options:
+ - id: 3796e08d-c2e3-434c-b4de-4ce1893e7b59
+ company_custom_field_id: 024ec137-6c92-43a3-b061-14a9720531d6
+ name: favorite fruit
+ description: Which is your favorite fruit?
+ type: radio
+ value: apple
+ selection_options:
+ - apple
+ - banana
+ - orange
+ garnishments: []
+ date_of_birth: '1986-06-25'
+ has_ssn: false
+ ssn: ''
+ phone: '1234567890'
+ preferred_first_name: Angel
+ work_email: angel.jaskolski@example.com
+ Create Historical Employee Example:
+ value:
+ uuid: ad85459f-8bf5-4a8f-9079-3b3fa790799e
+ first_name: Karl
+ middle_initial:
+ last_name: Jaskolski
+ email:
+ company_uuid: 3c69d228-a250-49b4-9946-24e4e4294da4
+ manager_uuid:
+ employee_code: rke7p1
+ version: dedac972dd28945fcd6cd941723cc71a
+ department:
+ department_uuid:
+ terminated: false
+ two_percent_shareholder: false
+ onboarded: true
+ historical: true
+ onboarding_status: onboarding_completed
+ onboarding_documents_config:
+ uuid:
+ 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:
+ preferred_first_name:
+ work_email:
+ Historical-Employee-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee"
+ examples:
+ Create Historical Employee Example:
+ value:
+ uuid: ad85459f-8bf5-4a8f-9079-3b3fa790799e
+ first_name: Karl
+ middle_initial:
+ last_name: Jaskolski
+ email:
+ company_uuid: 3c69d228-a250-49b4-9946-24e4e4294da4
+ manager_uuid:
+ employee_code: eh3st1
+ version: dedac972dd28945fcd6cd941723cc71a
+ department:
+ department_uuid:
+ terminated: true
+ two_percent_shareholder: false
+ onboarded: true
+ historical: true
+ onboarding_status: onboarding_completed
+ onboarding_documents_config:
+ uuid:
+ 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:
+ preferred_first_name:
+ work_email:
+ Employee-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee"
+ examples:
+ Example:
+ value:
+ - uuid: 9779767c-6044-48e0-bf68-aeb370b9a2e7
+ first_name: Nicole
+ middle_initial: M
+ last_name: Boehm
+ email: kory7757869450111548@barton-hermiston.io
+ company_uuid: c44d66dc-c41b-4a60-9e25-5e93ff8583f2
+ manager_uuid: 5e53e257-c8d6-45aa-aa8a-ec99283a3acd
+ version: 414dedaca594b77135e0b8d2f398516d
+ department: Stage Hand
+ department_uuid: 1802465d-4f68-4865-920c-1307ab095f12
+ terminated: false
+ two_percent_shareholder: false
+ onboarded: true
+ onboarding_status: onboarding_completed
+ onboarding_documents_config:
+ uuid: 9d5e3ce5-ea8f-4885-90e5-7ebbed03f7c5
+ i9_document: true
+ jobs:
+ - uuid: 5d5e3ce5-ea8f-4885-90e5-7ebaed03f7c5
+ version: 91179081a7309c9fbd31bb3cf7b9893e
+ employee_uuid: a987bce1-6d06-43f8-9978-9db886f479fb
+ current_compensation_uuid: 798a962f-0fcf-491e-9b71-cfa6a1db114f
+ payment_unit: Hour
+ primary: true
+ title: Client Support Manager
+ compensations:
+ - uuid: 94f17a77-cfe5-436a-af94-422bbf8248ff
+ version: 233f0096a8015e62d9795fadf1fd300d
+ payment_unit: Hour
+ flsa_status: Nonexempt
+ job_uuid: 64711ac0-83ff-4aaf-bec1-db72f5a44e56
+ effective_date: '2021-01-20'
+ rate: '22.00'
+ adjust_for_minimum_wage: false
+ minimum_wages: []
+ rate: '22.00'
+ hire_date: '2020-01-20'
+ eligible_paid_time_off:
+ - name: Sick Hours
+ policy_name: Sick Policy
+ policy_uuid: 9940d205-9904-4e55-9fec-652628e84af7
+ accrual_unit: Hour
+ accrual_rate: '208.0'
+ accrual_method: per_hour_worked
+ accrual_period: Year
+ accrual_balance: '71.0'
+ maximum_accrual_balance: '240.0'
+ paid_at_termination: false
+ - name: Vacation Hours
+ policy_name: Vacation Policy
+ policy_uuid: 8b312f0e-30e7-4810-9c06-1177a6484f2d
+ accrual_unit: Hour
+ accrual_rate: '208.0'
+ accrual_period: Year
+ accrual_balance: '34.0'
+ maximum_accrual_balance: '240.0'
+ paid_at_termination: true
+ terminations: []
+ garnishments: []
+ date_of_birth: '1996-05-08'
+ has_ssn: true
+ ssn: ''
+ phone: '1234567890'
+ preferred_first_name: Vanessa
+ work_email: vanessa.boehm@example.com
+ - uuid: d7cb289a-af62-4120-9cd5-acda324b5c04
+ first_name: Maci
+ middle_initial: M
+ last_name: Cassin
+ email: claud_reinger7757869450111549@gutkowski.net
+ company_uuid: 4522d043-5731-406d-a129-de1808042a32
+ manager_uuid: 5e53e257-c8d6-45aa-aa8a-ec99283a3acd
+ version: e867459e1360fa71e78b88142923d341
+ department: Band
+ department_uuid: 1802465d-4f68-4865-920c-1307ab095f12
+ terminated: false
+ two_percent_shareholder: false
+ onboarded: true
+ onboarding_status: onboarding_completed
+ onboarding_documents_config:
+ uuid: 1d5e3ce5-ea8f-4885-90e5-7ebbed03f7c5
+ i9_document: true
+ jobs:
+ - uuid: 62a00cf7-342b-465e-a151-ecd295152be0
+ version: d0e719137f89ca3dd334dd4cc248ffbb
+ employee_uuid: 5e53e257-c8d6-45aa-aa8a-ec99283a3acd
+ current_compensation_uuid: 93e5da92-173b-4faa-a0bd-d1a8dee68be0
+ payment_unit: Year
+ primary: true
+ title: Account Director
+ compensations:
+ - uuid: 1bad5177-c4ed-432e-ab43-66055d40c3a5
+ version: 994b75511d1debac5d7e2ddeae13679f
+ payment_unit: Year
+ flsa_status: Exempt
+ job_uuid: 1214875b-f43d-4267-bf2f-a6d2c298ff3d
+ effective_date: '2021-01-20'
+ rate: '78000.00'
+ adjust_for_minimum_wage: false
+ minimum_wages: []
+ rate: '78000.00'
+ hire_date: '2020-01-20'
+ eligible_paid_time_off:
+ - name: Sick Hours
+ policy_name: Sick Policy
+ policy_uuid: 8b312f0e-30e7-4810-9c06-1177a6484f2d
+ accrual_unit: Hour
+ accrual_rate: '208.0'
+ accrual_method: per_hour_worked
+ accrual_period: Year
+ accrual_balance: '74.0'
+ maximum_accrual_balance: '240.0'
+ paid_at_termination: false
+ - name: Vacation Hours
+ policy_name: Vacation Policy
+ policy_uuid: 0d4c755e-50ac-4c54-b46e-81bdfa03da5b
+ accrual_unit: Hour
+ accrual_rate: '208.0'
+ accrual_period: Year
+ accrual_balance: '16.0'
+ maximum_accrual_balance: '240.0'
+ paid_at_termination: true
+ terminations: []
+ garnishments: []
+ custom_fields:
+ - id: ee515986-f3ca-49da-b576-2691b95262f9
+ company_custom_field_id: ea7e5d57-6abb-47d7-b654-347c142886c0
+ name: employee_level
+ description: Employee Level
+ type: text
+ value: '2'
+ selection_options:
+ - id: 3796e08d-c2e3-434c-b4de-4ce1893e7b59
+ company_custom_field_id: 299650e4-e970-4acf-9bf0-6f05585d20ba
+ name: t-shirt size
+ description: What is your t-shirt size?
+ type: text
+ value: md
+ selection_options:
+ - id: 3796e08d-c2e3-434c-b4de-4ce1893e7b59
+ company_custom_field_id: 024ec137-6c92-43a3-b061-14a9720531d6
+ name: favorite fruit
+ description: Which is your favorite fruit?
+ type: radio
+ value: apple
+ selection_options:
+ - apple
+ - banana
+ - orange
+ date_of_birth: '1995-09-21'
+ has_ssn: true
+ ssn: ''
+ phone: '1234567890'
+ preferred_first_name: Denis
+ work_email: denis.cassin@example.com
+ Employee-Address-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Address"
+ examples:
+ Example:
+ value:
+ uuid: 56260b3d-c375-415c-b77a-75d99f717193
+ employee_id: 12345
+ street_1: 644 Fay Vista
+ street_2: Suite 842
+ city: Richmond
+ state: VA
+ zip: '23218'
+ country: USA
+ active: false
+ effective_date: '2021-01-01'
+ courtesy_withholding: true
+ Employee-Address-List:
+ description: List of employee addresses
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-Address"
+ examples:
+ Example:
+ value:
+ - uuid: 56260b3d-c375-415c-b77a-75d99f717193
+ employee_uuid: 7087a288-8349-4632-b92e-bc94fb79f29e
+ street_1: 644 Fay Vista
+ street_2: Suite 842
+ city: Richmond
+ state: VA
+ zip: '23218'
+ country: USA
+ active: false
+ effective_date: '2021-01-01'
+ courtesy_withholding: true
+ - uuid: d9f74049-8769-4fba-8e0f-eceef2da4e6b
+ employee_uuid: 7087a288-8349-4632-b92e-bc94fb79f29e
+ street_1: 100 5th Ave
+ street_2: Suite 555
+ city: New York
+ state: NY
+ zip: '10001'
+ country: USA
+ active: true
+ effective_date: '2022-03-03'
+ courtesy_withholding: true
+ Employee-Work-Address-List:
+ description: List of employee work addresses
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-Work-Address"
+ examples:
+ Example:
+ value:
+ - uuid: fc5b87dc-8d88-400d-b2da-c3587a7e5b15
+ employee_uuid: 7597f3e3-31d4-4953-83a5-f95be78d2fe2
+ location_uuid: d9456c94-f561-40d2-afec-919da5f59196
+ effective_date: '2022-01-01'
+ active: false
+ version: 139f9769a2e543e6a1259173e1ee3b8d
+ street_1: 800 Adolfo Gardens
+ street_2: Suite 419
+ city: Bremen
+ state: AL
+ zip: '35033'
+ country: USA
+ - uuid: be1c2e24-af86-4c36-b34e-3a55dbcdbdab
+ employee_uuid: 7597f3e3-31d4-4953-83a5-f95be78d2fe2
+ location_uuid: 6a119be7-b4b0-4e27-aaa0-89d5f2524635
+ effective_date: '2023-01-01'
+ active: true
+ version: bbe8d4c741339c6b9e0e2e1c1b120816
+ street_1: 2216 Icie Villages
+ street_2: Apt. 798
+ city: Big Delta
+ state: AK
+ zip: '99737'
+ country: USA
+ Company-Onboarding-Status-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Onboarding-Status"
+ examples:
+ Example:
+ value:
+ 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: Enter Your Federal Tax Information
+ id: federal_tax_setup
+ required: true
+ completed: true
+ completed_at: '2025-02-18T10:00:00Z'
+ skippable: false
+ requirements: []
+ - title: Select Industry
+ id: select_industry
+ required: true
+ completed: true
+ completed_at: '2025-02-18T10:00:00Z'
+ skippable: false
+ requirements: []
+ - title: Add Your Bank Account
+ id: add_bank_info
+ 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 State Tax Information
+ id: state_setup
+ required: true
+ completed: false
+ completed_at:
+ skippable: false
+ requirements:
+ - add_addresses
+ - add_employees
+ - title: Select a Pay Schedule
+ id: payroll_schedule
+ required: true
+ completed: false
+ completed_at:
+ skippable: false
+ requirements: []
+ - title: Sign Documents
+ id: sign_all_forms
+ required: true
+ completed: false
+ completed_at:
+ 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:
+ skippable: false
+ requirements:
+ - add_bank_info
+ Company-Onboarding-Status-Finish-Onboarding-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Onboarding-Status"
+ examples:
+ Example:
+ value:
+ uuid: c44d66dc-c41b-4a60-9e25-5e93ff8583f2
+ onboarding_completed: true
+ onboarding_steps:
+ - title: Add Your Company's Addresses
+ id: add_addresses
+ required: true
+ completed: true
+ skippable: false
+ requirements: []
+ - title: Enter Your Federal Tax Information
+ id: federal_tax_setup
+ required: true
+ completed: true
+ skippable: false
+ requirements: []
+ - title: Select Industry
+ id: select_industry
+ required: true
+ completed: true
+ skippable: false
+ requirements: []
+ - title: Add Your Bank Account
+ id: add_bank_info
+ required: true
+ completed: true
+ skippable: false
+ requirements: []
+ - title: Add Your Employees
+ id: add_employees
+ required: true
+ completed: true
+ skippable: true
+ requirements:
+ - add_addresses
+ - title: Enter Your State Tax Information
+ id: state_setup
+ required: true
+ completed: true
+ skippable: false
+ requirements:
+ - add_addresses
+ - add_employees
+ - title: Select a Pay Schedule
+ id: payroll_schedule
+ required: true
+ completed: true
+ skippable: false
+ requirements: []
+ - title: Sign Documents
+ id: sign_all_forms
+ required: true
+ completed: true
+ 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: true
+ skippable: false
+ requirements:
+ - add_bank_info
+ Webhook-Subscription-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Webhook-Subscription"
+ 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
+ - PayrollSync
+ - PaySchedule
+ - Signatory
+ Webhook-Subscriptions-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Webhook-Subscription"
+ 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
+ - PayrollSync
+ - PaySchedule
+ - Signatory
+ Company-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company"
+ examples:
+ Example:
+ value:
+ ein: 00-0000001
+ entity_type: C-Corporation
+ tier: core
+ contractor_only: false
+ is_suspended: false
+ company_status: Approved
+ uuid: c7a07c73-a703-4462-9343-1b181182b6e0
+ name: Shoppe Studios LLC
+ trade_name: Record Shoppe
+ slug: record-shoppe
+ is_partner_managed: false
+ pay_schedule_type: by_department
+ join_date: '2023-03-01'
+ funding_type: ach
+ 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
+ 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: 8a2ed9c2-9d1e-443a-8e56-a490d8bf73bb
+ first_name: Alda
+ middle_initial: ''
+ last_name: Carter
+ phone: 1-565-710-7558
+ 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
+ Signatory-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Signatory"
+ examples:
+ Example:
+ value:
+ uuid: f8c653dc-0094-41fb-8670-45d6399afade
+ first_name: Bob
+ last_name: Johnson
+ title: Owner
+ phone: '4239879876'
+ birthday: '2002-10-31'
+ email: olin.okuneva@denesik.us
+ is_admin: false
+ has_ssn: true
+ version: 49ea586f528411f5cfadfd54452b2423
+ home_address:
+ street_1: 524 Roob Divide
+ street_2: Suite 565
+ city: San Francisco
+ state: CA
+ zip: '94107'
+ country: USA
+ identity_verification_status: Skipped
+ Contractor-Address-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Employment-History-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ type: object
+ properties:
+ hire_date:
+ type: string
+ description: The employee's start day of work for an employment.
+ termination_date:
+ type: string
+ 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
+ x-examples:
+ example-1:
+ hire_date: '2023-01-30'
+ termination_date: '2023-03-30'
+ file_new_hire_report: false
+ two_percent_shareholder: false
+ employment_status: seasonal
+ examples:
+ Example:
+ value:
+ - hire_date: '2023-05-30'
+ termination_date:
+ file_new_hire_report: true
+ two_percent_shareholder: false
+ employment_status: seasonal
+ - hire_date: '2021-02-02'
+ termination_date: '2023-03-01'
+ file_new_hire_report: false
+ two_percent_shareholder: false
+ employment_status: full_time
+ Rehire-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Unprocessed-Termination-Pay-Period-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Accruing-Time-Off-Hour-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - hours_earned
+ properties:
+ hours_earned:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Accruing-Time-Off-Hour"
+ examples:
+ Example:
+ value:
+ - time_off_policy_uuid: c3a15554-f124-415d-b2c4-90b430fd8eb1
+ hours: '3.2'
+ - time_off_policy_uuid: 386fc48d-52d2-4009-87b3-368f74f6b3df
+ hours: '6.0'
+ Pay-Schedule-Assignment-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Pay-Schedule-Assignment-Preview-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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'
+ Benefit-Summary-Object:
+ description: Benefit summary response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Company-Benefit-With-Employee-Benefits-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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.0
+ company_contribution: 0.0
+ uuid: 9988f241-9aee-4383-bfca-eac79cf58135
+ contribution:
+ type: amount
+ value: 0.0
+ Employee-Pay-Stubs-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-Pay-Stub"
+ examples:
+ Example:
+ value:
+ - uuid: d2cec746-caee-464a-bcaf-00d93f7049c9
+ check_date: '2023-11-24'
+ gross_pay: 880.0
+ net_pay: 541.02
+ payroll_uuid: a039cafb-745e-4af4-bf1e-935a86fc18e0
+ check_amount: 500.2
+ description: OK
+ Company-Attachment-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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'
+ Company-Attachment-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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'
+ Signatory-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Signatory"
+ examples:
+ Example:
+ value:
+ - uuid: f8c653dc-0094-41fb-8670-45d6399afade
+ first_name: Bob
+ last_name: Johnson
+ title: Owner
+ phone: '4239879876'
+ birthday: '2002-10-31'
+ email: olin.okuneva@denesik.us
+ is_admin: false
+ has_ssn: true
+ version: 49ea586f528411f5cfadfd54452b2423
+ home_address:
+ street_1: 524 Roob Divide
+ street_2: Suite 565
+ city: San Francisco
+ state: CA
+ zip: '94107'
+ country: USA
+ identity_verification_status: Skipped
+ External-Payroll-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/External-Payroll"
+ 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
+ External-Payroll-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/External-Payroll-Basic"
+ 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-Tax-Suggestions-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/External-Payroll-Tax-Suggestions"
+ 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'
+ Tax-Liabilities-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Tax-Liabilities-Selections"
+ examples:
+ Example:
+ value:
+ - tax_id: 1
+ tax_name: Federal Income Tax
+ last_unpaid_external_payroll_uuid:
+ possible_liabilities:
+ - liability_amount: '0.0'
+ payroll_check_date:
+ external_payroll_uuid:
+ - 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:
+ possible_liabilities:
+ - liability_amount: '0.0'
+ payroll_check_date:
+ external_payroll_uuid:
+ - liability_amount: '50.0'
+ payroll_check_date: '2022-06-01'
+ external_payroll_uuid: 1bf1efe1-72d4-4e6e-a181-611f3ea66435
+ Flow-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Flow"
+ examples:
+ Example:
+ value:
+ url: https://flows.gusto-demo.com/flows/lO2BHHAMCScPVV9G5WEURW0Im_nP9mGYloQgjUWbenQ
+ Form-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Form"
+ 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:
+ year:
+ document_content_type: application/pdf
+ requires_signing: true
+ Form-Object-Pdf:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Form-Pdf"
+ 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
+ Form-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Form"
+ 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:
+ year:
+ document_content_type: application/pdf
+ requires_signing: true
+ Industry-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Industry"
+ examples:
+ Example:
+ value:
+ company_uuid: 423dd616-6dbc-4724-938a-403f6217a933
+ naics_code: '611420'
+ sic_codes:
+ - '8243'
+ title: Computer Training
+ Job-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Job"
+ 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'
+ Job-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Job"
+ 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'
+ Employee-Federal-Tax-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Federal-Tax"
+ examples:
+ Example:
+ value:
+ version: 56a489ce86ed6c1b0f0cecc4050a0b01
+ filing_status: Single
+ extra_withholding: '0.0'
+ two_jobs: true
+ dependents_amount: '0.0'
+ other_income: '0.0'
+ deductions: '0.0'
+ employee_id: 29
+ w4_data_type: rev_2020_w4
+ Location-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Location"
+ examples:
+ Example:
+ value:
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ version: 7d9753112507b9dda4fb97910f39b06e
+ phone_number: '5825710808'
+ uuid: 04552eb9-7829-4b18-ae96-6983552948df
+ street_1: 412 Kiera Stravenue
+ street_2: Suite 391
+ city: San Francisco
+ state: CA
+ zip: '94107'
+ country: USA
+ active: true
+ filing_address: false
+ mailing_address: false
+ created_at: '2023-09-12T16:42:25.000-07:00'
+ updated_at: '2023-09-12T16:42:25.000-07:00'
+ Location-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Location"
+ examples:
+ Example:
+ value:
+ - company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ version: 7d9753112507b9dda4fb97910f39b06e
+ phone_number: '5825710808'
+ uuid: 04552eb9-7829-4b18-ae96-6983552948df
+ street_1: 412 Kiera Stravenue
+ street_2: Suite 391
+ city: San Francisco
+ state: CA
+ zip: '94107'
+ country: USA
+ active: true
+ filing_address: false
+ mailing_address: false
+ created_at: '2023-09-12T16:42:25.000-07:00'
+ updated_at: '2023-09-12T16:42:25.000-07:00'
+ - company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ version: 15e6b9680e00f3122729e64e3cef3224
+ phone_number: '2866070827'
+ uuid: fa94a2fd-11a8-4024-87ff-85c587d9d2b4
+ street_1: 644 Fay Vista
+ street_2: Suite 842
+ city: Richmond
+ state: VA
+ zip: '23218'
+ country: USA
+ active: true
+ filing_address: false
+ mailing_address: false
+ created_at: '2023-09-12T16:42:25.000-07:00'
+ updated_at: '2023-09-12T16:42:25.000-07:00'
+ Contractor-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Contractor"
+ examples:
+ Example:
+ value:
+ - uuid: c9fc1ad3-c107-4e7b-aa21-2dd4b00a7a07
+ company_uuid: b7457fec-3b76-43bb-9c6e-69cca4688942
+ wage_type: Fixed
+ is_active: false
+ version: 63859768485e218ccf8a449bb60f14ed
+ type: Individual
+ first_name: Kory
+ last_name: Gottlieb
+ middle_initial: P
+ business_name:
+ ein:
+ has_ein: false
+ has_ssn: true
+ department: Backup Dancer
+ department_uuid: 1802465d-4f68-4865-920c-1307ab095f12
+ email: keira.west@mckenzie.org
+ start_date: '2022-01-01'
+ file_new_hire_report: false
+ work_state:
+ 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: '0.00'
+ - uuid: 183a86f4-a803-4b38-9357-cd9b78e2560c
+ company_uuid: afdd5d98-581b-4fc0-b988-706b7d23b2a5
+ wage_type: Fixed
+ is_active: true
+ version: 8aab307f1e8ed788697f8986346af559
+ type: Business
+ first_name:
+ last_name:
+ middle_initial:
+ business_name: Labadie-Stroman
+ ein: XX-XXX0001
+ has_ein: true
+ has_ssn: false
+ email: jonatan@kerluke.info
+ start_date: '2022-01-01'
+ 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'
+ file_new_hire_report: false
+ work_state:
+ - uuid: ea1c2d65-b622-4899-bcb7-5cd0fe0232aa
+ id: 7757515807623484
+ company_uuid: 281c763d-a2ba-4f51-b9e8-b1ed61576d62
+ company_id: 7757616923763477
+ wage_type: Fixed
+ is_active: true
+ version: b48c46abfed1487b873b442334b3c4ff
+ type: Individual
+ first_name: Chanel
+ last_name: Boyle
+ middle_initial: X
+ business_name:
+ ein:
+ has_ein: false
+ has_ssn: true
+ email: loyal@hettinger.biz
+ file_new_hire_report: true
+ work_state: TX
+ onboarded: true
+ onboarding_status: onboarding_completed
+ address:
+ street_1: 35913 Darrick Run
+ street_2: Apt. 913
+ city: Cypress
+ state: TX
+ zip: '77433'
+ country: USA
+ hourly_rate: '0.00'
+ Created-Contractor-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor"
+ examples:
+ Individual Contractor:
+ value:
+ uuid: c9fc1ad3-c107-4e7b-aa21-2dd4b00a7a07
+ company_uuid: b7457fec-3b76-43bb-9c6e-69cca4688942
+ wage_type: Hourly
+ start_date: '2022-01-01'
+ is_active: false
+ version: 63859768485e218ccf8a449bb60f14ed
+ type: Individual
+ first_name: Kory
+ last_name: Gottlieb
+ middle_initial: P
+ business_name:
+ ein:
+ has_ein: false
+ has_ssn: true
+ department_uuid:
+ email: keira.west@mckenzie.org
+ file_new_hire_report: true
+ work_state: FL
+ onboarded: true
+ onboarding_status: onboarding_completed
+ address:
+ hourly_rate: '60.00'
+ payment_method:
+ Business Contractor:
+ value:
+ 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:
+ last_name:
+ middle_initial:
+ business_name: Labadie-Stroman
+ ein: XX-XXX0001
+ has_ein: true
+ has_ssn: false
+ email: jonatan@kerluke.info
+ file_new_hire_report: false
+ work_state:
+ onboarded: false
+ onboarding_status: admin_onboarding_incomplete
+ address:
+ hourly_rate: '0.00'
+ payment_method:
+ Contractor-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor"
+ examples:
+ Individual Contractor:
+ value:
+ uuid: c9fc1ad3-c107-4e7b-aa21-2dd4b00a7a07
+ company_uuid: b7457fec-3b76-43bb-9c6e-69cca4688942
+ wage_type: Hourly
+ start_date: '2022-01-01'
+ is_active: false
+ version: 63859768485e218ccf8a449bb60f14ed
+ type: Individual
+ first_name: Kory
+ last_name: Gottlieb
+ middle_initial: P
+ business_name:
+ ein:
+ 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
+ Business Contractor:
+ value:
+ 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:
+ last_name:
+ middle_initial:
+ business_name: Labadie-Stroman
+ ein: XX-XXX0001
+ has_ein: true
+ has_ssn: false
+ email: jonatan@kerluke.info
+ file_new_hire_report: false
+ work_state:
+ onboarded: false
+ onboarding_status: admin_onboarding_incomplete
+ address:
+ hourly_rate: '0.00'
+ payment_method: Direct Deposit
+ Contractor-Onboarding-Status-Object:
+ description: Example response.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Onboarding-Status"
+ 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
+ Contractor-Payment-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment"
+ 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'
+ Contractor-Payment-Group-List:
+ description: List of Contractor Payment Groups
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Contractor-Payment-Group-Minimal"
+ examples:
+ Example:
+ value:
+ - 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'
+ Contractor-Payment-Group-Object:
+ description: Full contractor payment group object
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group"
+ examples:
+ Example:
+ value:
+ 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'
+ Contractor-Payment-Group-Null-Uuid-Object:
+ description: Full contractor payment group object with null uuid
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Contractor-Payment-Group"
+ - type: object
+ properties:
+ uuid:
+ type:
+ - string
+ - 'null'
+ examples:
+ Example:
+ value:
+ uuid:
+ company_uuid: c54046f7-1be4-4c54-8194-f4842c30c86d
+ check_date: '2024-05-07'
+ debit_date: '2024-05-01'
+ status: Unfunded
+ creation_token: nil
+ contractor_payments:
+ - uuid: nil
+ 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: nil
+ 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'
+ Contractor-Payment-Method-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Compensation-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Compensation"
+ examples:
+ Exempt:
+ value:
+ uuid: db57832c-d8bc-43a7-ae99-0a04480ff037
+ version: 98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872
+ job_uuid: d8f8fbe7-496d-4b69-86f0-1e2d1b73a086
+ rate: '60000.00'
+ payment_unit: Year
+ flsa_status: Exempt
+ effective_date: '2020-12-11'
+ adjust_for_minimum_wage: false
+ minimum_wages: []
+ Minimum Wage Adjusted:
+ value:
+ 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'
+ Compensation-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Compensation"
+ examples:
+ Example:
+ value:
+ - uuid: db57832c-d8bc-43a7-ae99-0a04480ff037
+ version: 98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872
+ job_uuid: d8f8fbe7-496d-4b69-86f0-1e2d1b73a086
+ rate: '70.00'
+ payment_unit: Hour
+ flsa_status: Nonexempt
+ effective_date: '2020-12-11'
+ adjust_for_minimum_wage: false
+ minimum_wages: []
+ - id: 1363316536327003
+ job_id: 1123581321345589
+ uuid: a4d9ba9c-32cc-4cc1-a5bc-6ef4cd653e7a
+ version: cc59bd3879d655fb940a1f6b675f2ad9
+ job_uuid: d8f8fbe7-496d-4b69-86f0-1e2d1b73a086
+ payment_unit: Hour
+ flsa_status: Nonexempt
+ effective_date: '2018-12-11'
+ rate: '5.00'
+ adjust_for_minimum_wage: true
+ minimum_wages:
+ - uuid: edeea5af-ecd6-4b1c-b5de-5cff2d302738
+ wage: '7.25'
+ effective_date: '2018-12-11'
+ Garnishment-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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:
+ total_amount:
+ pay_period_maximum: '100.00'
+ deduct_as_percentage: true
+ garnishment_type:
+ child_support:
+ 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:
+ recurring: true
+ annual_maximum:
+ total_amount:
+ 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:
+ remittance_number:
+ fips_code: '04000'
+ Garnishment-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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:
+ total_amount:
+ pay_period_maximum: '100.00'
+ deduct_as_percentage: true
+ garnishment_type:
+ child_support:
+ - 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:
+ recurring: true
+ annual_maximum:
+ total_amount:
+ 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:
+ remittance_number:
+ fips_code: '04000'
+ Child-Support-Data-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Child-Support-Data"
+ examples:
+ Example:
+ value:
+ agencies:
+ - state: AK
+ name: Alaska Child Support Services Division
+ manual_payment_required: false
+ fips_codes:
+ - county:
+ 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:
+ code: '39000'
+ required_attributes:
+ - key: case_number
+ label: CSE Case Number
+ - key: order_number
+ label: Order Identifier
+ Employee-Onboarding-Documents-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Onboarding-Document"
+ examples:
+ Example:
+ value:
+ i9_document: true
+ I9-Authorization-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ I9-Authorization-Documents-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ I9-Authorization-Document-Options-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Termination-Object:
+ description: Example Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Termination-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Pay-Period-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Pay-Period"
+ examples:
+ Example:
+ value:
+ - start_date: '2020-01-11'
+ end_date: '2020-01-24'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ payroll:
+ payroll_uuid: bfd8aad4-9c3f-4ca3-b072-a1b2b3ea689f
+ check_date: '2020-01-30'
+ processed: true
+ payroll_deadline: '2020-01-28'
+ payroll_type: regular
+ - start_date: '2020-12-12'
+ end_date: '2020-12-25'
+ pay_schedule_uuid: cb53db72-612f-4eb1-9b85-389e79cfa510
+ payroll:
+ payroll_uuid: 7ed29b45-4bb1-4d38-bd94-4d607d49fd21
+ check_date: '2020-12-30'
+ processed: true
+ payroll_deadline: '2020-12-28'
+ payroll_type: regular
+ Pay-Schedule-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Pay-Schedule"
+ - "$ref": "#/components/schemas/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
+ Pay-Schedule-Create-Update-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Pay-Schedule-Create-Update"
+ 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
+ Pay-Schedule-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ allOf:
+ - "$ref": "#/components/schemas/Pay-Schedule"
+ - "$ref": "#/components/schemas/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:
+ 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:
+ name: Staff
+ custom_name: Staff department pay schedule
+ auto_pilot: true
+ active: false
+ Benefit-Type-Requirements-Object:
+ description: Benefit type requirements response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Benefit-Type-Requirements"
+ examples:
+ Example:
+ value:
+ employee_deduction:
+ required: true
+ editable: true
+ default_value:
+ choices:
+ contribution:
+ required: true
+ editable: true
+ default_value:
+ type: percentage
+ value: 2
+ choices:
+ - percentage
+ deduct_as_percentage:
+ required: true
+ editable: true
+ default_value:
+ choices:
+ catch_up:
+ required: true
+ editable: true
+ default_value:
+ choices:
+ limit_option:
+ required: false
+ editable: false
+ default_value:
+ choices:
+ company_contribution_annual_maximum:
+ required: false
+ editable: false
+ default_value:
+ choices:
+ coverage_salary_multiplier:
+ required: false
+ editable: false
+ default_value:
+ choices:
+ coverage_amount:
+ required: false
+ editable: false
+ default_value:
+ choices:
+ Supported-Benefit-Object:
+ description: Supported benefit response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Supported-Benefit-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Admin-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Admin"
+ examples:
+ Example:
+ value:
+ first_name: John
+ last_name: Smith
+ email: jsmith99@gmail.com
+ uuid: 5de11791-98fd-4587-9ed0-d5d804b8e647
+ Admin-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Admin"
+ 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
+ Company-Benefit-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Company-Benefit-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Company-Custom-Field-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ custom_fields:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Company-Custom-Field"
+ examples:
+ Example:
+ value:
+ custom_fields:
+ - uuid: ea7e5d57-6abb-47d7-b654-347c142886c0
+ name: employee_level
+ description: Employee Level
+ type: text
+ selection_options:
+ - uuid: 299650e4-e970-4acf-9bf0-6f05585d20ba
+ name: t-shirt size
+ description: What is your t-shirt size?
+ type: text
+ selection_options:
+ - uuid: 024ec137-6c92-43a3-b061-14a9720531d6
+ name: favorite fruit
+ description: Which is your favorite fruit?
+ type: radio
+ selection_options:
+ - apple
+ - banana
+ - orange
+ Earning-Type-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ default:
+ type: array
+ description: The default earning types for the company.
+ items:
+ "$ref": "#/components/schemas/Earning-Type"
+ custom:
+ type: array
+ description: The custom earning types for the company.
+ items:
+ "$ref": "#/components/schemas/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
+ Earning-Type-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Earning-Type"
+ examples:
+ Example:
+ value:
+ name: Gym Membership Stipend
+ uuid: f4dc8972-8830-4c07-b623-349a04b040d7
+ Employee-Benefit-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Benefit"
+ 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:
+ deduct_as_percentage: false
+ catch_up: false
+ coverage_amount:
+ deduction_reduces_taxable_income:
+ 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'
+ Employee-Benefit-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-Benefit"
+ 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:
+ deduct_as_percentage: false
+ contribute_as_percentage: false
+ catch_up: false
+ coverage_amount:
+ deduction_reduces_taxable_income:
+ coverage_salary_multiplier: '0.00'
+ Contribution-Exclusion-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Payroll-Update-Object:
+ description: A prepared payroll
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Prepared"
+ examples:
+ Example:
+ value:
+ payroll_deadline: '2022-02-18T22:00:00Z'
+ check_date: '2021-02-22'
+ off_cycle: false
+ off_cycle_reason:
+ external: false
+ auto_pilot: false
+ processed: false
+ processed_date:
+ calculated_at:
+ uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ payroll_uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ created_at: '2022-02-01T22:00:00Z'
+ pay_period:
+ start_date: '2021-02-01'
+ end_date: '2021-02-15'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ payroll_status_meta:
+ cancellable: false
+ expected_check_date: '2022-02-22'
+ initial_check_date: '2022-02-22'
+ expected_debit_time: '2022-02-18T22:00:00Z'
+ payroll_late: false
+ initial_debit_cutoff_time: '2022-02-18T22:00:00Z'
+ processing_request:
+ employee_compensations:
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7067
+ version: 4ba36d23a78c7393b4900ef38019d8ff
+ first_name: Patricia
+ preferred_first_name: Patricia
+ last_name: Hamil
+ excluded: false
+ payment_method: Direct Deposit
+ fixed_compensations:
+ - name: Bonus
+ amount: '100.00'
+ job_uuid: 94e0d15e-9ed2-4077-98f6-64554f242ba5
+ - name: Reimbursement
+ amount: '100.00'
+ job_uuid: 91bc3b43-ded0-4ee7-98fe-215499e909ba
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Nonexempt
+ - name: Overtime
+ hours: '15.000'
+ job_uuid: 9d3760f0-d1f9-4700-8817-0fe2dce5cf23
+ compensation_multiplier: 1.5
+ flsa_status: Nonexempt
+ - name: Double overtime
+ hours: '0.000'
+ job_uuid: b5eef9a9-4a87-4649-a80d-14878c05f44e
+ compensation_multiplier: 2
+ flsa_status: Nonexempt
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: 332bd171-9efc-432b-abbb-a75c9dba706a
+ compensation_multiplier: 1
+ flsa_status: Nonexempt
+ - name: Overtime
+ hours: '5.000'
+ job_uuid: ca9b3dc1-57ac-4736-901a-9b1c9634b9d5
+ compensation_multiplier: 1.5
+ flsa_status: Nonexempt
+ - name: Double overtime
+ hours: '0.000'
+ job_uuid: 1bad01e2-140c-49ed-9542-2388ce4a19b3
+ compensation_multiplier: 2
+ flsa_status: Nonexempt
+ paid_time_off:
+ - name: Vacation Hours
+ hours: '20.000'
+ - name: Sick Hours
+ hours: '0.000'
+ - name: Holiday Hours
+ hours: '0.000'
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7012
+ version: ff083257a5583291fb86656ad0df1b42
+ first_name: Soren
+ preferred_first_name: Soren
+ last_name: Keck
+ excluded: false
+ payment_method: Direct Deposit
+ fixed_compensations:
+ - name: Bonus
+ amount: '100.00'
+ job_uuid: 94e0d15e-9ed2-4077-98f6-64554f242b34
+ - name: Reimbursement
+ amount: '100.00'
+ job_uuid: 91bc3b43-ded0-4ee7-98fe-215499e90955
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Commission Only Exempt
+ paid_time_off:
+ - name: Vacation Hours
+ hours: '20.000'
+ - name: Sick Hours
+ hours: '0.000'
+ - name: Holiday Hours
+ hours: '0.000'
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7781
+ version: 259816479e3729bf855318af9b9adddf
+ first_name: Patty
+ preferred_first_name: Patty
+ last_name: Tam
+ excluded: false
+ payment_method: Direct Deposit
+ fixed_compensations:
+ - name: Bonus
+ amount: '100.00'
+ job_uuid: 94e0d15e-9ed2-4077-98f6-64554f242bab
+ - name: Reimbursement
+ amount: '100.00'
+ job_uuid: 91bc3b43-ded0-4ee7-98fe-215499e909cd
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Exempt
+ paid_time_off:
+ - name: Vacation Hours
+ hours: '20.000'
+ - name: Sick Hours
+ hours: '0.000'
+ - name: Holiday Hours
+ hours: '0.000'
+ fixed_compensation_types:
+ - name: Bonus
+ - name: Commission
+ - name: Paycheck Tips
+ - name: Cash Tips
+ - name: Correction Payment
+ - name: Anniversary Bonus
+ - name: Internet Stipend
+ - name: Reimbursement
+ Off-Cycle-Payroll-Object:
+ description: An off-cycle payroll
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Prepared"
+ examples:
+ Example:
+ value:
+ version: 19289df18e6e20f797de4a585ea5a91535c7ddf7
+ payroll_deadline: '2022-02-18T22:00:00Z'
+ check_date: '2021-02-22'
+ off_cycle: true
+ off_cycle_reason: Bonus
+ external: false
+ auto_pilot: false
+ processed: false
+ processed_date:
+ calculated_at:
+ uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ payroll_uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ created_at: '2022-02-01T22:00:00Z'
+ withholding_pay_period: Every other week
+ skip_regular_deductions: true
+ fixed_withholding_rate: true
+ final_termination_payroll: false
+ pay_period:
+ start_date: '2021-02-01'
+ end_date: '2021-02-15'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ payroll_status_meta:
+ cancellable: false
+ expected_check_date: '2022-02-22'
+ initial_check_date: '2022-02-22'
+ expected_debit_time: '2022-02-18T22:00:00Z'
+ payroll_late: false
+ initial_debit_cutoff_time: '2022-02-18T22:00:00Z'
+ processing_request:
+ employee_compensations:
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7067
+ first_name: John
+ preferred_first_name: John
+ last_name: Doe
+ excluded: false
+ payment_method: Direct Deposit
+ fixed_compensations: []
+ memo:
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '0.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Nonexempt
+ - name: Overtime
+ hours: '0.000'
+ job_uuid: 9d3760f0-d1f9-4700-8817-0fe2dce5cf23
+ compensation_multiplier: 1.5
+ flsa_status: Nonexempt
+ - name: Double overtime
+ hours: '0.000'
+ job_uuid: b5eef9a9-4a87-4649-a80d-14878c05f44e
+ compensation_multiplier: 2
+ flsa_status: Nonexempt
+ - name: Regular Hours
+ hours: '0.000'
+ job_uuid: 332bd171-9efc-432b-abbb-a75c9dba706a
+ compensation_multiplier: 1
+ flsa_status: Nonexempt
+ - name: Overtime
+ hours: '0.000'
+ job_uuid: ca9b3dc1-57ac-4736-901a-9b1c9634b9d5
+ compensation_multiplier: 1.5
+ flsa_status: Nonexempt
+ - name: Double overtime
+ hours: '0.000'
+ job_uuid: 1bad01e2-140c-49ed-9542-2388ce4a19b3
+ compensation_multiplier: 2
+ flsa_status: Nonexempt
+ paid_time_off: []
+ Payroll-Show-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll"
+ examples:
+ Unprocessed:
+ value:
+ payroll_deadline: '2021-02-18T22:00:00Z'
+ check_date: '2021-02-22'
+ off_cycle: false
+ external: false
+ auto_pilot: false
+ processed: false
+ processed_date:
+ calculated_at:
+ uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ payroll_uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ created_at: '2022-02-01T22:00:00Z'
+ pay_period:
+ start_date: '2021-02-01'
+ end_date: '2021-02-15'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ payroll_status_meta:
+ cancellable: false
+ expected_check_date: '2021-02-22'
+ initial_check_date: '2021-02-22'
+ expected_debit_time: '2021-02-18T22:00:00Z'
+ payroll_late: false
+ initial_debit_cutoff_time: '2021-02-18T22:00:00Z'
+ submission_blockers:
+ - blocker_type: fast_ach_threshold_exceeded
+ blocker_name: Fast ACH Threshold Exceeded
+ unblock_options:
+ - unblock_type: wire_in
+ check_date: '2024-06-10'
+ metadata:
+ wire_in_deadline: '2024-06-19T18:00:00Z'
+ wire_in_amount: 400000.0
+ - unblock_type: move_to_four_day
+ check_date: '2024-06-12'
+ metadata: {}
+ selected_option:
+ status: unresolved
+ processing_request:
+ Processed:
+ value:
+ payroll_deadline: '2021-02-18T22:00:00Z'
+ check_date: '2021-02-22'
+ off_cycle: false
+ external: false
+ auto_pilot: true
+ processed: true
+ processed_date: '2021-02-18'
+ calculated_at: '2021-02-18T12:00:00Z'
+ payroll_uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ created_at: '2022-02-01T22:00:00Z'
+ pay_period:
+ start_date: '2021-02-01'
+ end_date: '2021-02-15'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ totals:
+ company_debit: '121747.71'
+ net_pay_debit: '79283.80'
+ tax_debit: '42463.91'
+ reimbursement_debit: '0.00'
+ child_support_debit: '0.00'
+ reimbursements: '0.00'
+ net_pay: '81752.94'
+ gross_pay: '130635.89'
+ employee_bonuses: '0.00'
+ employee_commissions: '18536.37'
+ employee_cash_tips: '0.00'
+ employee_paycheck_tips: '0.00'
+ additional_earnings: '0.00'
+ owners_draw: '0.00'
+ check_amount: '2469.14'
+ employer_taxes: '6917.19'
+ employee_taxes: '35546.72'
+ benefits: '0.00'
+ employee_benefits_deductions: '13336.23'
+ imputed_pay: '0.00'
+ deferred_payroll_taxes: '0.00'
+ other_deductions: '240.00'
+ company_taxes:
+ - name: MO Compensation Deduction
+ amount: "-0.92"
+ employer: true
+ - name: NY MCTMT
+ amount: '5.00'
+ employer: true
+ payroll_taxes:
+ - name: Federal Income Tax
+ employer: false
+ amount: 3546.72
+ - name: Social Security
+ employer: true
+ amount: 786.0
+ - name: Social Security
+ employer: false
+ amount: 786.0
+ - name: CA State Income Tax
+ employer: false
+ amount: 132.51
+ payroll_status_meta:
+ cancellable: false
+ expected_check_date: '2021-02-22'
+ initial_check_date: '2021-02-22'
+ expected_debit_time: '2021-02-18T22:00:00Z'
+ payroll_late: false
+ initial_debit_cutoff_time: '2021-02-18T22:00:00Z'
+ employee_compensations:
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7067
+ excluded: false
+ gross_pay: '2791.25'
+ net_pay: '1953.31'
+ check_amount: '1953.31'
+ payment_method: Direct Deposit
+ fixed_compensations:
+ - name: Bonus
+ amount: '100.00'
+ job_uuid: 94e0d15e-9ed2-4077-98f6-64554f242ba5
+ - name: Reimbursement
+ amount: '100.00'
+ job_uuid: 91bc3b43-ded0-4ee7-98fe-215499e909ba
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Nonexempt
+ - name: Overtime
+ hours: '15.000'
+ job_uuid: 9d3760f0-d1f9-4700-8817-0fe2dce5cf23
+ compensation_multiplier: 1.5
+ flsa_status: Nonexempt
+ - name: Double overtime
+ hours: '0.000'
+ job_uuid: b5eef9a9-4a87-4649-a80d-14878c05f44e
+ compensation_multiplier: 2
+ flsa_status: Nonexempt
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: 332bd171-9efc-432b-abbb-a75c9dba706a
+ compensation_multiplier: 1
+ flsa_status: Nonexempt
+ - name: Overtime
+ hours: '5.000'
+ job_uuid: ca9b3dc1-57ac-4736-901a-9b1c9634b9d5
+ compensation_multiplier: 1.5
+ flsa_status: Nonexempt
+ - name: Double overtime
+ hours: '0.000'
+ job_uuid: 1bad01e2-140c-49ed-9542-2388ce4a19b3
+ compensation_multiplier: 2
+ flsa_status: Nonexempt
+ paid_time_off:
+ - name: Vacation Hours
+ hours: '20.000'
+ - name: Sick Hours
+ hours: '0.000'
+ - name: Holiday Hours
+ hours: '0.000'
+ benefits:
+ - name: Group Term Life
+ employee_deduction: '100.00'
+ company_contribution: '50.00'
+ imputed: true
+ - name: 401K
+ employee_deduction: '100.00'
+ company_contribution: '50.00'
+ imputed: false
+ deductions:
+ - name: Child Support
+ amount: '80.00'
+ taxes:
+ - name: Federal Income Tax
+ employer: false
+ amount: '646.69'
+ - name: Social Security
+ employer: true
+ amount: '191.25'
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7012
+ excluded: false
+ gross_pay: '2791.25'
+ net_pay: '1953.31'
+ check_amount: '1953.31'
+ payment_method: Direct Deposit
+ fixed_compensations:
+ - name: Bonus
+ amount: '100.00'
+ job_uuid: 94e0d15e-9ed2-4077-98f6-64554f242b34
+ - name: Reimbursement
+ amount: '100.00'
+ job_uuid: 91bc3b43-ded0-4ee7-98fe-215499e90955
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Commission Only Exempt
+ paid_time_off:
+ - name: Vacation Hours
+ hours: '20.000'
+ - name: Sick Hours
+ hours: '0.000'
+ - name: Holiday Hours
+ hours: '0.000'
+ benefits:
+ - name: Group Term Life
+ employee_deduction: '100.00'
+ company_contribution: '50.00'
+ imputed: true
+ - name: 401K
+ employee_deduction: '100.00'
+ company_contribution: '50.00'
+ imputed: false
+ deductions:
+ - name: Child Support
+ amount: '80.00'
+ taxes:
+ - name: Federal Income Tax
+ employer: false
+ amount: '646.69'
+ - name: Social Security
+ employer: true
+ amount: '191.25'
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7781
+ excluded: false
+ gross_pay: '2791.25'
+ net_pay: '1953.31'
+ check_amount: '1953.31'
+ payment_method: Direct Deposit
+ fixed_compensations:
+ - name: Bonus
+ amount: '100.00'
+ job_uuid: 94e0d15e-9ed2-4077-98f6-64554f242bab
+ - name: Reimbursement
+ amount: '100.00'
+ job_uuid: 91bc3b43-ded0-4ee7-98fe-215499e909cd
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Exempt
+ paid_time_off:
+ - name: Vacation Hours
+ hours: '20.000'
+ - name: Sick Hours
+ hours: '0.000'
+ - name: Holiday Hours
+ hours: '0.000'
+ benefits:
+ - name: Group Term Life
+ employee_deduction: '100.00'
+ company_contribution: '50.00'
+ imputed: true
+ - name: 401K
+ employee_deduction: '100.00'
+ company_contribution: '50.00'
+ imputed: false
+ deductions:
+ - name: Child Support
+ amount: '80.00'
+ taxes:
+ - name: Federal Income Tax
+ employer: false
+ amount: 646.69
+ - name: Social Security
+ employer: true
+ amount: 191.25
+ credit_blockers:
+ - blocker_type: waiting_for_wire_in
+ blocker_name: Waiting for Wire In
+ unblock_options:
+ - unblock_type: submit_wire
+ check_date: '2024-06-10'
+ metadata:
+ wire_in_deadline: '2024-06-19T18:00:00Z'
+ wire_in_amount: 400000.0
+ wire_in_request_uuid: 187412e1-3dbe-491a-bb2f-2f40323a421a
+ selected_option: submit_wire
+ status: unresolved
+ processing_request:
+ status: submit_success
+ errors: []
+ Payroll-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Payroll-Minimal"
+ examples:
+ Example:
+ value:
+ - payroll_deadline: '2021-02-18T22:00:00Z'
+ check_date: '2021-02-22'
+ off_cycle: false
+ external: false
+ processed: true
+ processed_date: '2021-02-18'
+ calculated_at: '2021-02-18T12:00:00Z'
+ uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ payroll_uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ created_at: '2021-02-01T22:00:00Z'
+ reversal_payroll_uuids: []
+ pay_period:
+ start_date: '2021-02-01'
+ end_date: '2021-02-15'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ totals:
+ company_debit: '121747.71'
+ net_pay_debit: '79283.80'
+ tax_debit: '42463.91'
+ reimbursement_debit: '0.00'
+ child_support_debit: '0.00'
+ reimbursements: '0.00'
+ net_pay: '81752.94'
+ gross_pay: '130635.89'
+ employee_bonuses: '0.00'
+ employee_commissions: '18536.37'
+ employee_cash_tips: '0.00'
+ employee_paycheck_tips: '0.00'
+ additional_earnings: '0.00'
+ owners_draw: '0.00'
+ check_amount: '2469.14'
+ employer_taxes: '6917.19'
+ employee_taxes: '35546.72'
+ benefits: '0.00'
+ employee_benefits_deductions: '13336.23'
+ imputed_pay: '0.00'
+ deferred_payroll_taxes: '0.00'
+ other_deductions: '240.00'
+ - payroll_deadline: '2021-02-28'
+ check_date: '2021-03-01'
+ off_cycle: false
+ external: false
+ processed: false
+ processed_date: nil
+ calculated_at: nil
+ payroll_uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ created_at: '2022-02-01T22:00:00Z'
+ pay_period:
+ start_date: '2021-02-16'
+ end_date: '2021-03-01'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ Payment-Configs-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payment-Configs"
+ examples:
+ Example:
+ value:
+ company_uuid: 423dd616-6dbc-4724-938a-403f6217a933
+ partner_uuid: 556f05d0-48e0-4c47-bce5-db9aea923043
+ fast_payment_limit: '5000'
+ payment_speed: 2-day
+ earned_fast_ach_blockers:
+ - blocker_type: minimum_days
+ threshold: 15
+ - blocker_type: minimum_funded_payments
+ threshold: 1
+ Company-Bank-Account-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Bank-Account"
+ examples:
+ Example:
+ value:
+ 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
+ Company-Bank-Account-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Company-Bank-Account"
+ examples:
+ Example:
+ value:
+ - 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
+ Employee-Bank-Account-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Bank-Account"
+ 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
+ Employee-Bank-Account-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-Bank-Account"
+ 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
+ Employee-Payment-Method-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Payment-Method"
+ examples:
+ Example:
+ value:
+ version: 63859768485e218ccf8a449bb60f14ed
+ type: Direct Deposit
+ split_by: Amount
+ splits:
+ - uuid: e88f9436-b74e-49a8-87e9-777b9bfe715e
+ name: BoA Checking Account
+ priority: 1
+ split_amount: 500
+ - uuid: 0d2b7f73-05d6-4184-911d-269edeecc30a
+ name: Chase Checking Account
+ priority: 2
+ split_amount: 1000
+ - uuid: 1531e824-8d9e-4bd8-9f90-0d04608125d7
+ name: US Bank Checking Account
+ priority: 3
+ split_amount:
+ Federal-Tax-Details-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Employee-State-Taxes-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-State-Tax"
+ examples:
+ Employee-State-Taxes-List-Example:
+ value:
+ employee_uuid: 92fa4d30-e284-43d0-a26e-605619c04beb
+ file_new_hire_report: false
+ is_work_state: true
+ 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.
+
+'
+ 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:
+ - 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.
+
+'
+ key: withholding_allowance
+ input_question_format:
+ type: Number
+ answers:
+ - value: 1
+ valid_from: '2010-01-01'
+ valid_up_to:
+ - 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:
+ - 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
+ answers:
+ - value: true
+ valid_from: '2010-01-01'
+ valid_up_to:
+ Employee-Onboarding-Status-Object:
+ description: Example response.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Onboarding-Status"
+ examples:
+ Example:
+ value:
+ uuid: c44d66dc-c41b-4a60-9e25-5e93ff8583f2
+ onboarding_status: admin_onboarding_incomplete
+ onboarding_steps:
+ - title: Personal details
+ id: personal_details
+ required: true
+ completed: false
+ requirements: []
+ - title: Enter compensation details
+ id: compensation_details
+ required: true
+ completed: false
+ requirements: []
+ - title: Add work address
+ id: add_work_address
+ required: true
+ completed: false
+ requirements: []
+ - title: Add home address
+ id: add_home_address
+ required: true
+ completed: false
+ requirements: []
+ - title: Enter federal tax withholdings
+ id: federal_tax_setup
+ required: true
+ completed: false
+ 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: false
+ requirements: []
+ - title: Employee form signing
+ id: employee_form_signing
+ required: true
+ completed: false
+ requirements:
+ - federal_tax_setup
+ - state_tax_setup
+ Payroll-Blocker-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Payroll-Blocker"
+ examples:
+ Payroll Blockers:
+ value:
+ - key: eftps_in_error
+ message: We could not make payments to the Electronic Federal Tax Payment System.
+ - key: geocode_error
+ message: Company or employee address could not be verified. Please ensure all addresses are valid.
+ - key: geocode_needed
+ message: Company or employee address verification is missing. Please ensure all addresses are entered correctly.
+ - key: pay_schedule_setup_not_complete
+ message: Some employees don’t have a pay schedule set up yet. Please complete this step to run payroll.
+ - key: invalid_signatory
+ message: A signatory who is authorized to sign documents on behalf of your company is required. Please ensure their identity verification is successful.
+ - key: suspended
+ message: Company is suspended and cannot run payroll.
+ - key: soft_suspended
+ message: Company is placed in a 'soft' suspension state and requires missing/incorrect information to be corrected.
+ - key: pending_payroll_review
+ message: Payroll is blocked. We are reviewing payroll information in your account. Please contact support if you believe this is an error.
+ - key: pending_recovery_case
+ message: Payroll is blocked due to an open recovery case. Please contact support if you believe this is an error.
+ - key: pending_information_request
+ message: Payroll is blocked due to an open information request. Please contact support if you believe this is an error.
+ - key: needs_approval
+ message: Company needs to be approved to run payroll.
+ - key: missing_addresses
+ message: Company must add addresses in order to run payroll.
+ - key: missing_federal_tax_setup
+ message: Company must complete federal tax setup in order to run payroll.
+ - key: missing_industry_selection
+ message: Company must complete industry selection in order to run payroll.
+ - key: missing_bank_info
+ message: Company must have a bank account in order to run payroll.
+ - key: missing_employee_setup
+ message: Company must add employees in order to run payroll.
+ - key: missing_state_tax_setup
+ message: Company must complete state tax setup in order to run payroll.
+ - key: missing_pay_schedule
+ message: Company must have a pay schedule in order to run payroll.
+ - key: missing_forms
+ message: Company forms must be signed in order to run payroll.
+ - key: missing_bank_verification
+ message: Company bank account must be verified in order to run payroll.
+ - key: missing_signatory
+ message: Company must have a verified signatory in order to run payroll.
+ Generated-Document:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Generated-Document"
+ examples:
+ Example:
+ value:
+ document_urls:
+ - https://document.url.com
+ request_uuid: p83d0ca8-7d41-42a9-834y-7d218ef6cb20
+ status: succeeded
+ General-Ledger-Report:
+ 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
+ Report:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Report"
+ examples:
+ Example:
+ value:
+ report_urls:
+ - https://report.url.com
+ request_uuid: p83d0ca8-7d41-42a9-834y-7d218ef6cb20
+ status: succeeded
+ Create-Report:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Report-Template:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Notification:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Event-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Event"
+ examples:
+ Example:
+ value:
+ - 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
+ Payroll-Check:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Payroll-Receipt:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Receipt"
+ examples:
+ Example:
+ value:
+ totals:
+ company_debit: '1080.47'
+ net_pay_debit: '748.34'
+ child_support_debit: '100.0'
+ reimbursement_debit: '50.0'
+ tax_debit: '182.13'
+ taxes:
+ - name: Federal Income Tax
+ amount: '30.36'
+ - name: Social Security
+ amount: '104.54'
+ - name: Medicare
+ amount: '24.46'
+ - name: Additional Medicare
+ amount: '0.0'
+ - name: TX SUTA
+ amount: '22.77'
+ - name: FUTA
+ amount: '0.0'
+ employee_compensations:
+ - employee_uuid: f83d0bd8-7e20-43b9-834c-6d514ef6cb47
+ employee_first_name: Patricia
+ employee_last_name: Hamill
+ payment_method: Direct Deposit
+ net_pay: '748.34'
+ total_tax: '182.13'
+ total_garnishments: '0.0'
+ child_support_garnishment: '100.0'
+ total_reimbursement: '50.0'
+ licensee:
+ name: Gusto, Zenpayroll Inc.
+ address: 525 20th St
+ city: San Francisco
+ state: CA
+ postal_code: '94107'
+ phone_number: '4157778888'
+ payroll_uuid: afccb970-357e-4013-81f5-85dafc74f9b6
+ company_uuid: c827aa0d-3928-4d5a-ab1f-400641a7d2b8
+ name_of_sender: Torp and Sons and Sons
+ 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: '2022-06-02'
+ 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
+ Payroll-Reversal-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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:
+ category: convert_check_ee_requested
+ reversed_employee_uuids:
+ - 5f036964-185e-4c85-bbf2-3873e1203b30
+ Gross-Up-Pay:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Gross-Up-Pay"
+ examples:
+ Example:
+ value:
+ net_pay: '1183.25'
+ Contractor-Payment-Receipt:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Contractor-Bank-Account-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Bank-Account"
+ 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
+ Contractor-Bank-Account-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Contractor-Bank-Account"
+ 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
+ Time-Off-Policy-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ examples:
+ Unlimited Policy:
+ value:
+ uuid: 3f746cd0-dd08-408f-b712-8180c7c621e9
+ company_uuid: de83cff2-8e7a-448e-a28c-14258a9971c3
+ name: Test Vacation Unlimited Policy
+ policy_type: vacation
+ accrual_method: unlimited
+ accrual_rate:
+ accrual_rate_unit:
+ paid_out_on_termination: false
+ accrual_waiting_period_days:
+ carryover_limit_hours:
+ max_accrual_hours_per_year:
+ max_hours:
+ version: f5556bce3d75ec2b62bd11990aa7993a
+ is_active: true
+ complete: true
+ employees:
+ - uuid: 05ed3150-591e-4f8b-bfd5-55d478edd2d8
+ - uuid: 3633ce57-abb7-422f-8c5a-455566618e6a
+ - uuid: 9b37429c-e540-40fb-86b3-738ca9af65c7
+ Fixed Policy:
+ value:
+ uuid: 2439c13f-f6d7-4a93-af8c-175fd4cc7ce8
+ company_uuid: f5f7b10d-2ddb-42f6-a955-d55320ce5316
+ name: Test Vacation Fixed Policy
+ policy_type: vacation
+ accrual_method: per_anniversary_year
+ accrual_rate: '120.0'
+ accrual_rate_unit:
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 0
+ carryover_limit_hours: '240.0'
+ max_accrual_hours_per_year: '120.0'
+ max_hours: '300.0'
+ version: f5556bce3d75ec2b62bd11990aa7993a
+ is_active: true
+ complete: true
+ employees:
+ - uuid: de7a5fb3-2e0f-460a-abbf-467fe310bf5c
+ balance: '80.0'
+ - uuid: 92af03c7-a833-43ae-bae8-f67007a59b37
+ balance: '60.0'
+ Hourly Policy:
+ value:
+ uuid: bd5f354f-12e0-4a5e-ad1f-953bb2685ad4
+ company_uuid: 6767445f-5075-4ea4-a7f5-d5b5b93d4d60
+ name: Test Vacation Hourly Policy
+ policy_type: vacation
+ accrual_method: per_hour_paid
+ accrual_rate: '4.0'
+ accrual_rate_unit: '80.0'
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 30
+ carryover_limit_hours: '200.0'
+ max_accrual_hours_per_year: '120.0'
+ max_hours: '240.0'
+ version: f5556bce3d75ec2b62bd11990aa7993a
+ is_active: true
+ complete: true
+ employees:
+ - uuid: 1ea2764d-0f1a-4f09-b1d9-3006aecf63c4
+ balance: '56.0'
+ - uuid: a0db19a2-7c8f-42b4-9d4c-2e6246c3d6e8
+ balance: '84.0'
+ headers: {}
+ Time-Off-Policy-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ examples:
+ example:
+ value:
+ - uuid: 3f746cd0-dd08-408f-b712-8180c7c621e9
+ company_uuid: de83cff2-8e7a-448e-a28c-14258a9971c3
+ name: Test Vacation Unlimited Policy
+ policy_type: vacation
+ accrual_method: unlimited
+ accrual_rate:
+ accrual_rate_unit:
+ paid_out_on_termination: false
+ accrual_waiting_period_days:
+ carryover_limit_hours:
+ max_accrual_hours_per_year:
+ max_hours:
+ version: f5556bce3d75ec2b62bd11990aa7993a
+ is_active: true
+ complete: true
+ employees:
+ - uuid: 05ed3150-591e-4f8b-bfd5-55d478edd2d8
+ - uuid: 3633ce57-abb7-422f-8c5a-455566618e6a
+ - uuid: 9b37429c-e540-40fb-86b3-738ca9af65c7
+ - uuid: 2439c13f-f6d7-4a93-af8c-175fd4cc7ce8
+ company_uuid: f5f7b10d-2ddb-42f6-a955-d55320ce5316
+ name: Test Vacation Fixed Policy
+ policy_type: vacation
+ accrual_method: per_anniversary_year
+ accrual_rate: '120.0'
+ accrual_rate_unit:
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 0
+ carryover_limit_hours: '240.0'
+ max_accrual_hours_per_year: '120.0'
+ max_hours: '300.0'
+ version: f5556bce3d75ec2b62bd11990aa7993a
+ is_active: true
+ complete: true
+ employees:
+ - uuid: de7a5fb3-2e0f-460a-abbf-467fe310bf5c
+ balance: '80.0'
+ - uuid: 92af03c7-a833-43ae-bae8-f67007a59b37
+ balance: '60.0'
+ - uuid: bd5f354f-12e0-4a5e-ad1f-953bb2685ad4
+ company_uuid: 6767445f-5075-4ea4-a7f5-d5b5b93d4d60
+ name: Test Vacation Hourly Policy
+ policy_type: vacation
+ accrual_method: per_hour_paid
+ accrual_rate: '4.0'
+ accrual_rate_unit: '80.0'
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 30
+ carryover_limit_hours: '200.0'
+ max_accrual_hours_per_year: '120.0'
+ max_hours: '240.0'
+ version: f5556bce3d75ec2b62bd11990aa7993a
+ is_active: true
+ complete: true
+ employees:
+ - uuid: 1ea2764d-0f1a-4f09-b1d9-3006aecf63c4
+ balance: '56.0'
+ - uuid: a0db19a2-7c8f-42b4-9d4c-2e6246c3d6e8
+ balance: '84.0'
+ Time-Off-Activity-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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: {}
+ Invoice-Data-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Minimum-Wage-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Minimum-Wage"
+ examples:
+ Example:
+ value:
+ - uuid: 70c523ff-c71e-4474-9c83-a4ea51bd54a8
+ authority: State
+ wage: '13.0'
+ wage_type: Regular
+ effective_date: '2022-01-01'
+ notes: Employers with 6 or more employees
+ Information-Request-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Recovery-Case-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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:
+ amount_outstanding: '10499.43'
+ event_total_amount: '5912.07'
+ Ach-Transaction-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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:
+ 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
+ Wire-In-Request-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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'
+ Wire-In-Request-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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'
+ Time-Sheet-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Sheet"
+ examples:
+ example:
+ value:
+ uuid: 123e4567-e89b-12d3-a456-426655440000
+ company_uuid: 123e4567-e89b-12d3-a456-426655440000
+ status: approved
+ time_zone: America/Los_Angeles
+ entity_type: Employee
+ version: 72deb67e16f7b92713c00d3582fa6c68
+ job_uuid: 123e4567-e89b-12d3-a456-426655440000
+ entity_uuid: 123e4567-e89b-12d3-a456-426655440000
+ shift_started_at: '2025-03-04T13:07:10Z'
+ shift_ended_at: '2025-03-04T16:07:10Z'
+ created_at: '2025-04-29T16:08:53Z'
+ updated_at: '2025-04-29T16:08:53Z'
+ metadata: {}
+ entries:
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Regular
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Overtime
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Double overtime
+ Time-Sheet-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Time-Sheet"
+ examples:
+ Example:
+ value:
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ company_uuid: 123e4567-e89b-12d3-a456-426655440000
+ status: approved
+ time_zone: America/Los_Angeles
+ entity_type: Employee
+ version: 72deb67e16f7b92713c00d3582fa6c68
+ job_uuid: 123e4567-e89b-12d3-a456-426655440000
+ entity_uuid: 123e4567-e89b-12d3-a456-426655440000
+ shift_started_at: '2025-03-04T13:07:10Z'
+ shift_ended_at: '2025-03-04T16:07:10Z'
+ created_at: '2025-04-29T16:08:53Z'
+ updated_at: '2025-04-29T16:08:53Z'
+ metadata: {}
+ entries:
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Regular
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Overtime
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Double overtime
+ Company-Suspension:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Suspension"
+ Company-Suspension-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Company-Suspension"
+ Time-Off-Request-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Request"
+ Time-Off-Request-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Time-Off-Request"
+ requestBodies:
+ post-employee-ytd-benefit-amounts-from-different-company:
+ 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
+security:
+ - CompanyAccessAuth: []
diff --git a/.speakeasy/logs/changes/old.openapi.yaml b/.speakeasy/logs/changes/old.openapi.yaml
new file mode 100644
index 00000000..5036ebe2
--- /dev/null
+++ b/.speakeasy/logs/changes/old.openapi.yaml
@@ -0,0 +1,31142 @@
+openapi: 3.1.0
+tags:
+ - name: Introspection
+ - name: Companies
+ - name: Flows
+ - name: Locations
+ - name: Bank Accounts
+ - name: Payment Configs
+ - name: Pay Schedules
+ - name: Employees
+ - name: Employee Tax Setup
+ - name: Employee Payment Method
+ - name: Employee Employments
+ - name: Employee Addresses
+ - name: Jobs and Compensations
+ - name: Earning Types
+ - name: I-9 Verification
+ - name: Contractor Payment Groups
+ - name: Contractor Payment Method
+ - name: Contractor Payments
+ - name: Contractors
+ - name: Payrolls
+ - name: Company Forms
+ - name: Contractor Documents
+ - name: Employee Forms
+ - name: Company Benefits
+ - name: Employee Benefits
+ - name: Garnishments
+ - name: Federal Tax Details
+ - name: Industry Selection
+ - name: Signatories
+ - name: External Payrolls
+ - name: Tax Requirements
+ - name: Contractor Forms
+ - name: Time Off Policies
+ - name: Holiday Pay Policies
+ - name: Departments
+ - name: Reports
+ - name: Generated Documents
+ - name: Notifications
+ - name: Webhooks
+ - name: Events
+ - name: Invoices
+ - name: Recovery Cases
+ - name: Company Attachment
+ - name: Wire In Requests
+ - name: ACH Transactions
+ - name: Information Requests
+ - name: Time Tracking
+ - name: Time Off Requests
+ - name: Salary Estimates
+ - name: Reimbursements
+ - name: People Batches
+info:
+ title: Gusto API
+ version: '2025-06-15'
+ termsOfService: https://gusto.com/about/terms/developer-terms-of-service
+ description: Welcome to Gusto's Embedded Payroll API documentation!
+ contact:
+ name: Developer Relations
+ email: developer@gusto.com
+servers:
+ - url: https://api.gusto-demo.com
+ description: Demo
+ x-speakeasy-server-id: demo
+ - url: https://api.gusto.com
+ description: Prod
+ x-speakeasy-server-id: prod
+paths:
+ "/v1/token_info":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get info about the current access token
+ tags:
+ - Introspection
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ description: ''
+ type: object
+ properties:
+ scope:
+ type: string
+ description: Space delimited string of accessible scopes.
+ resource:
+ type: object
+ description: Information about the token resource.
+ nullable: true
+ properties:
+ type:
+ type: string
+ description: Type of object
+ uuid:
+ type: string
+ description: UUID of object
+ required:
+ - type
+ - uuid
+ resource_owner:
+ type: object
+ description: Information about the token owner
+ nullable: true
+ properties:
+ type:
+ type: string
+ enum:
+ - CompanyAdmin
+ - Employee
+ - Contractor
+ uuid:
+ type: string
+ description: UUID of resource owner
+ required:
+ - type
+ - uuid
+ required:
+ - scope
+ - resource
+ - resource_owner
+ operationId: get-v1-token-info
+ description: Returns scope and resource information associated with the current access token.
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: getInfo
+ "/oauth/token":
+ post:
+ summary: create or refresh an access token
+ operationId: oauth-access-token
+ security: []
+ description: |-
+ Creates or refreshes a system access token
+
+ scope: ``
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used.
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - type: object
+ 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
+ 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
+ tags:
+ - Introspection
+ responses:
+ '200':
+ description: Refresh access token
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Authentication"
+ "/v1/partner_managed_companies":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ operationId: post-v1-partner-managed-companies
+ summary: Create a partner managed company
+ tags:
+ - Companies
+ description: "Create a partner managed company. When you successfully call the API, it does the following:\n* Creates a new company in Gusto\n* Creates a new user using the provided email if the user does not already exist.\n* Makes the user the primary payroll administrator of the new company.\n\nIn response, you will receive oauth access tokens for the created company.\n\nIMPORTANT: 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.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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)"
+ requestBody:
+ 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
+ security:
+ - SystemAccessAuth: []
+ 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
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '401':
+ description: Authorization information is missing or invalid.
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: createPartnerManaged
+ "/v1/companies/{company_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a company
+ operationId: get-v1-companies
+ description: "Get a company. \nThe employees:read scope is required to return home_address and non-work locations. \nThe company_admin:read scope is required to return primary_payroll_admin. \nThe signatories:read scope is required to return primary_signatory. \n\nscope: `companies:read`"
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ tags:
+ - Companies
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a company
+ operationId: put-v1-companies
+ description: |-
+ Update a company.
+
+ scope: `companies:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ examples:
+ Example:
+ value:
+ contractor_only: false
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ tags:
+ - Companies
+ x-speakeasy-name-override: update
+ "/v1/partner_managed_companies/{company_uuid}/migrate":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Migrate company to embedded payroll
+ operationId: put-v1-partner-managed-companies-company-uuid-migrate
+ tags:
+ - Companies
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ 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
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-name-override: migrate
+ "/v1/partner_managed_companies/{company_uuid}/accept_terms_of_service":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Accept terms of service for a company user
+ operationId: post-partner-managed-companies-company_uuid-accept_terms_of_service
+ tags:
+ - Companies
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ 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.
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: acceptTermsOfService
+ "/v1/partner_managed_companies/{company_uuid}/retrieve_terms_of_service":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Retrieve terms of service status for a company user
+ operationId: post-partner-managed-companies-company_uuid-retrieve_terms_of_service
+ tags:
+ - Companies
+ description: |-
+ Retrieve the user acceptance status of the Gusto Embedded Payroll's [Terms of Service](https://flows.gusto.com/terms).
+
+ scope: `terms_of_services:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ 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
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: retrieveTermsOfService
+ "/v1/invoices/{invoice_period}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Retrieve invoicing data for companies
+ operationId: get-invoices-invoice-period
+ tags:
+ - Invoices
+ 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) \n\n> \U0001F4D8 System Access Authentication\n>\n> 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)\n\nscope: `invoices:read`"
+ security:
+ - SystemAccessAuth: []
+ parameters:
+ - "$ref": "#/components/parameters/invoice_period"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - 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`
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Invoice-Data-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: get
+ "/v1/companies/{company_id}/attachments/{company_attachment_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get Company Attachment Details
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Attachment-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-attachment
+ description: |-
+ Retrieve the detail of an attachment uploaded by the company.
+
+ scope: `company_attachments:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/company_attachment_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Attachment
+ x-speakeasy-group: companyAttachments
+ x-speakeasy-name-override: getDetails
+ "/v1/companies/{company_id}/attachments/{company_attachment_uuid}/download_url":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a temporary url to download the Company Attachment file
+ 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':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-attachment-url
+ description: |-
+ Retrieve a temporary url to download a attachment file uploaded
+ by the company.
+
+ scope: `company_attachments:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/company_attachment_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Attachment
+ x-speakeasy-group: companyAttachment
+ x-speakeasy-name-override: getDownloadUrl
+ "/v1/companies/{company_id}/attachments":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get List of Company Attachments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Attachment-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-attachments
+ description: |-
+ Retrieve a list of all the attachments uploaded by the company.
+
+ scope: `company_attachments:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Attachment
+ x-speakeasy-group: companyAttachments
+ x-speakeasy-name-override: getList
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create Company Attachment and Upload File
+ responses:
+ '201':
+ "$ref": "#/components/responses/Company-Attachment-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ operationId: post-v1-companies-attachment
+ description: "Upload a file and create a company attachment. We recommend uploading\nPDF files for optimal compatibility. However, the following file types are\nallowed: .qbb, .qbm, .gif, .jpg, .png, .pdf, .xls, .xlsx, .doc and .docx. \n\nscope: `company_attachments:write`"
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Attachment
+ requestBody:
+ 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
+ x-speakeasy-group: companyAttachments
+ x-speakeasy-name-override: create
+ "/v1/companies/{company_id}/federal_tax_details":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get Federal Tax Details
+ responses:
+ '200':
+ "$ref": "#/components/responses/Federal-Tax-Details-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-federal_tax_details
+ description: |-
+ Fetches attributes relevant for a company's federal taxes.
+
+ scope: `company_federal_taxes:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Federal Tax Details
+ x-speakeasy-group: federalTaxDetails
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update Federal Tax Details
+ responses:
+ '200':
+ "$ref": "#/components/responses/Federal-Tax-Details-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_id-federal_tax_details
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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:
+ - 941 (Quarterly federal tax return)
+ - 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:'
+ description: |-
+ 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`
+ tags:
+ - Federal Tax Details
+ x-speakeasy-group: federalTaxDetails
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_id}/industry_selection":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a company industry selection
+ tags:
+ - Industry Selection
+ operationId: get-v1-company-industry
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get industry selection for the company.
+
+ scope: `companies:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Industry-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: industrySelection
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a company industry selection
+ tags:
+ - Industry Selection
+ operationId: put-v1-company-industry
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Update the company industry selection by passing in industry classification codes: [NAICS code](https://www.naics.com), [SICS code](https://siccode.com/) and industry title. Our UI is leveraging [Middesk API](https://docs.middesk.com/reference/introduction) to determine industry classification codes.
+
+ scope: `companies:write`
+ responses:
+ '201':
+ "$ref": "#/components/responses/Industry-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ description: ''
+ type: object
+ properties:
+ title:
+ type: string
+ description: Industry title
+ naics_code:
+ type: string
+ 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
+ items:
+ type: string
+ description: A list of Standard Industrial Classification (SIC) codes, which are four digit number that categorize the industries that companies belong to based on their business activities. If sic_codes is not passed in, we will perform an internal lookup with naics_code.
+ required:
+ - naics_code
+ examples:
+ Example:
+ value:
+ title: Computer Training
+ naics_code: '611420'
+ sic_codes:
+ - '8243'
+ x-speakeasy-group: industrySelection
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_id}/admins":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create an admin for the company
+ tags:
+ - Companies
+ operationId: post-v1-companies-company_id-admins
+ responses:
+ '200':
+ "$ref": "#/components/responses/Admin-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ x-speakeasy-name-override: createAdmin
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all the admins at a company
+ tags:
+ - Companies
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ operationId: get-v1-companies-company_id-admins
+ responses:
+ '200':
+ "$ref": "#/components/responses/Admin-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ Returns a list of all the admins at a company
+
+ scope: `company_admin:read`
+ x-speakeasy-name-override: listAdmins
+ "/v1/companies/{company_uuid}/signatories":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a signatory
+ tags:
+ - Signatories
+ operationId: post-v1-company-signatories
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Create a company signatory with complete information.
+ 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.
+
+ scope: `signatories:manage`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Signatory-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ description: ''
+ properties:
+ ssn:
+ type: string
+ first_name:
+ type: string
+ middle_initial:
+ type: string
+ last_name:
+ type: string
+ email:
+ type: string
+ title:
+ type: string
+ phone:
+ type: string
+ birthday:
+ type: string
+ 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
+ required:
+ - street_1
+ - city
+ - state
+ - zip
+ required:
+ - ssn
+ - first_name
+ - last_name
+ - email
+ - title
+ - birthday
+ - home_address
+ - phone
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all company signatories
+ responses:
+ '200':
+ "$ref": "#/components/responses/Signatory-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_uuid-signatories
+ description: |-
+ Returns company signatories. Currently we only support a single signatory per company.
+
+ scope: `signatories:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Signatories
+ x-speakeasy-name-override: list
+ "/v1/companies/{company_uuid}/signatories/invite":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Invite a signatory
+ responses:
+ '200':
+ "$ref": "#/components/responses/Signatory-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_uuid-signatories-invite
+ description: Create a signatory with minimal information. This signatory can be invited to provide more information through the `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.
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ first_name:
+ type: string
+ last_name:
+ type: string
+ title:
+ type: string
+ email:
+ type: string
+ required:
+ - email
+ tags:
+ - Signatories
+ x-speakeasy-name-override: invite
+ "/v1/companies/{company_uuid}/signatories/{signatory_uuid}":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a signatory
+ responses:
+ '200':
+ "$ref": "#/components/responses/Signatory-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_uuid-signatories-signatory_uuid
+ description: |-
+ Update a signatory that has been either invited or created. If the signatory has been created with minimal information through the `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.
+
+ scope: `signatories:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/signatory_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ version:
+ type: string
+ description: The current version of the object. See the versioning guide for information on how to use this field.
+ first_name:
+ type: string
+ middle_initial:
+ type: string
+ last_name:
+ type: string
+ title:
+ type: string
+ phone:
+ type: string
+ birthday:
+ type: string
+ ssn:
+ type: string
+ home_address:
+ type: object
+ properties:
+ street_1:
+ type: string
+ street_2:
+ type: string
+ city:
+ type: string
+ state:
+ type: string
+ zip:
+ type: string
+ tags:
+ - Signatories
+ x-speakeasy-name-override: update
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ summary: Delete a signatory
+ operationId: delete-v1-companies-company_uuid-signatories-signatory_uuid
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ Delete a company signatory.
+
+ scope: `signatories:manage`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/signatory_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Signatories
+ x-speakeasy-name-override: delete
+ "/v1/companies/{company_uuid}/onboarding_status":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get the company's onboarding status
+ operationId: get-v1-company-onboarding-status
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - schema:
+ type: string
+ example: external_payroll
+ in: query
+ name: additional_steps
+ description: Comma delimited string indicating whether to include any additional steps of onboarding. Currently only supports the value "external_payroll".
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get company's onboarding status.
+ The data returned helps inform the required onboarding steps and respective completion status.
+
+ scope: `company_onboarding_status:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Onboarding-Status-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ tags:
+ - Companies
+ x-speakeasy-name-override: getOnboardingStatus
+ "/v1/companies/{company_uuid}/finish_onboarding":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Finish company onboarding
+ operationId: get-v1-company-finish-onboarding
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Finalize a given 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`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Onboarding-Status-Finish-Onboarding-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ tags:
+ - Companies
+ x-speakeasy-name-override: finishOnboarding
+ "/v1/companies/{company_id}/custom_fields":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: 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
+
+ scope: `companies:read`
+ operationId: get-v1-companies-company_id-custom_fields
+ tags:
+ - Companies
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Custom-Field-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getCustomFields
+ "/v1/companies/{company_uuid}/flows":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a flow
+ tags:
+ - Flows
+ operationId: post-v1-company-flows
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ 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.
+
+ scope: `flows:write`
+ responses:
+ '201':
+ "$ref": "#/components/responses/Flow-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ flow_type:
+ type: string
+ description: flow type
+ entity_uuid:
+ type: string
+ description: UUID of the target entity applicable to the flow. This field is optional for company flows, please refer to the flow_types table above for more details.
+ entity_type:
+ type: string
+ description: the type of target entity applicable to the flow. This field is optional for company flows, please refer to the flow_types table above for more details.
+ enum:
+ - Company
+ - Employee
+ 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 (e.g., { "provider": "guideline" }).'
+ additionalProperties: true
+ required:
+ - flow_type
+ examples:
+ Example:
+ value:
+ flow_type: company_retirement_benefits
+ Example with options:
+ value:
+ flow_type: company_retirement_benefits
+ entity_type: Company
+ options:
+ provider: guideline
+ x-speakeasy-name-override: create
+ "/v1/companies/{company_id}/locations":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a company location
+ responses:
+ '201':
+ "$ref": "#/components/responses/Location-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-locations
+ description: |-
+ Company locations represent all addresses associated with a company. These can be filing addresses, mailing addresses, and/or work locations; one address may serve multiple, or all, purposes.
+
+ Since all company locations are subsets of locations, retrieving or updating an individual record should be done via the locations endpoints.
+
+ scope: `companies:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ description: ''
+ type: object
+ properties:
+ phone_number:
+ type: string
+ pattern: "[0-9]{10}"
+ street_1:
+ type: string
+ street_2:
+ type: string
+ nullable: true
+ city:
+ type: string
+ state:
+ type: string
+ zip:
+ type: string
+ 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
+ examples:
+ Example:
+ value:
+ phone_number: '8009360383'
+ street_1: 425 2nd Street
+ street_2: Suite 602
+ city: San Francisco
+ state: CA
+ zip: '94107'
+ country: USA
+ description: Create a company location.
+ tags:
+ - Locations
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get company locations
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Location-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-locations
+ description: |-
+ Company locations represent all addresses associated with a company. These can be filing addresses, mailing addresses, and/or work locations; one address may serve multiple, or all, purposes.
+
+ Since all company locations are subsets of locations, retrieving or updating an individual record should be done via the locations endpoints.
+
+ scope: `companies:read`
+ tags:
+ - Locations
+ x-speakeasy-name-override: get
+ "/v1/locations/{location_id}":
+ get:
+ summary: Get a location
+ operationId: get-v1-locations-location_id
+ description: |-
+ Get a location.
+
+ scope: `companies:read`
+ tags:
+ - Locations
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Location"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: retrieve
+ put:
+ summary: Update a location
+ operationId: put-v1-locations-location_id
+ description: |-
+ Update a location.
+
+ scope: `companies:write`
+ tags:
+ - Locations
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Location"
+ '422':
+ description: Invalid state
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '409':
+ description: Invalid version param
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ nullable: true
+ 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
+ x-speakeasy-name-override: update
+ "/v1/locations/{location_uuid}/minimum_wages":
+ get:
+ summary: Get minimum wages for a location
+ operationId: get-v1-locations-location_uuid-minimum_wages
+ description: |-
+ Get minimum wages for a location
+
+ scope: `companies:read`
+ tags:
+ - Locations
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Minimum-Wage-List"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: getMinimumWages
+ "/v1/companies/{company_id}/bank_accounts":
+ get:
+ summary: Get all company bank accounts
+ operationId: get-v1-companies-company_id-bank-accounts
+ description: |-
+ Returns company bank accounts. Currently, we only support a single default bank account per company.
+
+ scope: `company_bank_accounts:read`
+ tags:
+ - Bank Accounts
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Company-Bank-Account"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: bankAccounts
+ x-speakeasy-name-override: get
+ post:
+ summary: Create a company bank account
+ operationId: post-v1-companies-company_id-bank-accounts
+ description: "This endpoint creates a new company bank account.\n\nUpon being created, two verification deposits are automatically sent to the bank account, and the bank account's verification_status is 'awaiting_deposits'.\n\nWhen 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.\nAfter successful verification, the bank account's verification_status is 'verified'.\n\n\n>\U0001F6A7 Warning\n>\n> 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.\n\nscope: `company_bank_accounts:write`"
+ tags:
+ - Bank Accounts
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '201':
+ description: created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Bank-Account"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: Invalid Attribute
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Bank-Account-Request"
+ required: true
+ x-speakeasy-group: bankAccounts
+ x-speakeasy-name-override: create
+ "/v1/companies/{company_id}/bank_accounts/{bank_account_uuid}/verify":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Verify a company bank account
+ operationId: put-v1-companies-company_id-bank-accounts-verify
+ tags:
+ - Bank Accounts
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Bank-Account-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ 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
+
+ We provide the endpoint `POST '/v1/companies/{company_id}/bank_accounts/{bank_account_uuid}/send_test_deposits'` to facilitate bank account verification in the demo environment. This endpoint simulates the micro-deposits transfer and returns them in the response. You can call this endpoint as many times as you wish to retrieve the values of the two micro deposits.
+
+ ```
+ POST '/v1/companies/89771af8-b964-472e-8064-554dfbcb56d9/bank_accounts/ade55e57-4800-4059-9ecd-fa29cfeb6dd2/send_test_deposits'
+
+ {
+ "deposit_1": 0.02,
+ "deposit_2": 0.42
+ }
+ ```
+
+ scope: `company_bank_accounts:write`
+ parameters:
+ - "$ref": "#/components/parameters/bank_account_uuid"
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ description: ''
+ type: object
+ properties:
+ deposit_1:
+ type: number
+ nullable: false
+ description: The dollar amount of the first micro-deposit
+ deposit_2:
+ type: number
+ nullable: false
+ description: The dollar amount of the second micro-deposit
+ required:
+ - deposit_1
+ - deposit_2
+ examples:
+ Example:
+ value:
+ deposit_1: 0.02
+ deposit_2: 0.42
+ x-speakeasy-group: bankAccounts
+ x-speakeasy-name-override: verify
+ "/v1/companies/{company_uuid}/external_payrolls":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a new external payroll for a company
+ tags:
+ - External Payrolls
+ responses:
+ '200':
+ "$ref": "#/components/responses/External-Payroll-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-external-payroll
+ description: |-
+ Creates a new external payroll for the company.
+
+ scope: `external_payrolls:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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'
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get external payrolls for a company
+ tags:
+ - External Payrolls
+ operationId: get-v1-company-external-payrolls
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get an external payroll for a given company.
+
+ scope: `external_payrolls:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/External-Payroll-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: get
+ "/v1/companies/{company_uuid}/external_payrolls/{external_payroll_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get an external payroll
+ tags:
+ - External Payrolls
+ operationId: get-v1-external-payroll
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/external_payroll_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get an external payroll for a given company.
+
+ scope: `external_payrolls:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/External-Payroll-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: retrieve
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ summary: Delete an external payroll
+ tags:
+ - External Payrolls
+ operationId: delete-v1-external-payroll
+ description: |-
+ Delete an external payroll.
+
+ scope: `external_payrolls:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/external_payroll_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: delete
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update an external payroll
+ tags:
+ - External Payrolls
+ operationId: put-v1-external-payroll
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/external_payroll_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/External-Payroll-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ Update an external payroll with a list of external payroll items
+
+ scope: `external_payrolls:write`
+ requestBody:
+ 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
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_uuid}/external_payrolls/{external_payroll_id}/calculate_taxes":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get tax suggestions for an external payroll
+ tags:
+ - External Payrolls
+ operationId: get-v1-external-payroll-calculate-taxes
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/external_payroll_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ 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`
+ responses:
+ '200':
+ "$ref": "#/components/responses/External-Payroll-Tax-Suggestions-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: calculateTaxes
+ "/v1/companies/{company_uuid}/external_payrolls/tax_liabilities":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get tax liabilities
+ tags:
+ - External Payrolls
+ operationId: get-v1-tax-liabilities
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get tax liabilities from aggregate external payrolls for a company.
+
+ scope: `external_payrolls:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Tax-Liabilities-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: listTaxLiabilities
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update tax liabilities
+ tags:
+ - External Payrolls
+ operationId: put-v1-tax-liabilities
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Tax-Liabilities-List"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ Update tax liabilities for a company.
+
+ scope: `external_payrolls:write`
+ requestBody:
+ 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
+ description: The UUID of the last unpaid external payroll uuid. It should be null when the full amount of tax liability has been paid.
+ nullable: true
+ 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.0
+ - tax_id: 2
+ last_unpaid_external_payroll_uuid: 5ed14dbb-958f-47c8-b16e-c4fed82dc486
+ unpaid_liability_amount: 400.0
+ - tax_id: 8
+ last_unpaid_external_payroll_uuid:
+ unpaid_liability_amount: 0.0
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: updateTaxLiabilities
+ "/v1/companies/{company_uuid}/external_payrolls/tax_liabilities/finish":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Finalize tax liabilities options and convert into processed payrolls
+ tags:
+ - External Payrolls
+ operationId: put-v1-tax-liabilities-finish
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '202':
+ description: Accepted
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ Finalizes tax liabilities for a company. All external payrolls edit action will be disabled.
+
+ scope: `external_payrolls:write`
+ x-speakeasy-group: externalPayrolls
+ x-speakeasy-name-override: finalizeTaxLiabilities
+ "/v1/companies/{company_uuid}/payment_configs":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a company's payment configs
+ tags:
+ - Payment Configs
+ operationId: get-v1-company-payment-configs
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get payment speed configurations for the company and fast payment limit (1-day is only applicable to partners that opt in).
+
+ scope: `company_payment_configs:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Payment-Configs-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: get
+ x-speakeasy-group: paymentConfigs
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a company's payment configs
+ tags:
+ - Payment Configs
+ operationId: put-v1-company-payment-configs
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Update payment speed and fast payment limit for a company. At least one of `payment_speed` or `fast_payment_limit` parameters is required. 1-day option is only applicable to partners that opt in.
+
+ scope: `company_payment_configs:write`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Payment-Configs-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - "$ref": "#/components/schemas/Fast-Payment-Limit-Required-Body"
+ - "$ref": "#/components/schemas/Payment-Speed-Required-Body"
+ examples:
+ Example:
+ value:
+ fast_payment_limit: '5000'
+ payment_speed: 2-day
+ x-speakeasy-group: paymentConfigs
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_id}/pay_schedules":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a new pay schedule
+ responses:
+ '201':
+ "$ref": "#/components/responses/Pay-Schedule-Create-Update-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-pay_schedules
+ 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.
+
+ 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.
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Pay Schedules
+ requestBody:
+ 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
+ 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.
+ nullable: true
+ 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
+ nullable: true
+ 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
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get the pay schedules for a company
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Pay-Schedule-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-pay_schedules
+ 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.
+
+ scope: `pay_schedules:read`
+ tags:
+ - Pay Schedules
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: getAll
+ "/v1/companies/{company_id}/pay_schedules/preview":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Preview pay schedule dates
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - 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
+ - "$ref": "#/components/parameters/VersionHeader"
+ 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
+ operationId: get-v1-companies-company_id-pay_schedules-preview
+ description: |-
+ Provides a preview of a pay schedule with the specified parameters for the next 18 months.
+
+ scope: `pay_schedules:write`
+ tags:
+ - Pay Schedules
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: getPreview
+ "/v1/companies/{company_id}/pay_schedules/{pay_schedule_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a pay schedule
+ responses:
+ '200':
+ "$ref": "#/components/responses/Pay-Schedule-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-pay_schedules-pay_schedule_id
+ 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.
+
+ scope: `pay_schedules:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/pay_schedule_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Pay Schedules
+ x-speakeasy-name-override: get
+ x-speakeasy-group: paySchedules
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a pay schedule
+ tags:
+ - Pay Schedules
+ responses:
+ '200':
+ "$ref": "#/components/responses/Pay-Schedule-Create-Update-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_id-pay_schedules-pay_schedule_id
+ description: |-
+ 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.
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/pay_schedule_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ 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.
+ nullable: true
+ 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
+ nullable: true
+ 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
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_id}/pay_periods":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get pay periods for a company
+ tags:
+ - Pay Schedules
+ responses:
+ '200':
+ "$ref": "#/components/responses/Pay-Period-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-pay_periods
+ description: |-
+ 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 payrolls#prepare endpoint.
+
+ scope: `payrolls:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/start_date"
+ - "$ref": "#/components/parameters/end_date"
+ - "$ref": "#/components/parameters/payroll_types"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: getPayPeriods
+ "/v1/companies/{company_id}/pay_periods/unprocessed_termination_pay_periods":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get termination pay periods for a company
+ tags:
+ - Pay Schedules
+ responses:
+ '200':
+ "$ref": "#/components/responses/Unprocessed-Termination-Pay-Period-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-unprocessed_termination_pay_periods
+ 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.
+
+ This endpoint returns the unprocessed pay periods for past and future terminated employees in a given company.
+
+ scope: `payrolls:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: getUnprocessedTerminationPeriods
+ "/v1/companies/{company_id}/pay_schedules/assignments":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get pay schedule assignments for a company
+ responses:
+ '200':
+ "$ref": "#/components/responses/Pay-Schedule-Assignment-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-pay_schedules-assignments
+ 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.
+
+ scope: `pay_schedules:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Pay Schedules
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: getAssignments
+ "/v1/companies/{company_id}/pay_schedules/assignment_preview":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Preview pay schedule assignments for a company
+ responses:
+ '200':
+ "$ref": "#/components/responses/Pay-Schedule-Assignment-Preview-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-pay_schedules-assignment_preview
+ description: |-
+ This endpoint returns the employee changes, including pay period and transition pay periods, for changing the pay schedule.
+
+ scope: `pay_schedules:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Pay Schedules
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: previewAssignment
+ "/v1/companies/{company_id}/pay_schedules/assign":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Assign pay schedules for a company
+ responses:
+ '200':
+ description: No Content
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-pay_schedules-assign
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Pay Schedules
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ x-speakeasy-group: paySchedules
+ x-speakeasy-name-override: assign
+ "/v1/companies/{company_id}/employees":
+ get:
+ summary: Get employees of a company
+ operationId: get-v1-companies-company_id-employees
+ description: |-
+ Get all of the employees, onboarding, active and terminated, for a given company.
+
+ scope: `employees:read`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Show-Employees"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: list
+ post:
+ summary: Create an employee
+ operationId: post-v1-employees
+ description: |-
+ Create an employee.
+
+ scope: `employees:manage`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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
+ responses:
+ '201':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: invalid attributes
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ format: email
+ description: The employee's personal email address.
+ 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
+ x-speakeasy-name-override: create
+ "/v1/companies/{company_id}/employees/payment_details":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get employee payment details for a company
+ operationId: get-v1-companies-company_id-employees-payment_details
+ tags:
+ - Employees
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - 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.
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ description: A list of employee payment details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/EmployeePaymentDetailsList"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ "/v1/companies/{company_uuid}/historical_employees":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a historical employee
+ operationId: post-v1-historical_employees
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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:
+ 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.
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Create a historical employee, an employee that was previously dismissed from the company in the current year.
+
+ scope: `employees:manage`
+ responses:
+ '201':
+ "$ref": "#/components/responses/Historical-Employee-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ tags:
+ - Employees
+ x-speakeasy-name-override: createHistorical
+ "/v1/companies/{company_uuid}/historical_employees/{historical_employee_uuid}":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a historical employee
+ operationId: put-v1-historical_employees
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - "$ref": "#/components/schemas/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:
+ 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.
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/historical_employee_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Update a historical employee, an employee that was previously dismissed from the company in the current year.
+
+ scope: `employees:manage`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Historical-Employee-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ tags:
+ - Employees
+ x-speakeasy-group: historicalEmployees
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_uuid}/departments":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: post-departments
+ summary: Create a department
+ tags:
+ - Departments
+ description: |-
+ Create a department
+
+ scope: `departments:write`
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ title:
+ type: string
+ examples:
+ Example:
+ value:
+ title: Stage Hand
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '201':
+ "$ref": "#/components/responses/Department-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all departments of a company
+ operationId: get-companies-departments
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get all of the departments for a given company with the employees and contractors assigned to that department.
+
+ scope: `departments:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Department-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ tags:
+ - Departments
+ x-speakeasy-name-override: getAll
+ "/v1/departments/{department_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: get-department
+ summary: Get a department
+ tags:
+ - Departments
+ description: |
+ Get a department given the UUID
+
+ scope: `departments:read`
+ parameters:
+ - "$ref": "#/components/parameters/department_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Department-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: put-departments
+ summary: Update a department
+ tags:
+ - Departments
+ description: |-
+ Update a department
+
+ scope: `departments:write`
+ parameters:
+ - "$ref": "#/components/parameters/department_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ responses:
+ '200':
+ "$ref": "#/components/responses/Department-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: update
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: delete-department
+ summary: Delete a department
+ tags:
+ - Departments
+ description: |
+ Delete a department. You cannot delete a department until all employees and contractors have been removed.
+
+ scope: `departments:write`
+ parameters:
+ - "$ref": "#/components/parameters/department_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: delete
+ "/v1/departments/{department_uuid}/add":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: put-add-people-to-department
+ summary: Add people to a department
+ tags:
+ - Departments
+ description: |
+ Add employees and contractors to a department
+
+ scope: `departments:write`
+ parameters:
+ - "$ref": "#/components/parameters/department_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ responses:
+ '200':
+ "$ref": "#/components/responses/Department-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: addPeople
+ "/v1/departments/{department_uuid}/remove":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: put-remove-people-from-department
+ summary: Remove people from a department
+ tags:
+ - Departments
+ description: |
+ Remove employees and contractors from a department
+
+ scope: `departments:write`
+ parameters:
+ - "$ref": "#/components/parameters/department_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ responses:
+ '200':
+ "$ref": "#/components/responses/Department-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: removePeople
+ "/v1/employees/{employee_id}":
+ get:
+ summary: Get an employee
+ operationId: get-v1-employees
+ description: |-
+ Get an employee.
+
+ scope: `employees:read`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: get
+ put:
+ summary: Update an employee.
+ operationId: put-v1-employees
+ description: |-
+ Update an employee.
+
+ scope: `employees:write`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee"
+ '409':
+ description: invalid version
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: invalid attributes
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - type: object
+ properties:
+ first_name:
+ type: string
+ example: Weezy
+ middle_initial:
+ type: string
+ nullable: true
+ 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
+ nullable: true
+ 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
+ nullable: false
+ example: new.partner.work@example.com
+ required: true
+ x-speakeasy-name-override: update
+ delete:
+ summary: Delete an onboarding employee
+ operationId: delete-v1-employee
+ description: |-
+ 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`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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
+ responses:
+ '204':
+ description: successful
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: cannot delete onboarded employee
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: delete
+ "/v1/employees/{employee_id}/terminations":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create an employee termination
+ tags:
+ - Employee Employments
+ responses:
+ '201':
+ "$ref": "#/components/responses/Termination-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-employees-employee_id-terminations
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ x-speakeasy-name-override: createTermination
+ x-speakeasy-group: employeeEmployments
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get terminations for an employee
+ tags:
+ - Employee Employments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Termination-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-terminations
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: getTerminations
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete an employee termination
+ operationId: delete-v1-employees-employee_id-terminations
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Employment-Not-Found-Error-Object"
+ description: |-
+ Delete an employee termination.
+
+ scope: `employments:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Employee Employments
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: deleteTermination
+ "/v1/terminations/{employee_id}":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update an employee termination
+ tags:
+ - Employee Employments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Termination-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Employment-Not-Found-Error-Object"
+ operationId: put-v1-terminations-employee_id
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: updateTermination
+ "/v1/employees/{employee_id}/rehire":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create an employee rehire
+ tags:
+ - Employee Employments
+ responses:
+ '201':
+ "$ref": "#/components/responses/Rehire-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-employees-employee_id-rehire
+ description: |-
+ Rehire is created whenever an employee is scheduled to return to the company.
+
+ scope: `employments:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Rehire-Body"
+ examples:
+ Example:
+ value:
+ effective_date: '2023-06-30'
+ work_location_uuid: b6ae9d93-d4b8-4119-8c96-dba595dd8c30
+ file_new_hire_report: true
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: createRehire
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update an employee rehire
+ tags:
+ - Employee Employments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Rehire-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Employment-Not-Found-Error-Object"
+ operationId: put-v1-employees-employee_id-rehire
+ description: |-
+ Update an employee's rehire.
+
+ scope: `employments:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - "$ref": "#/components/schemas/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
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: rehire
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get an employee rehire
+ tags:
+ - Employee Employments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Rehire-Object"
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Employment-Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-rehire
+ description: |-
+ Retrieve an employee's rehire, which contains information on when the employee returns to work.
+
+ scope: `employments:read`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: getRehire
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete an employee rehire
+ description: |-
+ Delete an employee rehire. An employee rehire cannot be deleted if it's active (past effective date).
+
+ scope: `employments:write`
+ operationId: delete-v1-employees-employee_id-rehire
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Employment-Not-Found-Error-Object"
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Employee Employments
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: deleteRehire
+ "/v1/employees/{employee_id}/employment_history":
+ get:
+ summary: Get employment history for an employee
+ operationId: get-v1-employees-employee_id-employment_history
+ description: |-
+ Retrieve the employment history for a given employee, which includes termination and rehire.
+
+ scope: `employments:read`
+ tags:
+ - Employee Employments
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employment-History-List"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: employeeEmployments
+ x-speakeasy-name-override: getHistory
+ "/v1/employees/{employee_id}/home_addresses":
+ get:
+ summary: Get an employee's home addresses
+ operationId: get-v1-employees-employee_id-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.
+
+ Supports home address effective dating and courtesy withholding.
+
+ scope: `employees:read`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Address-List"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: get
+ post:
+ summary: Create an employee's home address
+ operationId: post-v1-employees-employee_id-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.
+
+ Supports home address effective dating and courtesy withholding.
+
+ scope: `employees:write`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '201':
+ description: created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Address"
+ '422':
+ description: unprocessable entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ street_1:
+ type: string
+ example: 300 3rd Street
+ street_2:
+ type: string
+ nullable: true
+ city:
+ type: string
+ example: San Francisco
+ state:
+ type: string
+ example: CA
+ zip:
+ type: string
+ example: '94107'
+ effective_date:
+ type: string
+ format: date
+ nullable: true
+ example: '2022-01-31'
+ courtesy_withholding:
+ type: boolean
+ required: true
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: create
+ "/v1/home_addresses/{home_address_uuid}":
+ get:
+ summary: Get an employee's home address
+ operationId: get-v1-home_addresses-home_address_uuid
+ 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.
+
+ Supports home address effective dating and courtesy withholding.
+
+ scope: `employees:read`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Address"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: retrieveHomeAddress
+ put:
+ summary: Update an employee's home address
+ operationId: put-v1-home_addresses-home_address_uuid
+ 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.
+
+ Supports home address effective dating and courtesy withholding.
+
+ scope: `employees:write`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Address"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: unprocessable entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - type: object
+ properties:
+ street_1:
+ type: string
+ street_2:
+ type: string
+ nullable: true
+ city:
+ type: string
+ state:
+ type: string
+ zip:
+ type: string
+ effective_date:
+ type: string
+ format: date
+ nullable: true
+ courtesy_withholding:
+ type: boolean
+ required: true
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: update
+ delete:
+ summary: Delete an employee's home address
+ operationId: delete-v1-home_addresses-home_address_uuid
+ description: |-
+ Used for deleting an employee's home address. Cannot delete the employee's active home address.
+
+ scope: `employees:write`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '204':
+ description: successful
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: unprocessable entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: delete
+ "/v1/employees/{employee_id}/work_addresses":
+ get:
+ summary: Get an employee's work addresses
+ operationId: get-v1-employees-employee_id-work_addresses
+ description: |-
+ 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`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: List of employee work addresses
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Work-Addresses-List"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: getWorkAddresses
+ post:
+ summary: Create an employee work address
+ operationId: post-v1-employees-employee_id-work_addresses
+ description: |-
+ The work address of an employee describes when an employee began working at an associated company location.
+
+ scope: `employees:manage`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '201':
+ description: created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Work-Address"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: unprocessable entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: createWorkAddress
+ "/v1/work_addresses/{work_address_uuid}":
+ get:
+ summary: Get an employee work address
+ operationId: get-v1-work_addresses-work_address_uuid
+ description: |-
+ The work address of an employee is used for payroll tax purposes.
+
+ scope: `employees:read`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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.
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Work-Address"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: retrieveWorkAddress
+ put:
+ summary: Update an employee work address
+ operationId: put-v1-work_addresses-work_address_uuid
+ description: |-
+ The work address of an employee is used for payroll tax purposes.
+
+ scope: `employees:manage`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Work-Address"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: unprocessable entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: updateWorkAddress
+ delete:
+ summary: Delete an employee's work address
+ operationId: delete-v1-work_addresses-work_address_uuid
+ description: |-
+ Used for deleting an employee's work address. Cannot delete the employee's active work address.
+
+ scope: `employees:manage`
+ tags:
+ - Employee Addresses
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ 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.
+ responses:
+ '204':
+ description: no content
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: unprocessable entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: employeeAddresses
+ x-speakeasy-name-override: deleteWorkAddress
+ "/v1/employees/{employee_id}/custom_fields":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get an employee's custom fields
+ tags:
+ - Employees
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ custom_fields:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-Custom-Field"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-custom_fields
+ description: |-
+ Returns a list of the employee's custom fields.
+
+ scope: `employees:read`
+ x-speakeasy-name-override: getCustomFields
+ "/v1/employees/{employee_id}/onboarding_documents_config":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update an employee's onboarding documents config
+ tags:
+ - Employees
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Onboarding-Documents-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-employees-employee_id-onboarding_documents_config
+ description: |-
+ Indicate whether to include the Form I-9 for an employee during the onboarding process.
+
+ scope: `employees:manage`
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ i9_document:
+ type: boolean
+ description: Whether to include Form I-9 for an employee during onboarding
+ examples:
+ Example:
+ value:
+ i9_document: true
+ x-speakeasy-name-override: updateOnboardingDocumentsConfig
+ "/v1/employees/{employee_id}/onboarding_status":
+ get:
+ summary: Get the employee's onboarding status
+ operationId: get-v1-employees-employee_id-onboarding_status
+ description: |-
+ # 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`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Onboarding-Status"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: getOnboardingStatus
+ put:
+ summary: Update the employee's onboarding status
+ operationId: put-v1-employees-employee_id-onboarding_status
+ description: |-
+ 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`
+ tags:
+ - Employees
+ x-gusto-integration-type:
+ - embedded
+ security:
+ - CompanyAccessAuth: []
+ 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
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Onboarding-Status"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: invalid status transition
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-name-override: updateOnboardingStatus
+ "/v1/employees/{employee_uuid}/federal_taxes":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get an employee's federal taxes
+ tags:
+ - Employee Tax Setup
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Federal-Tax-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-federal_taxes
+ description: |-
+ Get attributes relevant for an employee's federal taxes.
+
+ scope: `employee_federal_taxes:read`
+ parameters:
+ - "$ref": "#/components/parameters/employee_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: employeeTaxSetup
+ x-speakeasy-name-override: getFederalTaxes
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update an employee's federal taxes
+ tags:
+ - Employee Tax Setup
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Federal-Tax-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-employees-employee_id-federal_taxes
+ description: |-
+ Update attributes relevant for an employee's federal taxes.
+
+ scope: `employee_federal_taxes:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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.
+ filing_status:
+ type: string
+ extra_withholding:
+ type: string
+ nullable: true
+ two_jobs:
+ type: boolean
+ dependents_amount:
+ type: string
+ other_income:
+ type: string
+ deductions:
+ type: string
+ w4_data_type:
+ type: string
+ federal_withholding_allowance:
+ type: integer
+ description: Only applicable when w4_data_type is 'pre_2020_w4'.
+ additional_withholding:
+ type: string
+ description: Only applicable when w4_data_type is 'pre_2020_w4'.
+ required:
+ - version
+ - w4_data_type
+ - filing_status
+ examples:
+ Example:
+ 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
+ x-speakeasy-group: employeeTaxSetup
+ x-speakeasy-name-override: updateFederalTaxes
+ "/v1/employees/{employee_uuid}/state_taxes":
+ get:
+ summary: Get an employee's state taxes
+ operationId: get-v1-employees-employee_id-state_taxes
+ description: |-
+ 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`
+ tags:
+ - Employee Tax Setup
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-State-Taxes-List"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: employeeTaxSetup
+ x-speakeasy-name-override: getStateTaxes
+ put:
+ summary: Update an employee's state taxes
+ operationId: put-v1-employees-employee_id-state_taxes
+ description: |-
+ 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`
+ tags:
+ - Employee Tax Setup
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-State-Taxes-List"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: unprocessable entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-State-Taxes-Request"
+ required: true
+ x-speakeasy-group: employeeTaxSetup
+ x-speakeasy-name-override: updateStateTaxes
+ "/v1/employees/{employee_id}/bank_accounts":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create an employee bank account
+ operationId: post-v1-employees-employee_id-bank_accounts
+ responses:
+ '201':
+ "$ref": "#/components/responses/Employee-Bank-Account-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ tags:
+ - Employee Payment Method
+ x-speakeasy-group: employeePaymentMethod
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all employee bank accounts
+ tags:
+ - Employee Payment Method
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ operationId: get-v1-employees-employee_id-bank_accounts
+ description: |-
+ Returns all employee bank accounts.
+
+ scope: `employee_payment_methods:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Bank-Account-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: employeePaymentMethods
+ x-speakeasy-name-override: getBankAccounts
+ "/v1/employees/{employee_id}/bank_accounts/{bank_account_uuid}":
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ summary: Delete an employee bank account
+ operationId: delete-v1-employees-employee_id-bank_accounts-bank_account_id
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/bank_account_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Employee Payment Method
+ x-speakeasy-group: employeePaymentMethod
+ x-speakeasy-name-override: deleteBankAccount
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update an employee bank account
+ operationId: put-v1-employees-employee_id-bank_accounts
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Bank-Account-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ Updates an employee bank account.
+
+ scope: `employee_payment_methods:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/bank_account_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ tags:
+ - Employee Payment Method
+ x-speakeasy-group: employeePaymentMethod
+ x-speakeasy-name-override: updateBankAccount
+ "/v1/employees/{employee_id}/payment_method":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get an employee's payment method
+ tags:
+ - Employee Payment Method
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Payment-Method-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-payment_method
+ description: |-
+ Fetches an employee's payment method. An employee payment method
+ describes how the payment should be split across the employee's associated
+ bank accounts.
+
+ scope: `employee_payment_methods:read`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: employeePaymentMethod
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update an employee's payment method
+ tags:
+ - Employee Payment Method
+ operationId: put-v1-employees-employee_id-payment_method
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Payment-Method-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ Updates an employee's payment method. Note that creating an employee
+ bank account will also update the employee's payment method.
+
+ scope: `employee_payment_methods:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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.
+ 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:
+ type: string
+ enum:
+ - Amount
+ - Percentage
+ 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 amount is in cents and the last `split` amount must be `null` to capture the remainder.
+ splits:
+ type: array
+ items:
+ type: object
+ properties:
+ uuid:
+ type: string
+ format: uuid
+ description: The bank account UUID
+ name:
+ type: string
+ description: The bank account name
+ priority:
+ description: The order of priority for each payment split, with priority 1 being the first bank account paid. Priority must be unique and sequential.
+ type: integer
+ 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%).
+ required:
+ - version
+ - type
+ 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:
+ 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: ''
+ x-speakeasy-group: employeePaymentMethod
+ x-speakeasy-name-override: update
+ "/v1/employees/{employee_id}/jobs":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a job
+ responses:
+ '201':
+ "$ref": "#/components/responses/Job-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-jobs-job_id
+ description: |-
+ Create a job.
+
+ scope: `jobs:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ description: Whether this job is eligible for workers' compensation coverage in the state of Washington (WA).
+ nullable: true
+ state_wc_class_code:
+ type: string
+ 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.
+ nullable: true
+ required:
+ - title
+ - hire_date
+ examples:
+ Example:
+ value:
+ title: Regional Manager
+ hire_date: '2020-12-21'
+ description: Create a job.
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: createJob
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get jobs for an employee
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - in: query
+ name: include
+ schema:
+ type: string
+ enum:
+ - all_compensations
+ description: |-
+ Available options:
+ - all_compensations: Include all effective dated compensations for each job instead of only the current compensation
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Job-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-jobs
+ description: |-
+ Get all of the jobs that an employee holds.
+
+ scope: `jobs:read`
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-name-override: getJobs
+ x-speakeasy-group: jobsAndCompensations
+ "/v1/employees/{employee_uuid}/time_off_activities":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get employee time off activities
+ responses:
+ '200':
+ "$ref": "#/components/responses/Time-Off-Activity-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-version-employees-time_off_activities
+ parameters:
+ - "$ref": "#/components/parameters/employee_uuid"
+ - "$ref": "#/components/parameters/time_off_type"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get employee time off activities.
+
+ scope: `employee_time_off_activities:read`
+ tags:
+ - Employees
+ x-speakeasy-name-override: getTimeOffActivities
+ "/v1/jobs/{job_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a job
+ responses:
+ '200':
+ "$ref": "#/components/responses/Job-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-jobs-job_id
+ parameters:
+ - "$ref": "#/components/parameters/job_id"
+ - in: query
+ name: include
+ schema:
+ type: string
+ enum:
+ - all_compensations
+ description: |-
+ Available options:
+ - all_compensations: Include all effective dated compensations for the job instead of only the current compensation
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get a job.
+
+ scope: `jobs:read`
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: getJob
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a job
+ responses:
+ '200':
+ "$ref": "#/components/responses/Job-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-jobs-job_id
+ description: |-
+ Update a job.
+
+ scope: `jobs:write`
+ parameters:
+ - "$ref": "#/components/parameters/job_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ description: Whether this job is eligible for workers' compensation coverage in the state of Washington (WA).
+ nullable: true
+ state_wc_class_code:
+ type: string
+ 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.
+ nullable: true
+ required:
+ - version
+ examples:
+ Example:
+ value:
+ version: gr78930htutrz444kuytr3s5hgxykuveb523fwl8sir
+ title: Regional Manager
+ hire_date: '2020-12-21'
+ description: Update a job.
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-name-override: update
+ x-speakeasy-group: jobsAndCompensations
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete an individual job
+ tags:
+ - Jobs and Compensations
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: delete-v1-jobs-job_id
+ description: |-
+ Deletes a specific job that an employee holds.
+
+ scope: `jobs:write`
+ parameters:
+ - "$ref": "#/components/parameters/job_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: delete
+ "/v1/jobs/{job_id}/compensations":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get compensations for a job
+ parameters:
+ - "$ref": "#/components/parameters/job_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - in: query
+ name: include
+ schema:
+ type: string
+ enum:
+ - all_compensations
+ description: |-
+ Available options:
+ - all_compensations: Include all effective dated compensations for each job instead of only the current compensation
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Compensation-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-jobs-job_id-compensations
+ 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`. By default the API returns only the current compensation - see the `include` query parameter for retrieving all compensations.
+
+ 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.
+
+ scope: `jobs:read`
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-name-override: getCompensations
+ x-speakeasy-group: jobsAndCompensations
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a compensation
+ responses:
+ '201':
+ "$ref": "#/components/responses/Compensation-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-compensations-compensation_id
+ 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`.
+
+ scope: `jobs:write`
+ parameters:
+ - "$ref": "#/components/parameters/job_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ description: ''
+ type: object
+ properties:
+ rate:
+ type: string
+ description: The dollar amount paid per payment unit.
+ 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
+ effective_date:
+ type: string
+ description: The date when the compensation takes effect.
+ flsa_status:
+ "$ref": "#/components/schemas/Flsa-Status-Type"
+ adjust_for_minimum_wage:
+ type: boolean
+ description: Determines whether the compensation should be adjusted for minimum wage. Only applies to Nonexempt employees.
+ minimum_wages:
+ type: array
+ items:
+ type: object
+ description: The minimum wage record you want to apply to the compensation
+ properties:
+ uuid:
+ type: string
+ description: The UUID of the minimum wage record. Required if adjust_for_minimum_wage set to true
+ required:
+ - payment_unit
+ - flsa_status
+ examples:
+ Exempt:
+ value:
+ rate: '60000.00'
+ payment_unit: Year
+ flsa_status: Exempt
+ Minimum Wage Adjusted:
+ value:
+ effective_date: '2023-01-01'
+ rate: '7.00'
+ payment_unit: Hour
+ flsa_status: Nonexempt
+ adjust_for_minimum_wage: true
+ minimum_wages:
+ - uuid: 340832db-ab28-4112-9e10-28dd1711835f
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: createCompensation
+ "/v1/compensations/{compensation_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a compensation
+ responses:
+ '200':
+ "$ref": "#/components/responses/Compensation-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-compensations-compensation_id
+ 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`.
+
+ scope: `jobs:read`
+ parameters:
+ - "$ref": "#/components/parameters/compensation_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: getCompensation
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a compensation
+ tags:
+ - Jobs and Compensations
+ responses:
+ '200':
+ "$ref": "#/components/responses/Compensation-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-compensations-compensation_id
+ 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`.
+
+ scope: `jobs:write`
+ parameters:
+ - "$ref": "#/components/parameters/compensation_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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.
+ rate:
+ type: string
+ description: The dollar amount paid per payment unit.
+ 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
+ flsa_status:
+ "$ref": "#/components/schemas/Flsa-Status-Type"
+ adjust_for_minimum_wage:
+ type: boolean
+ description: Determines whether the compensation should be adjusted for minimum wage. Only applies to Nonexempt employees.
+ minimum_wages:
+ type: array
+ items:
+ type: object
+ description: The minimum wage record you want to apply to the compensation
+ properties:
+ uuid:
+ type: string
+ description: The UUID of the minimum wage record. Required if adjust_for_minimum_wage set to true
+ required:
+ - version
+ examples:
+ Exempt:
+ value:
+ version: 98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872
+ rate: '60000.00'
+ payment_unit: Year
+ flsa_status: Exempt
+ Minimum Wage Adjusted:
+ value:
+ version: 98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872
+ rate: '7.00'
+ payment_unit: Hour
+ flsa_status: Nonexempt
+ adjust_for_minimum_wage: true
+ minimum_wages:
+ - uuid: 340832db-ab28-4112-9e10-28dd1711835f
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: updateCompensation
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete a compensation
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: delete-v1-compensations-compensation_id
+ 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.
+
+ scope: `jobs:write`
+ parameters:
+ - "$ref": "#/components/parameters/compensation_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Jobs and Compensations
+ x-speakeasy-group: jobsAndCompensations
+ x-speakeasy-name-override: deleteCompensation
+ "/v1/companies/{company_id}/earning_types":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a custom earning type
+ tags:
+ - Earning Types
+ responses:
+ '201':
+ "$ref": "#/components/responses/Earning-Type-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-earning_types
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ x-speakeasy-group: earningTypes
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all earning types for a company
+ tags:
+ - Earning Types
+ responses:
+ '200':
+ "$ref": "#/components/responses/Earning-Type-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-earning_types
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: earningTypes
+ x-speakeasy-name-override: list
+ "/v1/companies/{company_id}/earning_types/{earning_type_uuid}":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update an earning type
+ tags:
+ - Earning Types
+ responses:
+ '200':
+ "$ref": "#/components/responses/Earning-Type-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_id-earning_types-earning_type_uuid
+ description: |-
+ Update an earning type.
+
+ scope: `payrolls:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/earning_type_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ x-speakeasy-group: earningTypes
+ x-speakeasy-name-override: update
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Deactivate an earning type
+ tags:
+ - Earning Types
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: delete-v1-companies-company_id-earning_types-earning_type_uuid
+ description: |-
+ Deactivate an earning type.
+
+ scope: `payrolls:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/earning_type_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: earningTypes
+ x-speakeasy-name-override: delete
+ "/v1/companies/{company_uuid}/contractors":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a contractor
+ tags:
+ - Contractors
+ responses:
+ '201':
+ "$ref": "#/components/responses/Created-Contractor-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_uuid-contractors
+ description: |-
+ Create an individual or business contractor.
+
+ scope: `contractors:manage`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Contractor-Body"
+ - required:
+ - type
+ - wage_type
+ - start_date
+ examples:
+ Create an Individual contractor:
+ value:
+ 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 a Business contractor:
+ value:
+ type: Business
+ wage_type: Fixed
+ business_name: Johnson-Johnson Contractors
+ start_date: '2020-04-01'
+ description: Create an individual or business contractor.
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get contractors of a company
+ tags:
+ - Contractors
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/search_term"
+ - "$ref": "#/components/parameters/contractors_sort_by"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_uuid-contractors
+ description: |-
+ Get all contractors, active and inactive, individual and business, for a company.
+
+ scope: `contractors:read`
+ x-speakeasy-name-override: list
+ "/v1/contractors/{contractor_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a contractor
+ tags:
+ - Contractors
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-contractors-contractor_uuid
+ description: |-
+ Get a contractor.
+
+ scope: `contractors:read`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a contractor
+ tags:
+ - Contractors
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-contractors-contractor_uuid
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: "Update a contractor.\n\nscope: `contractors:write`\n\n> \U0001F6A7 Warning\n>\n> 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"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - "$ref": "#/components/schemas/Contractor-Body"
+ examples:
+ Update an Individual Contractor:
+ value:
+ 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 a Business Contractor:
+ value:
+ version: b48c46abfed1487b873b442334b3c4ff
+ start_date: '2020-01-11'
+ business_name: Contracting Solutions
+ ein: '991113334'
+ wage_type: Fixed
+ is_active: false
+ description: ''
+ x-speakeasy-name-override: update
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ summary: Delete a contractor
+ operationId: delete-v1-contractors-contractor_uuid
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ A contractor can only be deleted when there are no contractor payments.
+
+ scope: `contractors:manage`
+ tags:
+ - Contractors
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: delete
+ "/v1/contractors/{contractor_uuid}/bank_accounts":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a contractor bank account
+ operationId: post-v1-contractors-contractor_uuid-bank_accounts
+ responses:
+ '201':
+ "$ref": "#/components/responses/Contractor-Bank-Account-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ tags:
+ - Contractor Payment Method
+ x-speakeasy-group: contractorPaymentMethods
+ x-speakeasy-name-override: createBankAccount
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all contractor bank accounts
+ tags:
+ - Contractor Payment Method
+ operationId: get-v1-contractors-contractor_uuid-bank_accounts
+ description: |-
+ Returns all contractor bank accounts.
+
+ scope: `contractor_payment_methods:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Bank-Account-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: getBankAccounts
+ x-speakeasy-group: contractorPaymentMethod
+ "/v1/webhook_subscriptions":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a webhook subscription
+ responses:
+ '201':
+ "$ref": "#/components/responses/Webhook-Subscription-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-webhook-subscription
+ description: "Create a webhook subscription to receive events of the specified subscription_types whenever there is a state change.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:write`"
+ security:
+ - SystemAccessAuth: []
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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: ''
+ tags:
+ - Webhooks
+ x-speakeasy-name-override: createSubscription
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: List webhook subscriptions
+ tags:
+ - Webhooks
+ responses:
+ '200':
+ "$ref": "#/components/responses/Webhook-Subscriptions-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-webhook-subscriptions
+ description: "Returns all webhook subscriptions associated with the provided Partner API token.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:read`"
+ security:
+ - SystemAccessAuth: []
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: listSubscriptions
+ "/v1/webhook_subscriptions/{webhook_subscription_uuid}":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a webhook subscription
+ responses:
+ '200':
+ "$ref": "#/components/responses/Webhook-Subscription-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-webhook-subscription-uuid
+ description: "Updates the Webhook Subscription associated with the provided UUID.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:write`\n"
+ parameters:
+ - "$ref": "#/components/parameters/webhook_subscription_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ security:
+ - SystemAccessAuth: []
+ requestBody:
+ 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: ''
+ tags:
+ - Webhooks
+ x-speakeasy-name-override: updateSubscription
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a webhook subscription
+ responses:
+ '200':
+ "$ref": "#/components/responses/Webhook-Subscription-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-webhook-subscription-uuid
+ description: "Returns the Webhook Subscription associated with the provided UUID.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:read`\n"
+ parameters:
+ - "$ref": "#/components/parameters/webhook_subscription_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ security:
+ - SystemAccessAuth: []
+ tags:
+ - Webhooks
+ x-speakeasy-name-override: getSubscription
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete a webhook subscription
+ responses:
+ '204':
+ description: The resource was deleted successfully.
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: delete-v1-webhook-subscription-uuid
+ description: "Deletes the Webhook Subscription associated with the provided UUID.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:write`\n"
+ parameters:
+ - "$ref": "#/components/parameters/webhook_subscription_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ security:
+ - SystemAccessAuth: []
+ tags:
+ - Webhooks
+ x-speakeasy-name-override: deleteSubscription
+ "/v1/webhook_subscriptions/{webhook_subscription_uuid}/verify":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Verify the webhook subscription
+ responses:
+ '200':
+ "$ref": "#/components/responses/Webhook-Subscription-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-verify-webhook-subscription-uuid
+ 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.\n\nUse the /v1/webhook_subscriptions/{webhook_subscription_uuid}/request_verification_token API to resend the `verification_token` to the Subscriber.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:write`\n"
+ parameters:
+ - "$ref": "#/components/parameters/webhook_subscription_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ security:
+ - SystemAccessAuth: []
+ requestBody:
+ 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: ''
+ tags:
+ - Webhooks
+ x-speakeasy-name-override: verify
+ "/v1/webhook_subscriptions/{webhook_subscription_uuid}/request_verification_token":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Request the webhook subscription verification_token
+ responses:
+ '200':
+ description: No Content. The `verification_token` is POSTed to the Subscription URL.
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-webhook-subscription-verification-token-uuid
+ description: "Request that the webhook subscription `verification_token` be POSTed to the Subscription URL.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `webhook_subscriptions:read`\n"
+ parameters:
+ - "$ref": "#/components/parameters/webhook_subscription_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ security:
+ - SystemAccessAuth: []
+ tags:
+ - Webhooks
+ x-speakeasy-name-override: requestVerificationToken
+ "/v1/contractors/{contractor_uuid}/forms":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all contractor forms
+ tags:
+ - Contractor Forms
+ operationId: get-v1-contractor-forms
+ description: |-
+ Get a list of all contractor's forms
+
+ scope: `contractor_forms:read`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Form_1099"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: contractorForms
+ x-speakeasy-name-override: list
+ "/v1/contractors/{contractor_uuid}/forms/{form_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a contractor form
+ tags:
+ - Contractor Forms
+ operationId: get-v1-contractor-form
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get a contractor form
+
+ scope: `contractor_forms:read`
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Form_1099"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: contractorForms
+ x-speakeasy-name-override: get
+ "/v1/contractors/{contractor_uuid}/forms/{form_id}/pdf":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get the contractor form pdf
+ tags:
+ - Contractor Forms
+ operationId: get-v1-contractor-form-pdf
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get the link to the form PDF
+
+ scope: `contractor_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object-Pdf"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: contractorForms
+ x-speakeasy-name-override: getPdf
+ "/v1/contractors/{contractor_uuid}/documents":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all contractor documents
+ tags:
+ - Contractor Documents
+ operationId: get-v1-contractor-documents
+ description: |-
+ Get a list of all contractor's documents
+
+ scope: `contractor_documents:read`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Document"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: contractorDocuments
+ x-speakeasy-name-override: getAll
+ "/v1/documents/{document_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a contractor document
+ tags:
+ - Contractor Documents
+ operationId: get-v1-contractor-document
+ parameters:
+ - "$ref": "#/components/parameters/document_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get a contractor document.
+
+ scope: `contractor_documents:read`
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Document"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: get
+ x-speakeasy-group: contractorDocuments
+ "/v1/documents/{document_uuid}/pdf":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get the contractor document pdf
+ tags:
+ - Contractor Documents
+ operationId: get-v1-contractor-document-pdf
+ parameters:
+ - "$ref": "#/components/parameters/document_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get the contractor document pdf.
+
+ scope: `contractor_documents:read`
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Document-Pdf"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: contractorDocuments
+ x-speakeasy-name-override: getPdf
+ "/v1/documents/{document_uuid}/sign":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Sign a contractor document
+ tags:
+ - Contractor Documents
+ operationId: put-v1-contractor-document-sign
+ parameters:
+ - "$ref": "#/components/parameters/document_uuid"
+ - "$ref": "#/components/parameters/IpAddressHeader"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ description: |-
+ Sign a contractor document.
+
+ scope: `contractor_documents:write`
+ responses:
+ '200':
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Document-Signed"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: contractorDocuments
+ x-speakeasy-name-override: sign
+ "/v1/sandbox/generate_1099":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Generate a 1099 form [DEMO]
+ tags:
+ - Contractor Forms
+ operationId: post-v1-sandbox-generate_1099
+ description: "> \U0001F6A7 Demo action\n>\n> This action is only available in the Demo environment\n\nGenerates a 1099 document for testing purposes.\n\nscope: `contractors:write`"
+ requestBody:
+ 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.
+
+'
+ required:
+ - contractor_id
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Form_1099"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: contractorForms
+ x-speakeasy-name-override: generate1099
+ "/v1/sandbox/generate_w2":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Generate a W2 form [DEMO]
+ tags:
+ - Employee Forms
+ operationId: post-v1-sandbox-generate_w2
+ description: "> \U0001F6A7 Demo action\n>\n> This action is only available in the Demo environment\n\nGenerates a W2 document for testing purposes.\n\nscope: `employees:write`"
+ requestBody:
+ 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.
+
+'
+ required:
+ - employee_id
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ allOf:
+ - properties:
+ employee_uuid:
+ type: string
+ description: The UUID of the employee
+ readOnly: true
+ - "$ref": "#/components/schemas/Form"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: employeeForms
+ x-speakeasy-name-override: generateW2
+ "/v1/contractors/{contractor_uuid}/payment_method":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a contractor's payment method
+ tags:
+ - Contractor Payment Method
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Payment-Method-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-contractors-contractor_uuid-payment_method
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: contractorPaymentMethod
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a contractor's payment method
+ tags:
+ - Contractor Payment Method
+ operationId: put-v1-contractors-contractor_id-payment_method
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Payment-Method-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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.
+ see [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: ''
+ x-speakeasy-group: contractorPaymentMethod
+ x-speakeasy-name-override: update
+ "/v1/contractors/{contractor_uuid}/onboarding_status":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get the contractor's onboarding status
+ tags:
+ - Contractors
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Onboarding-Status-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-contractors-contractor_uuid-onboarding_status
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ 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` | 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. |
+ x-speakeasy-name-override: getOnboardingStatus
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Change the contractor's onboarding status
+ tags:
+ - Contractors
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Onboarding-Status-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-contractors-contractor_uuid-onboarding_status
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ 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` |
+ requestBody:
+ 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:
+ - onboarding_completed
+ required:
+ - onboarding_status
+ x-speakeasy-name-override: updateOnboardingStatus
+ "/v1/contractors/{contractor_uuid}/address":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ operationId: get-v1-contractors-contractor_uuid-address
+ summary: Get a contractor address
+ tags:
+ - Contractors
+ 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.
+
+ scope: `contractors:read`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Address-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getAddress
+ put:
+ x-gusto-integration-type:
+ - embedded
+ operationId: put-v1-contractors-contractor_uuid-address
+ summary: Create or update a contractor's address
+ tags:
+ - Contractors
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Address-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ 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.\n\nscope: `contractors:write`\n\n> \U0001F6A7 Contractors can only have one address.\n> \n> When a contractor is created, an address is created for them by default. Updating the address will replace the existing address."
+ parameters:
+ - "$ref": "#/components/parameters/contractor_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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:
+ city: San Francisco
+ state: CA
+ zip: '94107'
+ x-speakeasy-name-override: updateAddress
+ "/v1/companies/{company_id}/payrolls":
+ get:
+ summary: Get all payrolls for a company
+ operationId: get-v1-companies-company_id-payrolls
+ 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.
+
+ 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`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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`. Results are paginated, with a maximum page size of 100 payrolls.
+ - 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-List"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: list
+ post:
+ summary: Create an off-cycle payroll
+ operationId: post-v1-companies-company_id-payrolls
+ description: |-
+ 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`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Prepared"
+ '422':
+ description: unprocessable entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ 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
+ x-speakeasy-name-override: createOffCycle
+ "/v1/companies/{company_id}/payroll_reversals":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get approved payroll reversals
+ tags:
+ - Payrolls
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Payroll-Reversal-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-payroll_reversals
+ description: |-
+ Returns all approved Payroll Reversals for a Company.
+
+ scope: `payrolls:read`
+ x-speakeasy-name-override: getApprovedReversals
+ "/v1/companies/{company_id}/payrolls/{payroll_id}":
+ get:
+ summary: Get a single payroll
+ operationId: get-v1-companies-company_id-payrolls-payroll_id
+ 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.
+
+ 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`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful with wait_for_reverse_wire credit blocker
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Show"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: get
+ put:
+ summary: Update a payroll by ID
+ operationId: put-v1-companies-company_id-payrolls
+ description: |
+ 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`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Prepared"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: unprocessable entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Update"
+ required: true
+ x-speakeasy-name-override: update
+ delete:
+ summary: Delete a payroll
+ operationId: delete-v1-companies-company_id-payrolls
+ description: |-
+ 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`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '204':
+ description: no content
+ '202':
+ description: Accepted
+ content:
+ application/json: {}
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: delete
+ "/v1/companies/{company_id}/payrolls/{payroll_id}/prepare":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Prepare a payroll for update
+ tags:
+ - Payrolls
+ responses:
+ '200':
+ "$ref": "#/components/responses/Payroll-Update-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_id-payrolls-payroll_id-prepare
+ 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.
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/payroll_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/payroll_prepare_sort_by"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ employee_uuids:
+ type: array
+ description: An array of employee UUIDs. If passed, only those employees payroll items will be prepared.
+ items:
+ type: string
+ x-speakeasy-name-override: prepare
+ "/v1/payrolls/{payroll_uuid}/receipt":
+ get:
+ summary: Get a single payroll receipt
+ operationId: get-v1-payment-receipts-payrolls-payroll_uuid
+ description: |-
+ 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`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Receipt"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: getReceipt
+ "/v1/payrolls/{payroll_id}/employees/{employee_id}/calculate_accruing_time_off_hours":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Calculate accruing time off hours
+ tags:
+ - Time Off Policies
+ responses:
+ '200':
+ "$ref": "#/components/responses/Accruing-Time-Off-Hour-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ operationId: post-v1-payrolls-payroll_id-calculate_accruing_time_off_hours
+ description: |-
+ 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`
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ description: ''
+ type: object
+ properties:
+ regular_hours_worked:
+ type: number
+ description: regular hours worked in this pay period
+ overtime_hours_worked:
+ type: number
+ description: overtime hours worked in this pay period
+ double_overtime_hours_worked:
+ type: number
+ description: double overtime hours worked in this pay period
+ pto_hours_used:
+ type: number
+ description: paid time off hours used in this pay period
+ sick_hours_used:
+ type: number
+ description: sick hours used in this pay period
+ examples:
+ Example:
+ value:
+ regular_hours_worked: 30.25
+ overtime_hours_worked: 10
+ double_overtime_hours_worked: 0
+ pto_hours_used: 5.5
+ sick_hours_used: 0
+ parameters:
+ - "$ref": "#/components/parameters/payroll_id"
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: calculateAccruingTimeOffHours
+ "/v1/companies/{company_uuid}/payrolls/blockers":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all payroll blockers for a company
+ tags:
+ - Payrolls
+ operationId: get-v1-companies-payroll-blockers-company_uuid
+ description: |-
+ Returns a list of reasons that prevent the company from running payrolls. See the [payroll blockers guide](https://docs.gusto.com/embedded-payroll/docs/payroll-blockers) for a complete list of reasons.
+
+ The list is empty if there are no payroll blockers.
+
+ scope: `payrolls:run`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Payroll-Blocker-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getBlockers
+ "/v1/companies/{company_uuid}/payrolls/skip":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Skip a payroll
+ tags:
+ - Payrolls
+ operationId: post-companies-payroll-skip-company_uuid
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ 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
+ responses:
+ '202':
+ description: Accepted
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ - "$ref": "#/components/schemas/Payroll-Blockers-Error"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: skip
+ "/v1/payrolls/{payroll_uuid}/gross_up":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Calculate gross up
+ tags:
+ - Payrolls
+ operationId: post-payrolls-gross-up-payroll_uuid
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/payroll_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ description: ''
+ type: object
+ properties:
+ employee_uuid:
+ type: string
+ description: Employee UUID
+ net_pay:
+ type: string
+ description: Employee net earnings
+ required:
+ - employee_uuid
+ - net_pay
+ examples:
+ Example:
+ value:
+ employee_uuid: be48c41e-142d-4116-9430-5aba2313fac7
+ net_pay: '1000.00'
+ responses:
+ '200':
+ "$ref": "#/components/responses/Gross-Up-Pay"
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ - "$ref": "#/components/schemas/Payroll-Blockers-Error"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: calculateGrossUp
+ "/v1/contractor_payments/{contractor_payment_uuid}/receipt":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a single contractor payment receipt
+ tags:
+ - Contractor Payments
+ operationId: get-v1-contractor_payments-contractor_payment_uuid-receipt
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/contractor_payment_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Payment-Receipt"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getReceipt
+ x-speakeasy-group: contractorPayments
+ "/v1/contractor_payments/{contractor_payment_uuid}/fund":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Fund a contractor payment [DEMO]
+ tags:
+ - Contractor Payments
+ operationId: get-v1-contractor_payments-contractor_payment_uuid-fund
+ description: "> \U0001F6A7 Demo action\n>\n> This action is only available in the Demo environment\n\nSimulate 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.\n\nscope: `payrolls:run`"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Payment-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ parameters:
+ - "$ref": "#/components/parameters/contractor_payment_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: contractorPayments
+ x-speakeasy-name-override: fund
+ "/v1/companies/{company_id}/payrolls/{payroll_id}/calculate":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Calculate a payroll
+ tags:
+ - Payrolls
+ responses:
+ '202':
+ description: Accepted
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ - "$ref": "#/components/schemas/Payroll-Blockers-Error"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_id-payrolls-payroll_id-calculate
+ 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.
+
+ 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.
+ In v2023-04-01, *show_calculation=true* is no longer required.
+
+ 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.
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/payroll_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: calculate
+ "/v1/companies/{company_id}/payrolls/{payroll_id}/submit":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Submit payroll
+ tags:
+ - Payrolls
+ requestBody:
+ required: true
+ 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
+ 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.
+ responses:
+ '202':
+ description: Accepted
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ - "$ref": "#/components/schemas/Payroll-Blockers-Error"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-companies-company_id-payrolls-payroll_id-submit
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/payroll_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: submit
+ "/v1/companies/{company_id}/payrolls/{payroll_id}/cancel":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Cancel a payroll
+ tags:
+ - Payrolls
+ responses:
+ '200':
+ "$ref": "#/components/responses/Payroll-Show-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-api-v1-companies-company_id-payrolls-payroll_id-cancel
+ description: |
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/payroll_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: cancel
+ "/v1/companies/{company_id}/contractor_payments":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a contractor payment
+ tags:
+ - Contractor Payments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Payment-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-contractor_payments
+ description: |-
+ Pay a contractor. Information needed depends on the contractor's wage type (hourly vs fixed)
+
+ scope: `payrolls:run`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ 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: number
+ 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: number
+ example: 40
+ description: If the contractor is on an hourly wage, this is the number of hours that the contractor worked for the payment
+ bonus:
+ type: number
+ example: 500
+ description: If the contractor is on an hourly wage, this is the bonus the contractor earned
+ reimbursement:
+ type: number
+ example: 20
+ description: Reimbursed wages for the contractor
+ required:
+ - contractor_uuid
+ - date
+ x-speakeasy-group: contractorPayments
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get contractor payments for a company
+ tags:
+ - Contractor Payments
+ responses:
+ '200':
+ description: A JSON object containing contractor payments information
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - "$ref": "#/components/schemas/Contractor-Payment-Summary"
+ - "$ref": "#/components/schemas/Contractor-Payment-Summary-By-Dates"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-contractor_payments
+ description: |-
+ Returns an object containing individual contractor payments, within a given time period, including totals.
+
+ scope: `payrolls:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - schema:
+ type: string
+ example: '2020-01-01'
+ in: query
+ name: start_date
+ description: The time period for which to retrieve contractor payments
+ required: true
+ - schema:
+ type: string
+ example: '2020-12-31'
+ 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
+ - schema:
+ type: string
+ in: query
+ name: contractor_uuid
+ description: The UUID of the contractor. When specified, will load all payments for that contractor.
+ - schema:
+ type: boolean
+ in: query
+ name: group_by_date
+ description: Display contractor payments results group by check date if set to true.
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: contractorPayments
+ x-speakeasy-name-override: list
+ "/v1/companies/{company_id}/contractor_payments/{contractor_payment_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a single contractor payment
+ tags:
+ - Contractor Payments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contractor-Payment-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-contractor_payment-contractor-payment
+ description: |-
+ Returns a single contractor payment.
+ scope: `payrolls:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/contractor_payment_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: get
+ x-speakeasy-group: contractorPayments
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ summary: Cancel a contractor payment
+ tags:
+ - Contractor Payments
+ responses:
+ '204':
+ description: No Content
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: delete-v1-companies-company_id-contractor_payment-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.
+
+ scope: `payrolls:run`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/contractor_payment_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-internal: false
+ x-speakeasy-group: contractorPayments
+ x-speakeasy-name-override: delete
+ "/v1/companies/{company_id}/contractor_payment_groups":
+ get:
+ summary: Get contractor payment groups for a company
+ operationId: get-v1-companies-company_id-contractor_payment_groups
+ description: |-
+ Returns a list of minimal contractor payment groups within a given time period, including totals but not associated contractor payments.
+
+ scope: `payrolls:read`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: List of Contractor Payment Groups
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Contractor-Payment-Group-With-Blockers"
+ '404':
+ description: |
+ Not Found
+
+ The requested company does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: getList
+ x-speakeasy-group: contractorPaymentGroups
+ post:
+ summary: Create a contractor payment group
+ operationId: post-v1-companies-company_id-contractor_payment_groups
+ description: |-
+ Pay a group of contractors. Information needed depends on the contractor's wage type (hourly vs fixed)
+
+ scope: `payrolls:run`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '201':
+ description: Full contractor payment group object
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: |
+ Not Found
+
+ The requested company does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ 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: number
+ 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: number
+ example: 40
+ description: If the contractor is on an hourly wage, this is the number of hours that the contractor worked for the payment
+ bonus:
+ type: number
+ example: 500
+ description: If the contractor is on an hourly wage, this is the bonus the contractor earned
+ reimbursement:
+ type: number
+ example: 20
+ description: Reimbursed wages for the contractor
+ required: true
+ x-speakeasy-group: contractorPaymentGroups
+ x-speakeasy-name-override: create
+ "/v1/companies/{company_id}/contractor_payment_groups/preview":
+ post:
+ summary: Preview a contractor payment group
+ operationId: post-v1-companies-company_id-contractor_payment_groups-preview
+ 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.
+ The returned creation_token is a required parameter in order to create the contractor payment group.
+
+ scope: `payrolls:read`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: Full contractor payment group object with null uuid
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group-Preview"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided ID/UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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: number
+ 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: number
+ example: 40
+ description: If the contractor is on an hourly wage, this is the number of hours that the contractor worked for the payment
+ bonus:
+ type: number
+ example: 500
+ description: If the contractor is on an hourly wage, this is the bonus the contractor earned
+ reimbursement:
+ type: number
+ example: 20
+ description: Reimbursed wages for the contractor
+ check_date:
+ type: string
+ format: date
+ description: Date when payments should be processed
+ required: true
+ x-speakeasy-group: contractorPaymentGroups
+ x-speakeasy-name-override: preview
+ "/v1/contractor_payment_groups/{contractor_payment_group_uuid}":
+ get:
+ summary: Get a contractor payment group
+ operationId: get-v1-contractor_payment_groups-contractor_payment_group_id
+ description: |-
+ Returns a contractor payment group with all associated contractor payments.
+
+ scope: `payrolls:read`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: Successful response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group"
+ '404':
+ description: |
+ Not Found
+
+ The requested contractor payment group does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ x-speakeasy-group: contractorPaymentGroups
+ x-speakeasy-name-override: get
+ delete:
+ summary: Cancel a contractor payment group
+ operationId: delete-v1-contractor_payment_groups-contractor_payment_group_id
+ description: |-
+ Cancels a contractor payment group and all associated contractor payments. All contractor payments must be cancellable, unfunded.
+
+ scope: `payrolls:run`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '204':
+ description: Successfully cancelled
+ '404':
+ description: |
+ Not Found
+
+ The requested contractor payment group does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This 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.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: delete
+ x-speakeasy-group: contractorPaymentGroups
+ "/v1/contractor_payment_groups/{contractor_payment_group_uuid}/fund":
+ put:
+ summary: Fund a contractor payment group [DEMO]
+ operationId: put-v1-contractor_payment_groups-contractor_payment_group_id-fund
+ description: "> \U0001F6A7 Demo action\n> This action is only available in the Demo environment\n\nSimulate 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.\n\nscope: `payrolls:run`"
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: Full contractor payment group object
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group"
+ '404':
+ description: |
+ Not Found
+
+ The requested contractor payment group does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: fund
+ x-speakeasy-group: contractorPaymentGroups
+ "/v1/companies/{company_id}/forms":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all company forms
+ tags:
+ - Company Forms
+ operationId: get-v1-company-forms
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/company_forms_sort_by"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get a list of all company's forms
+
+ scope: `company_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getAll
+ x-speakeasy-group: companyForms
+ "/v1/forms/{form_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a company form
+ tags:
+ - Company Forms
+ operationId: get-v1-company-form
+ parameters:
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get a company form
+
+ scope: `company_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: companyForms
+ x-speakeasy-name-override: get
+ "/v1/forms/{form_id}/pdf":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a company form pdf
+ tags:
+ - Company Forms
+ operationId: get-v1-company-form-pdf
+ parameters:
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get the link to the form PDF
+
+ scope: `company_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object-Pdf"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getPdf
+ x-speakeasy-group: companyForms
+ "/v1/forms/{form_id}/sign":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Sign a company form
+ tags:
+ - Company Forms
+ operationId: put-v1-company-form-sign
+ parameters:
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/IpAddressHeader"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Sign a company form. Company forms must be signed by the company signatory.
+
+ scope: `company_forms:sign`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-group: companyForms
+ x-speakeasy-name-override: sign
+ "/v1/employees/{employee_id}/forms":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all employee forms
+ tags:
+ - Employee Forms
+ operationId: get-v1-employee-forms
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get a list of all employee's forms
+
+ scope: `employee_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: list
+ x-speakeasy-group: employeeForms
+ "/v1/employees/{employee_id}/forms/{form_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get an employee form
+ tags:
+ - Employee Forms
+ operationId: get-v1-employee-form
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get an employee form
+
+ scope: `employee_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: employeeForms
+ x-speakeasy-name-override: get
+ "/v1/employees/{employee_id}/forms/{form_id}/pdf":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get the employee form pdf
+ tags:
+ - Employee Forms
+ operationId: get-v1-employee-form-pdf
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ Get the link to the employee form PDF
+
+ scope: `employee_forms:read`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object-Pdf"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: employeeForms
+ x-speakeasy-name-override: getPdf
+ "/v1/employees/{employee_id}/forms/{form_id}/sign":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Sign an employee form
+ tags:
+ - Employee Forms
+ operationId: put-v1-employee-form-sign
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/form_id"
+ - "$ref": "#/components/parameters/IpAddressHeader"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ 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`
+ responses:
+ '200':
+ "$ref": "#/components/responses/Form-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-group: employeeForms
+ x-speakeasy-name-override: sign
+ "/v1/payrolls/{payroll_id}/employees/{employee_id}/pay_stub":
+ get:
+ summary: Get an employee pay stub (pdf)
+ operationId: get-v1-payrolls-payroll_uuid-employees-employee_uuid-pay_stub
+ 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.
+
+ scope: `pay_stubs:read`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/pdf:
+ schema:
+ type: string
+ format: binary
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: getPayStub
+ "/v1/employees/{employee_id}/pay_stubs":
+ get:
+ summary: Get an employee's pay stubs
+ operationId: get-v1-employees-employee_uuid-pay_stubs
+ description: |-
+ Get an employee's pay stubs
+
+ scope: `pay_stubs:read`
+ x-gusto-integration-type:
+ - embedded
+ tags:
+ - Payrolls
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Pay-Stubs-List"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-name-override: getPayStubs
+ "/v1/generated_documents/{document_type}/{request_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a generated document
+ tags:
+ - Generated Documents
+ operationId: get-v1-generated_documents-document_type-request_uuid
+ 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.
+
+ scope: `generated_documents:read`
+ parameters:
+ - "$ref": "#/components/parameters/document_type"
+ - "$ref": "#/components/parameters/request_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Generated-Document"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: generatedDocuments
+ x-speakeasy-name-override: get
+ "/v1/payrolls/{payroll_uuid}/generated_documents/printable_payroll_checks":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Generate printable payroll checks (pdf)
+ tags:
+ - Payrolls
+ operationId: post-v1-payrolls-payroll_uuid-generated_documents-printable_payroll_checks
+ 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.
+
+ scope: `generated_documents:write`
+ parameters:
+ - "$ref": "#/components/parameters/payroll_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Payroll-Check"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ x-speakeasy-name-override: generatePrintableChecks
+ "/v1/companies/{company_uuid}/reports":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a custom report
+ operationId: post-companies-company_uuid-reports
+ responses:
+ '200':
+ "$ref": "#/components/responses/Create-Report"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ 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
+ 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
+ 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.
+
+ scope: `company_reports:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Reports
+ x-speakeasy-name-override: createCustom
+ "/v1/payrolls/{payroll_uuid}/reports/general_ledger":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a general ledger report
+ operationId: post-payrolls-payroll_uuid-reports-general_ledger
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/payroll_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ nullable: true
+ 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'.
+ responses:
+ '200':
+ "$ref": "#/components/responses/General-Ledger-Report"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ tags:
+ - Reports
+ "/v1/reports/{request_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a report
+ operationId: get-reports-request_uuid
+ responses:
+ '200':
+ "$ref": "#/components/responses/Report"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ 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.
+
+ Reports containing PHI are inaccessible with `company_reports:read:tier_2_only` data scope
+
+ scope: `company_reports:read`
+ parameters:
+ - "$ref": "#/components/parameters/request_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Reports
+ "/v1/companies/{company_uuid}/report_templates/{report_type}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a report template
+ operationId: get-companies-company_uuid-report-templates-report_type
+ responses:
+ '200':
+ "$ref": "#/components/responses/Report-Template"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ 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.
+
+ scope: `company_reports:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/report_type"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Reports
+ x-speakeasy-name-override: getTemplate
+ "/v1/companies/{company_id}/company_benefits":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a company benefit
+ tags:
+ - Company Benefits
+ responses:
+ '201':
+ "$ref": "#/components/responses/Company-Benefit-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-companies-company_id-company_benefits
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ 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.
+ nullable: true
+ enum:
+ - elective
+ - deemed
+ required:
+ - benefit_id
+ - description
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get benefits for a company
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Benefit-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_id-company_benefits
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_id"
+ - 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`
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: list
+ "/v1/company_benefits/{company_benefit_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a company benefit
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Benefit-With-Employee-Benefits-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-company_benefits-company_benefit_id
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - 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:
+ - all_benefits: If with_employee_benefits=true, include all effective dated benefits for each employee instead of only the current benefits.
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a company benefit
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Company-Benefit-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-company_benefits-company_benefit_id
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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”.
+ catch_up_type:
+ type: string
+ 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.
+ nullable: true
+ enum:
+ - elective
+ - deemed
+ required:
+ - version
+ examples:
+ Example:
+ value:
+ version: 98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872
+ active: false
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: update
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete a company benefit
+ tags:
+ - Company Benefits
+ operationId: delete-v1-company_benefits-company_benefit_id
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '204':
+ description: No content
+ '422':
+ description: Unprocessable Entity
+ 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
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: delete
+ x-speakeasy-group: companyBenefits
+ "/v1/benefits":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all benefits supported by Gusto
+ responses:
+ '200':
+ "$ref": "#/components/responses/Supported-Benefit-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-benefits
+ description: |-
+ 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`
+ tags:
+ - Company Benefits
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: getAll
+ "/v1/benefits/{benefit_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: get-v1-benefits-benefit_id
+ summary: Get a supported benefit by ID
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Supported-Benefit-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: getSupported
+ "/v1/company_benefits/{company_benefit_id}/summary":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: get-v1-benefits-company_benefit_id-summary
+ summary: Get company benefit summary by company benefit id.
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - 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
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Benefit-Summary-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: getSummary
+ "/v1/company_benefits/{company_benefit_id}/employee_benefits":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all employee benefits for a company benefit
+ operationId: get-v1-company_benefits-company_benefit_id-employee_benefits
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - in: query
+ name: include
+ schema:
+ type: string
+ enum:
+ - all_benefits
+ description: |-
+ Available options:
+ - all_benefits: Include all effective dated benefits for each employee instead of only the current benefits.
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Benefit-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getEmployeeBenefits
+ x-speakeasy-group: companyBenefits
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Bulk update employee benefits for a company benefit
+ operationId: put-v1-company_benefits-company_benefit_id-employee_benefits
+ description: |-
+ 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`
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Benefit-List"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ employee_benefits:
+ type: array
+ description: The list of employee benefits to create or update
+ items:
+ "$ref": "#/components/schemas/Employee-Benefit-For-Company-Benefit"
+ required:
+ - employee_benefits
+ examples:
+ Example:
+ value:
+ employee_benefits:
+ - version: '09j3d29jqdpj92109j9j2d90dq'
+ employee_uuid: 8f9f3f68-8fd3-499d-ade7-4a052e56494e
+ active: true
+ employee_deduction: '250.00'
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: updateEmployeeBenefits
+ "/v1/company_benefits/{company_benefit_id}/contribution_exclusions":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get contribution exclusions for a company benefit
+ operationId: get-v1-company_benefits-company_benefit_id-contribution_exclusions
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contribution-Exclusion-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update contribution exclusions for a company benefit
+ operationId: put-v1-company_benefits-company_benefit_id-contribution_exclusions
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Contribution-Exclusion-List"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ contribution_exclusions:
+ type: array
+ description: The list of contribution exclusions to update
+ items:
+ "$ref": "#/components/schemas/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
+ "/v1/benefits/{benefit_id}/requirements":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ operationId: get-v1-benefits-benefits_id-requirements
+ summary: Get benefit fields requirements by ID
+ description: |-
+ Returns field requirements for the requested benefit type.
+
+ scope: `benefits:read`
+ parameters:
+ - "$ref": "#/components/parameters/benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Company Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Benefit-Type-Requirements-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: companyBenefits
+ x-speakeasy-name-override: getRequirements
+ "/v1/employees/{employee_id}/employee_benefits":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create an employee benefit
+ tags:
+ - Employee Benefits
+ responses:
+ '201':
+ "$ref": "#/components/responses/Employee-Benefit-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-employees-employee_id-employee_benefits
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ description: The maximum employee deduction amount per year. A null value signifies no limit.
+ nullable: true
+ contribution:
+ type: object
+ description: An object representing the company contribution type and value.
+ properties:
+ type:
+ type: string
+ description: |-
+ The company contribution scheme.
+
+ `amount`: The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ `percentage`: The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ `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.
+
+ For 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.
+
+ Use threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.
+
+ For example:
+
+ If 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.
+
+ If 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
+ description: The maximum company contribution amount per year. A null value signifies no limit.
+ nullable: true
+ limit_option:
+ type: string
+ description: |-
+ Some benefits require additional information to determine
+ their limit.
+
+ `Family` or `Individual`: Applicable to HSA benefit.
+
+ `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
+ nullable: true
+ 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
+ description: 'The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.'
+ nullable: true
+ 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
+ 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.'
+ nullable: true
+ 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
+ format: date
+ nullable: true
+ default:
+ 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: ''
+ x-speakeasy-name-override: create
+ x-speakeasy-group: employeeBenefits
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all benefits for an employee
+ tags:
+ - Employee Benefits
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - in: query
+ name: include
+ schema:
+ type: string
+ enum:
+ - all_benefits
+ description: |-
+ Available options:
+ - all_benefits: Include all effective dated benefits for each employee instead of only the current benefits.
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Benefit-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-employee_benefits
+ description: |-
+ 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`
+ x-speakeasy-group: employeeBenefits
+ x-speakeasy-name-override: get
+ "/v1/employee_benefits/{employee_benefit_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get an employee benefit
+ tags:
+ - Employee Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Benefit-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employee_benefits-employee_benefit_id
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: retrieve
+ x-speakeasy-group: employeeBenefits
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update an employee benefit
+ tags:
+ - Employee Benefits
+ responses:
+ '200':
+ "$ref": "#/components/responses/Employee-Benefit-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-employee_benefits-employee_benefit_id
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ description: The maximum employee deduction amount per year. A null value signifies no limit.
+ nullable: true
+ effective_date:
+ type: string
+ format: date
+ description: The date the employee benefit will start.
+ expiration_date:
+ type: string
+ format: date
+ nullable: true
+ 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.
+
+ `amount`: The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ `percentage`: The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ `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.
+
+ For 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.
+
+ Use threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.
+
+ For example:
+
+ If 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.
+
+ If 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
+ description: The maximum company contribution amount per year. A null value signifies no limit.
+ nullable: true
+ limit_option:
+ type: string
+ description: |-
+ Some benefits require additional information to determine
+ their limit.
+
+ `Family` or `Individual`: Applicable to HSA benefit.
+
+ `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
+ nullable: true
+ 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
+ description: 'The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.'
+ nullable: true
+ deduction_reduces_taxable_income:
+ type: string
+ 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.'
+ nullable: true
+ 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'
+ x-speakeasy-group: employeeBenefits
+ x-speakeasy-name-override: update
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Delete an employee benefit
+ tags:
+ - Employee Benefits
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: delete-v1-employee_benefits-employee_benefit_id
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_benefit_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: employeeBenefits
+ x-speakeasy-name-override: delete
+ "/v1/employees/{employee_id}/ytd_benefit_amounts_from_different_company":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get year-to-date benefit amounts from a different company
+ tags:
+ - Employee Benefits
+ operationId: get-employee-ytd-benefit-amounts-from-different-company
+ description: |-
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - 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.
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Ytd-Benefit-Amounts-From-Different-Company-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: employeeBenefits
+ x-speakeasy-name-override: getYtdBenefitAmountsFromDifferentCompany
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create year-to-date benefit amounts from a different company
+ tags:
+ - Employee Benefits
+ operationId: post-employee-ytd-benefit-amounts-from-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.
+
+ This endpoint only supports passing outside contributions for 401(k) benefits.
+
+ scope: `employee_benefits:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ "$ref": "#/components/requestBodies/post-employee-ytd-benefit-amounts-from-different-company"
+ responses:
+ '204':
+ description: No Content
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: employeeBenefits
+ x-speakeasy-name-override: createYtdBenefitAmountsFromDifferentCompany
+ "/v1/employees/{employee_id}/garnishments":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Create a garnishment
+ tags:
+ - Garnishments
+ responses:
+ '201':
+ "$ref": "#/components/responses/Garnishment-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: post-v1-employees-employee_id-garnishments
+ 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.
+
+ scope: `garnishments:write`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ readOnly: false
+ nullable: true
+ 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
+ readOnly: false
+ default:
+ nullable: true
+ 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:
+ nullable: true
+ description: The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. "200.00".
+ type: string
+ pay_period_maximum:
+ type: string
+ format: float
+ default:
+ nullable: true
+ 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
+ format: float
+ readOnly: false
+ nullable: true
+ description: A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum.
+ child_support:
+ "$ref": "#/components/schemas/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
+ x-speakeasy-name-override: create
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get garnishments for an employee
+ tags:
+ - Garnishments
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Garnishment-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-garnishments
+ 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.
+
+ scope: `garnishments:read`
+ x-speakeasy-name-override: list
+ "/v1/garnishments/{garnishment_id}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get a garnishment
+ tags:
+ - Garnishments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Garnishment-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-garnishments-garnishment_id
+ 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.
+
+ scope: `garnishments:read`
+ parameters:
+ - "$ref": "#/components/parameters/garnishment_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Update a garnishment
+ tags:
+ - Garnishments
+ responses:
+ '200':
+ "$ref": "#/components/responses/Garnishment-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-garnishments-garnishment_id
+ 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.
+
+ scope: `garnishments:write`
+ parameters:
+ - "$ref": "#/components/parameters/garnishment_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ readOnly: false
+ default:
+ nullable: true
+ 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:
+ nullable: true
+ description: The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. "200.00".
+ type: string
+ pay_period_maximum:
+ type: string
+ format: float
+ default:
+ nullable: true
+ 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
+ format: float
+ readOnly: false
+ nullable: true
+ description: A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum.
+ child_support:
+ "$ref": "#/components/schemas/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
+ x-speakeasy-name-override: update
+ "/v1/garnishments/child_support":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get child support garnishment data
+ responses:
+ '200':
+ "$ref": "#/components/responses/Child-Support-Data-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ tags:
+ - Garnishments
+ operationId: get-v1-garnishments-child_support
+ description: |-
+ Agency data and requirements to be used for creating child support garnishments
+
+ scope: `garnishments:read`
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-name-override: getChildSupportData
+ "/v1/employees/{employee_id}/i9_authorization":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get an employee's I-9 authorization
+ tags:
+ - I-9 Verification
+ responses:
+ '200':
+ "$ref": "#/components/responses/I9-Authorization-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-i9_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.
+
+ **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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: i9Verification
+ x-speakeasy-name-override: getAuthorization
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create or update an employee's I-9 authorization
+ tags:
+ - I-9 Verification
+ responses:
+ '200':
+ "$ref": "#/components/responses/I9-Authorization-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-employees-employee_id-i9_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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ authorization_status:
+ type: string
+ description: |
+ The employee's authorization status
+
+ * `citizen`: A citizen is someone who was born in the United States or is a naturalized citizen living in the United States.
+ * `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.
+ * `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.
+ * `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.
+ enum:
+ - citizen
+ - noncitizen
+ - permanent_resident
+ - alien
+ document_type:
+ type: string
+ description: |
+ The type of document an employee holds, based on their authorization status.
+
+ * This is unused for authorization status `citizen` or `noncitizen`.
+ * If the authorization status is `permanent_resident`, this must be `uscis_alien_registration_number`.
+ * If the authorization status is `alien`, this is required and may be any of the valid values.
+ 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.
+
+ * For `document_type:'uscis_alien_registration_number'`, this must be a USCIS Number/A-Number, which is 7 to 9 digits.
+ * For `document_type:'form_i94'`, this must be a Form I-94 Admission Number, which is 11 digits.
+ * For `document_type:'foreign_passport'`, this must be the passport number.
+
+ This is required when the document type is present.
+ country:
+ type: string
+ description: |
+ The document's country of issuance.
+
+ This is required when the document type is `foreign_passport`.
+ expiration_date:
+ type: string
+ description: |
+ The document's expiration date.
+
+ This may only be used when the authorization status is `alien`.
+ 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
+ x-speakeasy-name-override: update
+ x-speakeasy-group: i9Verification
+ "/v1/employees/{employee_id}/i9_authorization/document_options":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get an employee's I-9 verification document options
+ tags:
+ - I-9 Verification
+ responses:
+ '200':
+ "$ref": "#/components/responses/I9-Authorization-Document-Options-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-i9_authorization-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.
+
+ scope: `i9_authorizations:read`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: i9Verification
+ x-speakeasy-name-override: getDocumentOptions
+ "/v1/employees/{employee_id}/i9_authorization/documents":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get an employee's I-9 verification documents
+ tags:
+ - I-9 Verification
+ responses:
+ '200':
+ "$ref": "#/components/responses/I9-Authorization-Documents-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-employees-employee_id-i9_authorization-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.
+
+ scope: `i9_authorizations:read`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: i9Verification
+ x-speakeasy-name-override: getDocuments
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create an employee's I-9 authorization verification documents
+ tags:
+ - I-9 Verification
+ responses:
+ '200':
+ "$ref": "#/components/responses/I9-Authorization-Documents-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-employees-employee_id-i9_authorization-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.\n\nUse the document options endpoint to get the possible document types and titles, which can vary depending on the employee's authorization status.\n\n> \U0001F6A7 Every request must contain the complete list of documents for the Employee.\n>\n> Every request to this endpoint removes any previous verification document records for the employee.\n\nscope: `i9_authorizations:manage`\n"
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ x-speakeasy-group: i9Verification
+ x-speakeasy-name-override: createDocuments
+ "/v1/employees/{employee_id}/i9_authorization/documents/{document_id}":
+ delete:
+ x-gusto-integration-type:
+ - embedded
+ summary: Delete an employee's I-9 verification document
+ tags:
+ - I-9 Verification
+ responses:
+ '204':
+ description: No Content
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: delete-v1-employees-employee_id-i9_authorization-documents-document_id
+ 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.
+
+ scope: `i9_authorizations:manage`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/document_id"
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: i9Verification
+ x-speakeasy-name-override: deleteDocument
+ "/v1/employees/{employee_id}/i9_authorization/employer_sign":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Employer sign an employee's Form I-9
+ tags:
+ - I-9 Verification
+ responses:
+ '200':
+ "$ref": "#/components/responses/I9-Authorization-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: put-v1-employees-employee_id-i9_authorization-employer_sign
+ 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.
+
+ scope: `i9_authorizations:manage`
+ parameters:
+ - "$ref": "#/components/parameters/employee_id"
+ - "$ref": "#/components/parameters/IpAddressHeader"
+ - "$ref": "#/components/parameters/VersionHeader"
+ requestBody:
+ 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
+ x-speakeasy-group: i9Verification
+ x-speakeasy-name-override: employerSign
+ "/v1/plaid/processor_token":
+ post:
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a bank account from a plaid processor token
+ operationId: post-v1-plaid-processor_token
+ tags:
+ - Bank Accounts
+ responses:
+ '201':
+ description: A JSON object containing bank information
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - "$ref": "#/components/schemas/Company-Bank-Account"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ description: "This endpoint creates a new **verified** bank account by using a plaid processor token to retrieve its information.\n\nscope: `plaid_processor:write`\n\n> \U0001F4D8\n> To create a token please use the [plaid api](https://plaid.com/docs/api/processors/#processortokencreate) and select \"gusto\" as processor.\n\n> \U0001F6A7 Warning - Company Bank Accounts\n>\n> 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."
+ requestBody:
+ 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
+ parameters:
+ - "$ref": "#/components/parameters/VersionHeader"
+ x-speakeasy-group: bankAccounts
+ x-speakeasy-name-override: createFromPlaidToken
+ "/v1/companies/{company_uuid}/tax_requirements/{state}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get State Tax Requirements
+ description: |
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - 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.
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Tax Requirements
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Tax-Requirements-State"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_uuid-tax_requirements-state
+ x-speakeasy-group: taxRequirements
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Update State Tax Requirements
+ description: |-
+ Update State Tax Requirements
+
+ scope: `company_tax_requirements:write`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - schema:
+ type: string
+ name: state
+ in: path
+ required: true
+ description: 2-letter US state abbreviation
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Tax Requirements
+ operationId: put-v1-companies-company_uuid-tax_requirements-state
+ responses:
+ '200':
+ description: OK
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ x-examples:
+ example-1:
+ requirement_sets:
+ - key: registrations
+ effective_from:
+ 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:
+ "$ref": "#/components/schemas/Tax-Requirement-Set-Key"
+ effective_from:
+ "$ref": "#/components/schemas/Tax-Requirement-Effective-From"
+ state:
+ "$ref": "#/components/schemas/State"
+ requirements:
+ type: array
+ items:
+ type: object
+ properties:
+ key:
+ "$ref": "#/components/schemas/Tax-Requirement-Key"
+ value:
+ type: string
+ nullable: true
+ examples:
+ Example:
+ value:
+ requirement_sets:
+ - key: registrations
+ effective_from:
+ 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
+ x-speakeasy-group: taxRequirements
+ x-speakeasy-name-override: updateState
+ "/v1/companies/{company_uuid}/tax_requirements":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get All Tax Requirement States
+ description: |-
+ Returns objects describing the states that have tax requirements for the company
+
+ scope: `company_tax_requirements:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Tax Requirements
+ 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:
+ "$ref": "#/components/schemas/State"
+ setup_complete:
+ type: boolean
+ description: |-
+ If all requirements for the state have been satisfied such that the company can complete
+ onboarding, the company is `setup_complete` in the state. A company must be `setup_complete` in
+ all relevant states to complete the `state_setup` company onboarding step.
+ required:
+ - state
+ - setup_complete
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-v1-companies-company_uuid-tax_requirements
+ x-speakeasy-group: taxRequirements
+ x-speakeasy-name-override: getAll
+ "/v1/companies/{company_uuid}/contractor_payments/preview":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Preview contractor payment debit date
+ tags:
+ - Contractor Payments
+ 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'
+ '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.
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ operationId: get-companies-company_uuid-contractor_payments-preview
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ description: |-
+ 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`
+ requestBody:
+ 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.
+ x-speakeasy-name-override: preview
+ x-speakeasy-group: contractorPayments
+ "/v1/time_off_policies/{time_off_policy_uuid}":
+ get:
+ operationId: get-v1-time_off_policies-time_off_policy_uuid
+ description: |-
+ Get a time off policy
+
+ scope: `time_off_policies:read`
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a time off policy
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ tags:
+ - Time Off Policies
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: get
+ put:
+ operationId: put-v1-time_off_policies-time_off_policy_uuid
+ description: |-
+ Update a time off policy
+
+ scope: `time_off_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a time off policy
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '422':
+ description: Unlimited Policy updated with accrual rate
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - "$ref": "#/components/schemas/Time-Off-Policy-Update-Request"
+ tags:
+ - Time Off Policies
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: update
+ "/v1/companies/{company_uuid}/time_off_policies":
+ get:
+ summary: Get all time off policies for a company
+ operationId: get-v1-companies-company_uuid-time_off_policies
+ description: |-
+ Get all time off policies for a company
+
+ scope: `time_off_policies:read`
+ x-gusto-integration-type:
+ - embedded
+ tags:
+ - Time Off Policies
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: getAll
+ post:
+ operationId: post-v1-companies-company_uuid-time_off_policies
+ description: |-
+ Create a time off policy
+
+ scope: `time_off_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a time off policy
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '201':
+ description: created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '422':
+ description: Policy name required
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy-Request"
+ tags:
+ - Time Off Policies
+ x-speakeasy-name-override: create
+ x-speakeasy-group: timeOffPolicies
+ "/v1/time_off_policies/{time_off_policy_uuid}/add_employees":
+ put:
+ operationId: put-v1-time_off_policies-time_off_policy_uuid-add_employees
+ 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
+
+ scope: `time_off_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Add employees to a time off policy
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '422':
+ description: Add employees with no employees
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ tags:
+ - Time Off Policies
+ requestBody:
+ 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
+ nullable: true
+ description: The starting balance for the employee
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: addEmployees
+ "/v1/time_off_policies/{time_off_policy_uuid}/remove_employees":
+ put:
+ description: |-
+ Remove employees from a time off policy
+
+ scope: `time_off_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Remove employees from a time off policy
+ operationId: put-v1-time_off_policies-time_off_policy_uuid-remove_employees
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '422':
+ description: Remove employees with no employees
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ requestBody:
+ 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
+ tags:
+ - Time Off Policies
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: removeEmployees
+ "/v1/companies/{company_uuid}/suspensions":
+ get:
+ summary: Get suspensions for this company
+ operationId: get-companies-company_uuid-suspensions
+ 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.\n\n>\U0001F4D8 To check if company is already suspended\n>\n> 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.\n\nscope: `company_suspensions:read`"
+ tags:
+ - Companies
+ x-gusto-integration-type:
+ - embedded
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: Successful response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Suspension-List"
+ '404':
+ description: |
+ Not Found
+
+ The requested resource does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: companies.suspensions
+ x-speakeasy-name-override: get
+ post:
+ summary: Suspend a company's account
+ operationId: post-companies-company_uuid-suspensions
+ 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.
+
+ scope: `company_suspensions:write`
+ tags:
+ - Companies
+ x-gusto-integration-type:
+ - embedded
+ security:
+ - CompanyAccessAuth: []
+ 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
+ responses:
+ '200':
+ description: Successful response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Suspension"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Suspension-Creation-Errors"
+ requestBody:
+ 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> \U0001F6A7 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> \U0001F6A7 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
+ x-speakeasy-group: companies.suspensions
+ x-speakeasy-name-override: suspend
+ "/v1/companies/{company_uuid}/holiday_pay_policy":
+ get:
+ operationId: get-v1-companies-company_uuid-holiday_pay_policy
+ description: |-
+ Get a company's holiday pay policy
+
+ scope: `holiday_pay_policies:read`
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a company's holiday pay policy
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy"
+ '204':
+ description: no policy exists
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: get
+ post:
+ operationId: post-v1-companies-company_uuid-holiday_pay_policy
+ description: |-
+ Create a holiday pay policy for a company
+
+ scope: `holiday_pay_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Create a holiday pay policy for a company
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy"
+ '422':
+ description: company already has a policy
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy-Request"
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: create
+ put:
+ operationId: put-v1-companies-company_uuid-holiday_pay_policy
+ description: |-
+ Update a company's holiday pay policy
+
+ scope: `holiday_pay_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Update a company's holiday pay policy
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy"
+ '422':
+ description: no policy exists
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Versionable-Required"
+ - "$ref": "#/components/schemas/Holiday-Pay-Policy-Request"
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: update
+ delete:
+ operationId: delete-v1-companies-company_uuid-holiday_pay_policy
+ description: |-
+ Delete a company's holiday pay policy
+
+ scope: `holiday_pay_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Delete a company's holiday pay policy
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '204':
+ description: successful
+ '422':
+ description: no policy exists
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: delete
+ "/v1/companies/{company_uuid}/holiday_pay_policy/add":
+ put:
+ operationId: put-v1-companies-company_uuid-holiday_pay_policy-add
+ description: |-
+ Add employees to a company's holiday pay policy
+
+ scope: `holiday_pay_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Add employees to a company's holiday pay policy
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy"
+ '422':
+ description: no policy exists
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: addEmployees
+ "/v1/companies/{company_uuid}/holiday_pay_policy/remove":
+ put:
+ operationId: put-v1-companies-company_uuid-holiday_pay_policy-remove
+ description: |-
+ Remove employees from a company's holiday pay policy
+
+ scope: `holiday_pay_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Remove employees from a company's holiday pay policy
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy"
+ '422':
+ description: no policy exists
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: removeEmployees
+ "/v1/companies/{company_uuid}/paid_holidays":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Preview a company's paid holidays
+ operationId: get-companies-company_uuid-paid_holidays
+ responses:
+ '200':
+ "$ref": "#/components/responses/Paid-Holidays-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ 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'
+ description: |-
+ Preview a company's paid holidays
+
+ scope: `holiday_pay_policies:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Holiday Pay Policies
+ x-speakeasy-group: holidayPayPolicies
+ x-speakeasy-name-override: previewPaidHolidays
+ "/v1/time_off_policies/{time_off_policy_uuid}/balance":
+ put:
+ summary: Update employee time off balances
+ operationId: put-v1-time_off_policies-time_off_policy_uuid-balance
+ description: |-
+ Updates time off hours balances for employees for a time off policy.
+
+ scope: `time_off_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '422':
+ description: Unlimited policy balance update
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ tags:
+ - Time Off Policies
+ requestBody:
+ 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
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: updateBalance
+ "/v1/time_off_policies/{time_off_policy_uuid}/deactivate":
+ put:
+ description: |-
+ Deactivate a time off policy
+
+ scope: `time_off_policies:write`
+ x-gusto-integration-type:
+ - embedded
+ summary: Deactivate a time off policy
+ operationId: put-v1-time_off_policies-time_off_policy_uuid-deactivate
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ '422':
+ description: Policy has pending time off requests
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ tags:
+ - Time Off Policies
+ x-speakeasy-group: timeOffPolicies
+ x-speakeasy-name-override: deactivate
+ "/v1/notifications/{notification_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a notification's details
+ tags:
+ - Notifications
+ operationId: get-notifications-notification_uuid
+ 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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/notification_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Notification"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-name-override: getDetails
+ "/v1/events":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ summary: Get all events
+ tags:
+ - Events
+ operationId: get-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.\n\n> \U0001F4D8 System Access Authentication\n>\n> 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).\n\nscope: `events:read`"
+ security:
+ - SystemAccessAuth: []
+ parameters:
+ - "$ref": "#/components/parameters/starting_after_uuid"
+ - "$ref": "#/components/parameters/resource_uuid"
+ - "$ref": "#/components/parameters/limit"
+ - "$ref": "#/components/parameters/event_type"
+ - "$ref": "#/components/parameters/sort_order"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Event-List"
+ x-speakeasy-name-override: get
+ "/v1/companies/{company_uuid}/information_requests":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all information requests for a company
+ tags:
+ - Information Requests
+ operationId: get-information-requests
+ description: |-
+ Fetch all information requests for a company.
+
+ scope: `information_requests:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Information-Request-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ "/v1/companies/{company_uuid}/recovery_cases":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all recovery cases for a company
+ tags:
+ - Recovery Cases
+ operationId: get-recovery-cases
+ description: |-
+ Fetch all recovery cases for a company.
+
+ scope: `recovery_cases:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Recovery-Case-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: recoveryCases
+ x-speakeasy-name-override: get
+ "/v1/recovery_cases/{recovery_case_uuid}/redebit":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Initiate a redebit for a recovery case
+ tags:
+ - Recovery Cases
+ operationId: redebit-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.
+
+ 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`
+ parameters:
+ - "$ref": "#/components/parameters/recovery_case_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '202':
+ description: Accepted
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ x-speakeasy-group: recoveryCases
+ x-speakeasy-name-override: redebit
+ "/v1/companies/{company_uuid}/ach_transactions":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all ACH transactions for a company
+ tags:
+ - ACH Transactions
+ operationId: get-ach-transactions
+ description: |-
+ Fetches all ACH transactions for a company.
+
+ scope: `ach_transactions:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/contractor_payment_uuid_query"
+ - "$ref": "#/components/parameters/payroll_uuid_query"
+ - "$ref": "#/components/parameters/transaction_type"
+ - "$ref": "#/components/parameters/payment_direction"
+ - "$ref": "#/components/parameters/pageParam"
+ - "$ref": "#/components/parameters/perParam"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Ach-Transaction-List"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: achTransactions
+ x-speakeasy-name-override: getAll
+ "/v1/wire_in_requests/{wire_in_request_uuid}":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get a single Wire In Request
+ tags:
+ - Wire In Requests
+ operationId: get-wire_in_requests-wire_in_request_uuid
+ description: |-
+ Fetch a Wire In Request.
+
+ scope: `payrolls:read`
+ parameters:
+ - "$ref": "#/components/parameters/wire_in_request_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Wire-In-Request-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ x-speakeasy-group: wireInRequests
+ x-speakeasy-name-override: get
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Submit a wire in request
+ operationId: put-wire_in_requests-wire_in_request_uuid
+ responses:
+ '200':
+ "$ref": "#/components/responses/Wire-In-Request-Object"
+ '422':
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+ requestBody:
+ 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.0
+ additional_notes: Wire for 2024-06-15 payroll.
+ description: |-
+ Submit a wire in request for a payment
+
+ scope: `payrolls:run`
+ parameters:
+ - "$ref": "#/components/parameters/wire_in_request_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ tags:
+ - Wire In Requests
+ x-speakeasy-group: wireInRequests
+ x-speakeasy-name-override: submit
+ "/v1/companies/{company_uuid}/wire_in_requests":
+ get:
+ x-gusto-integration-type:
+ - embedded
+ summary: Get all Wire In Requests for a company
+ tags:
+ - Wire In Requests
+ operationId: get-companies-company_uuid-wire_in_request_uuid
+ description: |-
+ Fetches all Wire In Requests for a company.
+
+ scope: `payrolls:read`
+ parameters:
+ - "$ref": "#/components/parameters/company_uuid"
+ - "$ref": "#/components/parameters/VersionHeader"
+ responses:
+ '200':
+ "$ref": "#/components/responses/Wire-In-Request-List"
+ x-speakeasy-group: wireInRequests
+ x-speakeasy-name-override: list
+ "/v1/companies/{company_uuid}/notifications":
+ get:
+ summary: Get notifications for company
+ operationId: get-company-notifications
+ description: |-
+ Returns all notifications relevant for the given company.
+
+ scope: `notifications:read`
+ tags:
+ - Notifications
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Notifications-List"
+ "/v1/companies/{company_id}/contractors/payment_details":
+ get:
+ summary: List contractor payment details
+ operationId: get-v1-companies-company_id-contractors-payment_details
+ description: |-
+ 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`
+ tags:
+ - Contractors
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Details-List"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ "/v1/contractor_payment_groups/{id}/partner_disbursements":
+ get:
+ summary: Get partner disbursements for a contractor payment group
+ operationId: get-v1-contractor_payment_groups-id-partner_disbursements
+ description: |-
+ Get partner disbursements for a specific contractor payment group.
+
+ scope: `partner_disbursements:read`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group-Partner-Disbursements"
+ '404':
+ description: |
+ Not Found
+
+ The requested contractor payment group does not exist. Make sure the provided UUID is valid.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ patch:
+ summary: Update partner disbursements for a contractor payment group
+ operationId: patch-v1-contractor_payment_groups-id-partner_disbursements
+ description: |-
+ Update partner disbursements for a specific contractor payment group.
+
+ scope: `partner_disbursements:write`
+ tags:
+ - Contractor Payment Groups
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group-Partner-Disbursements"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Not-Found-Error-Object"
+ '422':
+ description: |
+ Unprocessable Entity
+
+ This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ "/v1/companies/{company_id}/payrolls/{id}/partner_disbursements":
+ get:
+ summary: Get partner disbursements for a payroll
+ operationId: get-v1-companies-company_id-payrolls-id-partner_disbursements
+ description: |-
+ Get partner disbursements for a specific payroll.
+
+ scope: `partner_disbursements:read`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Partner-Disbursements"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ patch:
+ summary: Update partner disbursements for a payroll
+ operationId: patch-v1-companies-company_id-payrolls-id-partner_disbursements
+ description: |-
+ Update partner disbursements for a specific payroll.
+
+ scope: `partner_disbursements:write`
+ tags:
+ - Payrolls
+ x-gusto-integration-type:
+ - embedded
+ 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Partner-Disbursements"
+ '422':
+ description: mixed single and multiple errors example
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ "/v1/companies/{company_id}/bank_accounts/{bank_account_id}":
+ delete:
+ summary: Delete a company bank account
+ operationId: delete-v1-companies-company_id-bank-accounts-bank_account_id
+ description: |-
+ 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`
+ tags:
+ - Bank Accounts
+ x-gusto-integration-type:
+ - embedded
+ parameters:
+ - 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
+ - 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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '204':
+ description: successful
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: Cannot delete bank account with unfunded payments
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ "/v1/webhooks/health_check":
+ get:
+ summary: Get the webhooks health status
+ operationId: get-v1-webhooks-health_check
+ description: "Returns the health status (`healthy`, `unhealthy`, or `unknown`) of the webhooks system based on the last ten minutes of activity.\n\n\U0001F4D8 System Access Authentication\n\nThis 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)\n\nscope: `webhook_subscriptions:read`"
+ tags:
+ - Webhooks
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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.
+ security:
+ - SystemAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Webhooks-Health-Check-Status"
+ "/v1/employees/{employee_id}/salary_estimates":
+ post:
+ summary: Create a salary estimate for an employee
+ operationId: post-v1-employees-employee_id-salary_estimates
+ 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.
+
+ 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`
+ tags:
+ - Salary Estimates
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '201':
+ description: successfully created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Salary-Estimate"
+ '422':
+ description: unprocessable entity - invalid parameters
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - zip_code
+ - occupations
+ properties:
+ annual_net_revenue:
+ type: number
+ nullable: true
+ 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.0
+ primary:
+ type: boolean
+ description: Whether this is the primary occupation
+ example: true
+ required: true
+ "/v1/salary_estimates/{uuid}":
+ get:
+ summary: Get a salary estimate
+ operationId: get-v1-salary_estimates-id
+ description: |-
+ 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`
+ tags:
+ - Salary Estimates
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Salary-Estimate"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ put:
+ summary: Update a salary estimate
+ operationId: put-v1-salary_estimates-id
+ description: |-
+ 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`
+ tags:
+ - Salary Estimates
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Salary-Estimate"
+ '422':
+ description: unprocessable entity - already finalized
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - zip_code
+ - occupations
+ properties:
+ annual_net_revenue:
+ type: number
+ nullable: true
+ 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
+ "/v1/salary_estimates/{uuid}/accept":
+ post:
+ summary: Accept a salary estimate
+ operationId: post-v1-salary_estimates-uuid-accept
+ description: |-
+ 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`
+ tags:
+ - Salary Estimates
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Salary-Estimate"
+ '422':
+ description: unprocessable entity - invalid employee job
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ "/v1/salary_estimates/occupations":
+ get:
+ summary: Search for BLS occupations
+ operationId: get-v1-salary_estimates-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.\n\nReturns a list of matching occupations with their codes, titles, and descriptions.\n\n\U0001F4D8 System Access Authentication\n\nThis 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)\n\nscope: `salary_estimates:read`"
+ tags:
+ - Salary Estimates
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ security:
+ - SystemAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/BLS-Occupation"
+ '422':
+ description: unprocessable entity - search term too short
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ "/v1/employees/{employee_id}/recurring_reimbursements":
+ get:
+ summary: Get recurring reimbursements for an employee
+ operationId: get-v1-employees-employee_id-recurring_reimbursements
+ description: |-
+ Get all active recurring reimbursements for an employee.
+
+ scope: `reimbursements:read`
+ tags:
+ - Reimbursements
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ type: object
+ properties:
+ uuid:
+ type: string
+ employee_uuid:
+ type: string
+ description:
+ type: string
+ amount:
+ type: string
+ version:
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ required:
+ - uuid
+ - employee_uuid
+ - description
+ - amount
+ - version
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ post:
+ summary: Create a recurring reimbursement
+ operationId: post-v1-employees-employee_id-recurring_reimbursements
+ description: |-
+ Create a recurring reimbursement for an employee.
+
+ scope: `reimbursements:write`
+ tags:
+ - Reimbursements
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ responses:
+ '201':
+ description: successful
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ uuid:
+ type: string
+ employee_uuid:
+ type: string
+ description:
+ type: string
+ amount:
+ type: string
+ version:
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ required:
+ - uuid
+ - employee_uuid
+ - description
+ - amount
+ - version
+ '422':
+ description: invalid attributes
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ "/v1/recurring_reimbursements/{id}":
+ get:
+ summary: Get a recurring reimbursement
+ operationId: get-v1-recurring_reimbursements
+ description: |-
+ Get a specific recurring reimbursement.
+
+ scope: `reimbursements:read`
+ tags:
+ - Reimbursements
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ uuid:
+ type: string
+ employee_uuid:
+ type: string
+ description:
+ type: string
+ amount:
+ type: string
+ version:
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ required:
+ - uuid
+ - employee_uuid
+ - description
+ - amount
+ - version
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ put:
+ summary: Update a recurring reimbursement
+ operationId: put-v1-recurring_reimbursements
+ description: |-
+ Update a recurring reimbursement.
+
+ scope: `reimbursements:write`
+ tags:
+ - Reimbursements
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ uuid:
+ type: string
+ employee_uuid:
+ type: string
+ description:
+ type: string
+ amount:
+ type: string
+ version:
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ required:
+ - uuid
+ - employee_uuid
+ - description
+ - amount
+ - version
+ '409':
+ description: invalid version
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: invalid attributes
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/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
+ delete:
+ summary: Delete a recurring reimbursement
+ operationId: delete-v1-recurring_reimbursements
+ description: |-
+ Delete (soft delete) a recurring reimbursement for an employee.
+
+ scope: `reimbursements:write`
+ tags:
+ - Reimbursements
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ security:
+ - CompanyAccessAuth: []
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ responses:
+ '204':
+ description: successful
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ "/v1/employees/{employee_uuid}/section603_high_earner_statuses":
+ get:
+ summary: Get all Section 603 high earner statuses for an employee
+ operationId: get-v1-employees-employee_uuid-section603_high_earner_statuses
+ description: |-
+ 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`
+ tags:
+ - Employee Benefits
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful - with records
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status-List"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ post:
+ summary: Create a Section 603 high earner status
+ operationId: post-v1-employees-employee_uuid-section603_high_earner_statuses
+ description: |-
+ 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`
+ tags:
+ - Employee Benefits
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '201':
+ description: created
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '409':
+ description: conflict - record already exists
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: unprocessable entity - invalid is_high_earner
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status-Create-Request"
+ required: true
+ "/v1/employees/{employee_uuid}/section603_high_earner_statuses/{effective_year}":
+ get:
+ summary: Get a Section 603 high earner status for a specific year
+ operationId: get-v1-employees-employee_uuid-section603_high_earner_statuses-effective_year
+ description: |-
+ 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`
+ tags:
+ - Employee Benefits
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status"
+ '404':
+ description: not found - employee does not exist
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: unprocessable entity - invalid effective_year
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ patch:
+ summary: Update a Section 603 high earner status
+ operationId: patch-v1-employees-employee_uuid-section603_high_earner_statuses-effective_year
+ description: |-
+ 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`
+ tags:
+ - Employee Benefits
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ 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:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status"
+ '404':
+ description: not found - employee does not exist
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '422':
+ description: unprocessable entity - invalid is_high_earner
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status-Update-Request"
+ required: true
+ "/v1/companies/{company_id}/people_batches":
+ post:
+ summary: Create a people batch
+ operationId: post-v1-companies-company_id-people_batches
+ description: |-
+ 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`
+ tags:
+ - People Batches
+ x-gusto-integration-type:
+ - embedded
+ 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-11-15'
+ default: '2025-11-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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '201':
+ description: created
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ uuid:
+ type: string
+ format: uuid
+ idempotency_key:
+ type: string
+ format: uuid
+ status:
+ type: string
+ enum:
+ - pending
+ - processing
+ - completed
+ - failed
+ batch_action:
+ type: string
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '409':
+ description: conflict - idempotency key already used
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ errors:
+ type: array
+ items:
+ type: object
+ properties:
+ error_key:
+ type: string
+ category:
+ type: string
+ message:
+ type: string
+ metadata:
+ type: object
+ properties:
+ entity_uuid:
+ type: string
+ format: uuid
+ entity_type:
+ type: string
+ '422':
+ description: unprocessable entity - validation errors
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ maxLength: 1
+ minLength: 1
+ nullable: true
+ description: Middle initial
+ preferred_first_name:
+ type: string
+ nullable: true
+ description: Preferred first name
+ email:
+ type: string
+ format: email
+ nullable: true
+ description: Personal email address
+ work_email:
+ type: string
+ format: email
+ nullable: true
+ description: Work email address
+ ssn:
+ type: string
+ nullable: true
+ description: 'Social Security Number (format: xxx-xx-xxxx)'
+ date_of_birth:
+ type: string
+ format: date
+ nullable: true
+ description: Date of birth (YYYY-MM-DD)
+ self_onboarding:
+ type: boolean
+ nullable: true
+ 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
+ nullable: true
+ description: Whether this job is eligible for workers' compensation coverage in the state of Washington (WA).
+ state_wc_class_code:
+ type: string
+ nullable: true
+ 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`.
+ effective_date:
+ type: string
+ format: date
+ description: The date when the compensation takes effect.
+ 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 accounts and payment methods for direct deposit. If 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
+ nullable: true
+ 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
+ nullable: true
+ description: Split amount in percentage or CENTS (`null` for remainder account)
+ required: true
+ "/v1/people_batches/{people_batch_uuid}":
+ get:
+ summary: Get a people batch
+ operationId: get-v1-people_batches-people_batch_uuid
+ description: |-
+ 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`
+ tags:
+ - People Batches
+ x-gusto-integration-type:
+ - embedded
+ 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-11-15'
+ default: '2025-11-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.
+ security:
+ - CompanyAccessAuth: []
+ responses:
+ '200':
+ description: successful
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ uuid:
+ type: string
+ format: uuid
+ idempotency_key:
+ type: string
+ format: uuid
+ status:
+ type: string
+ enum:
+ - pending
+ - processing
+ - completed
+ - failed
+ - partial_success
+ submitted_at:
+ type: string
+ format: date-time
+ completed_at:
+ type: string
+ format: date-time
+ nullable: true
+ submitted_items:
+ type: integer
+ nullable: true
+ processed_items:
+ type: integer
+ excluded_items:
+ type: integer
+ results:
+ type: array
+ 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
+ nullable: true
+ 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
+ nullable: true
+ description: Human-readable error message
+ errors:
+ type: array
+ nullable: true
+ description: Nested errors for sub-operations
+ items:
+ type: object
+ exclusions:
+ type: array
+ nullable: true
+ 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
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ "/v1/companies/{company_id}/reports/employees_annual_fica_wage":
+ post:
+ summary: Create an employees annual FICA wage report
+ operationId: post-v1-companies-company_id-reports-employees_annual_fica_wage
+ description: |-
+ 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`
+ tags:
+ - Reports
+ x-gusto-integration-type:
+ - embedded
+ - app-integrations
+ parameters:
+ - name: X-Gusto-API-Version
+ in: header
+ schema:
+ type: string
+ enum:
+ - '2024-04-01'
+ default: '2024-04-01'
+ description: Determines the date-based API version associated with your API call. 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
+ security:
+ - CompanyAccessAuth: []
+ 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
+ '422':
+ description: unprocessable entity - start year before minimum
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ '404':
+ description: not found
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Unprocessable-Entity-Error-Object"
+ requestBody:
+ 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
+ "/v1/information_requests/{information_request_uuid}/submit":
+ put:
+ x-gusto-integration-type:
+ - embedded
+ summary: Submit information request responses
+ tags:
+ - Information Requests
+ operationId: submit-information-request
+ x-speakeasy-group: informationRequests
+ x-speakeasy-name-override: submit
+ description: |-
+ Submit responses to an information request.
+ Supports both text responses and file uploads (multipart/form-data).
+ Maximum file size: 120MB.
+
+ scope: `information_requests:write`
+ parameters:
+ - "$ref": "#/components/parameters/information_request_uuid"
+ requestBody:
+ 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.
+ responses:
+ '200':
+ description: Information request successfully submitted
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Information-Request"
+ '422':
+ description: Validation error - invalid responses or missing required answers
+ "$ref": "#/components/responses/Unprocessable-Entity-Error-Object"
+ '404':
+ "$ref": "#/components/responses/Not-Found-Error-Object"
+components:
+ parameters:
+ search_term:
+ name: search_term
+ in: query
+ schema:
+ type: string
+ description: A string to search for in the object's names
+ pageParam:
+ schema:
+ type: integer
+ in: query
+ name: page
+ description: The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
+ perParam:
+ schema:
+ type: integer
+ in: query
+ name: per
+ description: Number of objects per page. For majority of endpoints will default to 25
+ start_date:
+ in: query
+ name: start_date
+ schema:
+ type: string
+ example: '2020-01-01'
+ end_date:
+ in: query
+ name: end_date
+ description: If left empty, defaults to today's date.
+ schema:
+ type: string
+ example: '2020-01-31'
+ bank_account_uuid:
+ name: bank_account_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the bank account
+ benefit_id:
+ schema:
+ type: string
+ name: benefit_id
+ in: path
+ required: true
+ description: The benefit type in Gusto.
+ compensation_id:
+ schema:
+ type: string
+ name: compensation_id
+ in: path
+ required: true
+ description: The UUID of the compensation
+ company_attachment_uuid:
+ schema:
+ type: string
+ name: company_attachment_uuid
+ in: path
+ required: true
+ description: The UUID of the company attachment
+ company_benefit_id:
+ schema:
+ type: string
+ name: company_benefit_id
+ in: path
+ required: true
+ description: The UUID of the company benefit
+ company_forms_sort_by:
+ name: sort_by
+ in: query
+ required: false
+ description: 'Sort company forms. Options: name, year, quarter, draft, document_content_type'
+ schema:
+ type: string
+ enum:
+ - name
+ - year
+ - quarter
+ - draft
+ - document_content_type
+ company_id:
+ name: company_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the company
+ company_uuid:
+ name: company_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the company
+ contractor_uuid:
+ name: contractor_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the contractor
+ contractor_payment_id:
+ name: contractor_payment_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the contractor payment
+ contractor_payment_uuid:
+ name: contractor_payment_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the contractor payment
+ contractor_payment_group_uuid:
+ name: contractor_payment_group_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the contractor payment group
+ contractors_sort_by:
+ name: sort_by
+ in: query
+ required: false
+ description: 'Sort contractors. Options: type, onboarding_status, name, created_at'
+ schema:
+ type: string
+ enum:
+ - type
+ - onboarding_status
+ - name
+ - created_at
+ department_uuid:
+ name: department_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the department
+ document_id:
+ name: document_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the document
+ earning_type_uuid:
+ schema:
+ type: string
+ name: earning_type_uuid
+ in: path
+ required: true
+ description: The UUID of the earning type
+ effective_date:
+ in: query
+ name: effective_date
+ required: false
+ schema:
+ type: string
+ example: '2020-01-31'
+ employee_benefit_id:
+ name: employee_benefit_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the employee benefit.
+ employee_id:
+ name: employee_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the employee
+ employee_uuid:
+ name: employee_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the employee
+ sort_order:
+ name: sort_order
+ in: query
+ required: false
+ schema:
+ type: string
+ example: asc
+ 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.
+ event_type:
+ name: event_type
+ in: query
+ required: false
+ schema:
+ type: string
+ 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.)
+ external_payroll_id:
+ name: external_payroll_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the external payroll
+ form_id:
+ name: form_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the form
+ document_uuid:
+ name: document_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the document
+ garnishment_id:
+ name: garnishment_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the garnishment
+ historical_employee_uuid:
+ name: historical_employee_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the historical employee
+ home_address_uuid:
+ name: home_address_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the home address
+ work_address_uuid:
+ name: work_address_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the work address
+ job_id:
+ schema:
+ type: string
+ name: job_id
+ in: path
+ required: true
+ description: The UUID of the job
+ limit:
+ name: limit
+ in: query
+ required: false
+ schema:
+ type: string
+ description: Limits the number of objects returned in a single response, between 1 and 100. The default is 25
+ location_id:
+ name: location_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the location
+ location_uuid:
+ name: location_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the location
+ payroll_id:
+ name: payroll_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the payroll
+ payroll_uuid:
+ name: payroll_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the payroll
+ pay_schedule_id:
+ name: pay_schedule_id
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the pay schedule
+ payroll_types:
+ name: payroll_types
+ in: query
+ required: false
+ schema:
+ type: string
+ description: regular and/or transition. Multiple options are comma separated. The default is regular pay periods if nothing is passed in.
+ payroll_prepare_sort_by:
+ name: sort_by
+ in: query
+ required: false
+ description: 'Sort employee compenstations by name. Options: first_name, last_name'
+ schema:
+ type: string
+ enum:
+ - first_name
+ - last_name
+ document_type:
+ name: document_type
+ in: path
+ required: true
+ schema:
+ type: string
+ enum:
+ - printable_payroll_checks
+ description: The type of document being generated
+ report_type:
+ schema:
+ type: string
+ name: report_type
+ in: path
+ required: true
+ description: The report type
+ report_uuid:
+ schema:
+ type: string
+ name: report_uuid
+ in: path
+ required: true
+ description: The UUID of the report request
+ request_uuid:
+ 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.
+ signatory_uuid:
+ name: signatory_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the signatory
+ starting_after_uuid:
+ name: starting_after_uuid
+ in: query
+ required: false
+ schema:
+ type: string
+ description: A cursor for pagination. Returns all events occuring after the specified UUID (exclusive). Events are sorted according to the provided sort_order param.
+ resource_uuid:
+ name: resource_uuid
+ in: query
+ required: false
+ schema:
+ type: string
+ description: The UUID of the company. If not specified, will return all events for all companies.
+ time_off_type:
+ 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'''
+ time_off_policy_uuid:
+ name: time_off_policy_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the company time off policy
+ webhook_subscription_uuid:
+ name: webhook_subscription_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The webhook subscription UUID.
+ VersionHeader:
+ 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'
+ IpAddressHeader:
+ 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
+ notification_uuid:
+ name: notification_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The notification entity_uuid
+ invoice_period:
+ 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
+ recovery_case_uuid:
+ name: recovery_case_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the recovery case
+ contractor_payment_uuid_query:
+ name: contractor_payment_uuid
+ in: query
+ required: false
+ schema:
+ type: string
+ description: The UUID of the contractor payment
+ payroll_uuid_query:
+ name: payroll_uuid
+ in: query
+ required: false
+ schema:
+ type: string
+ description: The UUID of the payroll
+ transaction_type:
+ 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".
+ payment_direction:
+ 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".
+ wire_in_request_uuid:
+ name: wire_in_request_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the Wire In Request
+ time_sheet_uuid:
+ name: time_sheet_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: UUID of the time sheet
+ entity_uuids:
+ name: entity_uuids
+ required: false
+ in: query
+ schema:
+ type: array
+ items:
+ type: string
+ description: Entity UUIDs that reported time sheets
+ entity_type:
+ name: entity_type
+ required: false
+ in: query
+ schema:
+ type: string
+ enum:
+ - Employee
+ - Contractor
+ description: 'Type of entities to filter. One of: "Employee", "Contractor"'
+ status:
+ name: status
+ required: false
+ in: query
+ schema:
+ type: string
+ enum:
+ - approved
+ - pending
+ - rejected
+ description: 'Status of time sheets. One of: "approved", "pending", "rejected"'
+ time_sheet_before:
+ name: before
+ required: false
+ in: query
+ schema:
+ type: string
+ description: time sheets that were created before ISO 8601 timestamp. Filtering by "created_at"
+ time_sheet_after:
+ name: after
+ required: false
+ in: query
+ schema:
+ type: string
+ description: time sheets that were created before ISO 8601 timestamp. Filtering by "created_at"
+ time_sheet_sort_by:
+ name: sort_by
+ required: false
+ in: query
+ schema:
+ type: string
+ enum:
+ - created_at
+ - updated_at
+ - shift_started_at
+ - shift_ended_at
+ description: 'Field to sort by. One of: "created_at", "updated_at", "shift_started_at", "shift_ended_at"'
+ time_sheet_sort_order:
+ name: sort_order
+ required: false
+ in: query
+ schema:
+ type: string
+ enum:
+ - asc
+ - desc
+ description: 'Sorting order. One of: "asc", "desc"'
+ resource_version:
+ name: version
+ required: true
+ in: query
+ schema:
+ 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.
+ information_request_uuid:
+ name: information_request_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ description: The UUID of the information request
+ schemas:
+ Versionable-Required:
+ 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
+ Versionable:
+ 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.
+ Employee-Address:
+ 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
+ Employee-Work-Address:
+ 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
+ Contractor-Address:
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/Address"
+ - type: object
+ properties:
+ contractor_uuid:
+ type: string
+ description: The UUID of the contractor
+ Address:
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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
+ Employee-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'
+ Department:
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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
+ Employee:
+ 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:
+ last_name: Koss
+ email: keena.feest@kiehn.co.uk
+ company_uuid: e904cc79-818a-4da8-9d37-0be0a86fdda8
+ manager_uuid:
+ version: a5cec1f1c0135feb3e76ca6ea3c46176
+ current_employment_status: full_time
+ onboarding_status: onboarding_completed
+ preferred_first_name:
+ department_uuid:
+ employee_code: 46f036
+ payment_method: Direct Deposit
+ department:
+ terminated: false
+ two_percent_shareholder: false
+ onboarded: true
+ historical: false
+ has_ssn: true
+ onboarding_documents_config:
+ uuid:
+ 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:
+ state_wc_class_code:
+ 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:
+ work_email:
+ member_portal_invitation_status:
+ status: sent
+ token_expired: false
+ welcome_email_sent_at: '2024-01-15T14:30:00Z'
+ last_password_resent_at:
+ 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:
+ type:
+ - string
+ - 'null'
+ description: The current onboarding status of the employee
+ 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
+ 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:
+ "$ref": "#/components/schemas/Job"
+ eligible_paid_time_off:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Paid-Time-Off"
+ terminations:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Termination"
+ garnishments:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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:
+ "$ref": "#/components/schemas/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:
+ type:
+ - string
+ - '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.'
+ enum:
+ - full_time
+ - part_time_under_twenty_hours
+ - part_time_twenty_plus_hours
+ - variable
+ - seasonal
+ 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:
+ "$ref": "#/components/schemas/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
+ Employee-Onboarding-Status:
+ 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
+ Company-Address:
+ 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
+ Location:
+ description: The representation of an address in Gusto.
+ type: object
+ title: ''
+ 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: CO
+ 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
+ Paid-Time-Off:
+ 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
+ Child-Support-Data:
+ 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
+ Garnishment-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.
+ 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.
+ 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:
+ 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:
+ 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:
+ 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:
+ 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:
+ type:
+ - string
+ - 'null'
+ enum:
+ - child_support
+ - federal_tax_lien
+ - state_tax_lien
+ - student_loan
+ - creditor_garnishment
+ - federal_loan
+ - other_garnishment
+ description: The specific type of garnishment for court ordered garnishments.
+ child_support:
+ "$ref": "#/components/schemas/Garnishment-Child-Support"
+ required:
+ - uuid
+ Employee-Onboarding-Document:
+ type: object
+ description: Configuration for an employee onboarding documents during onboarding
+ properties:
+ i9_document:
+ type: string
+ description: Whether to include Form I-9 for an employee during onboarding
+ readOnly: true
+ I9-Authorization:
+ 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
+ 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
+ description: The document's document type
+ enum:
+ - uscis_alien_registration_number
+ - form_i94
+ - foreign_passport
+ has_document_number:
+ type: boolean
+ description: Whether or not a `document_number` exists for this document.
+ expiration_date:
+ type: string
+ description: The document's expiration date
+ country:
+ type: string
+ 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
+ description: Any additional notes
+ alt_procedure:
+ type: boolean
+ 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
+ I9-Authorization-Document:
+ 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
+ I9-Authorization-Document-Option:
+ 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
+ Termination:
+ 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
+ Rehire-Body:
+ 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
+ Fast-Payment-Limit-Param:
+ type: string
+ description: Fast payment limit. This limit is an aggregate of all fast payrolls amount. This limit is only relevant when payment speed is 1-day or 2-day.
+ Payment-Speed-Param:
+ type: string
+ description: Gusto Embedded supports three payment speeds (1-day, 2-day, and 4-day). For next-day payments, funds are deposited in your team's bank account by the end of the next business day. Most people will see the funds arrive the next afternoon, but payments may arrive as late as the end of the business day.
+ enum:
+ - 1-day
+ - 2-day
+ - 4-day
+ Fast-Payment-Limit-Required-Body:
+ type: object
+ properties:
+ fast_payment_limit:
+ "$ref": "#/components/schemas/Fast-Payment-Limit-Param"
+ payment_speed:
+ "$ref": "#/components/schemas/Payment-Speed-Param"
+ required:
+ - fast_payment_limit
+ Payment-Speed-Required-Body:
+ type: object
+ properties:
+ fast_payment_limit:
+ "$ref": "#/components/schemas/Fast-Payment-Limit-Param"
+ payment_speed:
+ "$ref": "#/components/schemas/Payment-Speed-Param"
+ required:
+ - payment_speed
+ Historical-Employee-Body:
+ 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
+ Pay-Schedule-Assignment-Body:
+ type: object
+ properties:
+ type:
+ type:
+ - string
+ - 'null'
+ enum:
+ - single
+ - hourly_salaried
+ - by_employee
+ - by_department
+ 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
+ Flsa-Status-Type:
+ 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. '
+ Compensation:
+ 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:
+ "$ref": "#/components/schemas/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.
+ 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
+ Form-Document-Content-Type-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
+ Form:
+ 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:
+ "$ref": "#/components/schemas/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:
+ quarter:
+ requires_signing: true
+ document_content_type: application/pdf
+ x-tags:
+ - Forms
+ required:
+ - uuid
+ Form_1099:
+ 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:
+ "$ref": "#/components/schemas/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:
+ document_content_type: application/pdf
+ contractor_uuid: 123dd616-6dbc-4724-938a-403f6217a933
+ x-tags:
+ - Forms
+ required:
+ - uuid
+ Form-Pdf:
+ 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:
+ "$ref": "#/components/schemas/Form-Document-Content-Type-Type"
+ required:
+ - uuid
+ Document:
+ 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:
+ x: 69
+ "y": 94
+ width: 261
+ height: 13
+ page_number: 0
+ data_type: text
+ required: true
+ - key: optional_text1596141704672
+ value:
+ x: 69
+ "y": 118
+ width: 262
+ height: 13
+ page_number: 0
+ data_type: text
+ required: false
+ signed_at:
+ description: Form W-9, Request for Taxpayer Identification Number and Certification
+ requires_signing: true
+ draft: false
+ year:
+ quarter:
+ x-tags:
+ - Documents
+ Document-Signed:
+ 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:
+ quarter:
+ x-tags:
+ - Documents
+ Document-Pdf:
+ 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
+ Industry:
+ title: Industry
+ type: object
+ properties:
+ company_uuid:
+ type: string
+ description: Company uuid
+ readOnly: true
+ naics_code:
+ type:
+ - string
+ - 'null'
+ 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.
+ readOnly: true
+ sic_codes:
+ type: array
+ description: A list of Standard Industrial Classification (SIC) codes, which are four digit number that categorize the industries that companies belong to based on their business activities.
+ readOnly: true
+ items:
+ type: string
+ title:
+ type:
+ - string
+ - 'null'
+ description: Industry title
+ readOnly: true
+ x-examples:
+ Example:
+ company_uuid: 423dd616-6dbc-4724-938a-403f6217a933
+ naics_code: '611420'
+ sic_codes:
+ - '8243'
+ title: Computer Training
+ x-tags:
+ - Industry
+ Job:
+ 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:
+ 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:
+ "$ref": "#/components/schemas/Compensation"
+ readOnly: true
+ location_uuid:
+ type: string
+ nullable: false
+ description: The uuid of the employee's work location.
+ location:
+ "$ref": "#/components/schemas/Location"
+ description: The representation of a job in Gusto.
+ required:
+ - uuid
+ External-Payroll:
+ description: The representation of an external payroll.
+ type: object
+ x-tags:
+ - External Payrolls
+ title: ''
+ 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.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
+ required:
+ - uuid
+ Webhook-Subscription:
+ description: The representation of webhook subscription.
+ type: object
+ x-tags:
+ - Webhooks
+ title: ''
+ 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
+ External-Payroll-Basic:
+ description: The representation of an external payroll with minimal information.
+ type: object
+ x-tags:
+ - External Payrolls
+ title: ''
+ 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
+ External-Payroll-Tax-Suggestions:
+ description: The representation of an external payroll with minimal information.
+ type: object
+ x-tags:
+ - External Payrolls
+ title: ''
+ 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'
+ Tax-Liabilities-Selections:
+ description: The representation of tax liabilities selections.
+ type: array
+ x-tags:
+ - External Payrolls
+ title: ''
+ items:
+ type: object
+ 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:
+ possible_liabilities:
+ - liability_amount: '0.0'
+ payroll_check_date:
+ external_payroll_uuid:
+ - liability_amount: '3000.0'
+ payroll_check_date: '2022-06-01'
+ external_payroll_uuid: 1bf1efe1-72d4-4e6e-a181-611f3ea66435
+ Admin:
+ 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
+ Company:
+ 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:
+ type:
+ - string
+ - 'null'
+ enum:
+ - single
+ - hourly_salaried
+ - by_employee
+ - by_department
+ 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:
+ "$ref": "#/components/schemas/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:
+ Example:
+ ein: 00-0000001
+ entity_type: C-Corporation
+ tier: complete
+ contractor_only: false
+ is_suspended: false
+ company_status: Approved
+ name: Shoppe Studios LLC
+ trade_name: Record Shoppe
+ is_partner_managed: false
+ pay_schedule_type: by_department
+ 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
+ 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:
+ first_name: Alda
+ middle_initial: ''
+ last_name: Carter
+ phone:
+ 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
+ Company-Onboarding-Status:
+ description: The representation of a company's onboarding status
+ type: object
+ title: ''
+ 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:
+ skippable: false
+ requirements: []
+ - title: Sign Documents
+ id: sign_all_forms
+ required: true
+ completed: false
+ completed_at:
+ 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:
+ 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
+ Payment-Configs:
+ 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
+ readOnly: true
+ payment_speed:
+ type: string
+ description: Payment speed for 1-day, 2-day, 4-day
+ 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:
+ Example:
+ company_uuid: 423dd616-6dbc-4724-938a-403f6217a933
+ partner_uuid: 556f05d0-48e0-4c47-bce5-db9aea923043
+ fast_payment_limit: '5000'
+ payment_speed: 2-day
+ partner_owned_disbursement: false
+ earned_fast_ach_blockers:
+ - blocker_type: minimum_days
+ threshold: 15
+ - blocker_type: minimum_funded_payments
+ threshold: 1
+ x-tags:
+ - Payment Configs
+ Contractor-Body:
+ 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.
+
+'
+ enum:
+ - Fixed
+ - Hourly
+ start_date:
+ type: string
+ description: 'The day when the contractor will start working for the company.
+
+'
+ 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.
+ Self-onboarding is recommended so that contractors receive Gusto accounts.
+ If 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.
+ This attribute is required for `Individual` contractors and will be ignored for `Business` contractors.
+ last_name:
+ type: string
+ description: |-
+ The contractor’s last name.
+ This attribute is required for `Individual` contractors and will be ignored for `Business` contractors.
+ middle_initial:
+ type: string
+ description: |-
+ The contractor’s middle initial.
+ This 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.
+ This 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.
+ This value is used when generating the new hire report.
+ This 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.
+ Social 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.
+ This 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.
+ Contractor:
+ 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.
+ This 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:
+ type:
+ - string
+ - 'null'
+ description: The contractor's payment method.
+ enum:
+ - Direct Deposit
+ - Check
+ - 'null'
+ 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
+ dismissal_date:
+ type:
+ - string
+ - 'null'
+ description: The contractor's dismissal date.
+ readOnly: true
+ x-tags:
+ - Contractors
+ required:
+ - uuid
+ Contractor-Onboarding-Status:
+ 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
+ Contractor-Payment:
+ description: The representation of a single contractor payment.
+ type: object
+ x-examples:
+ Example:
+ uuid: 04552eb9-7829-4b18-ae96-6983552948df
+ 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
+ description: The bonus amount in the payment.
+ readOnly: true
+ date:
+ type: string
+ description: The payment date.
+ 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: Contractor payment status
+ 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 Payments
+ required:
+ - uuid
+ Contractor-Payment-Group:
+ description: The full contractor payment group, including associated contractor payments.
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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
+ "$ref": "#/components/schemas/Payroll-Submission-Blockers-Type"
+ credit_blockers:
+ type: array
+ description: List of credit blockers for the contractor payment group.
+ readOnly: true
+ items:
+ type: object
+ "$ref": "#/components/schemas/Payroll-Credit-Blockers-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:
+ "$ref": "#/components/schemas/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
+ Contractor-Payment-Group-Minimal:
+ description: The summary of a contractor payment group.
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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
+ Contractor-Payment-For-Group:
+ 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
+ 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:
+ Example:
+ 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
+ description: The total reimbursements for contractor payments within a given time period.
+ readOnly: true
+ wages:
+ type: string
+ 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
+ description: The total reimbursements for the contractor within a given time period.
+ readOnly: true
+ wage_total:
+ type: string
+ 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:
+ "$ref": "#/components/schemas/Contractor-Payment"
+ readOnly: true
+ readOnly: true
+ x-tags:
+ - Contractor Payments
+ Contractor-Payment-Summary-By-Dates:
+ description: The representation of the summary of contractor payments for a given company in a given time period.
+ type: object
+ x-examples:
+ Example:
+ 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
+ description: The total reimbursements for contractor payments within a given time period.
+ readOnly: true
+ wages:
+ type: string
+ 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
+ description: The total reimbursements for the contractor within a given time period.
+ readOnly: true
+ wage_total:
+ type: string
+ 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:
+ "$ref": "#/components/schemas/Contractor-Payment"
+ readOnly: true
+ readOnly: true
+ readOnly: true
+ x-tags:
+ - Contractor Payments
+ Contractor-Payment-Method:
+ 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:
+ type:
+ - string
+ - 'null'
+ enum:
+ - Direct Deposit
+ - Check
+ - '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:
+ type:
+ - string
+ - 'null'
+ enum:
+ - Amount
+ - Percentage
+ 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:
+ "$ref": "#/components/schemas/Payment-Method-Bank-Account"
+ x-tags:
+ - Contractor Payment Method
+ Payment-Method-Bank-Account:
+ 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
+ Unprocessable-Entity-Error-Object:
+ description: "Unprocessable Entity\n \nThis may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request 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:
+ "$ref": "#/components/schemas/Entity-Error-Object"
+ x-examples:
+ bank_account_delete_unfunded_payments:
+ errors:
+ - error_key: base
+ category: invalid_operation
+ message: FundingMethod has unfunded payments
+ bank_account_missing_routing:
+ errors:
+ - error_key: routing_number
+ category: invalid_attribute_value
+ message: Routing number is required.
+ 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.
+ invalid_version:
+ errors:
+ - error_key: base
+ category: invalid_resource_version
+ message: You are attempting to update a resource using an out-of-date version.
+ 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.
+ 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.
+ basic:
+ errors:
+ - error_key: base
+ category: payroll_blocker
+ message: Company must complete all onboarding requirements in order to run payroll.
+ metadata:
+ key: needs_onboarding
+ 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
+ Entity-Error-Object:
+ type: object
+ required:
+ - error_key
+ - category
+ properties:
+ error_key:
+ type: string
+ description: Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error.
+ category:
+ type: 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:
+ - "$ref": "#/components/schemas/Metadata-With-Multiple-Entities"
+ - "$ref": "#/components/schemas/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:
+ "$ref": "#/components/schemas/Entity-Error-Object"
+ Metadata-With-One-Entity:
+ type: object
+ description: single entity
+ additionalProperties: true
+ properties:
+ entity_type:
+ type: string
+ description: Name of the entity that the error corresponds to.
+ entity_uuid:
+ type: string
+ description: Unique identifier for the entity.
+ valid_from:
+ type:
+ - string
+ - 'null'
+ valid_up_to:
+ type:
+ - string
+ - 'null'
+ key:
+ type:
+ - string
+ - 'null'
+ state:
+ type:
+ - string
+ - 'null'
+ Metadata-With-Multiple-Entities:
+ type: object
+ description: multiple entities
+ required:
+ - entities
+ properties:
+ entities:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Metadata-With-One-Entity"
+ Payroll-Blockers-Error:
+ description: |-
+ Payroll Blockers Error
+
+ For 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"
+ Authentication:
+ description: ''
+ type: object
+ oneOf:
+ - "$ref": "#/components/schemas/Create-Token-Authentication"
+ - "$ref": "#/components/schemas/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
+ Pay-Schedule:
+ 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:
+ "$ref": "#/components/schemas/Pay-Schedule-Uuid"
+ frequency:
+ "$ref": "#/components/schemas/Pay-Schedule-Frequency"
+ anchor_pay_date:
+ "$ref": "#/components/schemas/Pay-Schedule-Anchor-Pay-Date"
+ anchor_end_of_pay_period:
+ "$ref": "#/components/schemas/Pay-Schedule-Anchor-End-Of-Pay-Period"
+ day_1:
+ "$ref": "#/components/schemas/Pay-Schedule-Day-1"
+ day_2:
+ "$ref": "#/components/schemas/Pay-Schedule-Day-2"
+ name:
+ "$ref": "#/components/schemas/Pay-Schedule-Name"
+ custom_name:
+ "$ref": "#/components/schemas/Pay-Schedule-Custom-Name"
+ auto_pilot:
+ "$ref": "#/components/schemas/Pay-Schedule-Auto-Pilot"
+ active:
+ "$ref": "#/components/schemas/Pay-Schedule-Active"
+ x-tags:
+ - Pay Schedules
+ required:
+ - uuid
+ Pay-Schedule-Create-Update:
+ 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:
+ "$ref": "#/components/schemas/Pay-Schedule-Uuid"
+ frequency:
+ "$ref": "#/components/schemas/Pay-Schedule-Frequency-Create-Update"
+ anchor_pay_date:
+ "$ref": "#/components/schemas/Pay-Schedule-Anchor-Pay-Date"
+ anchor_end_of_pay_period:
+ "$ref": "#/components/schemas/Pay-Schedule-Anchor-End-Of-Pay-Period"
+ day_1:
+ "$ref": "#/components/schemas/Pay-Schedule-Day-1"
+ day_2:
+ "$ref": "#/components/schemas/Pay-Schedule-Day-2"
+ name:
+ "$ref": "#/components/schemas/Pay-Schedule-Name"
+ custom_name:
+ "$ref": "#/components/schemas/Pay-Schedule-Custom-Name"
+ auto_pilot:
+ "$ref": "#/components/schemas/Pay-Schedule-Auto-Pilot"
+ active:
+ "$ref": "#/components/schemas/Pay-Schedule-Active"
+ x-tags:
+ - Pay Schedules
+ required:
+ - uuid
+ Pay-Schedule-Uuid:
+ type: string
+ description: The unique identifier of the pay schedule in Gusto.
+ readOnly: true
+ Pay-Schedule-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
+ Pay-Schedule-Frequency-Create-Update:
+ 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
+ Pay-Schedule-Anchor-Pay-Date:
+ type: string
+ description: The first date that employees on this pay schedule are paid with Gusto.
+ readOnly: true
+ Pay-Schedule-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
+ Pay-Schedule-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
+ Pay-Schedule-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
+ Pay-Schedule-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
+ Pay-Schedule-Custom-Name:
+ type: string
+ description: A custom name for a pay schedule, defaults to the pay frequency description.
+ readOnly: true
+ Pay-Schedule-Auto-Pilot:
+ type: boolean
+ description: With Autopilot® enabled, payroll will run automatically one day before your payroll deadlines.
+ Pay-Schedule-Active:
+ type: boolean
+ description: Whether this pay schedule is associated with any employees. A pay schedule is inactive when it's unassigned.
+ readOnly: true
+ Ytd-Benefit-Amounts-From-Different-Company:
+ 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
+ Company-Attachment:
+ 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
+ Company-Bank-Account:
+ 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.
+
+ 'awaiting_deposits' means the bank account is just created and money is being transferred.
+ 'ready_for_verification' means the micro-deposits are completed and the verification process can begin by using the verify endpoint.
+ '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.
+
+ 'bank_deposits' means the bank account is connected by entering routing and accounting numbers and verifying through micro-deposits.
+ 'plaid' means the bank account is connected through Plaid.
+ plaid_status:
+ type:
+ - string
+ - 'null'
+ enum:
+ - connected
+ - disconnected
+ 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
+ Benefit-Type-Requirements:
+ 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
+ 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
+ Benefit-Summary:
+ 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.
+ Supported-Benefit:
+ 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
+ Company-Benefit-With-Employee-Benefits:
+ 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
+ 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
+ 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.
+
+ "amount": The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ "percentage": The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ "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.
+
+ For 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.
+
+ Use threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.
+
+ For example:
+
+ If 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.
+
+ If 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
+ Company-Benefit:
+ 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
+ Earning-Type:
+ 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
+ Employee-Benefit-Base-Object:
+ description: ''
+ type: object
+ title: ''
+ 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.
+
+ "amount": The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ "percentage": The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.
+
+ "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.
+
+ For 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.
+
+ Use threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.
+
+ For example:
+
+ If 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.
+
+ If 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.
+
+ `Family` and `Individual` are applicable to HSA benefit.
+
+ `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.
+ Employee-Benefit:
+ description: The representation of an employee benefit.
+ type: object
+ title: ''
+ 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:
+ retirement_loan_identifier:
+ deduct_as_percentage: false
+ contribute_as_percentage: false
+ catch_up: false
+ coverage_amount:
+ deduction_reduces_taxable_income:
+ coverage_salary_multiplier: '0.00'
+ contribution:
+ type: amount
+ value: '100.00'
+ elective: false
+ effective_date: '2025-01-01'
+ expiration_date:
+ 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:
+ deduct_as_percentage: false
+ catch_up: false
+ coverage_amount:
+ deduction_reduces_taxable_income:
+ 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:
+ allOf:
+ - "$ref": "#/components/schemas/Employee-Benefit-Base-Object"
+ - 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
+ Employee-Benefit-For-Company-Benefit:
+ description: The representation of an employee benefit for a company benefit.
+ type: object
+ title: ''
+ allOf:
+ - "$ref": "#/components/schemas/Employee-Benefit-Base-Object"
+ - 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.
+ readOnly: true
+ required:
+ - employee_uuid
+ Employee-Pay-Stub:
+ 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
+ Pay-Period:
+ 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-tags:
+ - Payrolls
+ Contribution-Exclusion:
+ 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
+ Created-At-Type:
+ type: string
+ format: date-time
+ description: Datetime for when the resource was created.
+ readOnly: true
+ Off-Cycle-Reason-Type:
+ type:
+ - string
+ - 'null'
+ description: The off-cycle reason. Only included for off-cycle payrolls.
+ readOnly: true
+ enum:
+ - Adhoc
+ - Benefit reversal
+ - Bonus
+ - Correction
+ - Dismissed employee
+ - Hired employee
+ - Wage correction
+ - Tax reconciliation
+ - Reversal
+ - Disability insurance distribution
+ - Transition from old pay schedule
+ Auto-Pilot-Type:
+ type: boolean
+ description: Indicates whether the payroll is an auto pilot payroll
+ readOnly: true
+ Payroll-Employee-Compensations-Type:
+ 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
+ version:
+ type: string
+ 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.
+ 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
+ description: The outstanding hours paid upon termination. This field is only applicable for termination payrolls.
+ deductions:
+ type: array
+ uniqueItems: false
+ 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.
+ 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
+ Payroll-Totals-Type:
+ 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
+ Payroll-Company-Taxes-Type:
+ 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
+ Payroll-Payment-Speed-Changed-Type:
+ 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
+ Payroll-Payroll-Status-Meta-Type:
+ 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
+ Payroll-Pay-Period-Type:
+ 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
+ Payroll-Withholding-Pay-Period-Type:
+ 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
+ Payroll-Deadline-Type:
+ 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
+ Payroll-Check-Date-Type:
+ type: string
+ description: The date on which employees will be paid for the payroll.
+ readOnly: true
+ Payroll-Processed-Type:
+ 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
+ Payroll-Processed-Date-Type:
+ type:
+ - string
+ - 'null'
+ description: The date at which the payroll was processed. Null if the payroll isn't processed yet.
+ readOnly: true
+ Payroll-Calculated-At-Type:
+ 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
+ Payroll-Payroll-Uuid-Type:
+ type: string
+ description: The UUID of the payroll.
+ readOnly: true
+ Payroll-Company-Uuid-Type:
+ type: string
+ description: The UUID of the company for the payroll.
+ readOnly: true
+ Payroll-Off-Cycle-Type:
+ type: boolean
+ description: Indicates whether the payroll is an off-cycle payroll
+ readOnly: true
+ Payroll-External-Type:
+ type: boolean
+ description: Indicates whether the payroll is an external payroll
+ readOnly: true
+ Payroll-Final-Termination-Payroll-Type:
+ type: boolean
+ description: Indicates whether the payroll is the final payroll for a terminated employee. Only included for off-cycle payrolls.
+ readOnly: true
+ Payroll-Skip-Regular-Deductions-Type:
+ type:
+ - boolean
+ - 'null'
+ description: Block regular deductions and contributions for this payroll. Only included for off-cycle payrolls.
+ readOnly: true
+ Payroll-Fixed-Withholding-Rate-Type:
+ 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
+ Payroll-Fixed-Compensation-Types-Type:
+ type: array
+ items:
+ type: object
+ readOnly: true
+ properties:
+ name:
+ description: The name of an available type of fixed compensation.
+ type: string
+ readOnly: true
+ Payroll-Submission-Blockers-Type:
+ type: array
+ description: Only included for processed or calculated payrolls
+ uniqueItems: true
+ items:
+ type: object
+ 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
+ Payroll-Credit-Blockers-Type:
+ type: array
+ description: Only included for processed payrolls
+ uniqueItems: true
+ items:
+ type: object
+ 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:
+ - "$ref": "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Submit-Wire"
+ - "$ref": "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Submit-Bank-Screenshot"
+ - "$ref": "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Respond-To-High-Risk-Fraud-Rfi"
+ - "$ref": "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Wait-For-Reverse-Wire"
+ discriminator:
+ propertyName: unblock_type
+ mapping:
+ submit_wire: "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Submit-Wire"
+ submit_bank_screenshot: "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Submit-Bank-Screenshot"
+ respond_to_high_risk_fraud_rfi: "#/components/schemas/Payroll-Credit-Blocker-Unblock-Option-Respond-To-High-Risk-Fraud-Rfi"
+ wait_for_reverse_wire: "#/components/schemas/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
+ Reversal-Payroll-Uuids-Type:
+ 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
+ Payroll-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:
+ "$ref": "#/components/schemas/Entity-Error-Object"
+ Payroll:
+ 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:
+ properties:
+ payroll_deadline:
+ "$ref": "#/components/schemas/Payroll-Deadline-Type"
+ check_date:
+ "$ref": "#/components/schemas/Payroll-Check-Date-Type"
+ processed:
+ "$ref": "#/components/schemas/Payroll-Processed-Type"
+ processed_date:
+ "$ref": "#/components/schemas/Payroll-Processed-Date-Type"
+ calculated_at:
+ "$ref": "#/components/schemas/Payroll-Calculated-At-Type"
+ uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ payroll_uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ company_uuid:
+ "$ref": "#/components/schemas/Payroll-Company-Uuid-Type"
+ off_cycle:
+ "$ref": "#/components/schemas/Payroll-Off-Cycle-Type"
+ off_cycle_reason:
+ "$ref": "#/components/schemas/Off-Cycle-Reason-Type"
+ auto_pilot:
+ "$ref": "#/components/schemas/Auto-Pilot-Type"
+ external:
+ "$ref": "#/components/schemas/Payroll-External-Type"
+ final_termination_payroll:
+ "$ref": "#/components/schemas/Payroll-Final-Termination-Payroll-Type"
+ withholding_pay_period:
+ "$ref": "#/components/schemas/Payroll-Withholding-Pay-Period-Type"
+ skip_regular_deductions:
+ "$ref": "#/components/schemas/Payroll-Skip-Regular-Deductions-Type"
+ fixed_withholding_rate:
+ "$ref": "#/components/schemas/Payroll-Fixed-Withholding-Rate-Type"
+ pay_period:
+ "$ref": "#/components/schemas/Payroll-Pay-Period-Type"
+ payroll_status_meta:
+ "$ref": "#/components/schemas/Payroll-Payroll-Status-Meta-Type"
+ totals:
+ "$ref": "#/components/schemas/Payroll-Totals-Type"
+ company_taxes:
+ "$ref": "#/components/schemas/Payroll-Company-Taxes-Type"
+ payroll_taxes:
+ "$ref": "#/components/schemas/Payroll-Taxes-Type"
+ payment_speed_changed:
+ "$ref": "#/components/schemas/Payroll-Payment-Speed-Changed-Type"
+ created_at:
+ "$ref": "#/components/schemas/Created-At-Type"
+ submission_blockers:
+ "$ref": "#/components/schemas/Payroll-Submission-Blockers-Type"
+ credit_blockers:
+ "$ref": "#/components/schemas/Payroll-Credit-Blockers-Type"
+ processing_request:
+ "$ref": "#/components/schemas/Payroll-Processing-Request"
+ partner_owned_disbursement:
+ "$ref": "#/components/schemas/Payroll-Partner-Owned-Disbursement-Type"
+ Payroll-Prepared:
+ description: ''
+ 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:
+ calculated_at:
+ pay_period:
+ start_date: '2025-06-10'
+ end_date: '2025-06-16'
+ pay_schedule_uuid:
+ 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:
+ type: object
+ properties:
+ payroll_deadline:
+ "$ref": "#/components/schemas/Payroll-Deadline-Type"
+ check_date:
+ "$ref": "#/components/schemas/Payroll-Check-Date-Type"
+ processed:
+ "$ref": "#/components/schemas/Payroll-Processed-Type"
+ processed_date:
+ "$ref": "#/components/schemas/Payroll-Processed-Date-Type"
+ calculated_at:
+ "$ref": "#/components/schemas/Payroll-Calculated-At-Type"
+ uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ payroll_uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ company_uuid:
+ "$ref": "#/components/schemas/Payroll-Company-Uuid-Type"
+ off_cycle:
+ "$ref": "#/components/schemas/Payroll-Off-Cycle-Type"
+ off_cycle_reason:
+ "$ref": "#/components/schemas/Off-Cycle-Reason-Type"
+ auto_pilot:
+ "$ref": "#/components/schemas/Auto-Pilot-Type"
+ external:
+ "$ref": "#/components/schemas/Payroll-External-Type"
+ final_termination_payroll:
+ "$ref": "#/components/schemas/Payroll-Final-Termination-Payroll-Type"
+ withholding_pay_period:
+ "$ref": "#/components/schemas/Payroll-Withholding-Pay-Period-Type"
+ skip_regular_deductions:
+ "$ref": "#/components/schemas/Payroll-Skip-Regular-Deductions-Type"
+ fixed_withholding_rate:
+ "$ref": "#/components/schemas/Payroll-Fixed-Withholding-Rate-Type"
+ pay_period:
+ "$ref": "#/components/schemas/Payroll-Pay-Period-Type"
+ payroll_status_meta:
+ "$ref": "#/components/schemas/Payroll-Payroll-Status-Meta-Type"
+ employee_compensations:
+ type: array
+ uniqueItems: false
+ items:
+ "$ref": "#/components/schemas/Payroll-Employee-Compensations-Type"
+ payment_speed_changed:
+ "$ref": "#/components/schemas/Payroll-Payment-Speed-Changed-Type"
+ created_at:
+ "$ref": "#/components/schemas/Created-At-Type"
+ fixed_compensation_types:
+ "$ref": "#/components/schemas/Payroll-Fixed-Compensation-Types-Type"
+ processing_request:
+ "$ref": "#/components/schemas/Payroll-Processing-Request"
+ partner_owned_disbursement:
+ "$ref": "#/components/schemas/Payroll-Partner-Owned-Disbursement-Type"
+ Payroll-Minimal:
+ description: ''
+ type: object
+ x-tags:
+ - Payrolls
+ properties:
+ payroll_deadline:
+ "$ref": "#/components/schemas/Payroll-Deadline-Type"
+ check_date:
+ "$ref": "#/components/schemas/Payroll-Check-Date-Type"
+ processed:
+ "$ref": "#/components/schemas/Payroll-Processed-Type"
+ processed_date:
+ "$ref": "#/components/schemas/Payroll-Processed-Date-Type"
+ calculated_at:
+ "$ref": "#/components/schemas/Payroll-Calculated-At-Type"
+ uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ payroll_uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ company_uuid:
+ "$ref": "#/components/schemas/Payroll-Company-Uuid-Type"
+ off_cycle:
+ "$ref": "#/components/schemas/Payroll-Off-Cycle-Type"
+ off_cycle_reason:
+ "$ref": "#/components/schemas/Off-Cycle-Reason-Type"
+ auto_pilot:
+ "$ref": "#/components/schemas/Auto-Pilot-Type"
+ external:
+ "$ref": "#/components/schemas/Payroll-External-Type"
+ final_termination_payroll:
+ "$ref": "#/components/schemas/Payroll-Final-Termination-Payroll-Type"
+ withholding_pay_period:
+ "$ref": "#/components/schemas/Payroll-Withholding-Pay-Period-Type"
+ skip_regular_deductions:
+ "$ref": "#/components/schemas/Payroll-Skip-Regular-Deductions-Type"
+ fixed_withholding_rate:
+ "$ref": "#/components/schemas/Payroll-Fixed-Withholding-Rate-Type"
+ pay_period:
+ "$ref": "#/components/schemas/Payroll-Pay-Period-Type"
+ payroll_status_meta:
+ "$ref": "#/components/schemas/Payroll-Payroll-Status-Meta-Type"
+ totals:
+ "$ref": "#/components/schemas/Payroll-Totals-Type"
+ payment_speed_changed:
+ "$ref": "#/components/schemas/Payroll-Payment-Speed-Changed-Type"
+ created_at:
+ "$ref": "#/components/schemas/Created-At-Type"
+ submission_blockers:
+ "$ref": "#/components/schemas/Payroll-Submission-Blockers-Type"
+ credit_blockers:
+ "$ref": "#/components/schemas/Payroll-Credit-Blockers-Type"
+ reversal_payroll_uuids:
+ "$ref": "#/components/schemas/Reversal-Payroll-Uuids-Type"
+ required:
+ - company_uuid
+ - uuid
+ - payroll_uuid
+ - processed
+ Payroll-Blocker:
+ type: object
+ properties:
+ key:
+ type: string
+ description: The unique identifier of the reason
+ message:
+ type: string
+ description: User-friendly message describing the payroll blocker.
+ Payroll-Check:
+ 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:
+ - string
+ - '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
+ Generated-Document:
+ 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
+ Report:
+ 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
+ Create-Report:
+ 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
+ Report-Template:
+ 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
+ Payroll-Receipt:
+ 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
+ description: The total company debit for the payroll.
+ net_pay_debit:
+ type: string
+ description: The total company net pay for the payroll.
+ child_support_debit:
+ type: string
+ description: The total child support debit for the payroll.
+ reimbursement_debit:
+ type: string
+ description: The total reimbursements for the payroll.
+ tax_debit:
+ type: string
+ 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
+ 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
+ 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
+ description: The total of employer and employee taxes for the pay period.
+ total_garnishments:
+ type: string
+ description: The total garnishments for the pay period.
+ child_support_garnishment:
+ type: string
+ description: The total child support garnishment for the pay period.
+ total_reimbursement:
+ type: string
+ 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"
+ Payroll-Reversal:
+ 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
+ Gross-Up-Pay:
+ type: object
+ properties:
+ gross_up:
+ type: string
+ description: Gross up earnings.
+ Contractor-Payment-Receipt:
+ 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.
+
+ `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"
+ Custom-Field-Type:
+ type: string
+ description: Input type for the custom field.
+ enum:
+ - text
+ - currency
+ - number
+ - date
+ - radio
+ Employee-Custom-Field:
+ 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:
+ "$ref": "#/components/schemas/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
+ Company-Custom-Field:
+ 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:
+ "$ref": "#/components/schemas/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
+ Rehire:
+ 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
+ Signatory:
+ 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:
+ type:
+ - string
+ - 'null'
+ enum:
+ - Pass
+ - Fail
+ - Skipped
+ description: |-
+ | | |
+ |---|---|
+ |__Status__| __Description__ |
+ | Pass | Signatory can sign all forms |
+ | Fail | Signatory cannot sign forms |
+ | Skipped | Signatory cannot sign Form 8655 until the form is manually uploaded as wet-signed |
+ | 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
+ Flow:
+ description: The representation of a flow in Gusto white-label UI.
+ type: object
+ x-examples:
+ Example:
+ url: https://flows.gusto-demo.com/flows/lO2BHHAMCScPVV9G5WEURW0Im_nP9mGYloQgjUWbenQ
+ title: Flow
+ x-tags:
+ - Flows
+ properties:
+ url:
+ type: string
+ Unprocessed-Termination-Pay-Period:
+ 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
+ Pay-Schedule-Assignment:
+ 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:
+ type:
+ - string
+ - 'null'
+ enum:
+ - single
+ - hourly_salaried
+ - by_employee
+ - by_department
+ 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:
+ "$ref": "#/components/schemas/Pay-Schedule-Assignment-Employee"
+ departments:
+ type:
+ - array
+ - 'null'
+ description: List of departments and their pay schedules.
+ readOnly: true
+ items:
+ "$ref": "#/components/schemas/Pay-Schedule-Assignment-Department"
+ x-tags:
+ - Pay Schedules
+ Pay-Schedule-Assignment-Employee:
+ 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
+ Pay-Schedule-Assignment-Department:
+ 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
+ Pay-Schedule-Assignment-Preview:
+ 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:
+ type:
+ - string
+ - 'null'
+ enum:
+ - single
+ - hourly_salaried
+ - by_employee
+ - by_department
+ 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:
+ "$ref": "#/components/schemas/Pay-Schedule-Assignment-Employee-Change"
+ x-tags:
+ - Pay Schedules
+ Pay-Schedule-Assignment-Employee-Change:
+ 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:
+ "$ref": "#/components/schemas/Pay-Schedule-Assignment-Pay-Period"
+ transition_pay_period:
+ "$ref": "#/components/schemas/Pay-Schedule-Assignment-Transition-Pay-Period"
+ x-tags:
+ - Pay Schedules
+ Pay-Schedule-Assignment-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
+ Pay-Schedule-Assignment-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
+ Accruing-Time-Off-Hour:
+ description: The representation of an unprocessed termination pay period.
+ type: object
+ properties:
+ time_off_policy_uuid:
+ type: string
+ description: A unique identifier of the time off policy.
+ hours:
+ type: string
+ description: Hours accrued during this pay period.
+ Employee-Federal-Tax:
+ 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:
+ - "$ref": "#/components/schemas/Employee-Federal-Tax-Pre2020"
+ - "$ref": "#/components/schemas/Employee-Federal-Tax-Rev2020"
+ discriminator:
+ propertyName: w4_data_type
+ mapping:
+ pre_2020_w4: "#/components/schemas/Employee-Federal-Tax-Pre2020"
+ rev_2020_w4: "#/components/schemas/Employee-Federal-Tax-Rev2020"
+ 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
+ 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
+ x-tags:
+ - Employee Tax Setup
+ Employee-State-Tax:
+ 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.
+
+'
+ 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:
+ - 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.
+
+'
+ key: withholding_allowance
+ input_question_format:
+ type: Number
+ answers:
+ - value: 1
+ valid_from: '2010-01-01'
+ valid_up_to:
+ - 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:
+ - 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:
+ 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:
+ "$ref": "#/components/schemas/Employee-State-Tax-Question"
+ required:
+ - employee_uuid
+ - state
+ - questions
+ Employee-State-Tax-Question:
+ 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:
+ "$ref": "#/components/schemas/Employee-State-Tax-Input-Question-Format"
+ answers:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-State-Tax-Answer"
+ required:
+ - label
+ - description
+ - key
+ - input_question_format
+ - answers
+ - is_question_for_admin_only
+ Employee-State-Tax-Answer:
+ 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.
+ Employee-State-Tax-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
+ Federal-Tax-Details:
+ 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:
+ - C-Corporation
+ - S-Corporation
+ - Sole proprietor
+ - LLC
+ - LLP
+ - Limited partnership
+ - Co-ownership
+ - Association
+ - Trusteeship
+ - General partnership
+ - Joint venture
+ - 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:
+ - S-Corporation
+ - C-Corporation
+ - LLC
+ filing_form:
+ type: string
+ description: |-
+ The form used by the company for federal tax filing. One of:
+ - 941 (Quarterly federal tax return form)
+ - 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:
+ - `pending`: The EIN verification process has not completed (or the company does not yet have an EIN).
+ - `verified`: The EIN has been successfully verified as a valid EIN with the IRS.
+ - `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:
+ - Semiweekly
+ - 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
+ Employee-Bank-Account:
+ 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
+ Contractor-Bank-Account:
+ 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
+ DetailedPaymentAccountSplit:
+ 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
+ EmployeePaymentDetail:
+ 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:
+ type:
+ - string
+ - 'null'
+ description: How the payment is split. This field is applicable when `payment_method` is "Direct Deposit".
+ enum:
+ - Percentage
+ - Amount
+ readOnly: true
+ splits:
+ type:
+ - array
+ - 'null'
+ description: An array of payment splits. This field is applicable when `payment_method` is "Direct Deposit".
+ items:
+ "$ref": "#/components/schemas/DetailedPaymentAccountSplit"
+ 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
+ EmployeePaymentDetailsList:
+ title: EmployeePaymentDetailsList
+ type: array
+ description: A list of employee payment details.
+ items:
+ "$ref": "#/components/schemas/EmployeePaymentDetail"
+ Employee-Payment-Method:
+ 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:
+ 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:
+ type:
+ - string
+ - 'null'
+ enum:
+ - Amount
+ - Percentage
+ 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:
+ "$ref": "#/components/schemas/Payment-Method-Bank-Account"
+ x-tags:
+ - Employee Payment Method
+ Tax-Requirement:
+ 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:
+ properties:
+ key:
+ "$ref": "#/components/schemas/Tax-Requirement-Key"
+ 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:
+ "$ref": "#/components/schemas/Tax-Requirement-Key"
+ 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:
+ "$ref": "#/components/schemas/Tax-Requirement-Metadata"
+ Tax-Requirement-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:
+ 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.
+
+ - `text`: free-text input, no additional requirements
+ - `currency`: a value representing a dollar amount, e.g. `374.55` representing `$374.55`
+ - `radio`: choose one of options provided, see `options`
+ - `select`: choose one of options provided, see `options`
+ - `percent`: A decimal value representing a percentage, e.g. `0.034` representing `3.4%`
+ - `account_number`: An account number for a tax agency, more information provided by `mask` and `prefix`
+ - `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
+ - `workers_compensation_rate`: A decimal value representing a percentage, see `risk_class_code`, `risk_class_description`, and `rate_type`
+ 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:
+ - `percent`: A percentage formatted as a decimal, e.g. `0.01` for 1%
+ - `currency_per_hour`: A dollar amount per hour, e.g. `3.24` for $3.24/hr
+ enum:
+ - percent
+ - currency_per_hour
+ mask:
+ type:
+ - string
+ - 'null'
+ description: |
+ [for `account_number`] A pattern describing the format of the account number
+
+ The 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:
+ - `#`: a digit (`\d`)
+ - `@`: a upper or lower case letter (`[a-zA-Z]`)
+ - `^`: an uppercase letter (`[A-Z]`)
+ - `%`: a digit or uppercase letter (`[0-9A-Z]`)
+ - any other character represents the literal character
+
+ Examples:
+ - mask: `WHT-######` represents `WHT-` followed by 5 digits, e.g. `WHT-33421`
+ - mask: `%####-^^` supports values of `75544-AB` and `Z7654-HK`
+ 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.
+ - e.g. ["0.0", "0.001"] representing 0% and 0.1%
+ items:
+ type: string
+ required:
+ - type
+ required:
+ - type
+ description: ''
+ Tax-Requirement-Set:
+ type: object
+ x-examples:
+ tax-requirements-set-ga-registrations-example:
+ state: GA
+ key: registrations
+ label: Registrations
+ effective_from:
+ 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:
+ - 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:
+ description: ''
+ properties:
+ state:
+ "$ref": "#/components/schemas/State"
+ key:
+ "$ref": "#/components/schemas/Tax-Requirement-Set-Key"
+ label:
+ type: string
+ description: Customer facing label for the requirement set, e.g. "Registrations"
+ effective_from:
+ "$ref": "#/components/schemas/Tax-Requirement-Effective-From"
+ requirements:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Tax-Requirement"
+ Tax-Requirements-State:
+ 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:
+ 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:
+ - 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:
+ - 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:
+ "$ref": "#/components/schemas/State"
+ requirement_sets:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Tax-Requirement-Set"
+ Tax-Requirement-Set-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.
+ Tax-Requirement-Key:
+ title: Tax-Requirement-Key
+ type: string
+ description: An identifier for an individual requirement. Uniqueness is guaranteed within a requirement set.
+ Tax-Requirement-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)
+ Time-Off-Policy:
+ 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.0
+ accrual_rate_unit: 40.0
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 10
+ carryover_limit_hours: 100.0
+ max_accrual_hours_per_year: 100.0
+ max_hours: 100.0
+ 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.0
+ accrual_rate_unit: 40.0
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 10
+ carryover_limit_hours: 100.0
+ max_accrual_hours_per_year: 100.0
+ max_hours: 100.0
+ 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.0
+ accrual_rate_unit: 40.0
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 10
+ carryover_limit_hours: 100.0
+ max_accrual_hours_per_year: 100.0
+ max_hours: 100.0
+ complete: true
+ version:
+ 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
+ Time-Off-Activity:
+ 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
+ Holiday-Pay-Policy:
+ 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
+ Paid-Holidays:
+ 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)
+ Minimum-Wage:
+ 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
+ Notification:
+ 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
+ Event:
+ 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
+ Invoice-Data:
+ 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.
+ Information-Request:
+ 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
+ Recovery-Case:
+ 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:
+ 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
+ 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
+ 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
+ Ach-Transaction:
+ 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:
+ 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
+ Wire-In-Request:
+ 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
+ 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
+ Time-Sheet:
+ type: object
+ x-examples:
+ example:
+ uuid: 123e4567-e89b-12d3-a456-426655440000
+ company_uuid: 123e4567-e89b-12d3-a456-426655440000
+ status: approved
+ time_zone: America/Los_Angeles
+ entity_type: Employee
+ version: 72deb67e16f7b92713c00d3582fa6c68
+ job_uuid: 123e4567-e89b-12d3-a456-426655440000
+ entity_uuid: 123e4567-e89b-12d3-a456-426655440000
+ shift_started_at: '2025-03-04T13:07:10Z'
+ shift_ended_at: '2025-03-04T16:07:10Z'
+ created_at: '2025-04-29T16:08:53Z'
+ updated_at: '2025-04-29T16:08:53Z'
+ metadata: {}
+ entries:
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Regular
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Overtime
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Double overtime
+ description: Record representing an employee/contractor's time sheet
+ properties:
+ uuid:
+ type: string
+ description: Unique identifier of the time sheet.
+ status:
+ type: string
+ description: Status of the time sheet.
+ enum:
+ - pending
+ - rejected
+ - approved
+ company_uuid:
+ type: string
+ description: Unique identifier of the company to which the time sheet belongs.
+ time_zone:
+ type: string
+ description: Time zone of where the time was tracked.
+ entity_type:
+ type: string
+ description: Type of entity associated with the time sheet.
+ enum:
+ - Employee
+ - Contractor
+ entity_uuid:
+ type: string
+ description: Unique identifier of the entity associated with the time sheet.
+ version:
+ type: string
+ description: The current version of the object. See the [versioning guide](https://docs.gusto.com/app-integrations/docs/idempotency) for information on how to use this field.
+ job_uuid:
+ type: string
+ description: Unique identifier of the job for which time was reported.
+ shift_started_at:
+ type: string
+ format: date-time
+ description: The start time of the shift.
+ shift_ended_at:
+ type: string
+ format: date-time
+ description: The end time of the shift. If the shift is still ongoing this field will be null.
+ created_at:
+ type: string
+ format: date-time
+ description: Datetime for when time sheet was created.
+ updated_at:
+ type: string
+ format: date-time
+ description: Datetime for when time sheet was updated.
+ metadata:
+ type: object
+ additionalProperties:
+ type: string
+ maxLength: 500
+ propertyNames:
+ type: string
+ maxLength: 40
+ maxProperties: 50
+ description: Metadata associated with the time sheet. Key-value pairs of arbitrary data. Both keys and values must be strings.
+ entries:
+ type: array
+ description: Entries associated with the time sheet.
+ items:
+ type: object
+ properties:
+ uuid:
+ type: string
+ description: Unique identifier of the entry.
+ hours_worked:
+ type: string
+ format: float
+ description: Hours worked for this pay classification. Represented as a string, e.g. "1.500".
+ pay_classification:
+ type: string
+ description: Pay classification for the entry.
+ enum:
+ - Regular
+ - Overtime
+ - Double overtime
+ Company-Suspension:
+ 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:
+ 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:
+ reconcile_tax_method: pay_taxes
+ file_yearly_forms: true
+ file_quarterly_forms: true
+ comments:
+ 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.
+
+'
+ 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.
+
+'
+ 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`.
+
+'
+ items:
+ type: object
+ properties:
+ amount:
+ type: string
+ description: Dollar amount.
+ description:
+ type: string
+ description: What kind of tax this is.
+ Minimum-Wage-List:
+ 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:
+ "$ref": "#/components/schemas/Minimum-Wage"
+ Employment-History-List:
+ 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
+ Employee-Pay-Stubs-List:
+ type: array
+ x-examples:
+ success_status:
+ - uuid: d2cec746-caee-464a-bcaf-00d93f7049c9
+ check_date: '2023-11-24'
+ gross_pay: 880.0
+ 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
+ Employee-Work-Addresses-List:
+ 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:
+ "$ref": "#/components/schemas/Employee-Work-Address"
+ Employee-Address-List:
+ 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:
+ "$ref": "#/components/schemas/Employee-Address"
+ Employee-State-Taxes-List:
+ 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.
+
+'
+ 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:
+ - 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.
+
+'
+ key: withholding_allowance
+ input_question_format:
+ type: Number
+ answers:
+ - value: 1
+ valid_from: '2010-01-01'
+ valid_up_to:
+ - 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:
+ - 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:
+ 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:
+ "$ref": "#/components/schemas/Employee-State-Tax-Question"
+ required:
+ - employee_uuid
+ - state
+ - questions
+ Employee-State-Taxes-Request:
+ 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
+ Notifications-List:
+ 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:
+ 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:
+ 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:
+ "$ref": "#/components/schemas/Notification"
+ Contractor-Payment-Details-List:
+ type: array
+ x-examples:
+ success_status:
+ - contractor_uuid: e3d9487a-4ecb-49a3-b6ff-cf03ba7278b6
+ first_name: Yael
+ last_name: Kuvalis
+ payment_method: Check
+ split_by:
+ splits:
+ - 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:
+ encrypted_account_number:
+ 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:
+ type:
+ - string
+ - 'null'
+ enum:
+ - Amount
+ - Percentage
+ 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
+ Contractor-Payment-Group-Partner-Disbursements:
+ 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
+ Payroll-Partner-Disbursements:
+ 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
+ Payroll-Update:
+ 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
+ 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
+ Show-Employees:
+ type: array
+ items:
+ allOf:
+ - "$ref": "#/components/schemas/Employee"
+ - type: object
+ additionalProperties: true
+ properties:
+ current_home_address:
+ "$ref": "#/components/schemas/Employee-Home-Address"
+ all_home_addresses:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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:
+ last_name: Koss
+ email: keena.feest@kiehn.co.uk
+ company_uuid: e904cc79-818a-4da8-9d37-0be0a86fdda8
+ manager_uuid:
+ version: a5cec1f1c0135feb3e76ca6ea3c46176
+ current_employment_status: full_time
+ onboarding_status: onboarding_completed
+ preferred_first_name:
+ department_uuid:
+ employee_code: 46f036
+ payment_method: Direct Deposit
+ department:
+ terminated: false
+ two_percent_shareholder: false
+ onboarded: true
+ historical: false
+ has_ssn: true
+ onboarding_documents_config:
+ uuid:
+ 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:
+ state_wc_class_code:
+ 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:
+ work_email:
+ 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:
+ 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:
+ partner_portal_invitation_sent: true
+ Payroll-Partner-Owned-Disbursement-Type:
+ type:
+ - boolean
+ - 'null'
+ description: Will money movement for the payroll be performed by the partner rather than by Gusto?
+ Payroll-Employee-Compensations-Included:
+ type: object
+ 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.
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ amount:
+ type: number
+ amount_type:
+ type: string
+ enum:
+ - fixed
+ - percent
+ uuid:
+ type: string
+ readOnly: true
+ Payroll-Show:
+ 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:
+ 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:
+ 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:
+ 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:
+ 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:
+ 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:
+ 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:
+ 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
+ selected_option:
+ 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:
+ properties:
+ payroll_deadline:
+ "$ref": "#/components/schemas/Payroll-Deadline-Type"
+ check_date:
+ "$ref": "#/components/schemas/Payroll-Check-Date-Type"
+ processed:
+ "$ref": "#/components/schemas/Payroll-Processed-Type"
+ processed_date:
+ "$ref": "#/components/schemas/Payroll-Processed-Date-Type"
+ calculated_at:
+ "$ref": "#/components/schemas/Payroll-Calculated-At-Type"
+ uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ payroll_uuid:
+ "$ref": "#/components/schemas/Payroll-Payroll-Uuid-Type"
+ company_uuid:
+ "$ref": "#/components/schemas/Payroll-Company-Uuid-Type"
+ off_cycle:
+ "$ref": "#/components/schemas/Payroll-Off-Cycle-Type"
+ off_cycle_reason:
+ "$ref": "#/components/schemas/Off-Cycle-Reason-Type"
+ auto_pilot:
+ "$ref": "#/components/schemas/Auto-Pilot-Type"
+ external:
+ "$ref": "#/components/schemas/Payroll-External-Type"
+ final_termination_payroll:
+ "$ref": "#/components/schemas/Payroll-Final-Termination-Payroll-Type"
+ withholding_pay_period:
+ "$ref": "#/components/schemas/Payroll-Withholding-Pay-Period-Type"
+ skip_regular_deductions:
+ "$ref": "#/components/schemas/Payroll-Skip-Regular-Deductions-Type"
+ fixed_withholding_rate:
+ "$ref": "#/components/schemas/Payroll-Fixed-Withholding-Rate-Type"
+ pay_period:
+ "$ref": "#/components/schemas/Payroll-Pay-Period-Type"
+ payroll_status_meta:
+ "$ref": "#/components/schemas/Payroll-Payroll-Status-Meta-Type"
+ totals:
+ "$ref": "#/components/schemas/Payroll-Totals-Type"
+ company_taxes:
+ "$ref": "#/components/schemas/Payroll-Company-Taxes-Type"
+ payroll_taxes:
+ "$ref": "#/components/schemas/Payroll-Taxes-Type"
+ payment_speed_changed:
+ "$ref": "#/components/schemas/Payroll-Payment-Speed-Changed-Type"
+ created_at:
+ "$ref": "#/components/schemas/Created-At-Type"
+ submission_blockers:
+ "$ref": "#/components/schemas/Payroll-Submission-Blockers-Type"
+ credit_blockers:
+ "$ref": "#/components/schemas/Payroll-Credit-Blockers-Type"
+ processing_request:
+ "$ref": "#/components/schemas/Payroll-Processing-Request"
+ partner_owned_disbursement:
+ "$ref": "#/components/schemas/Payroll-Partner-Owned-Disbursement-Type"
+ employee_compensations:
+ type: array
+ uniqueItems: false
+ items:
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/Payroll-Employee-Compensations-Type"
+ - "$ref": "#/components/schemas/Payroll-Employee-Compensations-Included"
+ Company-Bank-Account-Request:
+ 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
+ Company-Suspension-List:
+ type: array
+ description: List of suspension records for a company.
+ items:
+ "$ref": "#/components/schemas/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:
+ reconcile_tax_method: refund_taxes
+ file_yearly_forms: false
+ file_quarterly_forms: false
+ comments:
+ 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: []
+ Company-Suspension-Creation-Errors:
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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
+ Time-Off-Request:
+ type: object
+ description: The representation of a time off request.
+ properties:
+ uuid:
+ type: string
+ description: The UUID of the time off request.
+ readOnly: true
+ status:
+ type: string
+ description: The status of the time off request.
+ enum:
+ - pending
+ - approved
+ - denied
+ readOnly: true
+ employee_note:
+ type: string
+ description: A note about the time off request, from the employee to the employer.
+ readOnly: true
+ employer_note:
+ type: string
+ description: A note about the time off request, from the employer to the employee.
+ readOnly: true
+ request_type:
+ type: string
+ description: The type of time off request.
+ enum:
+ - vacation
+ - sick
+ readOnly: true
+ days:
+ description: An object that represents the days in the time off request. The keys of the object are the dates, formatted as a YYYY-MM-DD string. The values of the object are the number of hours requested off for each day, formatted as a string representation of a numeric decimal to the thousands place.
+ type: object
+ readOnly: true
+ employee:
+ type: object
+ description: ''
+ properties:
+ uuid:
+ type: string
+ description: The UUID of the employee the time off request is for.
+ readOnly: true
+ full_name:
+ type: string
+ description: The full name of the employee the time off request is for.
+ readOnly: true
+ readOnly: true
+ initiator:
+ type:
+ - object
+ - 'null'
+ description: ''
+ properties:
+ uuid:
+ type: string
+ description: The UUID of the employee who initiated the time off request.
+ readOnly: true
+ full_name:
+ type: string
+ description: The full name of the employee who initiated the time off request.
+ readOnly: true
+ readOnly: true
+ approver:
+ type:
+ - object
+ - 'null'
+ description: This value will be null if the request has not been approved.
+ properties:
+ uuid:
+ type: string
+ description: The UUID of the employee who approved the time off request.
+ readOnly: true
+ full_name:
+ type: string
+ description: The full name of the employee who approved the time off request.
+ readOnly: true
+ readOnly: true
+ Time-Off-Request-List:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Time-Off-Request"
+ x-examples:
+ success_status:
+ - uuid: 9145390f-0431-45ee-b8a0-6e7a8850d4cf
+ status: approved
+ employee_note: Vacation at Disney World!
+ employer_note: But Universal has Harry Potter World...
+ days:
+ '2019-06-01': '4.000'
+ '2019-06-02': '8.000'
+ '2019-06-03': '2.000'
+ request_type: vacation
+ employee:
+ uuid: 05f8663b-5944-4cfb-910e-1ee0a6df7b42
+ full_name: Jessica Gusto
+ approver:
+ uuid: 21d8dff4-ce09-4120-a274-3a5628bf6769
+ full_name: Karen Gusto
+ initiator:
+ uuid: 05f8663b-5944-4cfb-910e-1ee0a6df7b42
+ full_name: Jessica Gusto
+ - uuid: 944cbbf4-8b13-4c45-babd-11ff13e17581
+ status: pending
+ employee_note: Coming down with the flu
+ employer_note: ''
+ days:
+ '2019-02-01': '8.000'
+ request_type: sick
+ employee:
+ uuid: c2236d10-959a-4bb9-a21d-e14c6df447b6
+ full_name: James Gusto
+ approver:
+ initiator:
+ uuid: c2236d10-959a-4bb9-a21d-e14c6df447b6
+ full_name: James Gusto
+ Not-Found-Error-Object:
+ 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:
+ "$ref": "#/components/schemas/Entity-Error-Object"
+ x-examples:
+ not_found:
+ errors:
+ - error_key: request
+ category: not_found
+ message: The requested resource was not found.
+ Contractor-Payment-For-Group-Preview:
+ 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
+ Contractor-Payment-Group-Preview:
+ 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
+ "$ref": "#/components/schemas/Payroll-Submission-Blockers-Type"
+ credit_blockers:
+ type: array
+ description: List of credit blockers for the contractor payment group.
+ readOnly: true
+ items:
+ type: object
+ "$ref": "#/components/schemas/Payroll-Credit-Blockers-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:
+ "$ref": "#/components/schemas/Contractor-Payment-For-Group-Preview"
+ x-examples:
+ success:
+ uuid:
+ 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:
+ submission_blockers: []
+ credit_blockers: []
+ contractor_payments:
+ - uuid:
+ 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:
+ 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:
+ submission_blockers:
+ - blocker_type: fast_ach_threshold_exceeded
+ blocker_name: Fast ACH Threshold Exceeded
+ selected_option:
+ 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:
+ 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'
+ Webhooks-Health-Check-Status:
+ 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
+ Contractor-Payment-Group-Base:
+ 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
+ Contractor-Payment-Group-With-Blockers:
+ description: Contractor payment group with submission and credit blockers, but without individual contractor payments.
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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
+ "$ref": "#/components/schemas/Payroll-Submission-Blockers-Type"
+ credit_blockers:
+ type: array
+ description: List of credit blockers for the contractor payment group.
+ readOnly: true
+ items:
+ type: object
+ "$ref": "#/components/schemas/Payroll-Credit-Blockers-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
+ Payroll-List:
+ 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:
+ items:
+ "$ref": "#/components/schemas/Payroll"
+ Payroll-Taxes-Type:
+ 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
+ Salary-Estimate:
+ 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:
+ annual_net_revenue: '500000'
+ zip_code: '94107'
+ result: 12000000
+ accepted_at:
+ 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
+ BLS-Occupation:
+ 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.
+ Payroll-Credit-Blocker-Unblock-Option-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
+ Payroll-Credit-Blocker-Unblock-Option-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
+ readOnly: true
+ Payroll-Credit-Blocker-Unblock-Option-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
+ Payroll-Credit-Blocker-Unblock-Option-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
+ readOnly: true
+ Employee-Section603-High-Earner-Status-List:
+ 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:
+ "$ref": "#/components/schemas/Employee-Section603-High-Earner-Status"
+ Employee-Section603-High-Earner-Status:
+ 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
+ Employee-Section603-High-Earner-Status-Create-Request:
+ 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
+ Employee-Section603-High-Earner-Status-Update-Request:
+ 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
+ Employee-Federal-Tax-Pre2020:
+ 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.
+ 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:
+ - Single
+ - Married
+ - Head of Household
+ - Exempt from withholding
+ - 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
+ Employee-Federal-Tax-Rev2020:
+ 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.
+ 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:
+ - Single
+ - Married
+ - Head of Household
+ - 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
+ Time-Off-Policy-Request:
+ type: object
+ description: Request body for creating a time off policy
+ allOf:
+ - "$ref": "#/components/schemas/Time-Off-Policy-Request-Base"
+ - type: object
+ required:
+ - name
+ - policy_type
+ - accrual_method
+ Holiday-Pay-Policy-Request:
+ 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
+ Create-Token-Authentication:
+ 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.
+ Refresh-Token-Authentication:
+ description: ''
+ type: object
+ allOf:
+ - "$ref": "#/components/schemas/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.
+ Time-Off-Policy-Request-Base:
+ 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
+ Time-Off-Policy-Update-Request:
+ type: object
+ description: Request body for updating a time off policy
+ allOf:
+ - "$ref": "#/components/schemas/Time-Off-Policy-Request-Base"
+ securitySchemes:
+ CompanyAccessAuth:
+ type: http
+ scheme: bearer
+ description: Company-level authentication
+ SystemAccessAuth:
+ type: http
+ scheme: bearer
+ description: System-level authentication
+ responses:
+ Unprocessable-Entity-Error-Object:
+ description: "Unprocessable Entity \n \nThis may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request 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:
+ "$ref": "#/components/schemas/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
+ Not-Found-Error-Object:
+ description: "Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"
+ Employment-Not-Found-Error-Object:
+ description: |-
+ Not Found
+
+ * The requested resource does not exist. Make sure the provided UUID is valid.
+ * The employee's employment is not in the right state.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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.
+ Authentication-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Authentication"
+ examples:
+ Example:
+ value:
+ access_token: 737HdeXfIqgx-NfaUFRuhV7JDe6ns6ptanJSMuQzjlc
+ token_type: bearer
+ expires_in: 7200
+ refresh_token: iEjL96L9Pndwmi-xVX3Q-xbrvvhnjHYGX87sopgGJ8E
+ scope: ach_transactions:read benefits:read companies:read
+ created_at: 1732033824
+ Holiday-Pay-Policy-Object:
+ description: Holiday Pay Policy Object Example
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Holiday-Pay-Policy"
+ examples:
+ Example:
+ value:
+ version: 1b37938b017c7fd7116bada007072290
+ company_uuid: b7845189-f12b-4378-918a-d2b9de3dc4ea
+ federal_holidays:
+ new_years_day:
+ selected: false
+ 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
+ Paid-Holidays-Object:
+ description: Paid Holidays Object Example
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Paid-Holidays"
+ examples:
+ Example:
+ value:
+ holiday_key: veterans_day
+ holiday_name: Veterans Day
+ start_date: '2023-11-11'
+ end_date: '2023-11-11'
+ Department-Object:
+ description: Department Object Example
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Ytd-Benefit-Amounts-From-Different-Company-List:
+ description: List of Ytd Benefit Amounts From Different Company List
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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'
+ Department-List:
+ description: List of departments
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Employee-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee"
+ examples:
+ Create-Employee-Example:
+ value:
+ uuid: 4b3f930f-82cd-48a8-b797-798686e12e5e
+ first_name: Isom
+ middle_initial:
+ last_name: Jaskolski
+ email: dane7757869450111550@botsford.net
+ company_uuid: a007e1ab-3595-43c2-ab4b-af7a5af2e365
+ manager_uuid: 5e53e257-c8d6-45aa-aa8a-ec99283a3acd
+ employee_code: fesa3w
+ version: 1c7ba9d62c8bafbfff998ffccad5d296
+ department: Stage Hand
+ department_uuid: 56260b3d-c375-415c-b77a-75d99f717193
+ terminated: false
+ two_percent_shareholder: false
+ onboarded: true
+ onboarding_status: onboarding_completed
+ onboarding_documents_config:
+ uuid:
+ i9_document: false
+ jobs:
+ - uuid: 428a653a-0745-4db4-9c80-558288d416fa
+ version: 6c0ed1521e8b86eb36bd4455a63a2dac
+ employee_uuid: f0689739-1985-49f3-b9ba-84562e71e85f
+ current_compensation_uuid: c9fd719b-8b07-48f3-8a4c-f447d2c59669
+ 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: '2021-01-20'
+ rate: '70000.00'
+ adjust_for_minimum_wage: false
+ minimum_wages: []
+ rate: '70000.00'
+ hire_date: '2020-01-20'
+ eligible_paid_time_off:
+ - name: Sick Hours
+ policy_name: Sick Policy
+ policy_uuid: 9940d205-9904-4e55-9fec-652628e84af7
+ accrual_unit: Hour
+ accrual_rate: '208.0'
+ accrual_method: per_hour_worked
+ accrual_period: Year
+ accrual_balance: '31.8'
+ maximum_accrual_balance: '240.0'
+ paid_at_termination: false
+ - name: Vacation Hours
+ policy_name: Vacation Policy
+ policy_uuid: ab59de61-239f-4805-933b-0e3360ed291c
+ accrual_unit: Hour
+ accrual_rate: '208.0'
+ accrual_period: Year
+ accrual_balance: '77.8'
+ maximum_accrual_balance: '240.0'
+ paid_at_termination: true
+ terminations: []
+ custom_fields:
+ - id: ee515986-f3ca-49da-b576-2691b95262f9
+ company_custom_field_id: ea7e5d57-6abb-47d7-b654-347c142886c0
+ name: employee_level
+ description: Employee Level
+ type: text
+ value: '2'
+ selection_options:
+ - id: 3796e08d-c2e3-434c-b4de-4ce1893e7b59
+ company_custom_field_id: 299650e4-e970-4acf-9bf0-6f05585d20ba
+ name: t-shirt size
+ description: What is your t-shirt size?
+ type: text
+ value: md
+ selection_options:
+ - id: 3796e08d-c2e3-434c-b4de-4ce1893e7b59
+ company_custom_field_id: 024ec137-6c92-43a3-b061-14a9720531d6
+ name: favorite fruit
+ description: Which is your favorite fruit?
+ type: radio
+ value: apple
+ selection_options:
+ - apple
+ - banana
+ - orange
+ garnishments: []
+ date_of_birth: '1986-06-25'
+ has_ssn: false
+ ssn: ''
+ phone: '1234567890'
+ preferred_first_name: Angel
+ work_email: angel.jaskolski@example.com
+ Create Historical Employee Example:
+ value:
+ uuid: ad85459f-8bf5-4a8f-9079-3b3fa790799e
+ first_name: Karl
+ middle_initial:
+ last_name: Jaskolski
+ email:
+ company_uuid: 3c69d228-a250-49b4-9946-24e4e4294da4
+ manager_uuid:
+ employee_code: rke7p1
+ version: dedac972dd28945fcd6cd941723cc71a
+ department:
+ department_uuid:
+ terminated: false
+ two_percent_shareholder: false
+ onboarded: true
+ historical: true
+ onboarding_status: onboarding_completed
+ onboarding_documents_config:
+ uuid:
+ 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:
+ preferred_first_name:
+ work_email:
+ Historical-Employee-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee"
+ examples:
+ Create Historical Employee Example:
+ value:
+ uuid: ad85459f-8bf5-4a8f-9079-3b3fa790799e
+ first_name: Karl
+ middle_initial:
+ last_name: Jaskolski
+ email:
+ company_uuid: 3c69d228-a250-49b4-9946-24e4e4294da4
+ manager_uuid:
+ employee_code: eh3st1
+ version: dedac972dd28945fcd6cd941723cc71a
+ department:
+ department_uuid:
+ terminated: true
+ two_percent_shareholder: false
+ onboarded: true
+ historical: true
+ onboarding_status: onboarding_completed
+ onboarding_documents_config:
+ uuid:
+ 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:
+ preferred_first_name:
+ work_email:
+ Employee-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee"
+ examples:
+ Example:
+ value:
+ - uuid: 9779767c-6044-48e0-bf68-aeb370b9a2e7
+ first_name: Nicole
+ middle_initial: M
+ last_name: Boehm
+ email: kory7757869450111548@barton-hermiston.io
+ company_uuid: c44d66dc-c41b-4a60-9e25-5e93ff8583f2
+ manager_uuid: 5e53e257-c8d6-45aa-aa8a-ec99283a3acd
+ version: 414dedaca594b77135e0b8d2f398516d
+ department: Stage Hand
+ department_uuid: 1802465d-4f68-4865-920c-1307ab095f12
+ terminated: false
+ two_percent_shareholder: false
+ onboarded: true
+ onboarding_status: onboarding_completed
+ onboarding_documents_config:
+ uuid: 9d5e3ce5-ea8f-4885-90e5-7ebbed03f7c5
+ i9_document: true
+ jobs:
+ - uuid: 5d5e3ce5-ea8f-4885-90e5-7ebaed03f7c5
+ version: 91179081a7309c9fbd31bb3cf7b9893e
+ employee_uuid: a987bce1-6d06-43f8-9978-9db886f479fb
+ current_compensation_uuid: 798a962f-0fcf-491e-9b71-cfa6a1db114f
+ payment_unit: Hour
+ primary: true
+ title: Client Support Manager
+ compensations:
+ - uuid: 94f17a77-cfe5-436a-af94-422bbf8248ff
+ version: 233f0096a8015e62d9795fadf1fd300d
+ payment_unit: Hour
+ flsa_status: Nonexempt
+ job_uuid: 64711ac0-83ff-4aaf-bec1-db72f5a44e56
+ effective_date: '2021-01-20'
+ rate: '22.00'
+ adjust_for_minimum_wage: false
+ minimum_wages: []
+ rate: '22.00'
+ hire_date: '2020-01-20'
+ eligible_paid_time_off:
+ - name: Sick Hours
+ policy_name: Sick Policy
+ policy_uuid: 9940d205-9904-4e55-9fec-652628e84af7
+ accrual_unit: Hour
+ accrual_rate: '208.0'
+ accrual_method: per_hour_worked
+ accrual_period: Year
+ accrual_balance: '71.0'
+ maximum_accrual_balance: '240.0'
+ paid_at_termination: false
+ - name: Vacation Hours
+ policy_name: Vacation Policy
+ policy_uuid: 8b312f0e-30e7-4810-9c06-1177a6484f2d
+ accrual_unit: Hour
+ accrual_rate: '208.0'
+ accrual_period: Year
+ accrual_balance: '34.0'
+ maximum_accrual_balance: '240.0'
+ paid_at_termination: true
+ terminations: []
+ garnishments: []
+ date_of_birth: '1996-05-08'
+ has_ssn: true
+ ssn: ''
+ phone: '1234567890'
+ preferred_first_name: Vanessa
+ work_email: vanessa.boehm@example.com
+ - uuid: d7cb289a-af62-4120-9cd5-acda324b5c04
+ first_name: Maci
+ middle_initial: M
+ last_name: Cassin
+ email: claud_reinger7757869450111549@gutkowski.net
+ company_uuid: 4522d043-5731-406d-a129-de1808042a32
+ manager_uuid: 5e53e257-c8d6-45aa-aa8a-ec99283a3acd
+ version: e867459e1360fa71e78b88142923d341
+ department: Band
+ department_uuid: 1802465d-4f68-4865-920c-1307ab095f12
+ terminated: false
+ two_percent_shareholder: false
+ onboarded: true
+ onboarding_status: onboarding_completed
+ onboarding_documents_config:
+ uuid: 1d5e3ce5-ea8f-4885-90e5-7ebbed03f7c5
+ i9_document: true
+ jobs:
+ - uuid: 62a00cf7-342b-465e-a151-ecd295152be0
+ version: d0e719137f89ca3dd334dd4cc248ffbb
+ employee_uuid: 5e53e257-c8d6-45aa-aa8a-ec99283a3acd
+ current_compensation_uuid: 93e5da92-173b-4faa-a0bd-d1a8dee68be0
+ payment_unit: Year
+ primary: true
+ title: Account Director
+ compensations:
+ - uuid: 1bad5177-c4ed-432e-ab43-66055d40c3a5
+ version: 994b75511d1debac5d7e2ddeae13679f
+ payment_unit: Year
+ flsa_status: Exempt
+ job_uuid: 1214875b-f43d-4267-bf2f-a6d2c298ff3d
+ effective_date: '2021-01-20'
+ rate: '78000.00'
+ adjust_for_minimum_wage: false
+ minimum_wages: []
+ rate: '78000.00'
+ hire_date: '2020-01-20'
+ eligible_paid_time_off:
+ - name: Sick Hours
+ policy_name: Sick Policy
+ policy_uuid: 8b312f0e-30e7-4810-9c06-1177a6484f2d
+ accrual_unit: Hour
+ accrual_rate: '208.0'
+ accrual_method: per_hour_worked
+ accrual_period: Year
+ accrual_balance: '74.0'
+ maximum_accrual_balance: '240.0'
+ paid_at_termination: false
+ - name: Vacation Hours
+ policy_name: Vacation Policy
+ policy_uuid: 0d4c755e-50ac-4c54-b46e-81bdfa03da5b
+ accrual_unit: Hour
+ accrual_rate: '208.0'
+ accrual_period: Year
+ accrual_balance: '16.0'
+ maximum_accrual_balance: '240.0'
+ paid_at_termination: true
+ terminations: []
+ garnishments: []
+ custom_fields:
+ - id: ee515986-f3ca-49da-b576-2691b95262f9
+ company_custom_field_id: ea7e5d57-6abb-47d7-b654-347c142886c0
+ name: employee_level
+ description: Employee Level
+ type: text
+ value: '2'
+ selection_options:
+ - id: 3796e08d-c2e3-434c-b4de-4ce1893e7b59
+ company_custom_field_id: 299650e4-e970-4acf-9bf0-6f05585d20ba
+ name: t-shirt size
+ description: What is your t-shirt size?
+ type: text
+ value: md
+ selection_options:
+ - id: 3796e08d-c2e3-434c-b4de-4ce1893e7b59
+ company_custom_field_id: 024ec137-6c92-43a3-b061-14a9720531d6
+ name: favorite fruit
+ description: Which is your favorite fruit?
+ type: radio
+ value: apple
+ selection_options:
+ - apple
+ - banana
+ - orange
+ date_of_birth: '1995-09-21'
+ has_ssn: true
+ ssn: ''
+ phone: '1234567890'
+ preferred_first_name: Denis
+ work_email: denis.cassin@example.com
+ Employee-Address-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Address"
+ examples:
+ Example:
+ value:
+ uuid: 56260b3d-c375-415c-b77a-75d99f717193
+ employee_id: 12345
+ street_1: 644 Fay Vista
+ street_2: Suite 842
+ city: Richmond
+ state: VA
+ zip: '23218'
+ country: USA
+ active: false
+ effective_date: '2021-01-01'
+ courtesy_withholding: true
+ Employee-Address-List:
+ description: List of employee addresses
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-Address"
+ examples:
+ Example:
+ value:
+ - uuid: 56260b3d-c375-415c-b77a-75d99f717193
+ employee_uuid: 7087a288-8349-4632-b92e-bc94fb79f29e
+ street_1: 644 Fay Vista
+ street_2: Suite 842
+ city: Richmond
+ state: VA
+ zip: '23218'
+ country: USA
+ active: false
+ effective_date: '2021-01-01'
+ courtesy_withholding: true
+ - uuid: d9f74049-8769-4fba-8e0f-eceef2da4e6b
+ employee_uuid: 7087a288-8349-4632-b92e-bc94fb79f29e
+ street_1: 100 5th Ave
+ street_2: Suite 555
+ city: New York
+ state: NY
+ zip: '10001'
+ country: USA
+ active: true
+ effective_date: '2022-03-03'
+ courtesy_withholding: true
+ Employee-Work-Address-List:
+ description: List of employee work addresses
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-Work-Address"
+ examples:
+ Example:
+ value:
+ - uuid: fc5b87dc-8d88-400d-b2da-c3587a7e5b15
+ employee_uuid: 7597f3e3-31d4-4953-83a5-f95be78d2fe2
+ location_uuid: d9456c94-f561-40d2-afec-919da5f59196
+ effective_date: '2022-01-01'
+ active: false
+ version: 139f9769a2e543e6a1259173e1ee3b8d
+ street_1: 800 Adolfo Gardens
+ street_2: Suite 419
+ city: Bremen
+ state: AL
+ zip: '35033'
+ country: USA
+ - uuid: be1c2e24-af86-4c36-b34e-3a55dbcdbdab
+ employee_uuid: 7597f3e3-31d4-4953-83a5-f95be78d2fe2
+ location_uuid: 6a119be7-b4b0-4e27-aaa0-89d5f2524635
+ effective_date: '2023-01-01'
+ active: true
+ version: bbe8d4c741339c6b9e0e2e1c1b120816
+ street_1: 2216 Icie Villages
+ street_2: Apt. 798
+ city: Big Delta
+ state: AK
+ zip: '99737'
+ country: USA
+ Company-Onboarding-Status-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Onboarding-Status"
+ examples:
+ Example:
+ value:
+ 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: Enter Your Federal Tax Information
+ id: federal_tax_setup
+ required: true
+ completed: true
+ completed_at: '2025-02-18T10:00:00Z'
+ skippable: false
+ requirements: []
+ - title: Select Industry
+ id: select_industry
+ required: true
+ completed: true
+ completed_at: '2025-02-18T10:00:00Z'
+ skippable: false
+ requirements: []
+ - title: Add Your Bank Account
+ id: add_bank_info
+ 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 State Tax Information
+ id: state_setup
+ required: true
+ completed: false
+ completed_at:
+ skippable: false
+ requirements:
+ - add_addresses
+ - add_employees
+ - title: Select a Pay Schedule
+ id: payroll_schedule
+ required: true
+ completed: false
+ completed_at:
+ skippable: false
+ requirements: []
+ - title: Sign Documents
+ id: sign_all_forms
+ required: true
+ completed: false
+ completed_at:
+ 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:
+ skippable: false
+ requirements:
+ - add_bank_info
+ Company-Onboarding-Status-Finish-Onboarding-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Onboarding-Status"
+ examples:
+ Example:
+ value:
+ uuid: c44d66dc-c41b-4a60-9e25-5e93ff8583f2
+ onboarding_completed: true
+ onboarding_steps:
+ - title: Add Your Company's Addresses
+ id: add_addresses
+ required: true
+ completed: true
+ skippable: false
+ requirements: []
+ - title: Enter Your Federal Tax Information
+ id: federal_tax_setup
+ required: true
+ completed: true
+ skippable: false
+ requirements: []
+ - title: Select Industry
+ id: select_industry
+ required: true
+ completed: true
+ skippable: false
+ requirements: []
+ - title: Add Your Bank Account
+ id: add_bank_info
+ required: true
+ completed: true
+ skippable: false
+ requirements: []
+ - title: Add Your Employees
+ id: add_employees
+ required: true
+ completed: true
+ skippable: true
+ requirements:
+ - add_addresses
+ - title: Enter Your State Tax Information
+ id: state_setup
+ required: true
+ completed: true
+ skippable: false
+ requirements:
+ - add_addresses
+ - add_employees
+ - title: Select a Pay Schedule
+ id: payroll_schedule
+ required: true
+ completed: true
+ skippable: false
+ requirements: []
+ - title: Sign Documents
+ id: sign_all_forms
+ required: true
+ completed: true
+ 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: true
+ skippable: false
+ requirements:
+ - add_bank_info
+ Webhook-Subscription-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Webhook-Subscription"
+ 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
+ Webhook-Subscriptions-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Webhook-Subscription"
+ 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
+ Company-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company"
+ examples:
+ Example:
+ value:
+ ein: 00-0000001
+ entity_type: C-Corporation
+ tier: core
+ contractor_only: false
+ is_suspended: false
+ company_status: Approved
+ uuid: c7a07c73-a703-4462-9343-1b181182b6e0
+ name: Shoppe Studios LLC
+ trade_name: Record Shoppe
+ slug: record-shoppe
+ is_partner_managed: false
+ pay_schedule_type: by_department
+ join_date: '2023-03-01'
+ funding_type: ach
+ 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
+ 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: 8a2ed9c2-9d1e-443a-8e56-a490d8bf73bb
+ first_name: Alda
+ middle_initial: ''
+ last_name: Carter
+ phone: 1-565-710-7558
+ 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
+ Signatory-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Signatory"
+ examples:
+ Example:
+ value:
+ uuid: f8c653dc-0094-41fb-8670-45d6399afade
+ first_name: Bob
+ last_name: Johnson
+ title: Owner
+ phone: '4239879876'
+ birthday: '2002-10-31'
+ email: olin.okuneva@denesik.us
+ is_admin: false
+ has_ssn: true
+ version: 49ea586f528411f5cfadfd54452b2423
+ home_address:
+ street_1: 524 Roob Divide
+ street_2: Suite 565
+ city: San Francisco
+ state: CA
+ zip: '94107'
+ country: USA
+ identity_verification_status: Skipped
+ Contractor-Address-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Employment-History-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ type: object
+ properties:
+ hire_date:
+ type: string
+ description: The employee's start day of work for an employment.
+ termination_date:
+ type: string
+ 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
+ x-examples:
+ example-1:
+ hire_date: '2023-01-30'
+ termination_date: '2023-03-30'
+ file_new_hire_report: false
+ two_percent_shareholder: false
+ employment_status: seasonal
+ examples:
+ Example:
+ value:
+ - hire_date: '2023-05-30'
+ termination_date:
+ file_new_hire_report: true
+ two_percent_shareholder: false
+ employment_status: seasonal
+ - hire_date: '2021-02-02'
+ termination_date: '2023-03-01'
+ file_new_hire_report: false
+ two_percent_shareholder: false
+ employment_status: full_time
+ Rehire-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Unprocessed-Termination-Pay-Period-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Accruing-Time-Off-Hour-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - hours_earned
+ properties:
+ hours_earned:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Accruing-Time-Off-Hour"
+ examples:
+ Example:
+ value:
+ - time_off_policy_uuid: c3a15554-f124-415d-b2c4-90b430fd8eb1
+ hours: '3.2'
+ - time_off_policy_uuid: 386fc48d-52d2-4009-87b3-368f74f6b3df
+ hours: '6.0'
+ Pay-Schedule-Assignment-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Pay-Schedule-Assignment-Preview-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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'
+ Benefit-Summary-Object:
+ description: Benefit summary response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Company-Benefit-With-Employee-Benefits-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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.0
+ company_contribution: 0.0
+ uuid: 9988f241-9aee-4383-bfca-eac79cf58135
+ contribution:
+ type: amount
+ value: 0.0
+ Employee-Pay-Stubs-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-Pay-Stub"
+ examples:
+ Example:
+ value:
+ - uuid: d2cec746-caee-464a-bcaf-00d93f7049c9
+ check_date: '2023-11-24'
+ gross_pay: 880.0
+ net_pay: 541.02
+ payroll_uuid: a039cafb-745e-4af4-bf1e-935a86fc18e0
+ check_amount: 500.2
+ description: OK
+ Company-Attachment-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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'
+ Company-Attachment-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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'
+ Signatory-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Signatory"
+ examples:
+ Example:
+ value:
+ - uuid: f8c653dc-0094-41fb-8670-45d6399afade
+ first_name: Bob
+ last_name: Johnson
+ title: Owner
+ phone: '4239879876'
+ birthday: '2002-10-31'
+ email: olin.okuneva@denesik.us
+ is_admin: false
+ has_ssn: true
+ version: 49ea586f528411f5cfadfd54452b2423
+ home_address:
+ street_1: 524 Roob Divide
+ street_2: Suite 565
+ city: San Francisco
+ state: CA
+ zip: '94107'
+ country: USA
+ identity_verification_status: Skipped
+ External-Payroll-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/External-Payroll"
+ 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
+ External-Payroll-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/External-Payroll-Basic"
+ 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-Tax-Suggestions-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/External-Payroll-Tax-Suggestions"
+ 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'
+ Tax-Liabilities-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Tax-Liabilities-Selections"
+ examples:
+ Example:
+ value:
+ - tax_id: 1
+ tax_name: Federal Income Tax
+ last_unpaid_external_payroll_uuid:
+ possible_liabilities:
+ - liability_amount: '0.0'
+ payroll_check_date:
+ external_payroll_uuid:
+ - 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:
+ possible_liabilities:
+ - liability_amount: '0.0'
+ payroll_check_date:
+ external_payroll_uuid:
+ - liability_amount: '50.0'
+ payroll_check_date: '2022-06-01'
+ external_payroll_uuid: 1bf1efe1-72d4-4e6e-a181-611f3ea66435
+ Flow-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Flow"
+ examples:
+ Example:
+ value:
+ url: https://flows.gusto-demo.com/flows/lO2BHHAMCScPVV9G5WEURW0Im_nP9mGYloQgjUWbenQ
+ Form-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Form"
+ 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:
+ year:
+ document_content_type: application/pdf
+ requires_signing: true
+ Form-Object-Pdf:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Form-Pdf"
+ 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
+ Form-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Form"
+ 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:
+ year:
+ document_content_type: application/pdf
+ requires_signing: true
+ Industry-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Industry"
+ examples:
+ Example:
+ value:
+ company_uuid: 423dd616-6dbc-4724-938a-403f6217a933
+ naics_code: '611420'
+ sic_codes:
+ - '8243'
+ title: Computer Training
+ Job-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Job"
+ 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'
+ Job-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Job"
+ 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'
+ Employee-Federal-Tax-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Federal-Tax"
+ examples:
+ Example:
+ value:
+ version: 56a489ce86ed6c1b0f0cecc4050a0b01
+ filing_status: Single
+ extra_withholding: '0.0'
+ two_jobs: true
+ dependents_amount: '0.0'
+ other_income: '0.0'
+ deductions: '0.0'
+ employee_id: 29
+ w4_data_type: rev_2020_w4
+ Location-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Location"
+ examples:
+ Example:
+ value:
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ version: 7d9753112507b9dda4fb97910f39b06e
+ phone_number: '5825710808'
+ uuid: 04552eb9-7829-4b18-ae96-6983552948df
+ street_1: 412 Kiera Stravenue
+ street_2: Suite 391
+ city: San Francisco
+ state: CA
+ zip: '94107'
+ country: USA
+ active: true
+ filing_address: false
+ mailing_address: false
+ created_at: '2023-09-12T16:42:25.000-07:00'
+ updated_at: '2023-09-12T16:42:25.000-07:00'
+ Location-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Location"
+ examples:
+ Example:
+ value:
+ - company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ version: 7d9753112507b9dda4fb97910f39b06e
+ phone_number: '5825710808'
+ uuid: 04552eb9-7829-4b18-ae96-6983552948df
+ street_1: 412 Kiera Stravenue
+ street_2: Suite 391
+ city: San Francisco
+ state: CA
+ zip: '94107'
+ country: USA
+ active: true
+ filing_address: false
+ mailing_address: false
+ created_at: '2023-09-12T16:42:25.000-07:00'
+ updated_at: '2023-09-12T16:42:25.000-07:00'
+ - company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ version: 15e6b9680e00f3122729e64e3cef3224
+ phone_number: '2866070827'
+ uuid: fa94a2fd-11a8-4024-87ff-85c587d9d2b4
+ street_1: 644 Fay Vista
+ street_2: Suite 842
+ city: Richmond
+ state: VA
+ zip: '23218'
+ country: USA
+ active: true
+ filing_address: false
+ mailing_address: false
+ created_at: '2023-09-12T16:42:25.000-07:00'
+ updated_at: '2023-09-12T16:42:25.000-07:00'
+ Contractor-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Contractor"
+ examples:
+ Example:
+ value:
+ - uuid: c9fc1ad3-c107-4e7b-aa21-2dd4b00a7a07
+ company_uuid: b7457fec-3b76-43bb-9c6e-69cca4688942
+ wage_type: Fixed
+ is_active: false
+ version: 63859768485e218ccf8a449bb60f14ed
+ type: Individual
+ first_name: Kory
+ last_name: Gottlieb
+ middle_initial: P
+ business_name:
+ ein:
+ has_ein: false
+ has_ssn: true
+ department: Backup Dancer
+ department_uuid: 1802465d-4f68-4865-920c-1307ab095f12
+ email: keira.west@mckenzie.org
+ start_date: '2022-01-01'
+ file_new_hire_report: false
+ work_state:
+ 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: '0.00'
+ - uuid: 183a86f4-a803-4b38-9357-cd9b78e2560c
+ company_uuid: afdd5d98-581b-4fc0-b988-706b7d23b2a5
+ wage_type: Fixed
+ is_active: true
+ version: 8aab307f1e8ed788697f8986346af559
+ type: Business
+ first_name:
+ last_name:
+ middle_initial:
+ business_name: Labadie-Stroman
+ ein: XX-XXX0001
+ has_ein: true
+ has_ssn: false
+ email: jonatan@kerluke.info
+ start_date: '2022-01-01'
+ 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'
+ file_new_hire_report: false
+ work_state:
+ - uuid: ea1c2d65-b622-4899-bcb7-5cd0fe0232aa
+ id: 7757515807623484
+ company_uuid: 281c763d-a2ba-4f51-b9e8-b1ed61576d62
+ company_id: 7757616923763477
+ wage_type: Fixed
+ is_active: true
+ version: b48c46abfed1487b873b442334b3c4ff
+ type: Individual
+ first_name: Chanel
+ last_name: Boyle
+ middle_initial: X
+ business_name:
+ ein:
+ has_ein: false
+ has_ssn: true
+ email: loyal@hettinger.biz
+ file_new_hire_report: true
+ work_state: TX
+ onboarded: true
+ onboarding_status: onboarding_completed
+ address:
+ street_1: 35913 Darrick Run
+ street_2: Apt. 913
+ city: Cypress
+ state: TX
+ zip: '77433'
+ country: USA
+ hourly_rate: '0.00'
+ Created-Contractor-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor"
+ examples:
+ Individual Contractor:
+ value:
+ uuid: c9fc1ad3-c107-4e7b-aa21-2dd4b00a7a07
+ company_uuid: b7457fec-3b76-43bb-9c6e-69cca4688942
+ wage_type: Hourly
+ start_date: '2022-01-01'
+ is_active: false
+ version: 63859768485e218ccf8a449bb60f14ed
+ type: Individual
+ first_name: Kory
+ last_name: Gottlieb
+ middle_initial: P
+ business_name:
+ ein:
+ has_ein: false
+ has_ssn: true
+ department_uuid:
+ email: keira.west@mckenzie.org
+ file_new_hire_report: true
+ work_state: FL
+ onboarded: true
+ onboarding_status: onboarding_completed
+ address:
+ hourly_rate: '60.00'
+ payment_method:
+ Business Contractor:
+ value:
+ 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:
+ last_name:
+ middle_initial:
+ business_name: Labadie-Stroman
+ ein: XX-XXX0001
+ has_ein: true
+ has_ssn: false
+ email: jonatan@kerluke.info
+ file_new_hire_report: false
+ work_state:
+ onboarded: false
+ onboarding_status: admin_onboarding_incomplete
+ address:
+ hourly_rate: '0.00'
+ payment_method:
+ Contractor-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor"
+ examples:
+ Individual Contractor:
+ value:
+ uuid: c9fc1ad3-c107-4e7b-aa21-2dd4b00a7a07
+ company_uuid: b7457fec-3b76-43bb-9c6e-69cca4688942
+ wage_type: Hourly
+ start_date: '2022-01-01'
+ is_active: false
+ version: 63859768485e218ccf8a449bb60f14ed
+ type: Individual
+ first_name: Kory
+ last_name: Gottlieb
+ middle_initial: P
+ business_name:
+ ein:
+ 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
+ Business Contractor:
+ value:
+ 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:
+ last_name:
+ middle_initial:
+ business_name: Labadie-Stroman
+ ein: XX-XXX0001
+ has_ein: true
+ has_ssn: false
+ email: jonatan@kerluke.info
+ file_new_hire_report: false
+ work_state:
+ onboarded: false
+ onboarding_status: admin_onboarding_incomplete
+ address:
+ hourly_rate: '0.00'
+ payment_method: Direct Deposit
+ Contractor-Onboarding-Status-Object:
+ description: Example response.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Onboarding-Status"
+ 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
+ Contractor-Payment-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment"
+ 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'
+ Contractor-Payment-Group-List:
+ description: List of Contractor Payment Groups
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Contractor-Payment-Group-Minimal"
+ examples:
+ Example:
+ value:
+ - 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'
+ Contractor-Payment-Group-Object:
+ description: Full contractor payment group object
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Payment-Group"
+ examples:
+ Example:
+ value:
+ 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'
+ Contractor-Payment-Group-Null-Uuid-Object:
+ description: Full contractor payment group object with null uuid
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Contractor-Payment-Group"
+ - type: object
+ properties:
+ uuid:
+ type: string
+ nullable: true
+ examples:
+ Example:
+ value:
+ uuid:
+ company_uuid: c54046f7-1be4-4c54-8194-f4842c30c86d
+ check_date: '2024-05-07'
+ debit_date: '2024-05-01'
+ status: Unfunded
+ creation_token: nil
+ contractor_payments:
+ - uuid: nil
+ 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: nil
+ 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'
+ Contractor-Payment-Method-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Compensation-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Compensation"
+ examples:
+ Exempt:
+ value:
+ uuid: db57832c-d8bc-43a7-ae99-0a04480ff037
+ version: 98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872
+ job_uuid: d8f8fbe7-496d-4b69-86f0-1e2d1b73a086
+ rate: '60000.00'
+ payment_unit: Year
+ flsa_status: Exempt
+ effective_date: '2020-12-11'
+ adjust_for_minimum_wage: false
+ minimum_wages: []
+ Minimum Wage Adjusted:
+ value:
+ 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'
+ Compensation-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Compensation"
+ examples:
+ Example:
+ value:
+ - uuid: db57832c-d8bc-43a7-ae99-0a04480ff037
+ version: 98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872
+ job_uuid: d8f8fbe7-496d-4b69-86f0-1e2d1b73a086
+ rate: '70.00'
+ payment_unit: Hour
+ flsa_status: Nonexempt
+ effective_date: '2020-12-11'
+ adjust_for_minimum_wage: false
+ minimum_wages: []
+ - id: 1363316536327003
+ job_id: 1123581321345589
+ uuid: a4d9ba9c-32cc-4cc1-a5bc-6ef4cd653e7a
+ version: cc59bd3879d655fb940a1f6b675f2ad9
+ job_uuid: d8f8fbe7-496d-4b69-86f0-1e2d1b73a086
+ payment_unit: Hour
+ flsa_status: Nonexempt
+ effective_date: '2018-12-11'
+ rate: '5.00'
+ adjust_for_minimum_wage: true
+ minimum_wages:
+ - uuid: edeea5af-ecd6-4b1c-b5de-5cff2d302738
+ wage: '7.25'
+ effective_date: '2018-12-11'
+ Garnishment-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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:
+ total_amount:
+ pay_period_maximum: '100.00'
+ deduct_as_percentage: true
+ garnishment_type:
+ child_support:
+ 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:
+ recurring: true
+ annual_maximum:
+ total_amount:
+ 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:
+ remittance_number:
+ fips_code: '04000'
+ Garnishment-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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:
+ total_amount:
+ pay_period_maximum: '100.00'
+ deduct_as_percentage: true
+ garnishment_type:
+ child_support:
+ - 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:
+ recurring: true
+ annual_maximum:
+ total_amount:
+ 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:
+ remittance_number:
+ fips_code: '04000'
+ Child-Support-Data-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Child-Support-Data"
+ examples:
+ Example:
+ value:
+ agencies:
+ - state: AK
+ name: Alaska Child Support Services Division
+ manual_payment_required: false
+ fips_codes:
+ - county:
+ 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:
+ code: '39000'
+ required_attributes:
+ - key: case_number
+ label: CSE Case Number
+ - key: order_number
+ label: Order Identifier
+ Employee-Onboarding-Documents-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Onboarding-Document"
+ examples:
+ Example:
+ value:
+ i9_document: true
+ I9-Authorization-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ I9-Authorization-Documents-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ I9-Authorization-Document-Options-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Termination-Object:
+ description: Example Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Termination-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Pay-Period-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Pay-Period"
+ examples:
+ Example:
+ value:
+ - start_date: '2020-01-11'
+ end_date: '2020-01-24'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ payroll:
+ payroll_uuid: bfd8aad4-9c3f-4ca3-b072-a1b2b3ea689f
+ check_date: '2020-01-30'
+ processed: true
+ payroll_deadline: '2020-01-28'
+ payroll_type: regular
+ - start_date: '2020-12-12'
+ end_date: '2020-12-25'
+ pay_schedule_uuid: cb53db72-612f-4eb1-9b85-389e79cfa510
+ payroll:
+ payroll_uuid: 7ed29b45-4bb1-4d38-bd94-4d607d49fd21
+ check_date: '2020-12-30'
+ processed: true
+ payroll_deadline: '2020-12-28'
+ payroll_type: regular
+ Pay-Schedule-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ allOf:
+ - "$ref": "#/components/schemas/Pay-Schedule"
+ - "$ref": "#/components/schemas/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
+ Pay-Schedule-Create-Update-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Pay-Schedule-Create-Update"
+ 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
+ Pay-Schedule-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ allOf:
+ - "$ref": "#/components/schemas/Pay-Schedule"
+ - "$ref": "#/components/schemas/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:
+ 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:
+ name: Staff
+ custom_name: Staff department pay schedule
+ auto_pilot: true
+ active: false
+ Benefit-Type-Requirements-Object:
+ description: Benefit type requirements response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Benefit-Type-Requirements"
+ examples:
+ Example:
+ value:
+ employee_deduction:
+ required: true
+ editable: true
+ default_value:
+ choices:
+ contribution:
+ required: true
+ editable: true
+ default_value:
+ type: percentage
+ value: 2
+ choices:
+ - percentage
+ deduct_as_percentage:
+ required: true
+ editable: true
+ default_value:
+ choices:
+ catch_up:
+ required: true
+ editable: true
+ default_value:
+ choices:
+ limit_option:
+ required: false
+ editable: false
+ default_value:
+ choices:
+ company_contribution_annual_maximum:
+ required: false
+ editable: false
+ default_value:
+ choices:
+ coverage_salary_multiplier:
+ required: false
+ editable: false
+ default_value:
+ choices:
+ coverage_amount:
+ required: false
+ editable: false
+ default_value:
+ choices:
+ Supported-Benefit-Object:
+ description: Supported benefit response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Supported-Benefit-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Admin-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Admin"
+ examples:
+ Example:
+ value:
+ first_name: John
+ last_name: Smith
+ email: jsmith99@gmail.com
+ uuid: 5de11791-98fd-4587-9ed0-d5d804b8e647
+ Admin-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Admin"
+ 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
+ Company-Benefit-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Company-Benefit-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Company-Custom-Field-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ custom_fields:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Company-Custom-Field"
+ examples:
+ Example:
+ value:
+ custom_fields:
+ - uuid: ea7e5d57-6abb-47d7-b654-347c142886c0
+ name: employee_level
+ description: Employee Level
+ type: text
+ selection_options:
+ - uuid: 299650e4-e970-4acf-9bf0-6f05585d20ba
+ name: t-shirt size
+ description: What is your t-shirt size?
+ type: text
+ selection_options:
+ - uuid: 024ec137-6c92-43a3-b061-14a9720531d6
+ name: favorite fruit
+ description: Which is your favorite fruit?
+ type: radio
+ selection_options:
+ - apple
+ - banana
+ - orange
+ Earning-Type-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ default:
+ type: array
+ description: The default earning types for the company.
+ items:
+ "$ref": "#/components/schemas/Earning-Type"
+ custom:
+ type: array
+ description: The custom earning types for the company.
+ items:
+ "$ref": "#/components/schemas/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
+ Earning-Type-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Earning-Type"
+ examples:
+ Example:
+ value:
+ name: Gym Membership Stipend
+ uuid: f4dc8972-8830-4c07-b623-349a04b040d7
+ Employee-Benefit-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Benefit"
+ 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:
+ deduct_as_percentage: false
+ catch_up: false
+ coverage_amount:
+ deduction_reduces_taxable_income:
+ 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'
+ Employee-Benefit-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-Benefit"
+ 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:
+ deduct_as_percentage: false
+ contribute_as_percentage: false
+ catch_up: false
+ coverage_amount:
+ deduction_reduces_taxable_income:
+ coverage_salary_multiplier: '0.00'
+ Contribution-Exclusion-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Payroll-Update-Object:
+ description: A prepared payroll
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Prepared"
+ examples:
+ Example:
+ value:
+ payroll_deadline: '2022-02-18T22:00:00Z'
+ check_date: '2021-02-22'
+ off_cycle: false
+ off_cycle_reason:
+ external: false
+ auto_pilot: false
+ processed: false
+ processed_date:
+ calculated_at:
+ uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ payroll_uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ created_at: '2022-02-01T22:00:00Z'
+ pay_period:
+ start_date: '2021-02-01'
+ end_date: '2021-02-15'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ payroll_status_meta:
+ cancellable: false
+ expected_check_date: '2022-02-22'
+ initial_check_date: '2022-02-22'
+ expected_debit_time: '2022-02-18T22:00:00Z'
+ payroll_late: false
+ initial_debit_cutoff_time: '2022-02-18T22:00:00Z'
+ processing_request:
+ employee_compensations:
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7067
+ version: 4ba36d23a78c7393b4900ef38019d8ff
+ first_name: Patricia
+ preferred_first_name: Patricia
+ last_name: Hamil
+ excluded: false
+ payment_method: Direct Deposit
+ fixed_compensations:
+ - name: Bonus
+ amount: '100.00'
+ job_uuid: 94e0d15e-9ed2-4077-98f6-64554f242ba5
+ - name: Reimbursement
+ amount: '100.00'
+ job_uuid: 91bc3b43-ded0-4ee7-98fe-215499e909ba
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Nonexempt
+ - name: Overtime
+ hours: '15.000'
+ job_uuid: 9d3760f0-d1f9-4700-8817-0fe2dce5cf23
+ compensation_multiplier: 1.5
+ flsa_status: Nonexempt
+ - name: Double overtime
+ hours: '0.000'
+ job_uuid: b5eef9a9-4a87-4649-a80d-14878c05f44e
+ compensation_multiplier: 2
+ flsa_status: Nonexempt
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: 332bd171-9efc-432b-abbb-a75c9dba706a
+ compensation_multiplier: 1
+ flsa_status: Nonexempt
+ - name: Overtime
+ hours: '5.000'
+ job_uuid: ca9b3dc1-57ac-4736-901a-9b1c9634b9d5
+ compensation_multiplier: 1.5
+ flsa_status: Nonexempt
+ - name: Double overtime
+ hours: '0.000'
+ job_uuid: 1bad01e2-140c-49ed-9542-2388ce4a19b3
+ compensation_multiplier: 2
+ flsa_status: Nonexempt
+ paid_time_off:
+ - name: Vacation Hours
+ hours: '20.000'
+ - name: Sick Hours
+ hours: '0.000'
+ - name: Holiday Hours
+ hours: '0.000'
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7012
+ version: ff083257a5583291fb86656ad0df1b42
+ first_name: Soren
+ preferred_first_name: Soren
+ last_name: Keck
+ excluded: false
+ payment_method: Direct Deposit
+ fixed_compensations:
+ - name: Bonus
+ amount: '100.00'
+ job_uuid: 94e0d15e-9ed2-4077-98f6-64554f242b34
+ - name: Reimbursement
+ amount: '100.00'
+ job_uuid: 91bc3b43-ded0-4ee7-98fe-215499e90955
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Commission Only Exempt
+ paid_time_off:
+ - name: Vacation Hours
+ hours: '20.000'
+ - name: Sick Hours
+ hours: '0.000'
+ - name: Holiday Hours
+ hours: '0.000'
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7781
+ version: 259816479e3729bf855318af9b9adddf
+ first_name: Patty
+ preferred_first_name: Patty
+ last_name: Tam
+ excluded: false
+ payment_method: Direct Deposit
+ fixed_compensations:
+ - name: Bonus
+ amount: '100.00'
+ job_uuid: 94e0d15e-9ed2-4077-98f6-64554f242bab
+ - name: Reimbursement
+ amount: '100.00'
+ job_uuid: 91bc3b43-ded0-4ee7-98fe-215499e909cd
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Exempt
+ paid_time_off:
+ - name: Vacation Hours
+ hours: '20.000'
+ - name: Sick Hours
+ hours: '0.000'
+ - name: Holiday Hours
+ hours: '0.000'
+ fixed_compensation_types:
+ - name: Bonus
+ - name: Commission
+ - name: Paycheck Tips
+ - name: Cash Tips
+ - name: Correction Payment
+ - name: Anniversary Bonus
+ - name: Internet Stipend
+ - name: Reimbursement
+ Off-Cycle-Payroll-Object:
+ description: An off-cycle payroll
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Prepared"
+ examples:
+ Example:
+ value:
+ version: 19289df18e6e20f797de4a585ea5a91535c7ddf7
+ payroll_deadline: '2022-02-18T22:00:00Z'
+ check_date: '2021-02-22'
+ off_cycle: true
+ off_cycle_reason: Bonus
+ external: false
+ auto_pilot: false
+ processed: false
+ processed_date:
+ calculated_at:
+ uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ payroll_uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ created_at: '2022-02-01T22:00:00Z'
+ withholding_pay_period: Every other week
+ skip_regular_deductions: true
+ fixed_withholding_rate: true
+ final_termination_payroll: false
+ pay_period:
+ start_date: '2021-02-01'
+ end_date: '2021-02-15'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ payroll_status_meta:
+ cancellable: false
+ expected_check_date: '2022-02-22'
+ initial_check_date: '2022-02-22'
+ expected_debit_time: '2022-02-18T22:00:00Z'
+ payroll_late: false
+ initial_debit_cutoff_time: '2022-02-18T22:00:00Z'
+ processing_request:
+ employee_compensations:
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7067
+ first_name: John
+ preferred_first_name: John
+ last_name: Doe
+ excluded: false
+ payment_method: Direct Deposit
+ fixed_compensations: []
+ memo:
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '0.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Nonexempt
+ - name: Overtime
+ hours: '0.000'
+ job_uuid: 9d3760f0-d1f9-4700-8817-0fe2dce5cf23
+ compensation_multiplier: 1.5
+ flsa_status: Nonexempt
+ - name: Double overtime
+ hours: '0.000'
+ job_uuid: b5eef9a9-4a87-4649-a80d-14878c05f44e
+ compensation_multiplier: 2
+ flsa_status: Nonexempt
+ - name: Regular Hours
+ hours: '0.000'
+ job_uuid: 332bd171-9efc-432b-abbb-a75c9dba706a
+ compensation_multiplier: 1
+ flsa_status: Nonexempt
+ - name: Overtime
+ hours: '0.000'
+ job_uuid: ca9b3dc1-57ac-4736-901a-9b1c9634b9d5
+ compensation_multiplier: 1.5
+ flsa_status: Nonexempt
+ - name: Double overtime
+ hours: '0.000'
+ job_uuid: 1bad01e2-140c-49ed-9542-2388ce4a19b3
+ compensation_multiplier: 2
+ flsa_status: Nonexempt
+ paid_time_off: []
+ Payroll-Show-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll"
+ examples:
+ Unprocessed:
+ value:
+ payroll_deadline: '2021-02-18T22:00:00Z'
+ check_date: '2021-02-22'
+ off_cycle: false
+ external: false
+ auto_pilot: false
+ processed: false
+ processed_date:
+ calculated_at:
+ uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ payroll_uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ created_at: '2022-02-01T22:00:00Z'
+ pay_period:
+ start_date: '2021-02-01'
+ end_date: '2021-02-15'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ payroll_status_meta:
+ cancellable: false
+ expected_check_date: '2021-02-22'
+ initial_check_date: '2021-02-22'
+ expected_debit_time: '2021-02-18T22:00:00Z'
+ payroll_late: false
+ initial_debit_cutoff_time: '2021-02-18T22:00:00Z'
+ submission_blockers:
+ - blocker_type: fast_ach_threshold_exceeded
+ blocker_name: Fast ACH Threshold Exceeded
+ unblock_options:
+ - unblock_type: wire_in
+ check_date: '2024-06-10'
+ metadata:
+ wire_in_deadline: '2024-06-19T18:00:00Z'
+ wire_in_amount: 400000.0
+ - unblock_type: move_to_four_day
+ check_date: '2024-06-12'
+ metadata: {}
+ selected_option:
+ status: unresolved
+ processing_request:
+ Processed:
+ value:
+ payroll_deadline: '2021-02-18T22:00:00Z'
+ check_date: '2021-02-22'
+ off_cycle: false
+ external: false
+ auto_pilot: true
+ processed: true
+ processed_date: '2021-02-18'
+ calculated_at: '2021-02-18T12:00:00Z'
+ payroll_uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ created_at: '2022-02-01T22:00:00Z'
+ pay_period:
+ start_date: '2021-02-01'
+ end_date: '2021-02-15'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ totals:
+ company_debit: '121747.71'
+ net_pay_debit: '79283.80'
+ tax_debit: '42463.91'
+ reimbursement_debit: '0.00'
+ child_support_debit: '0.00'
+ reimbursements: '0.00'
+ net_pay: '81752.94'
+ gross_pay: '130635.89'
+ employee_bonuses: '0.00'
+ employee_commissions: '18536.37'
+ employee_cash_tips: '0.00'
+ employee_paycheck_tips: '0.00'
+ additional_earnings: '0.00'
+ owners_draw: '0.00'
+ check_amount: '2469.14'
+ employer_taxes: '6917.19'
+ employee_taxes: '35546.72'
+ benefits: '0.00'
+ employee_benefits_deductions: '13336.23'
+ imputed_pay: '0.00'
+ deferred_payroll_taxes: '0.00'
+ other_deductions: '240.00'
+ company_taxes:
+ - name: MO Compensation Deduction
+ amount: "-0.92"
+ employer: true
+ - name: NY MCTMT
+ amount: '5.00'
+ employer: true
+ payroll_taxes:
+ - name: Federal Income Tax
+ employer: false
+ amount: 3546.72
+ - name: Social Security
+ employer: true
+ amount: 786.0
+ - name: Social Security
+ employer: false
+ amount: 786.0
+ - name: CA State Income Tax
+ employer: false
+ amount: 132.51
+ payroll_status_meta:
+ cancellable: false
+ expected_check_date: '2021-02-22'
+ initial_check_date: '2021-02-22'
+ expected_debit_time: '2021-02-18T22:00:00Z'
+ payroll_late: false
+ initial_debit_cutoff_time: '2021-02-18T22:00:00Z'
+ employee_compensations:
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7067
+ excluded: false
+ gross_pay: '2791.25'
+ net_pay: '1953.31'
+ check_amount: '1953.31'
+ payment_method: Direct Deposit
+ fixed_compensations:
+ - name: Bonus
+ amount: '100.00'
+ job_uuid: 94e0d15e-9ed2-4077-98f6-64554f242ba5
+ - name: Reimbursement
+ amount: '100.00'
+ job_uuid: 91bc3b43-ded0-4ee7-98fe-215499e909ba
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Nonexempt
+ - name: Overtime
+ hours: '15.000'
+ job_uuid: 9d3760f0-d1f9-4700-8817-0fe2dce5cf23
+ compensation_multiplier: 1.5
+ flsa_status: Nonexempt
+ - name: Double overtime
+ hours: '0.000'
+ job_uuid: b5eef9a9-4a87-4649-a80d-14878c05f44e
+ compensation_multiplier: 2
+ flsa_status: Nonexempt
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: 332bd171-9efc-432b-abbb-a75c9dba706a
+ compensation_multiplier: 1
+ flsa_status: Nonexempt
+ - name: Overtime
+ hours: '5.000'
+ job_uuid: ca9b3dc1-57ac-4736-901a-9b1c9634b9d5
+ compensation_multiplier: 1.5
+ flsa_status: Nonexempt
+ - name: Double overtime
+ hours: '0.000'
+ job_uuid: 1bad01e2-140c-49ed-9542-2388ce4a19b3
+ compensation_multiplier: 2
+ flsa_status: Nonexempt
+ paid_time_off:
+ - name: Vacation Hours
+ hours: '20.000'
+ - name: Sick Hours
+ hours: '0.000'
+ - name: Holiday Hours
+ hours: '0.000'
+ benefits:
+ - name: Group Term Life
+ employee_deduction: '100.00'
+ company_contribution: '50.00'
+ imputed: true
+ - name: 401K
+ employee_deduction: '100.00'
+ company_contribution: '50.00'
+ imputed: false
+ deductions:
+ - name: Child Support
+ amount: '80.00'
+ taxes:
+ - name: Federal Income Tax
+ employer: false
+ amount: '646.69'
+ - name: Social Security
+ employer: true
+ amount: '191.25'
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7012
+ excluded: false
+ gross_pay: '2791.25'
+ net_pay: '1953.31'
+ check_amount: '1953.31'
+ payment_method: Direct Deposit
+ fixed_compensations:
+ - name: Bonus
+ amount: '100.00'
+ job_uuid: 94e0d15e-9ed2-4077-98f6-64554f242b34
+ - name: Reimbursement
+ amount: '100.00'
+ job_uuid: 91bc3b43-ded0-4ee7-98fe-215499e90955
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Commission Only Exempt
+ paid_time_off:
+ - name: Vacation Hours
+ hours: '20.000'
+ - name: Sick Hours
+ hours: '0.000'
+ - name: Holiday Hours
+ hours: '0.000'
+ benefits:
+ - name: Group Term Life
+ employee_deduction: '100.00'
+ company_contribution: '50.00'
+ imputed: true
+ - name: 401K
+ employee_deduction: '100.00'
+ company_contribution: '50.00'
+ imputed: false
+ deductions:
+ - name: Child Support
+ amount: '80.00'
+ taxes:
+ - name: Federal Income Tax
+ employer: false
+ amount: '646.69'
+ - name: Social Security
+ employer: true
+ amount: '191.25'
+ - employee_uuid: 187412e1-3dbe-491a-bb2f-2f40323a7781
+ excluded: false
+ gross_pay: '2791.25'
+ net_pay: '1953.31'
+ check_amount: '1953.31'
+ payment_method: Direct Deposit
+ fixed_compensations:
+ - name: Bonus
+ amount: '100.00'
+ job_uuid: 94e0d15e-9ed2-4077-98f6-64554f242bab
+ - name: Reimbursement
+ amount: '100.00'
+ job_uuid: 91bc3b43-ded0-4ee7-98fe-215499e909cd
+ hourly_compensations:
+ - name: Regular Hours
+ hours: '40.000'
+ job_uuid: bd378298-3e0c-4145-904a-baadf8a91fa3
+ compensation_multiplier: 1
+ flsa_status: Exempt
+ paid_time_off:
+ - name: Vacation Hours
+ hours: '20.000'
+ - name: Sick Hours
+ hours: '0.000'
+ - name: Holiday Hours
+ hours: '0.000'
+ benefits:
+ - name: Group Term Life
+ employee_deduction: '100.00'
+ company_contribution: '50.00'
+ imputed: true
+ - name: 401K
+ employee_deduction: '100.00'
+ company_contribution: '50.00'
+ imputed: false
+ deductions:
+ - name: Child Support
+ amount: '80.00'
+ taxes:
+ - name: Federal Income Tax
+ employer: false
+ amount: 646.69
+ - name: Social Security
+ employer: true
+ amount: 191.25
+ credit_blockers:
+ - blocker_type: waiting_for_wire_in
+ blocker_name: Waiting for Wire In
+ unblock_options:
+ - unblock_type: submit_wire
+ check_date: '2024-06-10'
+ metadata:
+ wire_in_deadline: '2024-06-19T18:00:00Z'
+ wire_in_amount: 400000.0
+ wire_in_request_uuid: 187412e1-3dbe-491a-bb2f-2f40323a421a
+ selected_option: submit_wire
+ status: unresolved
+ processing_request:
+ status: submit_success
+ errors: []
+ Payroll-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Payroll-Minimal"
+ examples:
+ Example:
+ value:
+ - payroll_deadline: '2021-02-18T22:00:00Z'
+ check_date: '2021-02-22'
+ off_cycle: false
+ external: false
+ processed: true
+ processed_date: '2021-02-18'
+ calculated_at: '2021-02-18T12:00:00Z'
+ uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ payroll_uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ created_at: '2021-02-01T22:00:00Z'
+ reversal_payroll_uuids: []
+ pay_period:
+ start_date: '2021-02-01'
+ end_date: '2021-02-15'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ totals:
+ company_debit: '121747.71'
+ net_pay_debit: '79283.80'
+ tax_debit: '42463.91'
+ reimbursement_debit: '0.00'
+ child_support_debit: '0.00'
+ reimbursements: '0.00'
+ net_pay: '81752.94'
+ gross_pay: '130635.89'
+ employee_bonuses: '0.00'
+ employee_commissions: '18536.37'
+ employee_cash_tips: '0.00'
+ employee_paycheck_tips: '0.00'
+ additional_earnings: '0.00'
+ owners_draw: '0.00'
+ check_amount: '2469.14'
+ employer_taxes: '6917.19'
+ employee_taxes: '35546.72'
+ benefits: '0.00'
+ employee_benefits_deductions: '13336.23'
+ imputed_pay: '0.00'
+ deferred_payroll_taxes: '0.00'
+ other_deductions: '240.00'
+ - payroll_deadline: '2021-02-28'
+ check_date: '2021-03-01'
+ off_cycle: false
+ external: false
+ processed: false
+ processed_date: nil
+ calculated_at: nil
+ payroll_uuid: b50e611d-8f3d-4f24-b001-46675f7b5777
+ company_uuid: 6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb
+ created_at: '2022-02-01T22:00:00Z'
+ pay_period:
+ start_date: '2021-02-16'
+ end_date: '2021-03-01'
+ pay_schedule_uuid: 00ebc4a4-ec88-4435-8f45-c505bb63e501
+ Payment-Configs-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payment-Configs"
+ examples:
+ Example:
+ value:
+ company_uuid: 423dd616-6dbc-4724-938a-403f6217a933
+ partner_uuid: 556f05d0-48e0-4c47-bce5-db9aea923043
+ fast_payment_limit: '5000'
+ payment_speed: 2-day
+ earned_fast_ach_blockers:
+ - blocker_type: minimum_days
+ threshold: 15
+ - blocker_type: minimum_funded_payments
+ threshold: 1
+ Company-Bank-Account-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Bank-Account"
+ examples:
+ Example:
+ value:
+ 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
+ Company-Bank-Account-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Company-Bank-Account"
+ examples:
+ Example:
+ value:
+ - 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
+ Employee-Bank-Account-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Bank-Account"
+ 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
+ Employee-Bank-Account-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-Bank-Account"
+ 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
+ Employee-Payment-Method-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Payment-Method"
+ examples:
+ Example:
+ value:
+ version: 63859768485e218ccf8a449bb60f14ed
+ type: Direct Deposit
+ split_by: Amount
+ splits:
+ - uuid: e88f9436-b74e-49a8-87e9-777b9bfe715e
+ name: BoA Checking Account
+ priority: 1
+ split_amount: 500
+ - uuid: 0d2b7f73-05d6-4184-911d-269edeecc30a
+ name: Chase Checking Account
+ priority: 2
+ split_amount: 1000
+ - uuid: 1531e824-8d9e-4bd8-9f90-0d04608125d7
+ name: US Bank Checking Account
+ priority: 3
+ split_amount:
+ Federal-Tax-Details-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Employee-State-Taxes-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Employee-State-Tax"
+ examples:
+ Employee-State-Taxes-List-Example:
+ value:
+ employee_uuid: 92fa4d30-e284-43d0-a26e-605619c04beb
+ file_new_hire_report: false
+ is_work_state: true
+ 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.
+
+'
+ 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:
+ - 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.
+
+'
+ key: withholding_allowance
+ input_question_format:
+ type: Number
+ answers:
+ - value: 1
+ valid_from: '2010-01-01'
+ valid_up_to:
+ - 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:
+ - 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
+ answers:
+ - value: true
+ valid_from: '2010-01-01'
+ valid_up_to:
+ Employee-Onboarding-Status-Object:
+ description: Example response.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Employee-Onboarding-Status"
+ examples:
+ Example:
+ value:
+ uuid: c44d66dc-c41b-4a60-9e25-5e93ff8583f2
+ onboarding_status: admin_onboarding_incomplete
+ onboarding_steps:
+ - title: Personal details
+ id: personal_details
+ required: true
+ completed: false
+ requirements: []
+ - title: Enter compensation details
+ id: compensation_details
+ required: true
+ completed: false
+ requirements: []
+ - title: Add work address
+ id: add_work_address
+ required: true
+ completed: false
+ requirements: []
+ - title: Add home address
+ id: add_home_address
+ required: true
+ completed: false
+ requirements: []
+ - title: Enter federal tax withholdings
+ id: federal_tax_setup
+ required: true
+ completed: false
+ 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: false
+ requirements: []
+ - title: Employee form signing
+ id: employee_form_signing
+ required: true
+ completed: false
+ requirements:
+ - federal_tax_setup
+ - state_tax_setup
+ Payroll-Blocker-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Payroll-Blocker"
+ examples:
+ Payroll Blockers:
+ value:
+ - key: eftps_in_error
+ message: We could not make payments to the Electronic Federal Tax Payment System.
+ - key: geocode_error
+ message: Company or employee address could not be verified. Please ensure all addresses are valid.
+ - key: geocode_needed
+ message: Company or employee address verification is missing. Please ensure all addresses are entered correctly.
+ - key: pay_schedule_setup_not_complete
+ message: Some employees don’t have a pay schedule set up yet. Please complete this step to run payroll.
+ - key: invalid_signatory
+ message: A signatory who is authorized to sign documents on behalf of your company is required. Please ensure their identity verification is successful.
+ - key: suspended
+ message: Company is suspended and cannot run payroll.
+ - key: soft_suspended
+ message: Company is placed in a 'soft' suspension state and requires missing/incorrect information to be corrected.
+ - key: pending_payroll_review
+ message: Payroll is blocked. We are reviewing payroll information in your account. Please contact support if you believe this is an error.
+ - key: pending_recovery_case
+ message: Payroll is blocked due to an open recovery case. Please contact support if you believe this is an error.
+ - key: pending_information_request
+ message: Payroll is blocked due to an open information request. Please contact support if you believe this is an error.
+ - key: needs_approval
+ message: Company needs to be approved to run payroll.
+ - key: missing_addresses
+ message: Company must add addresses in order to run payroll.
+ - key: missing_federal_tax_setup
+ message: Company must complete federal tax setup in order to run payroll.
+ - key: missing_industry_selection
+ message: Company must complete industry selection in order to run payroll.
+ - key: missing_bank_info
+ message: Company must have a bank account in order to run payroll.
+ - key: missing_employee_setup
+ message: Company must add employees in order to run payroll.
+ - key: missing_state_tax_setup
+ message: Company must complete state tax setup in order to run payroll.
+ - key: missing_pay_schedule
+ message: Company must have a pay schedule in order to run payroll.
+ - key: missing_forms
+ message: Company forms must be signed in order to run payroll.
+ - key: missing_bank_verification
+ message: Company bank account must be verified in order to run payroll.
+ - key: missing_signatory
+ message: Company must have a verified signatory in order to run payroll.
+ Generated-Document:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Generated-Document"
+ examples:
+ Example:
+ value:
+ document_urls:
+ - https://document.url.com
+ request_uuid: p83d0ca8-7d41-42a9-834y-7d218ef6cb20
+ status: succeeded
+ General-Ledger-Report:
+ 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
+ nullable: true
+ 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
+ Report:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Report"
+ examples:
+ Example:
+ value:
+ report_urls:
+ - https://report.url.com
+ request_uuid: p83d0ca8-7d41-42a9-834y-7d218ef6cb20
+ status: succeeded
+ Create-Report:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Report-Template:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Notification:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Event-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Event"
+ examples:
+ Example:
+ value:
+ - 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
+ Payroll-Check:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Payroll-Receipt:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Payroll-Receipt"
+ examples:
+ Example:
+ value:
+ totals:
+ company_debit: '1080.47'
+ net_pay_debit: '748.34'
+ child_support_debit: '100.0'
+ reimbursement_debit: '50.0'
+ tax_debit: '182.13'
+ taxes:
+ - name: Federal Income Tax
+ amount: '30.36'
+ - name: Social Security
+ amount: '104.54'
+ - name: Medicare
+ amount: '24.46'
+ - name: Additional Medicare
+ amount: '0.0'
+ - name: TX SUTA
+ amount: '22.77'
+ - name: FUTA
+ amount: '0.0'
+ employee_compensations:
+ - employee_uuid: f83d0bd8-7e20-43b9-834c-6d514ef6cb47
+ employee_first_name: Patricia
+ employee_last_name: Hamill
+ payment_method: Direct Deposit
+ net_pay: '748.34'
+ total_tax: '182.13'
+ total_garnishments: '0.0'
+ child_support_garnishment: '100.0'
+ total_reimbursement: '50.0'
+ licensee:
+ name: Gusto, Zenpayroll Inc.
+ address: 525 20th St
+ city: San Francisco
+ state: CA
+ postal_code: '94107'
+ phone_number: '4157778888'
+ payroll_uuid: afccb970-357e-4013-81f5-85dafc74f9b6
+ company_uuid: c827aa0d-3928-4d5a-ab1f-400641a7d2b8
+ name_of_sender: Torp and Sons and Sons
+ 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: '2022-06-02'
+ 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
+ Payroll-Reversal-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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:
+ category: convert_check_ee_requested
+ reversed_employee_uuids:
+ - 5f036964-185e-4c85-bbf2-3873e1203b30
+ Gross-Up-Pay:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Gross-Up-Pay"
+ examples:
+ Example:
+ value:
+ net_pay: '1183.25'
+ Contractor-Payment-Receipt:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Contractor-Bank-Account-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Contractor-Bank-Account"
+ 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
+ Contractor-Bank-Account-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Contractor-Bank-Account"
+ 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
+ Time-Off-Policy-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ examples:
+ Unlimited Policy:
+ value:
+ uuid: 3f746cd0-dd08-408f-b712-8180c7c621e9
+ company_uuid: de83cff2-8e7a-448e-a28c-14258a9971c3
+ name: Test Vacation Unlimited Policy
+ policy_type: vacation
+ accrual_method: unlimited
+ accrual_rate:
+ accrual_rate_unit:
+ paid_out_on_termination: false
+ accrual_waiting_period_days:
+ carryover_limit_hours:
+ max_accrual_hours_per_year:
+ max_hours:
+ version: f5556bce3d75ec2b62bd11990aa7993a
+ is_active: true
+ complete: true
+ employees:
+ - uuid: 05ed3150-591e-4f8b-bfd5-55d478edd2d8
+ - uuid: 3633ce57-abb7-422f-8c5a-455566618e6a
+ - uuid: 9b37429c-e540-40fb-86b3-738ca9af65c7
+ Fixed Policy:
+ value:
+ uuid: 2439c13f-f6d7-4a93-af8c-175fd4cc7ce8
+ company_uuid: f5f7b10d-2ddb-42f6-a955-d55320ce5316
+ name: Test Vacation Fixed Policy
+ policy_type: vacation
+ accrual_method: per_anniversary_year
+ accrual_rate: '120.0'
+ accrual_rate_unit:
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 0
+ carryover_limit_hours: '240.0'
+ max_accrual_hours_per_year: '120.0'
+ max_hours: '300.0'
+ version: f5556bce3d75ec2b62bd11990aa7993a
+ is_active: true
+ complete: true
+ employees:
+ - uuid: de7a5fb3-2e0f-460a-abbf-467fe310bf5c
+ balance: '80.0'
+ - uuid: 92af03c7-a833-43ae-bae8-f67007a59b37
+ balance: '60.0'
+ Hourly Policy:
+ value:
+ uuid: bd5f354f-12e0-4a5e-ad1f-953bb2685ad4
+ company_uuid: 6767445f-5075-4ea4-a7f5-d5b5b93d4d60
+ name: Test Vacation Hourly Policy
+ policy_type: vacation
+ accrual_method: per_hour_paid
+ accrual_rate: '4.0'
+ accrual_rate_unit: '80.0'
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 30
+ carryover_limit_hours: '200.0'
+ max_accrual_hours_per_year: '120.0'
+ max_hours: '240.0'
+ version: f5556bce3d75ec2b62bd11990aa7993a
+ is_active: true
+ complete: true
+ employees:
+ - uuid: 1ea2764d-0f1a-4f09-b1d9-3006aecf63c4
+ balance: '56.0'
+ - uuid: a0db19a2-7c8f-42b4-9d4c-2e6246c3d6e8
+ balance: '84.0'
+ headers: {}
+ Time-Off-Policy-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Time-Off-Policy"
+ examples:
+ example:
+ value:
+ - uuid: 3f746cd0-dd08-408f-b712-8180c7c621e9
+ company_uuid: de83cff2-8e7a-448e-a28c-14258a9971c3
+ name: Test Vacation Unlimited Policy
+ policy_type: vacation
+ accrual_method: unlimited
+ accrual_rate:
+ accrual_rate_unit:
+ paid_out_on_termination: false
+ accrual_waiting_period_days:
+ carryover_limit_hours:
+ max_accrual_hours_per_year:
+ max_hours:
+ version: f5556bce3d75ec2b62bd11990aa7993a
+ is_active: true
+ complete: true
+ employees:
+ - uuid: 05ed3150-591e-4f8b-bfd5-55d478edd2d8
+ - uuid: 3633ce57-abb7-422f-8c5a-455566618e6a
+ - uuid: 9b37429c-e540-40fb-86b3-738ca9af65c7
+ - uuid: 2439c13f-f6d7-4a93-af8c-175fd4cc7ce8
+ company_uuid: f5f7b10d-2ddb-42f6-a955-d55320ce5316
+ name: Test Vacation Fixed Policy
+ policy_type: vacation
+ accrual_method: per_anniversary_year
+ accrual_rate: '120.0'
+ accrual_rate_unit:
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 0
+ carryover_limit_hours: '240.0'
+ max_accrual_hours_per_year: '120.0'
+ max_hours: '300.0'
+ version: f5556bce3d75ec2b62bd11990aa7993a
+ is_active: true
+ complete: true
+ employees:
+ - uuid: de7a5fb3-2e0f-460a-abbf-467fe310bf5c
+ balance: '80.0'
+ - uuid: 92af03c7-a833-43ae-bae8-f67007a59b37
+ balance: '60.0'
+ - uuid: bd5f354f-12e0-4a5e-ad1f-953bb2685ad4
+ company_uuid: 6767445f-5075-4ea4-a7f5-d5b5b93d4d60
+ name: Test Vacation Hourly Policy
+ policy_type: vacation
+ accrual_method: per_hour_paid
+ accrual_rate: '4.0'
+ accrual_rate_unit: '80.0'
+ paid_out_on_termination: true
+ accrual_waiting_period_days: 30
+ carryover_limit_hours: '200.0'
+ max_accrual_hours_per_year: '120.0'
+ max_hours: '240.0'
+ version: f5556bce3d75ec2b62bd11990aa7993a
+ is_active: true
+ complete: true
+ employees:
+ - uuid: 1ea2764d-0f1a-4f09-b1d9-3006aecf63c4
+ balance: '56.0'
+ - uuid: a0db19a2-7c8f-42b4-9d4c-2e6246c3d6e8
+ balance: '84.0'
+ Time-Off-Activity-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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: {}
+ Invoice-Data-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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
+ Minimum-Wage-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Minimum-Wage"
+ examples:
+ Example:
+ value:
+ - uuid: 70c523ff-c71e-4474-9c83-a4ea51bd54a8
+ authority: State
+ wage: '13.0'
+ wage_type: Regular
+ effective_date: '2022-01-01'
+ notes: Employers with 6 or more employees
+ Information-Request-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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
+ Recovery-Case-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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:
+ amount_outstanding: '10499.43'
+ event_total_amount: '5912.07'
+ Ach-Transaction-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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:
+ 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
+ Wire-In-Request-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/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'
+ Wire-In-Request-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/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'
+ Time-Sheet-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Sheet"
+ examples:
+ example:
+ value:
+ uuid: 123e4567-e89b-12d3-a456-426655440000
+ company_uuid: 123e4567-e89b-12d3-a456-426655440000
+ status: approved
+ time_zone: America/Los_Angeles
+ entity_type: Employee
+ version: 72deb67e16f7b92713c00d3582fa6c68
+ job_uuid: 123e4567-e89b-12d3-a456-426655440000
+ entity_uuid: 123e4567-e89b-12d3-a456-426655440000
+ shift_started_at: '2025-03-04T13:07:10Z'
+ shift_ended_at: '2025-03-04T16:07:10Z'
+ created_at: '2025-04-29T16:08:53Z'
+ updated_at: '2025-04-29T16:08:53Z'
+ metadata: {}
+ entries:
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Regular
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Overtime
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Double overtime
+ Time-Sheet-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Time-Sheet"
+ examples:
+ Example:
+ value:
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ company_uuid: 123e4567-e89b-12d3-a456-426655440000
+ status: approved
+ time_zone: America/Los_Angeles
+ entity_type: Employee
+ version: 72deb67e16f7b92713c00d3582fa6c68
+ job_uuid: 123e4567-e89b-12d3-a456-426655440000
+ entity_uuid: 123e4567-e89b-12d3-a456-426655440000
+ shift_started_at: '2025-03-04T13:07:10Z'
+ shift_ended_at: '2025-03-04T16:07:10Z'
+ created_at: '2025-04-29T16:08:53Z'
+ updated_at: '2025-04-29T16:08:53Z'
+ metadata: {}
+ entries:
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Regular
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Overtime
+ - uuid: 123e4567-e89b-12d3-a456-426655440000
+ hours_worked: '1.000'
+ pay_classification: Double overtime
+ Company-Suspension:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Company-Suspension"
+ Company-Suspension-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Company-Suspension"
+ Time-Off-Request-Object:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Time-Off-Request"
+ Time-Off-Request-List:
+ description: Example response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/Time-Off-Request"
+ requestBodies:
+ post-employee-ytd-benefit-amounts-from-different-company:
+ 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
+security:
+ - CompanyAccessAuth: []
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
index 589e33a0..4ea901dc 100644
--- a/.speakeasy/workflow.lock
+++ b/.speakeasy/workflow.lock
@@ -1,21 +1,20 @@
-speakeasyVersion: 1.692.0
+speakeasyVersion: 1.759.1
sources:
GustoEmbedded-OAS:
sourceNamespace: gusto-embedded-oas
- sourceRevisionDigest: sha256:830c753d02c15435169a357383c3757b9cf086825f7ebcb7ecbea75fd9d928a0
- sourceBlobDigest: sha256:bc5e757c99f4bfb2a8e8081f377fae1b07eee46e9aea1d1dc08b618685afc86f
+ sourceRevisionDigest: sha256:2dd17821859a345f80e44ea59de357043b7c487e5a07d83900df0727cff01373
+ sourceBlobDigest: sha256:e0fc49724e71a4d3f3712eda2aae743c479293f3654e40328f58f442d8c2dfe5
tags:
- latest
- - speakeasy-sdk-regen-1768522952
- "2025-06-15"
targets:
gusto-embedded:
source: GustoEmbedded-OAS
sourceNamespace: gusto-embedded-oas
- sourceRevisionDigest: sha256:830c753d02c15435169a357383c3757b9cf086825f7ebcb7ecbea75fd9d928a0
- sourceBlobDigest: sha256:bc5e757c99f4bfb2a8e8081f377fae1b07eee46e9aea1d1dc08b618685afc86f
+ sourceRevisionDigest: sha256:2dd17821859a345f80e44ea59de357043b7c487e5a07d83900df0727cff01373
+ sourceBlobDigest: sha256:e0fc49724e71a4d3f3712eda2aae743c479293f3654e40328f58f442d8c2dfe5
codeSamplesNamespace: gusto-embedded-oas-java-code-samples
- codeSamplesRevisionDigest: sha256:d2af391897b29300b26571ba0f2713bcc06569178a238dcb179bef6a7a4d91ca
+ codeSamplesRevisionDigest: sha256:64463c837d06bb30b82a76e8e4f3df38299141ea1b9c6ad04b00239809968cc1
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
diff --git a/gusto_embedded/.gitattributes b/gusto_embedded/.gitattributes
index 87cd6547..8f8da085 100644
--- a/gusto_embedded/.gitattributes
+++ b/gusto_embedded/.gitattributes
@@ -4,8 +4,5 @@
# Linux start script should use lf
/gradlew text eol=lf
-# These are Windows script files and should use crlf
-*.bat text eol=crlf
-
# This allows generated code to be indexed correctly
*.java linguist-generated=false
\ No newline at end of file
diff --git a/gusto_embedded/.speakeasy/gen.lock b/gusto_embedded/.speakeasy/gen.lock
index c43ca1bf..efe65c4b 100644
--- a/gusto_embedded/.speakeasy/gen.lock
+++ b/gusto_embedded/.speakeasy/gen.lock
@@ -1,82 +1,75 @@
lockVersion: 2.0.0
id: 5d57a1bf-31fa-4bb7-8d47-6fe0473a6fda
management:
- docChecksum: be45802dc4ba00d65ab9a94525be8fd8
+ docChecksum: 4562d587647e3ad7b84541473d23c9d3
docVersion: "2025-06-15"
- speakeasyVersion: 1.692.0
- generationVersion: 2.797.1
- releaseVersion: 0.3.1
- configChecksum: f71701f8b840034cc7a5a7871b5eb719
+ speakeasyVersion: 1.759.1
+ generationVersion: 2.869.10
+ releaseVersion: 0.3.2
+ configChecksum: 845e495a5ce1dc4804fcdf96799126fd
repoURL: https://github.com/Gusto/gusto-java-client.git
repoSubDirectory: gusto_embedded
+ installationURL: https://github.com/Gusto/gusto-java-client
persistentEdits:
- generation_id: 37fd4065-5af7-4439-a753-f23542fe2217
- pristine_commit_hash: 6dd323602367b90fa53d0884caf6b76b169a26c7
- pristine_tree_hash: 3a7c7d1e9c9af7c83d521d2479531a4a6498d735
+ generation_id: 8a79f30f-de5c-4229-94e9-d092c519a0a1
+ pristine_commit_hash: 71f0d5282b9acbe61f6a25b4b3fbfa30074f5f38
+ pristine_tree_hash: f3325d1eb4dcc2095aff10efaca00d02a96500dd
features:
java:
additionalDependencies: 0.1.0
additionalProperties: 0.0.1
- constsAndDefaults: 0.1.1
- core: 3.55.8
+ constsAndDefaults: 0.1.3
+ core: 3.55.22
deprecations: 2.81.2
downloadStreams: 0.1.1
flattening: 2.81.1
getRequestBodies: 2.81.1
- globalSecurity: 2.83.1
+ globalSecurity: 2.83.2
globalSecurityCallbacks: 0.1.0
globalSecurityFlattening: 0.1.0
- globalServerURLs: 2.83.0
+ globalServerURLs: 2.83.1
groups: 2.81.3
inputOutputModels: 2.83.0
- methodSecurity: 2.82.2
- nameOverrides: 2.81.3
+ methodSecurity: 2.82.4
+ nameOverrides: 2.81.5
nullables: 0.1.0
sdkHooks: 1.2.0
serverIDs: 2.81.1
- unions: 0.3.1
+ unions: 0.3.5
uploadStreams: 0.1.0
trackedFiles:
.gitattributes:
id: 24139dae6567
- last_write_checksum: sha1:18563f88a3e50e55f2ae6f2b62440464808f5d6f
- pristine_git_object: 87cd6547287adad3b806972ee22a765ed80ab806
+ last_write_checksum: sha1:2b27a763ec2b5c70648554e408dc254181222d09
+ pristine_git_object: 8f8da085659bbf87d293b49b4593e43137a4acb0
USAGE.md:
id: 3aed33ce6e6f
- last_write_checksum: sha1:0e18283b1fddb077dba7a30baf607d4488a60aa6
- pristine_git_object: 3bc4235ad7007df76d9cbea0a4922bbe744a4374
+ last_write_checksum: sha1:4be58e2376040ba503a8e4e565ad246bf6e69421
+ pristine_git_object: 82971d7bcdec241be81b8035d5411644d00b2864
build.gradle:
id: f07866736216
last_write_checksum: sha1:772cca456fb4b75b31025439ac270f44e4fe4b2d
pristine_git_object: 47d6bd8f4f770f80914be5611c10d9b95ef7a80b
docs/models/components/AccountType.md:
id: 32b5b4e60da5
- last_write_checksum: sha1:b96cc460e2458ffd18caf5fe00da8fce473fd834
- pristine_git_object: 62e4d33d1b35263230b24cf755851c924f642219
+ last_write_checksum: sha1:64a3904460454c1e640f6072b47616114bee2af4
+ pristine_git_object: 4aceb21088dd8cd8342a093649a8021188a14373
docs/models/components/AccrualMethod.md:
id: 6b69b2ad83e6
- last_write_checksum: sha1:62dc8a2866defe5302de01880338041aaf96bde3
- pristine_git_object: e1452305d941af64cee1d04165032e0a86e72464
- docs/models/components/AccruingTimeOffHour.md:
- id: 26267af39b2a
- last_write_checksum: sha1:4be08e007456fd3fa1ea565541f4b25ae09bc4df
- pristine_git_object: cc359259597a30a3960a736f8de5c05e269940d4
- docs/models/components/AccruingTimeOffHourObject.md:
- id: ff75e29d64d5
- last_write_checksum: sha1:63c5a315630b616d7778c0bac50e383e5897f9a2
- pristine_git_object: 5ab51974f8229ef2e43570084ea961fd878394da
+ last_write_checksum: sha1:6cf4c02b56162a34a86e3d14dd44e34ceb06e7b4
+ pristine_git_object: 43161598279764d47c0c307505a073128d75e6e1
docs/models/components/AchTransaction.md:
id: c49ada058827
last_write_checksum: sha1:ef36761c14bd02295ec1779243e4f754c99d8d88
pristine_git_object: bea6d9f3cb065a198fedec9a4a782d66de3ce08f
docs/models/components/AchTransactionRecipientType.md:
id: 29d384f9a03f
- last_write_checksum: sha1:8e2e6b1dd22da7d5723034bb98cd9d3201e993af
- pristine_git_object: d7dc2a038fe1511e6cec79ee00673e7f94a948c1
+ last_write_checksum: sha1:0e0e5835073b445e7fec17e8b81754b62f45d1d1
+ pristine_git_object: ff6bc1fcbe8679f391681ded85386f782283ef57
docs/models/components/Action.md:
id: 45f4a6205564
- last_write_checksum: sha1:2373a6c4549631b3ee3b29ab91c8600c055328b2
- pristine_git_object: 9d1c06584253bc9ed65df10fce9a83919daa72e1
+ last_write_checksum: sha1:5fb591b202e62ef2b78f291d0644c023c7d767af
+ pristine_git_object: 1ce2a77266e6067469909455b7c75ea4ff6dce42
docs/models/components/ActiveCompanies.md:
id: 02b485a63b18
last_write_checksum: sha1:0d81d79bd5d77175ed18df800e65d7d5a6c4c034
@@ -95,12 +88,12 @@ trackedFiles:
pristine_git_object: a8deac80b4f101043b4c0e8f6e7ba2a6e6d9fb8c
docs/models/components/Aggregation.md:
id: e5d63019622a
- last_write_checksum: sha1:15b9edde841ca21b967c2640509546d0dd9ed147
- pristine_git_object: 6eb639eb8b2105af14fbff6915b702def3426945
+ last_write_checksum: sha1:82687f1291fad080f9c29dd6736d7e0dd439c3ff
+ pristine_git_object: 55962ec107c1aca163bf35954718becb9b9e5a82
docs/models/components/AmountType.md:
id: 663939309beb
- last_write_checksum: sha1:7b8d94cb8b4bc8e0a0d5fbce4c351a2025e1f36e
- pristine_git_object: bbb815ff6d0692d1dcb52ae2fea64e1a14e3538a
+ last_write_checksum: sha1:2392a74ad9c1208d622a5f47e6d98c7b78ee260d
+ pristine_git_object: 37df9d31d98ade3d8c5c7c9cdacb50140eff46d3
docs/models/components/Answers.md:
id: 10d18224c68c
last_write_checksum: sha1:0ba98cc9ad50397318c53ccab7d78b750d024ac1
@@ -127,8 +120,8 @@ trackedFiles:
pristine_git_object: a6bc914fdc542e4997934eb467f655a5ed129580
docs/models/components/AuthorizationStatus.md:
id: 4801cd6d3980
- last_write_checksum: sha1:a6b6783a680eb0a6616e96a1e119945ed85d5fec
- pristine_git_object: f20ddbceec5affd60cad9b23ebfe961fe7bedfe4
+ last_write_checksum: sha1:be6c86096b36cc3c912150303d0c7800f2666dfc
+ pristine_git_object: 861ae3585c8d29c177a2e070e02224db6dcc84ef
docs/models/components/BLSOccupation.md:
id: 20967708af45
last_write_checksum: sha1:ed956489d874d0c26582da5ea27b7e7e91ccd332
@@ -187,24 +180,28 @@ trackedFiles:
pristine_git_object: 15c56573a3245624c19449e23d20e24c1621caed
docs/models/components/BlockerType.md:
id: 81b2707bdbe2
- last_write_checksum: sha1:1d883097916b23f020e2675f0b43529ba201018f
- pristine_git_object: 32799eef3ec8db1ac1145edd18fa97c14e521334
+ last_write_checksum: sha1:3abfd9df75bf16c4ada068c0b79e7dd4ea44c9e0
+ pristine_git_object: 1902bff23d8faffcb7051c14139f80e9a00662ca
docs/models/components/CatchUp.md:
id: 75e0752e3b9d
last_write_checksum: sha1:db54f44c482e58ca3645f210669374cff574e80a
pristine_git_object: 2b203368153931641a90f05a9df7894b650bc848
docs/models/components/CatchUpType.md:
id: 06c7c51b04b2
- last_write_checksum: sha1:83e51b763ea78526bf643c8b533928c6bd92b729
- pristine_git_object: 019ae78cb5fdeb0fa852330f015337fa45b4a8a8
+ last_write_checksum: sha1:894d84fb376be6fd735d29612629774e0ceef1df
+ pristine_git_object: 7a868b0d5ca709c47c1cdd91c928e57f5a769318
docs/models/components/Category.md:
id: 46e83fd791ba
- last_write_checksum: sha1:5054837bd195828fb07380d65747d58561a25a98
- pristine_git_object: 9adb382dedee7ea6210eceaba00d20b0632a2a74
+ last_write_checksum: sha1:90c722a6e9aa87735b114e049f0657f24e12e7d6
+ pristine_git_object: 4ad497d5e8b2933fd8b478864839650bd92d1cc0
docs/models/components/ChildSupportData.md:
id: a2b1716f631f
last_write_checksum: sha1:841139fa011bb5b2276a60e260950f754c80345d
pristine_git_object: 55cf0267a0b225ec54e6b3df88d5c6c0cb7bfef7
+ docs/models/components/ChildSupportDataKey.md:
+ id: 3b8d1a3cb8e6
+ last_write_checksum: sha1:bc06868fa45701396e2e1d9ad5b7630e0e7e3e5d
+ pristine_git_object: aad1de03689cefc4d8036670fc4ddcf9c792583f
docs/models/components/ChristmasDay.md:
id: 366ec2907e65
last_write_checksum: sha1:3a3f580f5b32eca9da2a73d9a041050d6c84f567
@@ -219,8 +216,8 @@ trackedFiles:
pristine_git_object: f48e8129350a2d0fa688240cac5a6fadd60859bd
docs/models/components/CompanyAddress.md:
id: a84b948ba88b
- last_write_checksum: sha1:b43e800deaa46ab2b465847fc5a5393382a5a3d8
- pristine_git_object: 218288a20fb5caa49c152c639d3cabe7fb6f0f1d
+ last_write_checksum: sha1:393f1348a5d3627688a38ba9f95d099a3b4e7daa
+ pristine_git_object: 302ddc4f58a7b812f819f5fce7bd18d124d3724e
docs/models/components/CompanyAttachment.md:
id: 21a1b4521436
last_write_checksum: sha1:c767f13636bb2f786039ad8581279d522a37f3a9
@@ -235,8 +232,12 @@ trackedFiles:
pristine_git_object: fe64c955fe3aa5b5e1eacaaf07ddfe693c92e682
docs/models/components/CompanyBankAccountRequestAccountType.md:
id: 79a3664b2448
- last_write_checksum: sha1:8417ff64bb9085403b9ce589c6899d37ce493676
- pristine_git_object: b0badaea9a463491295d547b2225f363bc7355bd
+ last_write_checksum: sha1:2680a048cd88e13b81c9173b89b66f5a8274a968
+ pristine_git_object: b04377ddc2b7452c3fb7427490796b68e3bb28f6
+ docs/models/components/CompanyBankAccountVerifyRequest.md:
+ id: 5653e422f05a
+ last_write_checksum: sha1:f0063554652dafecbfa68de032baf856700aa88f
+ pristine_git_object: 72335d1632a18e21a83e47278d5d6b4091e37b45
docs/models/components/CompanyBenefit.md:
id: 386d8e8adb35
last_write_checksum: sha1:665d99433903bd239222c7f3769495b6734f77a4
@@ -247,16 +248,16 @@ trackedFiles:
pristine_git_object: ceec158a92290cee5080044d84ce0753d9ef43ed
docs/models/components/CompanyBenefitWithEmployeeBenefitsCatchUpType.md:
id: 58274eab7d1d
- last_write_checksum: sha1:3290dd259d7f6c8f6ed5c887d844af20c4875ebf
- pristine_git_object: c2ce36fa9260c01d7ccb3c1ceffc5cd8e9a8da4c
+ last_write_checksum: sha1:1ff22b94bd9234c757104554ccaf7aff585f5b71
+ pristine_git_object: d13278ecd341c9c356b491b01af8e1a03798ce33
docs/models/components/CompanyBenefitWithEmployeeBenefitsContribution.md:
id: 4c0a589feedc
last_write_checksum: sha1:b401f850c19f3f71b1ccaada1bbb26a0fac7848b
pristine_git_object: 0cdf61a7f56fb46fd5af54e25cf076833e01a7a5
docs/models/components/CompanyBenefitWithEmployeeBenefitsSource.md:
id: 72d3c59fdee3
- last_write_checksum: sha1:7d266f082cd9bfaa05ea708ea494801af29cfb13
- pristine_git_object: 8afd239c12053a9e428e790db3b2f67a1f59a60d
+ last_write_checksum: sha1:9973d1647414bfa9ea5273dc59da5790842f26fd
+ pristine_git_object: 97a34661da30c5d0fda4890f76491d379a3a0272
docs/models/components/CompanyBenefitWithEmployeeBenefitsValue.md:
id: 23904f5e0ea1
last_write_checksum: sha1:3eb1049cabc5848449c9a79711fbb342582986bf
@@ -281,14 +282,18 @@ trackedFiles:
id: c2ac1b07ff85
last_write_checksum: sha1:4e9cfed486a2945357d0565380654727a89df5fd
pristine_git_object: 26276b9ccd93147bc3100cd0d7dc3f5527683bf4
- docs/models/components/CompanyFormsSortBy.md:
- id: dddda59be7ce
- last_write_checksum: sha1:ce8b3cdd299d1ceeb109029e42f6fc5ca77384fd
- pristine_git_object: 8bd8688154aaaa7bdb960026bdfcf2817c52d036
docs/models/components/CompanyHomeAddress.md:
id: f45430922021
last_write_checksum: sha1:752446cdc6e28579e3a8d133e8950926c941bf2d
pristine_git_object: f34f9e21a916dc812cb5f89f66e02858248a1e74
+ docs/models/components/CompanyIndustrySelectionRequiredBody.md:
+ id: ee8ff5a61544
+ last_write_checksum: sha1:bf37307191f8c0f0ac237351068fdd337aeafafb
+ pristine_git_object: 8052d6a591f0957384292b512c08bfc493b82975
+ docs/models/components/CompanyLocationRequest.md:
+ id: 5c30c0d9c335
+ last_write_checksum: sha1:4d15a85c520684600bc19190705ee050ee519868
+ pristine_git_object: 8267977c33fedbabc4b36a7d73c1a90abf245fca
docs/models/components/CompanyOnboardingStatus.md:
id: ddeca7454688
last_write_checksum: sha1:569d94590f0b1656dfec5ef77a7ec0563e351d22
@@ -299,24 +304,48 @@ trackedFiles:
pristine_git_object: dbdc09b9db644e61b6da5e631958a99fe9f7144e
docs/models/components/CompanyStatus.md:
id: 4a7cac94e8aa
- last_write_checksum: sha1:8bbcbfb09f152ba4212802512c52da3a0a04b1d9
- pristine_git_object: 8a7916a7723dbe031076a3b4afe2ca2c6910fabe
+ last_write_checksum: sha1:42ac66771cebe5b35ae77c1cd4c85f64ce8b0f67
+ pristine_git_object: e433a0469ae2076603f5febddf9de5abfcc4c520
docs/models/components/CompanySuspension.md:
id: e25915c22ee4
last_write_checksum: sha1:4177a16ec383a94e3f431725e242828ddab5da85
pristine_git_object: 77110dfa93da8809887a7cced573c066cd71d82e
docs/models/components/Compensation.md:
id: 88db7704f39b
- last_write_checksum: sha1:3620a8ff43199ed0dc509e24ea9ac0bed8190541
- pristine_git_object: 2592156b5baff2e5a6b28ca99a89abf1ae887bf5
+ last_write_checksum: sha1:61672d9b3daa6b7cce8d329664f5251a53dbaf42
+ pristine_git_object: 6ee9da445b2c4e75c90689ab836d1862976e3818
docs/models/components/Compensations.md:
id: df60e4d215ac
last_write_checksum: sha1:2757e1c080cccc29639d580f3c9594db5ca84d37
pristine_git_object: 166d22402559989071fb7706076f909ec4d91cd8
+ docs/models/components/CompensationsRequestBody.md:
+ id: 80e1ce3d899f
+ last_write_checksum: sha1:5b12685123f4959d93a2679329dd1a3f5925a958
+ pristine_git_object: 9ec5cec7c6f265366bca56d0c840ee2c48bd5859
+ docs/models/components/CompensationsRequestBodyMinimumWages.md:
+ id: f695f791c124
+ last_write_checksum: sha1:0ee4718e1a7f2818635629ace93fa509c316616c
+ pristine_git_object: 29eb0ac627ad76748198a6ba9605c2e3abf08201
+ docs/models/components/CompensationsRequestBodyPaymentUnit.md:
+ id: fa73b4fa8fed
+ last_write_checksum: sha1:db4963995f4ab9cc5b40dc9b2a652df5728651b5
+ pristine_git_object: 4468297a68ed3be6db112c914d1180a90167e9a6
+ docs/models/components/CompensationsUpdateRequestBody.md:
+ id: eaec8f55093d
+ last_write_checksum: sha1:40d4c17d529b7d20634af84235b3bd646d21bde5
+ pristine_git_object: a6738efd80fd83cf657b619e47e9f30149ca1e39
+ docs/models/components/CompensationsUpdateRequestBodyMinimumWages.md:
+ id: 233a5afcc308
+ last_write_checksum: sha1:048dd1dcc172c211058f2a4f21bd62ee57101c0f
+ pristine_git_object: 6155621f6d099b93bd40a9b3c02abb69ac4c9543
+ docs/models/components/CompensationsUpdateRequestBodyPaymentUnit.md:
+ id: 8575a3dc7100
+ last_write_checksum: sha1:3ae0a4e6c3621a2f874e8f1a5fb2affcf8ccaf50
+ pristine_git_object: 9848d2e45c01ef224e5b06ec9f4c5ccaa657258a
docs/models/components/Contractor.md:
id: 1920d517318b
- last_write_checksum: sha1:c0674ca49c9264a4e9c500e293e34a027b747834
- pristine_git_object: 8a0004a818840065e4d0778af3ba5c11161f9760
+ last_write_checksum: sha1:6248f449acd567e8ba9f5dc9a40ebb5a19c8c857
+ pristine_git_object: fb6c9bd83719ba9221e473081b3264c408027d13
docs/models/components/ContractorAddress.md:
id: 6e7add70317c
last_write_checksum: sha1:381e290b1b51f365e6753ef09660ac381d4a024e
@@ -327,20 +356,28 @@ trackedFiles:
pristine_git_object: b38d6dddeaeed5fa034a35b2c949a73a003bde21
docs/models/components/ContractorBankAccountAccountType.md:
id: b373baedfa0d
- last_write_checksum: sha1:5c7333800569e444edfc478e64bbf6bbdf32251f
- pristine_git_object: f1e9d2564bc9f3ab0a0a0d9fe5e29a3eef5b09ca
+ last_write_checksum: sha1:169cd898b4eb2160dec68c35a060021deaae9214
+ pristine_git_object: 64439a894a6416e54c866e1583ddc34cdbe25a2f
+ docs/models/components/ContractorCreateRequestBody.md:
+ id: ee6e4128485c
+ last_write_checksum: sha1:0ae7b687d169326cf8a0fcb682c976ef3f7b8e3c
+ pristine_git_object: 08a3379ba61f4fb0a4a3185a3007d5378523c98e
+ docs/models/components/ContractorCreateRequestBodyType.md:
+ id: 5b55ad3dc1ec
+ last_write_checksum: sha1:c908529744af5a89d9e9f486e2d2d8e9535853a4
+ pristine_git_object: fd3aad2c7c449164e9bfb1d3e8735bc0c5013248
docs/models/components/ContractorOnboardingStatus.md:
id: c306bc054c2a
last_write_checksum: sha1:24b923fabf9ae55d38162de2965d892fdd999b98
pristine_git_object: 07dd219462278f2d07aa0f8d8e257b93517b2554
docs/models/components/ContractorOnboardingStatus1.md:
id: df90c6ab9d9a
- last_write_checksum: sha1:d0c209f848e0fc6c45f5145405aa61fac3867b88
- pristine_git_object: 5c04ac29ce96d38f6d877d233c71abae6418c317
+ last_write_checksum: sha1:dd4deb1ef7d5d3189d3c608a08ce9a9e40e92e0f
+ pristine_git_object: 9afd0ee79d594b1a0f0ff9cffaa5891153b2848f
docs/models/components/ContractorOnboardingStatusOnboardingStatus.md:
id: a96d4a36ea23
- last_write_checksum: sha1:1da97f9c5dadc09bc6b82abbdbea6a46d853a2a7
- pristine_git_object: 4de1fdad5c65e70f60f230c818c5ac03dc34d37e
+ last_write_checksum: sha1:dfb4a58d7e39020371173d7e4b92750c21a02acb
+ pristine_git_object: b9b67d6b9d39d729376f551e138681ad681cfcb4
docs/models/components/ContractorOnboardingStatusOnboardingStep.md:
id: 530245a146a1
last_write_checksum: sha1:0171870479e1ab9e73a5e186abad827110500f58
@@ -349,94 +386,102 @@ trackedFiles:
id: 8ef0b378728a
last_write_checksum: sha1:9c5c70d8bf00fe03b9adf3e162ad981d9783b671
pristine_git_object: 15b7a028a19e8f6b4afa8f2dc3261fa0c7523e4f
+ docs/models/components/ContractorPaymentBody.md:
+ id: add96f290dde
+ last_write_checksum: sha1:8f2f08d1350ca8b8bb1f51f4798b4b19016de6f7
+ pristine_git_object: 86d15ac3c73dd0f11d6bd571148608e3d3ae17eb
+ docs/models/components/ContractorPaymentBodyPaymentMethod.md:
+ id: 2251899169da
+ last_write_checksum: sha1:ee0dd54aaf84aa870efdb78b121a6468a68af68a
+ pristine_git_object: 34382d511e3fd57efa67c3ed15d46d09cf729a6b
docs/models/components/ContractorPaymentDetailsList.md:
id: 05a6d3271b00
last_write_checksum: sha1:56041c84a7855b82e2440f201eb8907c22c5f282
pristine_git_object: 0ef967a97b6c62c7b360a3c6aa1c5a806bfd9e71
docs/models/components/ContractorPaymentDetailsListPaymentMethod.md:
id: a05648d10967
- last_write_checksum: sha1:37e968e3bac08f25a9ddf40c641fa891397523c1
- pristine_git_object: 958d10273da31b71d3cb6348e57b17c90e7c316e
+ last_write_checksum: sha1:a6b1fd5664778eec822c13a1937fce0e96593cda
+ pristine_git_object: c66399e72a18c5bdd72dd31516c88ea800287e06
docs/models/components/ContractorPaymentDetailsListSplitBy.md:
id: b5f97cf3c40b
- last_write_checksum: sha1:f9051796903117fb2494d783c8d52ba3b122fa71
- pristine_git_object: 9c2b9d98ef2d07f4532c595638209df95736c93b
+ last_write_checksum: sha1:2727a956b9821dfe16feaf1b95ea5136d0fdb3e5
+ pristine_git_object: 493b8592a8609d2ec11b1e81336a1f6c08c97c0d
docs/models/components/ContractorPaymentForGroup.md:
id: e008571f2391
last_write_checksum: sha1:f686e34304e836599ef4e4c83f4bde8b033409f4
pristine_git_object: 93f003f8a84d7c8fc490a8050cb065c8258baf94
docs/models/components/ContractorPaymentForGroupPaymentMethod.md:
id: 8262616db56d
- last_write_checksum: sha1:198b65a1e6466040f81ceb7d42f1cc70906b1cc9
- pristine_git_object: d5065ac2a4741ec057eb9e5725f1624c44e1b16b
+ last_write_checksum: sha1:cbad6952e27c166ebfe7c8917013b2a28fcb31dd
+ pristine_git_object: ce7e964a012f179598212ff015559763d69922d3
docs/models/components/ContractorPaymentForGroupPreview.md:
id: f97b69bed015
last_write_checksum: sha1:ea75a4a97299dd1a0a23ce05d8e4ed00af8eaa06
pristine_git_object: 3692137c4272fb25dc79e67f5de351dd1a534092
docs/models/components/ContractorPaymentForGroupPreviewPaymentMethod.md:
id: 9ae712d92f35
- last_write_checksum: sha1:bf7401e5c8b732b31d1e233c3d44849adf15d50e
- pristine_git_object: 5ea4eae355d9cbe806017585bfae9da9f306450a
+ last_write_checksum: sha1:096a259b3bdcfa5383150c834c28dd52c924aa98
+ pristine_git_object: 579da5d9ebaf02d852a8386e303df60115286967
docs/models/components/ContractorPaymentForGroupPreviewStatus.md:
id: 7db296ff554e
- last_write_checksum: sha1:b4fd4d123291866fdee9b6a7d3384b5d82e8bd42
- pristine_git_object: fe234fa1a91a17cebc8aaafa4b44386201784341
+ last_write_checksum: sha1:a510640eebbc206384aebd756277f0121eb2d6b6
+ pristine_git_object: d07ebc7fe4f8e9821e55ee4d6ac5aff641037a33
docs/models/components/ContractorPaymentForGroupPreviewWageType.md:
id: 1d1887b54b00
- last_write_checksum: sha1:6196aa084973a05c6d705f3bf65e85723f0c851b
- pristine_git_object: aba10ce016ce37868a5cfa66c0ed9ecf313fbbfa
+ last_write_checksum: sha1:b2cb94a02e05c13402e6ca237bea8c6681f50d11
+ pristine_git_object: d617c2000ca8ddc28dc936974cb3d139085298b8
docs/models/components/ContractorPaymentForGroupStatus.md:
id: c2349f6e3976
- last_write_checksum: sha1:2664dffcc20e2f07411f02a01d035d6f77a839ae
- pristine_git_object: 65e062d5330cb677365a39eb4009d11c21bccaa3
+ last_write_checksum: sha1:1342d10f978ad06c34e199780d906651548ade8c
+ pristine_git_object: cc5b49fb1bd2882a0cebf974118ec1f6e0587845
docs/models/components/ContractorPaymentForGroupWageType.md:
id: 867285c8d59c
- last_write_checksum: sha1:401ad71677b9d663f61125ce11b8fecdbae7da00
- pristine_git_object: dac0e400cb8b8e4f74680d8189a1c1d867b8caea
+ last_write_checksum: sha1:5bda7ca29f8415c4f4952792bcdfc91aac50c64c
+ pristine_git_object: 18183f3dfdf0dabf486f2c43ef930250adababb1
docs/models/components/ContractorPaymentGroup.md:
id: ef7ca0a71924
- last_write_checksum: sha1:c54e17bb9017d246ddca895c6176971f04c6e951
- pristine_git_object: 65a1e34ba93d0b36492bdc52a5138600a22590ad
+ last_write_checksum: sha1:163e9516138c5977c3c965cd921f2189f1473922
+ pristine_git_object: dd0708d97ea59424b00e11202fd6f945ae5669e4
docs/models/components/ContractorPaymentGroupPartnerDisbursements.md:
id: 06b4edc663ac
last_write_checksum: sha1:a55adb227d2742d96885c0e0451c6a4c15cf3dc8
pristine_git_object: d84f5d94c047632703fd3206089d92a72f67b1c5
docs/models/components/ContractorPaymentGroupPartnerDisbursementsPaymentMethod.md:
id: 4b9ee3966a77
- last_write_checksum: sha1:9380ec56af31f858f7cda5d9a2ae478f4f3543d3
- pristine_git_object: 1e5d6771d5bed02842ce3cf46d1dcc3f2a1ae638
+ last_write_checksum: sha1:db6281a6cce1be3ec66422370e97faccbdfdaea4
+ pristine_git_object: aef1e785f867b5f2e8c079d42c818977822786d1
docs/models/components/ContractorPaymentGroupPartnerDisbursementsPaymentStatus.md:
id: c65b35cd6248
- last_write_checksum: sha1:a5e268b193fd27e8b080860ec79336a2c2d793aa
- pristine_git_object: 0d958e874839425be70c1e0ca3c9c8dbabd0751f
+ last_write_checksum: sha1:74b9baf9bbe17a515dd6c6e51e323dc906ebd1f6
+ pristine_git_object: 96dc4038df1d2d1917adc1e1de638285b4eec239
docs/models/components/ContractorPaymentGroupPreview.md:
id: 67cf3509a6eb
- last_write_checksum: sha1:6ba1e4c37c86d8f844f8b1929da16a8635f5e3a9
- pristine_git_object: a630fc3b1541276924736f8e20dc85aa6a69b181
+ last_write_checksum: sha1:1788ff25019d22d4ac7bd653f06fcc0681e07834
+ pristine_git_object: 3783123f764f3dda950d96bb4a78a84a61ec12fc
docs/models/components/ContractorPaymentGroupPreviewStatus.md:
id: b7e4e82369a4
- last_write_checksum: sha1:e9546f8e8e37fbc57265aa587f1be4d48c7afc77
- pristine_git_object: 47adce566dd9437ee398b88b129d9cc6a7101baa
+ last_write_checksum: sha1:34de58d2d9b1e5a03ba32e6b73c6c8fda83d63db
+ pristine_git_object: 4604f6b7b68055e138f4fc76a8d7f7c132485028
docs/models/components/ContractorPaymentGroupPreviewTotals.md:
id: 92b24d10edaa
last_write_checksum: sha1:c3d67d0ac2ab9c7d334717b6221949a637a5ca93
pristine_git_object: 99c1c6ceaace3d490d3137e882ed52094ae78baa
docs/models/components/ContractorPaymentGroupStatus.md:
id: 73671f7c5629
- last_write_checksum: sha1:caf85d9e506e1a1994cda6e0b75b1dac189f770e
- pristine_git_object: f432b08d9ea65afbdc7fb9e8a2ddb26b4de75b03
+ last_write_checksum: sha1:201a2321e4a50dad5378d76f90da6a6fad0fd153
+ pristine_git_object: 7d739bb5f76bcbf70e686899a1e757b3440ce80d
docs/models/components/ContractorPaymentGroupTotals.md:
id: c6f5666cfb46
last_write_checksum: sha1:64cbeb25e4eb84564c83a7fbec70e228d1ffa8eb
pristine_git_object: 8fd34475c68c3b1943364ea6bcd3be33fdf0a105
docs/models/components/ContractorPaymentGroupWithBlockers.md:
id: 325059c77f32
- last_write_checksum: sha1:916599f674db3e96df5f5df4b40f07e84c4503d3
- pristine_git_object: 26e470903fcca38ede9a9ed20c4daa387394e735
+ last_write_checksum: sha1:3de623282218f353a8232e57b49013c7f7b7a3e9
+ pristine_git_object: 71aa47f88509f9f8cc57bd2dbace549e4272d18d
docs/models/components/ContractorPaymentGroupWithBlockersStatus.md:
id: 40a55565fed2
- last_write_checksum: sha1:1b5bbeef913090a0853ac2dc0118d5204d126825
- pristine_git_object: 04afb691a32d3da443a3146bf1ccb6a419caeb0a
+ last_write_checksum: sha1:a3644e9dc2da7ddde3bc33e07a7298fc495c9513
+ pristine_git_object: 4f84eca6d3132651fefeab48d61291758b13ccdc
docs/models/components/ContractorPaymentGroupWithBlockersTotals.md:
id: c9289cc61b3b
last_write_checksum: sha1:e8486803edc4a43235044125f7d2adf27bde177c
@@ -447,20 +492,20 @@ trackedFiles:
pristine_git_object: ace68c395933b9e84001e78b384fb6b7dfbc0769
docs/models/components/ContractorPaymentMethod1.md:
id: 4c39b3dc87c3
- last_write_checksum: sha1:c9ebe2b5761aa3d73f18f71245703092af7866e9
- pristine_git_object: 65ae15fbb9638872e77717a6b20e035e5a5d2cb1
+ last_write_checksum: sha1:205441b298d0f5568f4aee9d8c78f4f4c4685a01
+ pristine_git_object: 27fe3b03ef740f84ad78fa8862e7d3a51d6bb9a6
docs/models/components/ContractorPaymentMethodSplitBy.md:
id: d8d8f3aea0b0
- last_write_checksum: sha1:fc2efebb2e705194e62609662b7d8b5313af7385
- pristine_git_object: f5b9925fc04bd3cd84f4aa8cdec2a31b48d7b452
+ last_write_checksum: sha1:49e47b7bbc64032bf6ad9e702c8c9dd383f0ad94
+ pristine_git_object: 95990ae55521b71e56dba42da408040a0943edfe
docs/models/components/ContractorPaymentMethodType.md:
id: a36252b915d1
- last_write_checksum: sha1:79b8dd0070e90ddf1190b89bcbb7ee23b1977b85
- pristine_git_object: d1f048278fa6e34a6d790ef1cc9a760356734d95
+ last_write_checksum: sha1:43fbcb9b0db87fbcb1062ef30a5c985be739ad48
+ pristine_git_object: 784db73a269599f44084757bcaf433c3baacbfc5
docs/models/components/ContractorPaymentPaymentMethod.md:
id: 05342fcfe2c6
- last_write_checksum: sha1:daa66abb28cdd7c2e55490a30e7ac15e5dd1f461
- pristine_git_object: 75955acd521d450d9bd380d3aece8745cdc6ea2f
+ last_write_checksum: sha1:cdc13c9a3175fdd002dbd81708e0be798f0ef01f
+ pristine_git_object: 14666197365af8dc7636f0e099a37436535b1eaa
docs/models/components/ContractorPaymentReceipt.md:
id: bc8aad722e24
last_write_checksum: sha1:35f598d7aee6485c4278a02bfcf972bf8200996b
@@ -471,16 +516,16 @@ trackedFiles:
pristine_git_object: b0731de4a0ff6ca1ae3b01ec13d835433f6cd2ab
docs/models/components/ContractorPaymentReceiptPaymentMethod.md:
id: 9d6ca11aed19
- last_write_checksum: sha1:47a04417e618a57985376676ee3bb4b62c754193
- pristine_git_object: 0a91c964389d4f187ea63e4c3fa68659d3dc39cb
+ last_write_checksum: sha1:0d626e472b86edbced4e60072b47e2b95edaefd8
+ pristine_git_object: 0cf4e6f989482ac5de32617132cd94ad53153bf3
docs/models/components/ContractorPaymentReceiptTotals.md:
id: f9c8bdb0f564
last_write_checksum: sha1:9a25a9f057fbfedd82ea7fe0f1d496c9af66b759
pristine_git_object: 718e6a8db2639b83d738841052292395e75783dd
docs/models/components/ContractorPaymentStatus.md:
id: f33865ef4add
- last_write_checksum: sha1:02aa92801d1615ae04d57ed9081e090f393be288
- pristine_git_object: 860ea8a8f3ce6874835ef3423fa36ead84ae8543
+ last_write_checksum: sha1:ec8b99435199f1d128c605fd9b39ce6c14532ec0
+ pristine_git_object: 637fed14fd80606e8144e1f65c0ec6edcffebea7
docs/models/components/ContractorPaymentSummary.md:
id: 63fe2e442467
last_write_checksum: sha1:cf55960b1e01a38c39367571d5062196ec2a5400
@@ -503,24 +548,36 @@ trackedFiles:
pristine_git_object: 24e1c0548324ccad771e5939bae9010101a55a76
docs/models/components/ContractorPaymentWageType.md:
id: 499bee63481b
- last_write_checksum: sha1:7fe9b4cad33fbfc8ed46cc5b399ca4a2194f17c1
- pristine_git_object: 885cfb17c3a58fb86f9d2af41fe9f08efec7e5cf
+ last_write_checksum: sha1:83a96f5c45046a0da60d332c06a4500e1b42880b
+ pristine_git_object: 2570ffb935a366764b5d537210f6e353940d898f
docs/models/components/ContractorPayments.md:
id: eb57e3c43cbe
last_write_checksum: sha1:671fdeacb4de1342457989ab8867e0da396f72eb
pristine_git_object: e474adff9b306fb131ecc5dbb71c1dd5495c0cd5
docs/models/components/ContractorType.md:
id: 4a6aca453702
- last_write_checksum: sha1:cda7b9728954b34b67849b37568fd371c9e31371
- pristine_git_object: 5f813b8b9a98f65fb85cd68a16295bbbf20289b0
+ last_write_checksum: sha1:942a05bb3f382546ee6812293705b0164ce5b363
+ pristine_git_object: 8b035944e595006f70c62cd1531236713342a6ce
+ docs/models/components/ContractorUpdateRequestBody.md:
+ id: 5da71416e591
+ last_write_checksum: sha1:6c99740eb1b45ddc6d16aabd571361080a657f7b
+ pristine_git_object: 4e536ba3615f2d20c26baa4e4fcdae0125f91b96
+ docs/models/components/ContractorUpdateRequestBodyType.md:
+ id: 74afb8e29b3d
+ last_write_checksum: sha1:e2c5e3d6dbd27eaf5816db7301a050cfd2e8a7a8
+ pristine_git_object: 1f123add5dfdd3cc3b95466b2fed1437127289c3
+ docs/models/components/ContractorUpdateRequestBodyWageType.md:
+ id: 15e3ac5dda07
+ last_write_checksum: sha1:58813eee8e33c0d6a7df51379f728b3433949cd6
+ pristine_git_object: a8f5956d84268510f5d5b5d92feaf0f683a68606
+ docs/models/components/ContractorWageType.md:
+ id: 489fc035761c
+ last_write_checksum: sha1:c9bcca983d91a5841dc7e4606cf454bb1402fc2d
+ pristine_git_object: c4a434cef341087bb91fc81d0d5fd366914cc981
docs/models/components/Contractors.md:
id: c4b207ef8d50
last_write_checksum: sha1:b6510b9cabbf2f3a33eb37f4e18cbb6a9effc7c1
pristine_git_object: d838ba611c786d95f14ead12157a35dfbf8ed4b0
- docs/models/components/ContractorsSortBy.md:
- id: 68cb55af5a2b
- last_write_checksum: sha1:2bc1332eee3d87706c446f2a6ace4fa46cce3b4d
- pristine_git_object: dda6aba4fb35a9869f141da71686d0d7b9e4047f
docs/models/components/Contribution.md:
id: 6292eec0ae66
last_write_checksum: sha1:ec4cddfd512f945362306f57eda2aad99214b832
@@ -537,6 +594,14 @@ trackedFiles:
id: c7661e55985e
last_write_checksum: sha1:a35e0b4f6fc8bff386ae94ca70e36e408dc94270
pristine_git_object: 48d050ad29a01efab81613561ef677fe0038f875
+ docs/models/components/CreateFlowRequest.md:
+ id: f27f7c3e28f6
+ last_write_checksum: sha1:d81988a7e2fa69d59684b89a2ea050fe7d471fe8
+ pristine_git_object: 888220d48c0f2e1b41ef0ca31b2ac34bd0eaa7da
+ docs/models/components/CreateFlowRequestEntityType.md:
+ id: df68fac7d21f
+ last_write_checksum: sha1:15e0f1ff08502471638b332283d593cd3a0f2494
+ pristine_git_object: 7bdeef529b25656dbb224f8fc4692951c13d3a40
docs/models/components/CreateReport.md:
id: c9bf0aac8450
last_write_checksum: sha1:eb3ddadeb0782c30ce48c09a31a1941b71a85359
@@ -547,24 +612,24 @@ trackedFiles:
pristine_git_object: adc48e10ce9dab29f31e81985fbbfafc90e88fa8
docs/models/components/CurrentEmploymentStatus.md:
id: 4a5247db4544
- last_write_checksum: sha1:8864a4d83fafd5b52c9fe3e0dc6cb4a809b62622
- pristine_git_object: 1e52d3031451d4073d7b3bacc592cdcd36833f8b
+ last_write_checksum: sha1:9bb5d4b66bf893f759d56d21fd2216271d74aee7
+ pristine_git_object: c0fe1b76fc1162086ac76eb23a12d6bd0abd77b0
docs/models/components/CustomFieldType.md:
id: 167a6296115c
- last_write_checksum: sha1:aa97797fe843dbef8c04d1dce30f0fdff4803d14
- pristine_git_object: f047a52ababfbb180c4a8dd5f7513d0446b448d9
+ last_write_checksum: sha1:1fdb84b368638c08fb4ff512955569ae140971bd
+ pristine_git_object: 7499427b4d86e8befa3e5f06d6fdafeb273cdec2
docs/models/components/DeductAsPercentage.md:
id: a6071fb8b05c
last_write_checksum: sha1:590f9508ad01b411d4294eef760fbdd67395d56b
pristine_git_object: 8b8d46e73e8c54724d05b0c7ebf0f945ba677bfd
docs/models/components/DeductionReducesTaxableIncome.md:
id: b4e3557236bb
- last_write_checksum: sha1:124f3e443d83a5aec0ace6bbf162865c7887b0f5
- pristine_git_object: 0e715da11c1f53b3110f7bd9fd88eddd026a3b29
+ last_write_checksum: sha1:12123b76cea4b1d8d6aa79a7fa9cecb9f9c4d470
+ pristine_git_object: ed2bfe7ecef0c97793c8f11e56f67864d23e9395
docs/models/components/Deductions.md:
id: 131138e2f8b2
- last_write_checksum: sha1:4a2354e8f5266ab54eb995045e8657d81291740a
- pristine_git_object: 64fc9eea4540cb43bf2ea4617169ad8633060a79
+ last_write_checksum: sha1:fd5780b4e90914ac1bdc43034a7a12d210f0dfd9
+ pristine_git_object: c9331a68ef235392ac3a5a9e5a422c7c9ece00c3
docs/models/components/DefaultValue.md:
id: a9b187fe3a66
last_write_checksum: sha1:7211c86d2b3ef59d9abbf98ca6da3f0b705d1bd3
@@ -603,12 +668,16 @@ trackedFiles:
pristine_git_object: c9bb865a62ada37d37ee50eab22a4806832b6128
docs/models/components/DocumentSignedRecipientType.md:
id: 08438597be15
- last_write_checksum: sha1:204aa0a424234ec1281ffd1bc457483fdcc3bfa1
- pristine_git_object: 3e93509cd17f59cc16944fb2281ae4f305957faa
+ last_write_checksum: sha1:61c87bd266f85e0bd3c023428d6b6f6f4661d66f
+ pristine_git_object: b8cc94c2c5ae4e47f6ee90f0d671e94f1ac04e92
docs/models/components/DocumentType.md:
id: 5b6a4498d3f0
- last_write_checksum: sha1:940635e22da4a78d23ea06d1d67c929999252d92
- pristine_git_object: 453de9a18627efb29b91d81dc8a5bb70254655c3
+ last_write_checksum: sha1:5967e7a61295675f6fd6e3a55f0acc1611b79da6
+ pristine_git_object: 9bf337411e3b1ac345b960cdb0580f9f3b294cad
+ docs/models/components/Documents.md:
+ id: 7a33f447fbc8
+ last_write_checksum: sha1:96aa44beeed177f338a24aeb0728e3afa93f814f
+ pristine_git_object: 2964337fcac006cb6b688554fa7eec72e97371f7
docs/models/components/EarnedFastAchBlockers.md:
id: ecc287f16ed1
last_write_checksum: sha1:ca12698ea539f46b0cc86c13684904a1d119d7fa
@@ -643,24 +712,24 @@ trackedFiles:
pristine_git_object: aa2f1b466f0aa587bfd18a2cec184f25aea3d7a8
docs/models/components/EmployeeBankAccountAccountType.md:
id: b3d33998427f
- last_write_checksum: sha1:0d717c075560ddc414fb675f25590500708c0e9c
- pristine_git_object: 6c0df0e1276294c0f5d3bed6c72d02f724a9f991
+ last_write_checksum: sha1:971f3c6b23415dd838a8d6aa82452ba6a8119cf4
+ pristine_git_object: d10f1dd17dfd13517929bedc3c28c6677a06cb3d
docs/models/components/EmployeeBenefit.md:
id: a4e381075da7
last_write_checksum: sha1:58b075fcbd7f373cdb34bb3f211001a51ccb8de5
pristine_git_object: a58561d366e29bfc9c3ea0ea8c995a7805fc6214
docs/models/components/EmployeeBenefitForCompanyBenefit.md:
id: 69865c2cbf69
- last_write_checksum: sha1:06212aacdb0ab81ddb57cec2ac60d8a784bd6a06
- pristine_git_object: f1d5eecaa1af8ced2e953a2a3c94bb5c8f02b525
+ last_write_checksum: sha1:d5e15314e722f5efdedca48627861563c0314401
+ pristine_git_object: f56321e3bb89cccd8b97c92f7e6f2a5db4c5217b
docs/models/components/EmployeeBenefitForCompanyBenefitContribution.md:
id: 56d09a335808
last_write_checksum: sha1:8e6f83d012228acfb7aed1a3c2f1b4109097ff40
pristine_git_object: 3897827b830dc7635aa8249f2154b1810947c7b0
docs/models/components/EmployeeBenefitForCompanyBenefitDeductionReducesTaxableIncome.md:
id: fad69b6fed31
- last_write_checksum: sha1:becde149755e6ed9d3452a49940eddde913adef3
- pristine_git_object: 7249344ff8f8c974a29a2bc6b1caf51ee14bd864
+ last_write_checksum: sha1:0b3150b827110aa25c55f34833221231a5a4bccf
+ pristine_git_object: 1eb445dedbea2adcb5fc65dc32ec0adc727d7f9f
docs/models/components/EmployeeBenefitForCompanyBenefitValue.md:
id: 35b2c144c1d9
last_write_checksum: sha1:be9b355133173927454f7405b59a7874a749e005
@@ -671,20 +740,20 @@ trackedFiles:
pristine_git_object: 7b7a25360d188db4997db6ed5f47f0b740c33f52
docs/models/components/EmployeeBenefits.md:
id: 2e9b8988072a
- last_write_checksum: sha1:00bfc2111bb89a9f2cfeb45354a1154303a77465
- pristine_git_object: 3e67b6969abbd467a1c7c026d6f44c96462aae5b
+ last_write_checksum: sha1:05f6185452391e0c5b99584d83dd2bebe05ebb5b
+ pristine_git_object: 8122081d64564bd043664c552ce9393fc48bbbed
docs/models/components/EmployeeCheckNumberMapping.md:
id: 6f734c997fab
last_write_checksum: sha1:da760db18bb8f3ef7ea0dc4589e08954345901df
pristine_git_object: 0cddc21f2f557b797d4328cc5ff3b8318723fc38
docs/models/components/EmployeeCompensations.md:
id: 6819a79517c5
- last_write_checksum: sha1:7015de6ac9a6ea0141d3ade8e1face1385d40da0
- pristine_git_object: 49c7e5b03212299649b4151fde1c2c2b544a0e5b
+ last_write_checksum: sha1:a05fbd01b3009a030a1ff63e8294f5c43968087f
+ pristine_git_object: 010678ff2ebbae0928ec84eee003b9417b05ccc5
docs/models/components/EmployeeCurrentEmploymentStatus.md:
id: 2f375e797a0f
- last_write_checksum: sha1:c9b48606734d814ed6e6edc899cce8200b89503a
- pristine_git_object: 46aa3991c9b2239f66b67c6a6bdfe32f48ce233e
+ last_write_checksum: sha1:c12fb225a07050c9a24d266bae31f6e73dee7e94
+ pristine_git_object: 16812657c463ff01b120f3d7730db5cc82502cec
docs/models/components/EmployeeCustomField.md:
id: e57ca94db19e
last_write_checksum: sha1:7dd3e1b10fae4c3a7280a3d6a14d664d8166595c
@@ -699,16 +768,16 @@ trackedFiles:
pristine_git_object: 7cd116c4e304fb5c97e158c255d1ce078c02c55c
docs/models/components/EmployeeFederalTaxPre2020.md:
id: bb732b9e9386
- last_write_checksum: sha1:45a1a5af895f30c7049e11eae649aedf8735c97a
- pristine_git_object: a872f848e175d3d4eb7341fffbba6e77c70b4a92
+ last_write_checksum: sha1:e8226a87a35aea7ba2b9cb0f7f918a9563e45e84
+ pristine_git_object: 5404343cf5044576019e243db22e21f0f8face8c
docs/models/components/EmployeeFederalTaxRev2020.md:
id: a0dfe16c95c7
- last_write_checksum: sha1:2003f88684e5a763b43f706754fee5bbfe949fee
- pristine_git_object: 66f3661d82ff21557be6121973939cbf50531661
+ last_write_checksum: sha1:1934c0a36594be1cc0f1623590058f69a247fae9
+ pristine_git_object: 38b8abf83274e9cfd267d4ce58d30eaa542c860f
docs/models/components/EmployeeFederalTaxRev2020W4DataType.md:
id: 30c2fd18e54e
- last_write_checksum: sha1:66362257fd8f064519274adaf101e4735517f556
- pristine_git_object: 65b4f1f82f055d5b3beb9c491d5b03bad1494b0a
+ last_write_checksum: sha1:37375d2f89cd25de47dc09628eeb2a28402f0e4b
+ pristine_git_object: 6663b497bc81dc8a5e251b6c44acb681b083b3a9
docs/models/components/EmployeeHomeAddress.md:
id: a80e235b637d
last_write_checksum: sha1:1c2f91c54713fe6ce0e254adc415c1a7a4caa5f2
@@ -719,20 +788,24 @@ trackedFiles:
pristine_git_object: 2148a7bf440dd89dd1dab0ed92f5f7779247e13d
docs/models/components/EmployeeOnboardingDocument.md:
id: f88a5c3812b0
- last_write_checksum: sha1:1e6aed836ef3e4560e0a27f2ef49178340813c87
- pristine_git_object: 4d55301f61e7d216a56041873e213ecb91177721
+ last_write_checksum: sha1:fb432469b940ef6b757b332b3384dc3a47bf5ffa
+ pristine_git_object: f32acf0c989fd67487288f2aedf186d5a46def57
docs/models/components/EmployeeOnboardingDocumentsConfig.md:
id: e88a30f8bbc5
last_write_checksum: sha1:d36741e4539145a03ba6c821cd0334cc117bec13
pristine_git_object: 9f937d820c51d59e1c86e435c57af1427591b7e2
+ docs/models/components/EmployeeOnboardingDocumentsConfigRequest.md:
+ id: 1b241c82d0ad
+ last_write_checksum: sha1:4400364b358bbc5534ba89c3085cbc836e61b8b6
+ pristine_git_object: 2ad69f6f195260ef44657c6d061c9c7f7feed72a
docs/models/components/EmployeeOnboardingStatus.md:
id: 60902bb5f747
last_write_checksum: sha1:3782dad967a2782a22f1ab36d78231513f1cd8eb
pristine_git_object: 75686cf105d8952edea3234c6cec04e7ac542278
docs/models/components/EmployeeOnboardingStatus1.md:
id: a17d7e9198af
- last_write_checksum: sha1:1a5524f0427004a84a8c06f88f69b1c145ec254f
- pristine_git_object: 1719e031d07c4c4252ae227134120a4e261dc185
+ last_write_checksum: sha1:fed0e0aa8ae75e3bb649eca170b142f4ec06e2ba
+ pristine_git_object: 3f61bea62a48e564466b6429122d855523293e92
docs/models/components/EmployeeOnboardingStatusOnboardingStep.md:
id: edb79f2cb32d
last_write_checksum: sha1:0294bb77a1838eabe1d4d061e6384c1b19f5ca2b
@@ -743,32 +816,32 @@ trackedFiles:
pristine_git_object: c226c144122055569261122f478bb52b5d1fcf2c
docs/models/components/EmployeePayStubsListPaymentMethod.md:
id: 262abe92952f
- last_write_checksum: sha1:27e6eca5df8348b21156ce7095505a9a0c0f9cb8
- pristine_git_object: 460ae0cc8a3455c2190c2cb61a0debd6f4a84dc4
+ last_write_checksum: sha1:0cbefcc9a3fb421b65593ba1f8a1c37da7e47be6
+ pristine_git_object: 5523d62576d3b07db2427da6d9fa1006bceb2993
docs/models/components/EmployeePaymentDetail.md:
id: 819782e2d296
last_write_checksum: sha1:3301b94f094b3ba5764f3d13bdcd9bf3d57d3599
pristine_git_object: 741a27f8438351da53f7812ad72ba1e3f9407553
docs/models/components/EmployeePaymentDetailPaymentMethod.md:
id: 1884a8fd0083
- last_write_checksum: sha1:0eb6321ca96f49d7629eb0236ca918ade38444a4
- pristine_git_object: 4f605187a698cc64bdef949a9bbd4d61552d7ceb
+ last_write_checksum: sha1:2667bede401c213fc58f8204b38b8d7e8c3143cd
+ pristine_git_object: f728e16552de2faac1be19fe4352aa9a1c0b34a5
docs/models/components/EmployeePaymentMethod.md:
id: eb15f80af445
- last_write_checksum: sha1:ee0c52d2ac96ab844d2075782fd440887ab6b899
- pristine_git_object: 26fc250afc887e96a8b10fb31de795511824bc48
+ last_write_checksum: sha1:876e2c54d596ddc89a0def568df35788f5b9ffce
+ pristine_git_object: efb6b081ffd98ef95be5d02a048252f0c042594a
docs/models/components/EmployeePaymentMethod1.md:
id: f4f599a7e5a4
- last_write_checksum: sha1:70fbafbb9ebe7c04b8d99fbbbda19f3e4e42892b
- pristine_git_object: 659626f555467dec87268df69b48a5f6523171ff
+ last_write_checksum: sha1:8a49a65bdafd3536ee51fd3f8aadde64a80d9ef8
+ pristine_git_object: 4a01e9f9f04a68231d5f65c73443eb9ec300d7d3
docs/models/components/EmployeePaymentMethodSplitBy.md:
id: 8eb0d66a2e34
- last_write_checksum: sha1:8acbba68b23fd93f2186f41ba82f19b645e3efb7
- pristine_git_object: 5a7e79981f217c6419ff0b4248fe061b706e76ed
+ last_write_checksum: sha1:18b57050542a3487e56c7f0a9e5e58943a71d90f
+ pristine_git_object: 78ee0d2a95e904e4482f757b9946250bca1da4de
docs/models/components/EmployeePaymentMethodType.md:
id: bcc026988e67
- last_write_checksum: sha1:973e8bef97995de4ab5212e37d7c17c26a142d4b
- pristine_git_object: e4317497b1e8cac31e58b10373ca6d92d05b55a4
+ last_write_checksum: sha1:7c39a08f3162a97b2b972f698b34eed1f175236f
+ pristine_git_object: a778e48a6b6abb3177344831c08e7a3deac3cee1
docs/models/components/EmployeeSection603HighEarnerStatus.md:
id: de13a04a838c
last_write_checksum: sha1:fd5818cd2611b2a4e9d150e9e14203b408fefb9f
@@ -815,8 +888,8 @@ trackedFiles:
pristine_git_object: 0861fda0312fdb9a3137492c840a32f6fedb0c1d
docs/models/components/EmployeeStatus.md:
id: 8d11011679f9
- last_write_checksum: sha1:cba442771a3ce2f77df902e20ec6276bf7cd1b05
- pristine_git_object: 4cce6b5b29ff65791e6c2713180e913693964702
+ last_write_checksum: sha1:de8779f8f7d0b438599e636799544b41e0649911
+ pristine_git_object: 3f6881edac6a3ad904b8238b195a71469706a75b
docs/models/components/EmployeeWorkAddress.md:
id: 7acf4ed1eae8
last_write_checksum: sha1:556e9af90b0ec8a9807fe34e33b4428663c0d665
@@ -831,28 +904,32 @@ trackedFiles:
pristine_git_object: 8895a5a4592b3668d7ee6dc756b7898cef7362aa
docs/models/components/EmploymentHistoryListEmploymentStatus.md:
id: 37aa3f5100e8
- last_write_checksum: sha1:6a36f8a1c675c91c220c3b7fdf0bf77eb064720a
- pristine_git_object: 8ec6fffc82982fa9c46b4ed7c2c332ff47ad11d8
+ last_write_checksum: sha1:feeb56969e151b7c7a585dae253b7fc02e29a73e
+ pristine_git_object: 77d618a9a4a7bf8e18d9f53ed9f552b53cd38f9d
docs/models/components/EmploymentStatus.md:
id: ce77cdbe50a3
- last_write_checksum: sha1:a3326228611f6102d8a21b001b0d130e2ca57488
- pristine_git_object: 94bf4f41dd5c422b9772bfc068376645585481af
+ last_write_checksum: sha1:9e25d539a5b1b21f4169a25f9a36c4f4525b121e
+ pristine_git_object: 6a1a3241b010c17e1c8ca333d4112442278299e6
docs/models/components/EntityErrorObject.md:
id: 5dd1d4dfcf55
last_write_checksum: sha1:7f2733a4ca492029ac9876620c715a923e699e0e
pristine_git_object: e5804c15285533944671827eb775cc9b65d63299
docs/models/components/EntityType.md:
id: 702dd0a87f4c
- last_write_checksum: sha1:c256c665082d1046e73ba9e85de30a01af4ed5d3
- pristine_git_object: b75ff12b7ad0479a734abe2c0c9842b537d129a5
+ last_write_checksum: sha1:46bee600f53303a3011c9cfcff040a1c2fd85318
+ pristine_git_object: e0f8946ae22cd3caeb91845648a22a7d3576b751
docs/models/components/Event.md:
id: 30ea2ea346e2
last_write_checksum: sha1:7f81e63a5842701fe2f29d9aacc13cea3fb6ebca
pristine_git_object: 8efa51b28f66dafa1ebb031a21905137e625b36f
+ docs/models/components/Exclusions.md:
+ id: 40623fc4f64c
+ last_write_checksum: sha1:f373b1e30f3c6fd6b2d95c1fa263555a022cbea8
+ pristine_git_object: 232149141752d4ac4b138426fb680d4cecb0f17f
docs/models/components/ExperienceLevel.md:
id: 9278dff1da72
- last_write_checksum: sha1:018cfb6674d8136dfdf0c4b4d64974527bb9b0f5
- pristine_git_object: 16efc21c1156e7972958aeb19f5553f1340fc361
+ last_write_checksum: sha1:8a42af1b347df6a9ef6c5ff1c360756d5caf059d
+ pristine_git_object: 091a6adb750e1c7e56b319647bf0f940afa07b50
docs/models/components/ExternalPayroll.md:
id: 503361dfebed
last_write_checksum: sha1:c7ccd7edcbbd1f275a8311b9274c893cf9ed0daf
@@ -863,8 +940,8 @@ trackedFiles:
pristine_git_object: 008fcfd6b272d9a311b51440ea5170a24c639ac1
docs/models/components/ExternalPayrollBasicStatus.md:
id: 41985d32bad3
- last_write_checksum: sha1:78607f284eba5c5b896fdd4244d9ceac4c7bfc72
- pristine_git_object: 1fb166696ea255a07edefede72610aa94591b4f6
+ last_write_checksum: sha1:eca75c805726eab79718533924ea445cfc248315
+ pristine_git_object: ad45a9407becfd493dcbdadc7c545f9c096622cf
docs/models/components/ExternalPayrollItems.md:
id: 5d784c51faba
last_write_checksum: sha1:bef76ac230957354797b58503e1b8d8f2a749c3b
@@ -881,10 +958,6 @@ trackedFiles:
id: 1b534a44c4ec
last_write_checksum: sha1:56afa645d6542fc46ab96c1319558e8c99e230df
pristine_git_object: 363e11d3fc786b94d1e84784ce46b4a700be5fa0
- docs/models/components/FastPaymentLimitRequiredBody.md:
- id: af7a438c2a6a
- last_write_checksum: sha1:9de1a8d423126f4aa771cbe598891843f22143af
- pristine_git_object: 3bb51e9f9fbc34196d1488799016ee79c32e228e
docs/models/components/FederalHolidays.md:
id: f8409ad07138
last_write_checksum: sha1:4a3fe9c86f7f0faee23315866f3768814868c80a
@@ -895,8 +968,8 @@ trackedFiles:
pristine_git_object: 2d2e921009c64748bb588f0cc238c07c80f3f78b
docs/models/components/FederalTaxDetailsStatus.md:
id: 3793c28a59bc
- last_write_checksum: sha1:f5b873baedfa6810f959293f4f4cb26a922307c1
- pristine_git_object: 04b78b395c2600e0616f276f82641866d2cb2ed7
+ last_write_checksum: sha1:e82befc88c48549cfe55323aa44a040a864ef0a8
+ pristine_git_object: 14ed22baabf792a0acc4610828ec574248fb8af6
docs/models/components/Fields.md:
id: 7d2684d56319
last_write_checksum: sha1:b9d0469f2b3540f1238b8915ae2491e8c754e61b
@@ -919,8 +992,8 @@ trackedFiles:
pristine_git_object: 6aaaa58f96ed72e8509a316827fbccc2aaf01d24
docs/models/components/FlsaStatusType.md:
id: c07f16c6dcfe
- last_write_checksum: sha1:93c647f344ca2a55c698006d6bcada2103167e92
- pristine_git_object: 3f494bf4fc3bfd4d937bed953199ba948a1d7da6
+ last_write_checksum: sha1:d8c45f585a617a4e086ab70e8e9a959e5271eee2
+ pristine_git_object: e8003862c6b61a06577ef67fe340f2865d9f2be2
docs/models/components/Form.md:
id: 7007b9665757
last_write_checksum: sha1:c6901b82c93682b9b8a5205dab78aa3f63be10a5
@@ -935,8 +1008,8 @@ trackedFiles:
pristine_git_object: fed060771636c8a6a97c1e05f28956a562790d3b
docs/models/components/FundingType.md:
id: aaeb29923574
- last_write_checksum: sha1:84bd6d01bbf628642d901c417ff23200757bb799
- pristine_git_object: 1c99751eb70227191691411c9abf056d6c7e956c
+ last_write_checksum: sha1:b0ac3610f430517e717b96bb8b7d556e549e48ee
+ pristine_git_object: ea4ec3206925d0de0e3e9c9e3608c216b68d1e23
docs/models/components/Garnishment.md:
id: 52dd0c074ec9
last_write_checksum: sha1:8f7c5f973c817a758fa9364745522d04d11adcf5
@@ -947,8 +1020,8 @@ trackedFiles:
pristine_git_object: 1e3d3c622ae6a928ade10dde4dc7e66fb5b1de05
docs/models/components/GarnishmentType.md:
id: 24fad97d81ad
- last_write_checksum: sha1:12f87b616ea7586744cdeb643ee78f0b7575727b
- pristine_git_object: e96ded8467793ae79158316d3daaebc806242fb7
+ last_write_checksum: sha1:ef7841ddc6c62c03b4ab0be01e93bce6433282ba
+ pristine_git_object: 021735215e45cf39611b459fa710b4d3ce3a1bf9
docs/models/components/GeneralLedgerReport.md:
id: aedbd7a1344f
last_write_checksum: sha1:57cbb1d912fd83d6afb27ddf20744dd7448c8102
@@ -959,8 +1032,8 @@ trackedFiles:
pristine_git_object: d298d17635c95b10787689f0b7ebe86e3b399e78
docs/models/components/GeneratedDocumentStatus.md:
id: fc5c2925206d
- last_write_checksum: sha1:98e4bb64f9d6ce438b463e7113f48257e3f906ac
- pristine_git_object: d171193a33b5c8e0f4e2a4ba01e1351fa5fc0a83
+ last_write_checksum: sha1:0152db2a043317c2ff3d7697e0cf38e042dbdbd6
+ pristine_git_object: ba3cb0a7c82af9069da3eed3c61d11a73289ff48
docs/models/components/HistoricalEmployeeBody.md:
id: 22a9ae47117a
last_write_checksum: sha1:06196bb6265117b5ebb9c1c1b3e2d015a5e483b3
@@ -1039,8 +1112,8 @@ trackedFiles:
pristine_git_object: 1160075611195525c477e68b405c755aa90c4e66
docs/models/components/HomeAddress.md:
id: 27a386629905
- last_write_checksum: sha1:2ab3cde14a1add231d34ed7a45b6e7f25d0b8aa2
- pristine_git_object: a35071d04565e0df75aba024f7b08a0c5ba9e003
+ last_write_checksum: sha1:1002d09b5d150a7032927dac6bc4503eea66c625
+ pristine_git_object: a3c1a9062b72f9cabdc61e7db4876c9fd939cb71
docs/models/components/Hourly.md:
id: 7023361a6f67
last_write_checksum: sha1:8b5d8d6134afcb556cd94e6965d0ffd4b1968913
@@ -1049,54 +1122,78 @@ trackedFiles:
id: 589cd0dc43b1
last_write_checksum: sha1:f21cc9bc6cb7171036ee8970264aae3fb349033a
pristine_git_object: de9c9594cdb6ccbd8edf4d22460db17d5d01c69a
+ docs/models/components/HoursEarned.md:
+ id: "809726145860"
+ last_write_checksum: sha1:47cb037da6b9e056b892004a7325854cf27fe08f
+ pristine_git_object: 01a9760313808e6fd901f4de861071d606f2d47c
docs/models/components/I9Authorization.md:
id: 5a024699bf90
- last_write_checksum: sha1:0274ae2e8a63e3885d742ba38fa7d55c973034db
- pristine_git_object: 53d100314335e9f56d644d04219edc9157234ea1
+ last_write_checksum: sha1:c3210b9ed350934fd1a416d417338dda1c5914e6
+ pristine_git_object: 9dfe60c9aab4244a4ef8e2d82b8d793a965daef3
docs/models/components/I9AuthorizationDocument.md:
id: c744af0a454f
- last_write_checksum: sha1:d6231602629722c3f63040186b99711a8cc4d4af
- pristine_git_object: 649bec7b6c10a4de86c14ac2477ac508394e732a
+ last_write_checksum: sha1:2a6d1a5da34f356b31dec73303f3f6dd83bdda13
+ pristine_git_object: 551a208c6a62859a6ea82e6d6efea3173faa80a4
docs/models/components/I9AuthorizationDocumentOption.md:
id: 3a5d0190ac4d
last_write_checksum: sha1:50694108ecb36137bfb39c48fbed3b277e2ba9e6
pristine_git_object: 8dde9cf6451493ecc2072eb500045daae5346300
docs/models/components/I9AuthorizationDocumentType.md:
id: f8b3a27fa447
- last_write_checksum: sha1:486fdf788c1e86787a0ca89091dfa5d8cf350604
- pristine_git_object: c8737452859b5a186f804ae1becaedeaa708c506
+ last_write_checksum: sha1:040cc53c631cdaf18bc62b7a11ab8cbe9e2ccfc1
+ pristine_git_object: fffba7061ec330290209954b0f9c6a03aa60de97
+ docs/models/components/I9AuthorizationDocumentsRequestBody.md:
+ id: 74b248a7d1ce
+ last_write_checksum: sha1:1f904f5cb54c8f0b90180e7fde84caa9947f1c9a
+ pristine_git_object: 443fead07c864416db036f123a25faccf3e939a1
+ docs/models/components/I9AuthorizationEmployerSignRequestBody.md:
+ id: 4a8e0f2d6514
+ last_write_checksum: sha1:7d4c8e7539f34b51353e734aac1b1a6e643e61de
+ pristine_git_object: 8e6a61913313e39008918a7139dec0902bd7316e
+ docs/models/components/I9AuthorizationRequestBody.md:
+ id: a6ad15ec9810
+ last_write_checksum: sha1:7a7b48dbc65c4e52bbbcc5cd56be24e2ca19441a
+ pristine_git_object: 1f5dacb76573898efcadfcdf13110c693d7e5ec8
+ docs/models/components/I9AuthorizationRequestBodyAuthorizationStatus.md:
+ id: 0bb7852fc673
+ last_write_checksum: sha1:045e06b893aab980baae3929f0584a57fd7027e3
+ pristine_git_object: e1398a18fbc02f125f49ef26ea57666f9cfc800d
+ docs/models/components/I9AuthorizationRequestBodyDocumentType.md:
+ id: 092cb8663549
+ last_write_checksum: sha1:bddddf6e19f6b621628e44754d1607bf579192d1
+ pristine_git_object: 1295e49760f3ae9051030fa7a8b077b61fe6ac38
docs/models/components/Id.md:
id: 175b55d44af1
- last_write_checksum: sha1:acd573a191d174b86bf848dc5a2adb4f03d93510
- pristine_git_object: d60bda673e578a811cbfeb0360823ba7d351bf17
+ last_write_checksum: sha1:3e39f8de6177787176489272dd378b266dc2e8f5
+ pristine_git_object: e8a269b3e68115b591fabd0a5d7ae4ea4cd91b4d
docs/models/components/IdentityVerificationStatus.md:
id: 4d317a33cb10
- last_write_checksum: sha1:cd4e0e71cb2a63cf8ca901c9a382efffa0aefd5f
- pristine_git_object: 7703dd72c386a189edc1b97843595ea010afb0ed
+ last_write_checksum: sha1:4db9a0b338e543120bfa0ad56c97fc2fe369f779
+ pristine_git_object: a3b32057670770ac9663c41e5d8848669a77e8bb
docs/models/components/IndependenceDay.md:
id: 6bb14955b091
last_write_checksum: sha1:2c1c76f5b864bb6b79e31800c780b3d554fc23e1
pristine_git_object: 92f19537a47ae4c74a22cc02644e064490cf5b8b
docs/models/components/Industry.md:
id: 47e50551cae5
- last_write_checksum: sha1:06a1f051ed1adda6f4b8e50a7d92ae2608435a8c
- pristine_git_object: e2c1c1a73a5363b4a50f7625b3aef9482ff76992
+ last_write_checksum: sha1:ffd470fea055a0676650d9267a410fcc505ba869
+ pristine_git_object: c4e2b2f97d6dc0f9b2cb143192e8f9536fbfdebd
docs/models/components/InformationRequest.md:
id: 470109d2da90
last_write_checksum: sha1:af0be8266a6fdc22b7fdf91906d0579d307d95d2
pristine_git_object: 1c639bc54cba3ff352f1cccf4b0ff0b05d274994
docs/models/components/InformationRequestStatus.md:
id: a7fb91cc6721
- last_write_checksum: sha1:9645b47be020067ad9f24eb8c6b53e776334a29b
- pristine_git_object: ca299e28e9dba4f352305234c1c5c913c447728d
+ last_write_checksum: sha1:cbfe3033e2ddc6dbd4127c356fcb1eaba8c8a6cf
+ pristine_git_object: 556ee57eab0be46469ee71701d10d07e1fe6e594
docs/models/components/InformationRequestType.md:
id: dd5f7c58e010
- last_write_checksum: sha1:0f319bc6c9e50e7efbbe27ab57149c45862cc768
- pristine_git_object: d82da06878b9850574ef072259fa2667a223b05a
+ last_write_checksum: sha1:1e8a23782d7606d63ca9756ca4620065c462cda6
+ pristine_git_object: ec762e81ef11559ae5df69f8be3fb28d57bd1f33
docs/models/components/IntegrationType.md:
id: 7d8b32aeb211
- last_write_checksum: sha1:8ab2980610157c49c49dfabfed86287f2e2b77ba
- pristine_git_object: 84e9b1135b59641bd0af76489425c91e26305f5f
+ last_write_checksum: sha1:6391a4e8d616cfe4f0af75b3d7311e302695a7e6
+ pristine_git_object: 788e163264d679b96746c6dbfe453bdd6c3eabe6
docs/models/components/InvoiceData.md:
id: a7d5f3f4c2f1
last_write_checksum: sha1:5faf7b97e3bbbdaabd28e26326a81d4ff49930af
@@ -1111,8 +1208,8 @@ trackedFiles:
pristine_git_object: b778e6cd86d9af180e114a906eb5b255356b1e47
docs/models/components/Key.md:
id: bb713ad599f6
- last_write_checksum: sha1:c479fdcb045bb38da11ff25bfac33f09c2ab3887
- pristine_git_object: 2241e90b382ee2cbc5d7bb4b5aa4728e03a20ba4
+ last_write_checksum: sha1:e6966f91f59b976a61b490111118b06416452eaa
+ pristine_git_object: e80167e94785f2f808b8ac21d82625d2d910cd15
docs/models/components/LaborDay.md:
id: 7236b3dd857b
last_write_checksum: sha1:08446f321c45c044ad0a0697a57d793cee948b84
@@ -1163,8 +1260,8 @@ trackedFiles:
pristine_git_object: 4a575d31e8aac21a2edebb72f3dc8d97bcd1300a
docs/models/components/Name.md:
id: 5b1d98ebed09
- last_write_checksum: sha1:9f8ee297f58b2fbfbf99c5dca72a85fbcf8c20ce
- pristine_git_object: 50791f4372506af054cb01a95f4d63f694f7c334
+ last_write_checksum: sha1:a724826537b43fe98074f166f7c3f8f45ee42c6d
+ pristine_git_object: 2bfb6ed70efed807a22ebfcb7d311a408d3ce2da
docs/models/components/NewYearsDay.md:
id: 729bf5f0cec5
last_write_checksum: sha1:81940bba834e53c2e655b3f312b11c34e5169ae3
@@ -1175,28 +1272,28 @@ trackedFiles:
pristine_git_object: 553933dd4eb6f9eb3746cb78419792c9beacf327
docs/models/components/NotificationEntityType.md:
id: 73cdc2a4dc7c
- last_write_checksum: sha1:d7fede9be91bcf700c5146ee86061ea27af0bbfe
- pristine_git_object: cbe4b65f1f0e5b215d3aecf99c65114f1bfad4bf
+ last_write_checksum: sha1:eca8b9e68d746aa3070e0ae8fe174a3335e425cd
+ pristine_git_object: 813af26416ac46a8bac55ae367bc236ee294bf89
docs/models/components/NotificationStatus.md:
id: 3ad8df3857c1
- last_write_checksum: sha1:7472b24a78c527281d049bc6521489375c8a558c
- pristine_git_object: 4f9d3eaa2b056f7f782eb28935429d097bfa2b6c
+ last_write_checksum: sha1:e0a6792d0710a918bc41f68978b5e84ea8640679
+ pristine_git_object: 370554c50910a03c3394798d13444e35be00197a
docs/models/components/Occupations.md:
id: 60617051371e
last_write_checksum: sha1:dfc3dc9fe24e2e1fc4045452b4d22f0c96821420
pristine_git_object: f00befa5cff50031dd43aece3807b39cf2d1ae68
docs/models/components/OffCycleReasonType.md:
id: 3843d36454c7
- last_write_checksum: sha1:065917b275522ec97cfb32ea0fa4952ca0debf19
- pristine_git_object: dd89492dd4de8c7df8b63bb434a13dbc0b8a809b
+ last_write_checksum: sha1:d2f0ca830f7fdd037e4a30ee39ba5216ca243592
+ pristine_git_object: 0c233b9b33051752e9f9ad86b597189f160e859c
docs/models/components/OnboardingDocumentsConfig.md:
id: 0cdfe1350491
last_write_checksum: sha1:0b6b218b334876464833835225ea3057a3c5d889
pristine_git_object: d47a2b4b9aeb3117ef26fbbe0c5264ea254f002f
docs/models/components/OnboardingStatus.md:
id: 991770e866a2
- last_write_checksum: sha1:ce9d9649b02684650d519d43b0300686be31841c
- pristine_git_object: 07cd9c571dd09b7be24e84b0efaae37de7e66469
+ last_write_checksum: sha1:5d2ca9a24c9bbd12c910c73fedc2582b85fae961
+ pristine_git_object: af5abc944087ac0c0dfea25ff637799cd7a73fb2
docs/models/components/OnboardingStep.md:
id: e664633073d3
last_write_checksum: sha1:0d257e3400171bef028a80e77bea28f7d623e1b9
@@ -1225,6 +1322,10 @@ trackedFiles:
id: fcaab06768e0
last_write_checksum: sha1:7694153174f0da2b9060d4b481d0abd759cc9695
pristine_git_object: fcd55d98fd12a9284b4f0a6ebd9c4354c18cec18
+ docs/models/components/PaySchedule.md:
+ id: b3cb71f362f4
+ last_write_checksum: sha1:0d999b3b0b3badc0f1de3f9990ab441a320f319c
+ pristine_git_object: 2a5cbda5e5e7f1e0480d931072e590015458d603
docs/models/components/PayScheduleAssignment.md:
id: 81151504d731
last_write_checksum: sha1:209f6bd89e6e82301e68eb258977339de1b822b1
@@ -1235,8 +1336,8 @@ trackedFiles:
pristine_git_object: 44af68c52d11ae8f0c20bd4df634ae3dc12b4ecc
docs/models/components/PayScheduleAssignmentBodyType.md:
id: 18032cb63895
- last_write_checksum: sha1:749cea88d9b4c25d686f6cf7abbf8f970dce3e8c
- pristine_git_object: 16c18b508ef61ca4b2ebeb21d1c363bb20709721
+ last_write_checksum: sha1:15e8d4c9d383eb1d4fb7ef75524171d4660cbe10
+ pristine_git_object: b2e5ded83185ccb63283b8d5c82b4f737f31ca7c
docs/models/components/PayScheduleAssignmentDepartment.md:
id: b18cfde44eea
last_write_checksum: sha1:3cf67c17f8f716d3b5615402c287fc22f41edd28
@@ -1259,100 +1360,140 @@ trackedFiles:
pristine_git_object: 7ce1431990af1d89257d7ea86fdebf3930a3ba6f
docs/models/components/PayScheduleAssignmentPreviewType.md:
id: 68033b912376
- last_write_checksum: sha1:3aaef7543f3b9ffd3db6462e8139be3e29787847
- pristine_git_object: f27bf21df0651b5a7484f6770ef51b6032ce7dab
+ last_write_checksum: sha1:27bb72c54b00b2466e545c6ee04b3c1672e20d7d
+ pristine_git_object: e928b4eedc391fe9c16e35ace6910da307ba2e87
docs/models/components/PayScheduleAssignmentTransitionPayPeriod.md:
id: 5a76ae1c7e0f
last_write_checksum: sha1:8ebd94b63f41d469c979ba8b7f9b6df5a478f167
pristine_git_object: 96b66d83bc2db4f2207a52aba08f01e999731e02
- docs/models/components/PayScheduleCreateUpdate.md:
- id: 810494fc2773
- last_write_checksum: sha1:d3109812b27897274af3bf9697355aa5d51af562
- pristine_git_object: 8f9c1962e3b5b8514b51061a645ac7b63b359823
+ docs/models/components/PayScheduleAutoPayrollEnablementBlocker.md:
+ id: c0f3a76f0e90
+ last_write_checksum: sha1:96a63386a72fe2388bfe81195b1339f2f3530b8d
+ pristine_git_object: a354c4acd3a4e0e83f8d23e65bd6f2fe2bd94a64
+ docs/models/components/PayScheduleAutoPayrollEnablementBlockerMetadata.md:
+ id: ffdc9b1a9801
+ last_write_checksum: sha1:bea258766300ffc574f5f6571068634c3467fce6
+ pristine_git_object: 3412c0c86a8d88cd1ae8f956c2533aa2571afd3f
+ docs/models/components/PayScheduleCreateRequest.md:
+ id: 5bdb1a56e866
+ last_write_checksum: sha1:4f98fe31f5211488b2ea57acaab9a314aa3884d2
+ pristine_git_object: 3bb6e323465088ddf24887f372ffab90abb01e43
docs/models/components/PayScheduleFrequency.md:
id: 1a0fdb728d66
- last_write_checksum: sha1:6faddc7538bad519846b85503dad6145c230ae67
- pristine_git_object: 623cdbd64bad8857e77aaf0ff07be6b8e0688f87
+ last_write_checksum: sha1:e0d677d7e1a91852230d0dadadc8f018e6bac439
+ pristine_git_object: fc2c0677759fdc68c1782ccfa4d1c15d1b220933
docs/models/components/PayScheduleFrequencyCreateUpdate.md:
id: 679a6d761d10
- last_write_checksum: sha1:530bdd06df66496c4d3a00c675abec0ff2bf1041
- pristine_git_object: e073ae46cfb23de2c82749d32cb187c430da8845
- docs/models/components/PayScheduleList.md:
- id: 5972ad44cea2
- last_write_checksum: sha1:fe2d35deb68fbf2aa3465dc259d63a841ce2f240
- pristine_git_object: 5e086c90ab21d67188c697bd9142df308108f97c
- docs/models/components/PayScheduleObject.md:
- id: c3c2edce8e0c
- last_write_checksum: sha1:9a0d86a90b44cb02fcbe93ffb35814671c41b5a7
- pristine_git_object: 9f008da2dd01322ea9d004f9c4dfc6580c46ad0a
+ last_write_checksum: sha1:9ba9c6f1ae264d58bb7994ae7b670ed9d1fd4fcf
+ pristine_git_object: 2e582733416f69a826abff39e92b7821d8ee779e
+ docs/models/components/PaySchedulePreview.md:
+ id: 0600bdfc4888
+ last_write_checksum: sha1:3bc2d9aaf7ff9cb217034051721becc1ce9d23e6
+ pristine_git_object: e2025c893ed84cea857f6481208060523d24b66e
+ docs/models/components/PaySchedulePreviewPayPeriod.md:
+ id: 4a2254b6dce7
+ last_write_checksum: sha1:4a91818787f8544b73cece60efc3f8ed811c8fb3
+ pristine_git_object: 14e8dd0524f399a0587148b0bbbd99400d546650
docs/models/components/PayScheduleType.md:
id: 75b1bc2a034a
- last_write_checksum: sha1:e4f19f44aa84fc0b21e484931f154df5e8c7bc67
- pristine_git_object: 5e71f81658307ad4cd084ed132b0b750808699dd
+ last_write_checksum: sha1:12ab961344ea8134e98efbef5fd4bb14284ce87a
+ pristine_git_object: 4213babf6bc8d865b51caf779c3ab92fecad3ad2
+ docs/models/components/PayScheduleUpdateRequest.md:
+ id: 3d9bdc2fe687
+ last_write_checksum: sha1:11897e8e726ed5f6d810a77f31b60268b0f78be1
+ pristine_git_object: cbefa2c53352aa3eff71316e4fd9323b468b1e43
docs/models/components/PaymentConfigs.md:
id: 762b80e82adb
- last_write_checksum: sha1:c13532f264a0ed129964afcf730eb227fb9a0543
- pristine_git_object: 915779e80a1cbc28eb613b1644d52249874f28b5
+ last_write_checksum: sha1:f88ac27261183d3592fa2bb8f348d05ec97fc121
+ pristine_git_object: 96e2a3a06052fa9be3e53583b601015989a0a08d
+ docs/models/components/PaymentConfigsUpdateRequest.md:
+ id: fc1f55b0bcd8
+ last_write_checksum: sha1:5839d3cabc4b47d89f4a656c63fb4b4c5ac04b59
+ pristine_git_object: 4650f334e4947a78c374a9f10b70ddb9e1c43058
+ docs/models/components/PaymentConfigsUpdateRequestPaymentConfigs.md:
+ id: 242fc3f43252
+ last_write_checksum: sha1:913e16892f251fb61cea03ce77cb7c219ba09f3b
+ pristine_git_object: ae60a076923918759bf051042115074e5b92afe0
+ docs/models/components/PaymentConfigsUpdateRequestPaymentSpeed.md:
+ id: 605abf84097c
+ last_write_checksum: sha1:5468994c386d90c0ad4135837fa45f08eceb7952
+ pristine_git_object: a42d420dc650f6a30e6569c4b7900580ec4feef2
docs/models/components/PaymentDirection.md:
id: ea8071743bf7
- last_write_checksum: sha1:15c9bd4c49028889e48c287e04da3e6efc69dbd5
- pristine_git_object: 3e8fefdeaccd74f8970a3e3e1201f031ea6174d2
+ last_write_checksum: sha1:a2bfc12692f4f9f1bf5a21b1bfc0410fe22ae5f9
+ pristine_git_object: 09f9250c336bc54889f3245ec65f9e6764bbfeea
docs/models/components/PaymentEventType.md:
id: 82f57638e949
- last_write_checksum: sha1:a0754ed09da36c0862ae368f5523c5c9e9c25fd0
- pristine_git_object: 2fce136008bb11e76ac5fca99c8b49e30679d619
+ last_write_checksum: sha1:0752548d628acf9554317477393ad1dffe16226f
+ pristine_git_object: 218ea46d3febd3fd432f6ddeb2d1b9e9d10c1e67
docs/models/components/PaymentMethod.md:
id: 1b54b132ff41
- last_write_checksum: sha1:ff3303833656b46e4b9aad4934afad9db7f3f173
- pristine_git_object: 33bcb3f7cd06889d56a733c94b052f56b62f1ef4
+ last_write_checksum: sha1:ae58defdac83e40e1c3b2b8310ec2fb52213ff20
+ pristine_git_object: dda535e831f695023de4b15c0d3e36cdf29c67bf
docs/models/components/PaymentMethodBankAccount.md:
id: 3e0f4e30abac
last_write_checksum: sha1:718c3a58ad65e5b3a0dba93269145404fa026ef7
pristine_git_object: 4c646a0a9b5e3ea299c45c53563c6d1631af3cc0
docs/models/components/PaymentPeriod.md:
id: 099bca4cb5cc
- last_write_checksum: sha1:0967344568d6f6b0b78342f1cff9a4029425621a
- pristine_git_object: ee2e9aac332d61136822f2ec34771826fb9e8426
- docs/models/components/PaymentSpeedParam.md:
- id: c30994e2b55f
- last_write_checksum: sha1:1023ecfc6008e05815c220e3990528f4863c719c
- pristine_git_object: a2d4a02cea188ec7c80691ea4bb469b2a724ab16
- docs/models/components/PaymentSpeedRequiredBody.md:
- id: 0b4250c729b9
- last_write_checksum: sha1:c23659eca4c7a557288ec006f8c6aa39888b97e8
- pristine_git_object: d3b2f14bb5b426956262648d0788818a4e38e44c
+ last_write_checksum: sha1:cca000b1297276218b145b4b4f41864447f81833
+ pristine_git_object: 89c3fedec05250ae3a65cf30636e481a2f9e9e82
+ docs/models/components/PaymentSpeed.md:
+ id: 8b818c6c9103
+ last_write_checksum: sha1:ec5cbb64fc1e3991e22bd032f0f9a455d9e75b91
+ pristine_git_object: 8603736977777e31c4e47c37b9bd25f43cb88965
docs/models/components/PaymentStatus.md:
id: 0df64a5775c3
- last_write_checksum: sha1:931a917ef91a58a86a828e8de4e0114780f503a2
- pristine_git_object: d65e716b08bb762ff0f624a21b6621de03639d13
+ last_write_checksum: sha1:8e0f5cf0bda8ce1edf524ad64db34578e856641a
+ pristine_git_object: 4cb3ddff2d73b957b7390578f78a0e7e3a7e66b1
docs/models/components/PaymentType.md:
id: c9b9b9c30eff
- last_write_checksum: sha1:8770cd23224d963dc0883f0cb3185279581cfad9
- pristine_git_object: b8b734297ce0daa308ea9de4df2b3bf09e848e0f
+ last_write_checksum: sha1:1e173a085d5e38a4e1a3538608fc049418b246e9
+ pristine_git_object: 230168857a82dad0a63cb3b309c152575c4ee50c
docs/models/components/PaymentUnit.md:
id: 7f5f06f1cb92
- last_write_checksum: sha1:69088498d77c48f364c18e9805ab538baf58f7fe
- pristine_git_object: a5eaa828252a382bd90ac678016cd87f90f12ea4
+ last_write_checksum: sha1:bee11baf1185c50c3a441d470bf1992a4d7b5208
+ pristine_git_object: 11d862cd30ac88c59561a1a7426c282a30984bb1
docs/models/components/Payroll.md:
id: 4fa486c1417a
- last_write_checksum: sha1:a7400c8256c85d2bd77ab1fbd767e0c46572293f
- pristine_git_object: ab907f812284bba1ce8e77f6f8d00c38be56d681
+ last_write_checksum: sha1:9d4894092e2e50118fe2f1e24ff3dc2c9f70a26b
+ pristine_git_object: 6366881f026553113269a03236b14eb214e688d7
docs/models/components/PayrollBenefits.md:
id: 6272f369fea6
last_write_checksum: sha1:6ebc0b9c32b506836852515c74ecedec22584d58
pristine_git_object: ba52102e624327718667083d0ec1f5b55a380345
docs/models/components/PayrollBlocker.md:
id: 33a01762cf1c
- last_write_checksum: sha1:24fbda8e0063f8e79ae9f67dbeecccca3e367950
- pristine_git_object: 25a6a4868f837300194bc6ef87021f9fbe7f52e4
+ last_write_checksum: sha1:af3b32007078aafadd0f7d8416c0b47156e9e1c8
+ pristine_git_object: dfad05117299e332893030a6b569e8ef36e0d64b
+ docs/models/components/PayrollCalculateAccruingTimeOffHoursRequest.md:
+ id: 6bc4a13c976f
+ last_write_checksum: sha1:cc65af0595b380d17d0a6ffa716ffd24f0ab0aa2
+ pristine_git_object: 3e25f2c58db2b854e2c87513452d763ed8934e87
+ docs/models/components/PayrollCalculateAccruingTimeOffHoursResponse.md:
+ id: 64ca0f37fee1
+ last_write_checksum: sha1:aa92ad205757d6617b35ada2efdda387926ce270
+ pristine_git_object: 93de3d62be63bd197ce8de40694946ea498aefc9
docs/models/components/PayrollCheck.md:
id: 6fd237c21ee8
- last_write_checksum: sha1:e9000537367f6a59805ab231fef2a407092f0161
- pristine_git_object: 347584fe34705185fa2f8fe83b2b6ebe88067ca2
+ last_write_checksum: sha1:f645050c4d329922b87d27ddbe2534eca87547c0
+ pristine_git_object: 053cf367e9faf9ca0e59bdfd662f2a909e818203
docs/models/components/PayrollCompanyTaxesType.md:
id: 5a389ccf2d4d
last_write_checksum: sha1:a7ea11eafb46f5d93ed09885fcb8d06f94ce8dda
pristine_git_object: f9cd47816abf3e1f6c426f8e5ed056e595c8987f
+ docs/models/components/PayrollCreditBlockerType.md:
+ id: 1819a613fbd3
+ last_write_checksum: sha1:2aa45fbc6a77c07f3c186fde91f9e6113795d2dc
+ pristine_git_object: b66e4da24530a8ff72c74b69ba0cbd782afeb438
+ docs/models/components/PayrollCreditBlockerTypeStatus.md:
+ id: 3c84153441ce
+ last_write_checksum: sha1:483f018e6ef8e4b7d6b9ee320d7101bc7b9268fc
+ pristine_git_object: 3439325ad7984f1d14d1374378f7dd4102b5b4ed
+ docs/models/components/PayrollCreditBlockerTypeUnblockOptions.md:
+ id: 564f8ee56bd3
+ last_write_checksum: sha1:c3b7b2b9ed6329cf82a81cac5df7d6fdcffead1f
+ pristine_git_object: 153a8bcdae2240ab2156645dc917517ca5fcf8c5
docs/models/components/PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfi.md:
id: 42bbe8771583
last_write_checksum: sha1:3fd8c2e22a7fd0295db4c34089ddcba09504b0d4
@@ -1363,20 +1504,20 @@ trackedFiles:
pristine_git_object: 4d8b2f5b045c3d5e23267d3a8bd03f817b2a62d4
docs/models/components/PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfiUnblockType.md:
id: ba4df38317f4
- last_write_checksum: sha1:6133d9c8fbaeda8a01ea6f22e708fa385e6e0d36
- pristine_git_object: 0536292cbed2fd4041226351e24a6027611bef15
+ last_write_checksum: sha1:a37bb3a852c5a8b6d9257452cf322764ec4b051f
+ pristine_git_object: de41fe59c1c71f2c551c878ed9eafa08305a9114
docs/models/components/PayrollCreditBlockerUnblockOptionSubmitBankScreenshot.md:
id: 18a7fbc90baf
last_write_checksum: sha1:db27af16877d19ba01dd395316bbd3f69a97d43e
pristine_git_object: 040beb4fb1496a7048cdc61ff7708e59ae8d46fd
docs/models/components/PayrollCreditBlockerUnblockOptionSubmitBankScreenshotMetadata.md:
id: 22b6f620b1db
- last_write_checksum: sha1:97f77d3e96b9cfa6886b30dc72d9b13bf20b2eb4
- pristine_git_object: aa83de59a3b59f1dc4a577eba20748f0747b084d
+ last_write_checksum: sha1:bf680a39cdfb28dd5cd931123d6cb511cafc57e5
+ pristine_git_object: 1739e34f85bd7ac270ee83fb3c14532742e7b5c3
docs/models/components/PayrollCreditBlockerUnblockOptionSubmitBankScreenshotUnblockType.md:
id: ea7f5b789fd5
- last_write_checksum: sha1:033bfc438812caca60779fbbb0cc3da95a837c33
- pristine_git_object: 61b124231f61bbcdba1c4f7c2a0180871e0137c0
+ last_write_checksum: sha1:dfcd762f21b53d5068e3127bdc43d36ab5948d92
+ pristine_git_object: f2b92b827c13cb642ce5b360a8b410f2cc5f69c7
docs/models/components/PayrollCreditBlockerUnblockOptionSubmitWire.md:
id: 6a2e84fc4c9d
last_write_checksum: sha1:e86687f41a5ff5cfb758ff3de42f8df05a07dfc5
@@ -1391,40 +1532,48 @@ trackedFiles:
pristine_git_object: fae6d874ac15641f9a70779f26ec1f847b04db10
docs/models/components/PayrollCreditBlockerUnblockOptionWaitForReverseWireMetadata.md:
id: 050f4f2cd823
- last_write_checksum: sha1:a0e1fdcf7b20fa4026112a6f3f7a028caf079e9e
- pristine_git_object: 30dd04d66df11ca19c79f972b4e15011ef930534
+ last_write_checksum: sha1:c2ce122b8c3ab6bbbd2d360ce7988717199887b9
+ pristine_git_object: baf92e2bb2101bd11eef21b078ece207e4cf48dc
docs/models/components/PayrollCreditBlockerUnblockOptionWaitForReverseWireUnblockType.md:
id: e12db0b3d340
- last_write_checksum: sha1:4441118fd61e5b3053d8ff097c3c398d8d1bd3e4
- pristine_git_object: 6debf194dc0f13e346d0a8038a6c576ad902db13
- docs/models/components/PayrollCreditBlockersType.md:
- id: 8f7a8ec688bb
- last_write_checksum: sha1:ec94c9835bfd06f226e8a6bdb471facc9fb650ac
- pristine_git_object: 218fd3fa7192fdc1c5800d6b52fd09a85fdecab4
- docs/models/components/PayrollCreditBlockersTypeStatus.md:
- id: 430a93aecc27
- last_write_checksum: sha1:63df4424a005703316293b9b0deb082d689876fd
- pristine_git_object: 266068a7ea9da2bb5e33c9f69b78cf8e6cc56bd5
- docs/models/components/PayrollCreditBlockersTypeUnblockOptions.md:
- id: 7749a80faa1d
- last_write_checksum: sha1:4d340710103f6ece0d175967f5142e44a275f5e1
- pristine_git_object: e5deb9505fc3e3ce5ca6f5b6bca79f78866bf2a0
+ last_write_checksum: sha1:f90e018afcda6a02077910c06ebb685220a4a43a
+ pristine_git_object: 2a528ca4a10a775b64747b353ed30fc12626a71c
docs/models/components/PayrollEmployeeCompensationsType.md:
id: be4c680f6697
- last_write_checksum: sha1:69bf5f08d0221a04c092a91f03316a3e8331c316
- pristine_git_object: f4f59155ae3c835df7054bcffb009e867eafc8b0
+ last_write_checksum: sha1:0f4953434f28497b409e18b2382f6cc733167d02
+ pristine_git_object: 3d03e72a66b6289180ff1e330707a2b2fe49a93d
+ docs/models/components/PayrollEmployeeCompensationsTypeFixedCompensations.md:
+ id: 48d8a817e979
+ last_write_checksum: sha1:f763abc85ccff7352f73e2f292877ebc3823d5bd
+ pristine_git_object: 631946a82bc650831066f1646d94f357514ca22a
+ docs/models/components/PayrollEmployeeCompensationsTypeHourlyCompensations.md:
+ id: e874fb06c090
+ last_write_checksum: sha1:1abe9a40b6d67d1445079202d04250c4b4a3efff
+ pristine_git_object: cf0b473d7bdedb89cece05ec90e52bd13a2cfde9
docs/models/components/PayrollEmployeeCompensationsTypePaidTimeOff.md:
id: c18ebc92a47a
- last_write_checksum: sha1:b4805155974a93966a7311706aa3e1d1d73eb932
- pristine_git_object: b902b1d0821940b6def390679400dff0d8cd73ed
+ last_write_checksum: sha1:d59c12c2a95bffe3e9878782af384e931477d4a1
+ pristine_git_object: 582b091a4bcce4dbb7fe7c8958797ce35463d6ab
docs/models/components/PayrollEmployeeCompensationsTypePaymentMethod.md:
id: a5ad40ccd570
- last_write_checksum: sha1:d5cf1ad4976318c30d67e7b93a25bb8d2fd988b1
- pristine_git_object: c9f579633d9d411afcc4e99aa4ca8002e360f7cd
+ last_write_checksum: sha1:53a106516b53b34438eb17acc52a42eeb795e444
+ pristine_git_object: 413e1381c9740d39310725cf27440f9694739721
+ docs/models/components/PayrollEmployeeCompensationsTypeReimbursements.md:
+ id: db897da1d796
+ last_write_checksum: sha1:a1535c91e360a4dfc13486fa62ff74a14845abd6
+ pristine_git_object: c6b17aa06c86c4ce017190ba008bed614f99a970
docs/models/components/PayrollFixedCompensationTypesType.md:
id: f0144f0ddb81
last_write_checksum: sha1:a89c0be09f2a3251c943503e66be1faedf4662d0
pristine_git_object: 9c1ec9275f717c0e9e6770dfd4d7ff00bfa8a370
+ docs/models/components/PayrollGrossUpRequest.md:
+ id: 6c57efe859c5
+ last_write_checksum: sha1:74be8ff468bdd44b9695a8ec447cf81942fcfbae
+ pristine_git_object: 4133cbe091edeb3a4e6983f2dcb572dcede100c3
+ docs/models/components/PayrollGrossUpResponse.md:
+ id: 196957231ed7
+ last_write_checksum: sha1:c993ad0884e94baccc6bbeb3321df85f19a34ad0
+ pristine_git_object: 938f5338a6ada6a0c427d889f244430ac5e5a409
docs/models/components/PayrollPartnerDisbursements.md:
id: 8e2f44e37833
last_write_checksum: sha1:685629babc12236c00fb57a0db7181e89036df9b
@@ -1435,12 +1584,12 @@ trackedFiles:
pristine_git_object: b1e9256f93fe4db0366a91b6d44bddecbb90a5f0
docs/models/components/PayrollPartnerDisbursementsPaymentMethod.md:
id: 14c723655e46
- last_write_checksum: sha1:b633ccfbeec42e15b22aa2f79adf1926837d47b1
- pristine_git_object: 7b0a67d31b50535378987e4eb9df416cab29f99c
+ last_write_checksum: sha1:a6f525a215a4b9cf25766b73fc3e5bc316076758
+ pristine_git_object: 04571272256891e8dc1f8b466f7eb9d46c29cf3e
docs/models/components/PayrollPartnerDisbursementsPaymentStatus.md:
id: 81a719e7b2bd
- last_write_checksum: sha1:e147b07e799651c56dd14981bc16a8b3b6ba818e
- pristine_git_object: 33dc5f29a9f486156185b4fafe670bbcd467e449
+ last_write_checksum: sha1:3494e897963fb36156dca964495cfecb9b0e5fe3
+ pristine_git_object: 22630dc851a649bc351b0aea683d261d30115e7e
docs/models/components/PayrollPayPeriodType.md:
id: 25efe448305c
last_write_checksum: sha1:662507ea2ecaccf31c7145beae0b13b7ab8b7b8c
@@ -1453,22 +1602,18 @@ trackedFiles:
id: ef7d802cd123
last_write_checksum: sha1:f8c60b7db714d308e5fbd3d5be84785267ff0dfc
pristine_git_object: 8c33ce2408adcbd610eaf9cdba22d70dd65f28c7
- docs/models/components/PayrollPrepareSortBy.md:
- id: 058fcf157cd9
- last_write_checksum: sha1:6fb3c4e8701bb6911c56bf2a076c21c02da70d7b
- pristine_git_object: 6f5e98678ee669ef1825766b60a4bc0a76a32558
docs/models/components/PayrollPrepared.md:
id: 229fc6d2292a
- last_write_checksum: sha1:c244adf7e735e97c60bb4d6a8565256652547498
- pristine_git_object: 5598971ed73f7f8221f32e5ae271f0121ca65d99
+ last_write_checksum: sha1:c984633de0a5db1cc66c51a839281a94f9c8e6f0
+ pristine_git_object: 26d8262192398b73c5416a68db4977ac6230ec97
docs/models/components/PayrollProcessingRequest.md:
id: c501a79b708f
last_write_checksum: sha1:115abefc7b15ecf40221958653ab467d84285e8f
pristine_git_object: c2c997e7d80c87d66e7a44c34a24562f04275b95
docs/models/components/PayrollProcessingRequestStatus.md:
id: ca9c1a7f3e3e
- last_write_checksum: sha1:f9927e08e01e5fed7adbeb9742a9f841e026678a
- pristine_git_object: c4b983e175e484858c1cba30d4c26c96563f499a
+ last_write_checksum: sha1:73c4ac65a0b04db70c0b03e137f04e708894741e
+ pristine_git_object: 5a028da0475137952ef4de604c6c8453f7e46f5d
docs/models/components/PayrollReceipt.md:
id: bc8b694da3f3
last_write_checksum: sha1:3cdb3310ee8c3bdf54cf1d9f4dc3973f069a5f0c
@@ -1479,28 +1624,28 @@ trackedFiles:
pristine_git_object: 8152d0a41569a823d0f5ee0b8e9aaeece9f2b2f3
docs/models/components/PayrollReceiptPaymentMethod.md:
id: b2ff9c2dcea9
- last_write_checksum: sha1:6295c6fe93c9bb3e2d657493898bf9f94bbb1006
- pristine_git_object: 8740c61dd498678dab1153a9d79b309a1d266972
+ last_write_checksum: sha1:10be57d411f17eec72697a60c9100dfd7365625a
+ pristine_git_object: 7573f5374ae3c4216a0a6efe6135438eb237422d
docs/models/components/PayrollReversal.md:
id: e37d94f01d36
last_write_checksum: sha1:d6644579dec5c0b5157ce06a93f088575140a873
pristine_git_object: 1bc5d232c5c87fca8afc11b1e8d770b8893de15c
docs/models/components/PayrollShow.md:
id: 9bba956dd5a9
- last_write_checksum: sha1:689df3f7765cdde3a63a1052c89e1c6774639c08
- pristine_git_object: f9e44a096e2a3f771ba9905126b4600313f22b13
+ last_write_checksum: sha1:27b9aae8d592a1d21508354ccc534e2973822df6
+ pristine_git_object: a39f720af6cf25e8ffe07b3022a7faf94c2da033
docs/models/components/PayrollShowAmountType.md:
id: 541e1e932137
- last_write_checksum: sha1:2508577f2cf175892e5246c2ef7946b69d976189
- pristine_git_object: bb3e1575db1675fdcac0f70ceb14329ab1c72497
+ last_write_checksum: sha1:f107d3050de5bb4fbd8b4b098c98bdbf1b6052ed
+ pristine_git_object: 8df023a853fd4d59b2055eaf0380559a921b01c9
docs/models/components/PayrollShowBenefits.md:
id: 10eebfca6377
last_write_checksum: sha1:bb8dd69bb6b76644f58b701bb869c6ed8e68a2d6
pristine_git_object: 2eb21a6cd6b638ba86128a32857bdc8079e30a15
docs/models/components/PayrollShowDeductions.md:
id: 0871b8250a52
- last_write_checksum: sha1:bc341477760ed8d8518daacfce3e96a05fea20ec
- pristine_git_object: 8db5ff4a183335ba8a93bb5b62a3a42329edfcda
+ last_write_checksum: sha1:b673d6e663d8282dd9664d7c84b18a2d581770eb
+ pristine_git_object: 8f6b928958514ea2390ff1b066ff98f775b9b7ab
docs/models/components/PayrollShowFixedCompensations.md:
id: 6831dec3ae52
last_write_checksum: sha1:af9bb58a56e81fe4673ca44a2b77a56b9422201f
@@ -1511,12 +1656,12 @@ trackedFiles:
pristine_git_object: 01342eeb7c48636faf9c000687231a8acd0bbe6b
docs/models/components/PayrollShowPaidTimeOff.md:
id: d444bbcd3049
- last_write_checksum: sha1:45d852ef02be398b7004bc9ebef51b5cadb98d3f
- pristine_git_object: dc267f3af07b1ab1507b491b488f17b3852ec3d5
+ last_write_checksum: sha1:55f1e610c75887ba0148ea83b65bf684136bd7df
+ pristine_git_object: 0b41c7585dc67ca11e9a74bf167b4616b938a1b4
docs/models/components/PayrollShowPaymentMethod.md:
id: b2015e48193f
- last_write_checksum: sha1:72ba0c65456c2d6f06857a4add76d844bbf1306d
- pristine_git_object: f505933be2bb97725ff855acf8d5df444c13c330
+ last_write_checksum: sha1:0b2a9f4d1c4211ce5a89ffd20b8ef355fd220fd5
+ pristine_git_object: 0ea9a2b53e0332a14b39d9d81b60fc6fb2079d2c
docs/models/components/PayrollShowReimbursements.md:
id: 8b674ae511bf
last_write_checksum: sha1:3e0071ceae31e9672729bde69c551910293a1d7b
@@ -1525,14 +1670,18 @@ trackedFiles:
id: ce867da55c07
last_write_checksum: sha1:a05b50206cd160d90e878c01b019953d8b86201a
pristine_git_object: aa2239758c2855e80c82a7f714cb5135d8fa2d99
- docs/models/components/PayrollSubmissionBlockersType.md:
- id: e8c8f2e134d9
- last_write_checksum: sha1:7d40ba6d88caf6c343c56c4cc1d479bb58e25406
- pristine_git_object: 0982ef1990260d45078ce1aee3d4085ba0983753
- docs/models/components/PayrollSubmissionBlockersTypeStatus.md:
- id: c1b7d93a03f0
- last_write_checksum: sha1:811c83abb6fd0eb4f5894ea726bace60e760db03
- pristine_git_object: b24c7b295b9167e08ef4cdfabe9b14fc90827d85
+ docs/models/components/PayrollSubmissionBlockerRequestType.md:
+ id: 0c2fe1a016f0
+ last_write_checksum: sha1:37d986a7c9779d178dbc09d6883c064d9863483f
+ pristine_git_object: db5ea38727886c3d89b7c20771c5d71263078f15
+ docs/models/components/PayrollSubmissionBlockerType.md:
+ id: 401e528edb20
+ last_write_checksum: sha1:f68950fb2f1ce57a74eaf5913d657c88ff1c3efe
+ pristine_git_object: 430eca3feaf7435bb4ef3620e6f66372a30c74c4
+ docs/models/components/PayrollSubmissionBlockerTypeStatus.md:
+ id: e008de95315e
+ last_write_checksum: sha1:ac60174481599e3fc53f58feb47035916e6292d3
+ pristine_git_object: 314d694d5eeabe6dd943bf4087379702e2e3be6e
docs/models/components/PayrollTaxesType.md:
id: 0538dd1c5603
last_write_checksum: sha1:4056242fb546d7ed8d90867392f76d929c2c214d
@@ -1543,16 +1692,32 @@ trackedFiles:
pristine_git_object: 0fafb14a1ca0682ac9ef7142c7e928602dbb8953
docs/models/components/PayrollType.md:
id: 9dea148cef4e
- last_write_checksum: sha1:bf395650f185e9e5548515eb44c1a1699add6473
- pristine_git_object: ebf3a9f9f96773915227c43dd776741e40d52d53
+ last_write_checksum: sha1:f06634a831b26a364ff638153f0c9a9f76e2beda
+ pristine_git_object: e4bc42a194df8500f5385fa3fa1b44ae61c307b3
+ docs/models/components/PayrollUnprocessed.md:
+ id: 1792fd462562
+ last_write_checksum: sha1:feae2bdd0262f265508503839473bc4247b39cc3
+ pristine_git_object: 1041f6d160b7e93c05d42b6253beba7f16f48a42
+ docs/models/components/PayrollUnprocessedEmployeeCompensationsType.md:
+ id: 12faf57e77a6
+ last_write_checksum: sha1:86b5017a71b74c86fa577172e6893158d12de9a5
+ pristine_git_object: 8dc5537b968a27f59d6941bdc6616e0698e0ecd6
+ docs/models/components/PayrollUnprocessedEmployeeCompensationsTypePaidTimeOff.md:
+ id: 026d1745e945
+ last_write_checksum: sha1:feb019f0b17f1f3414c92e6853dedfe949a99ea6
+ pristine_git_object: 77e4d9a1dda0f79ca131ad8c839c6658b7b2a1d9
+ docs/models/components/PayrollUnprocessedEmployeeCompensationsTypePaymentMethod.md:
+ id: cf8c3a1562f3
+ last_write_checksum: sha1:61fd66be44d54358031ff65ac5306fe92797ace5
+ pristine_git_object: ae5c92687060656817e243819961358f8a42732d
docs/models/components/PayrollUpdate.md:
id: 8e2688800bcd
last_write_checksum: sha1:8d4a9c237dd1507da92fb4c42045854612cfe8f0
pristine_git_object: 1bd9614ffc40eff88d706e05da41dc8cb0da4c41
docs/models/components/PayrollUpdateAmountType.md:
id: e0586e313149
- last_write_checksum: sha1:cf92a1c634486ab38373ecc21afbb131c84caed0
- pristine_git_object: dee0734098afc30c70b8657c7385987342ed1227
+ last_write_checksum: sha1:314fae2ece4b367087f87254f5bb38c4fb365086
+ pristine_git_object: bcc19a88cdad98272c11722d01be2b6951d2ee7f
docs/models/components/PayrollUpdateDeductions.md:
id: 7ddee42b04ea
last_write_checksum: sha1:75f3070e514a301daf2366ff3afb207a12255e5b
@@ -1571,28 +1736,56 @@ trackedFiles:
pristine_git_object: 95ffe176a5aaf032fb55165b7c571f91e1881789
docs/models/components/PayrollUpdatePaidTimeOff.md:
id: 0c1798874b93
- last_write_checksum: sha1:fb6a541e0ee41fd9966c59cb559cf190bbc17d56
- pristine_git_object: cc7e8963b3f3307774109225b006fcc0a1cbc9fb
+ last_write_checksum: sha1:f1bb4e10c83dbdb2c6086ca7960a2dd4e41d73e0
+ pristine_git_object: 8ae8a94c1dcb6f883d55378370ee6a9f934d068d
docs/models/components/PayrollUpdatePaymentMethod.md:
id: da6a6f7d96f0
- last_write_checksum: sha1:7957e43b4a6fca1331b6be8066af9d1e3d52b81d
- pristine_git_object: 88b6b10932a01799683af80470ddd20b737d256a
+ last_write_checksum: sha1:67c04270c0f5d9ecff703ac0aa91f06d67ecdb3d
+ pristine_git_object: b2fd45f9f21a73f25e70b0f1f571097f7a6f4f92
docs/models/components/PayrollUpdateReimbursements.md:
id: c8928c5a8280
last_write_checksum: sha1:757cd2d5c9198af30c1be53e6d54252bcee84f98
pristine_git_object: d3f6d0d05817dd893d6f64fc9e57ae77eb3e5620
docs/models/components/PayrollWithholdingPayPeriodType.md:
id: b768dbd78092
- last_write_checksum: sha1:f45bac11f4a3654335577f9e1120188b98054cda
- pristine_git_object: cb5fc1ab1229136877835731ac93001c2f6b4aac
+ last_write_checksum: sha1:b35e5e9c2702195453c73e625ff781e9c750a6fd
+ pristine_git_object: ad22ce959bdb20dc0440a9f23fac5a6ec0875904
+ docs/models/components/PeopleBatch.md:
+ id: 7103eed9536b
+ last_write_checksum: sha1:c165e5979638b6f5901718988527da71fd254e3f
+ pristine_git_object: 5621d3f319e2e4ba4dc01b457a87c330e7e5a25b
+ docs/models/components/PeopleBatchResults.md:
+ id: e2e042b339fa
+ last_write_checksum: sha1:204c17bf44cb2089bdbaf50c3b7db75e69286cf6
+ pristine_git_object: 2002eb602e967ca1e625c6c400c659aea81527d6
+ docs/models/components/PeopleBatchResultsErrors.md:
+ id: 56004f6492cf
+ last_write_checksum: sha1:1859e61136a846604a90527dc14c210d4abb0049
+ pristine_git_object: 8067200cdd2ab4ed2e677b29d179928d2c9fd7f2
+ docs/models/components/PeopleBatchResultsResultsErrors.md:
+ id: 194377318a00
+ last_write_checksum: sha1:ef76f6a24fb3c10d97d777ebb336b7a289c06582
+ pristine_git_object: 62915ae049e78d9c568ed0aa90782a51a32d171b
+ docs/models/components/PeopleBatchResultsResultsStatus.md:
+ id: d9065059e931
+ last_write_checksum: sha1:4e641a242f8261493e59c4642ed64d3f23468b9d
+ pristine_git_object: d3b304aa28191e6c34d73cae2a857a7e171770ce
+ docs/models/components/PeopleBatchResultsStatus.md:
+ id: 59c1819a91e5
+ last_write_checksum: sha1:2b810c69980d41bb658170f4c394943a7bd88855
+ pristine_git_object: 935786f8ae41a5f0947f0f0613fa65faeabeffcb
+ docs/models/components/PeopleBatchStatus.md:
+ id: 3f167b5742da
+ last_write_checksum: sha1:d718849ffed4a21c6d0fcf9b45aaec0fb425e862
+ pristine_git_object: d9a110cea4cf82cb3aa1ec52622e0c13d22f1a26
docs/models/components/PlaidStatus.md:
id: b4ef129afe67
- last_write_checksum: sha1:ae4f6affd4ac175f8046fa4d25fe7a57d8d63210
- pristine_git_object: c7e89c2a2e9b84a003927775ffea8a5c91d5191f
+ last_write_checksum: sha1:3f3e336aa7c7b7b4fc117379c3adc609bec6df13
+ pristine_git_object: 1649fa3383637a69aa38c1f894f2e6f4565e1cc9
docs/models/components/PolicyType.md:
id: 87a569ac675f
- last_write_checksum: sha1:3a8da8092b0904462aba9baaa26ff5a8d5f46f50
- pristine_git_object: 6d28ad23e3bf862a04936ee53e9fd8b5ec1eef07
+ last_write_checksum: sha1:c541627bf5fad27e85cffb028771d05e918553ee
+ pristine_git_object: deb02cd7171be5119fd89e94592fd9edb205d31b
docs/models/components/PossibleLiabilities.md:
id: f9263cb25062
last_write_checksum: sha1:b3b3ab1aa0f1060b62fd601f4e62679765cdf74a
@@ -1619,24 +1812,28 @@ trackedFiles:
pristine_git_object: 37594692c517b455985f4aa7b4ca8d1e64352c02
docs/models/components/RateType.md:
id: 082482c12fc1
- last_write_checksum: sha1:c7415d1a3bc828193d7ea6842f5c3acae412939c
- pristine_git_object: 3a8ab5b1ed940ff548d0ab14f8ceb01452927a3c
+ last_write_checksum: sha1:12f44f84ee64c1df620bceb7064a1004acbf0f67
+ pristine_git_object: 437bf9865faf5981fa9883462b1b5221bdf6f3ad
docs/models/components/RecipientType.md:
id: 8fe24b71cad1
- last_write_checksum: sha1:4adcbe3ef2bc1fa4cca2adecfa1b01a5e8053ce0
- pristine_git_object: 8d2fdfedf31b3f7d708b3a11587d6af59d02a3e1
+ last_write_checksum: sha1:c41b9ab0a2f050151eb7d7304299d1728eb1a85e
+ pristine_git_object: 475d32ba26b87ebf213d22f0e2824712dd0c0b5b
docs/models/components/ReconcileTaxMethod.md:
id: 64d843ce1128
- last_write_checksum: sha1:adb17b8f29d03a124984c96355628bd6a0f072d4
- pristine_git_object: 38662ebcd3a9b2e640dcb2d105dcf1f94ef1b3c6
+ last_write_checksum: sha1:679875dd1519258e889cf2367ca5be33ae908e0c
+ pristine_git_object: 1859bfd305dc9cac2ed89be2c62bd5abe255911d
docs/models/components/RecoveryCase.md:
id: 29f4da7dfa9e
- last_write_checksum: sha1:133b2da3f7ed8684d3642a17c5d50bdd7ab485f9
- pristine_git_object: a44272c779ba352ba9e4c165685b87281e244cc9
+ last_write_checksum: sha1:8534e4e0e4fa2acff2cc69f6535625e584a30950
+ pristine_git_object: 122fd499cb9a716b278edcd502b92f66cfd5dcd5
docs/models/components/RecoveryCaseStatus.md:
id: 078044df8c0b
- last_write_checksum: sha1:61cb6f8e94ec598ca49ccfd69bd413bd3763c8fa
- pristine_git_object: 353558de977ded2ec5c860a0a4f447b090683fad
+ last_write_checksum: sha1:e7873e68de667089deb421388c5c7860555cce18
+ pristine_git_object: 38e3ee7dd51d6fe062b2f7b35628d6f8ce03127d
+ docs/models/components/RecurringReimbursement.md:
+ id: 4fbbc4eabadd
+ last_write_checksum: sha1:e31b3e75fd481090241d2b39e13e90ddc5227c84
+ pristine_git_object: f90ed9ec08b9c13d9c6174c4d55530c99bc65b35
docs/models/components/RefreshTokenAuthentication.md:
id: abc694228ac2
last_write_checksum: sha1:945871a5b00b72b22b31a99d3c23d2b779605981
@@ -1651,8 +1848,8 @@ trackedFiles:
pristine_git_object: d2ddf6b320d038fddd662e285f8881508639ed6a
docs/models/components/RehireEmploymentStatus.md:
id: bcfe5ddcf68c
- last_write_checksum: sha1:2e452826f5ee57ece8de50e0d1949dba234cf64f
- pristine_git_object: a0948f618869d4987cf48cea05eb2766325d7b59
+ last_write_checksum: sha1:0c523a03728e605105415c438557a7f74fec9d67
+ pristine_git_object: 422b1df33d937a7b92a8e080674260754936bf52
docs/models/components/Reimbursements.md:
id: 6f3910d6c30b
last_write_checksum: sha1:c3a7d04f962865f801d1ef2a7557ed9af3561281
@@ -1667,28 +1864,44 @@ trackedFiles:
pristine_git_object: 73dfd6171f47bb46dd6646d9bac39ba9ece0c0a2
docs/models/components/RequiredAttributes.md:
id: 5a3341555761
- last_write_checksum: sha1:f71dcbcd4fbb7ff6f24474dc0412b5844483bdf2
- pristine_git_object: df640bc94c6a0d8cbe1ae2da66a6f5f372fe8802
+ last_write_checksum: sha1:c3da23b44cf58c5e98b06f98599f81fdf53f3935
+ pristine_git_object: 5dbd3e6c6a42df0694e2ef2069d588d754eb245a
docs/models/components/RequiredQuestions.md:
id: 3f844f076f8c
last_write_checksum: sha1:abb438414e92479d76488e4675a87a73ca057cc4
pristine_git_object: ca4a863b9792b96a3152b1b5cf706c653b6a1c02
docs/models/components/Requirements.md:
id: 00fdaf4bd6ca
- last_write_checksum: sha1:2e596c261fe3b7b937d33640a4e8aef897f31135
- pristine_git_object: b702b2c2da4fa297b108f6efbc8ff1f85375fc1d
+ last_write_checksum: sha1:c88c12b0826026f4f65c26c79e18304ff200d9ba
+ pristine_git_object: 7cb710238c6b689a50899b028bd5c7b5b1914fa1
+ docs/models/components/Resource.md:
+ id: 910c51010442
+ last_write_checksum: sha1:4364b82199c82b0ed8877feda62233ca6c44db35
+ pristine_git_object: 808649abb8fe3793d7ab739ba7ee97c2da61836d
+ docs/models/components/ResourceOwner.md:
+ id: 23970427175b
+ last_write_checksum: sha1:9ddeaa53de1b6b4520ebbe2e71d049f2f09a760f
+ pristine_git_object: 92c0d42802413b4ed567e19d5b5b07d3eb89473f
docs/models/components/ResourceType.md:
id: 80cdc92132aa
- last_write_checksum: sha1:631aeb41c4c677b95a9c2127c7852842d944463b
- pristine_git_object: 0c6c237622c7f5d48446e2b7cba3c0f25f077c7b
+ last_write_checksum: sha1:7d3f2628842bc0980d90578218b404f5d500aa58
+ pristine_git_object: 987ad515c02dc53af5ed84eeeffbe12c7569c2ed
docs/models/components/Resources.md:
id: cf6417b7edbf
last_write_checksum: sha1:42af4a14322d976c7e3e6e46ccd084dc0ee50fd0
pristine_git_object: fc416b60a8e83a865b92b0e5e0b341f10cf0dc6d
docs/models/components/ResponseType.md:
id: d6966d83e0e9
- last_write_checksum: sha1:7e36e2bd169578468e0d2ca0871141a27ae094f5
- pristine_git_object: aab2d5c4eb385d4d11c94047e083af9dee0d3595
+ last_write_checksum: sha1:b343803fdd0ca148590f5cf17c73769297883879
+ pristine_git_object: fc94d7b72fb4bfd41764484260cd32b9054f12df
+ docs/models/components/Results.md:
+ id: 1a859def686b
+ last_write_checksum: sha1:fd708580cddc4edf1e18d51bbaebe3fc95e8e852
+ pristine_git_object: 48e2f05cd6db21eeb06ebdd28f02ae2dded1a8b3
+ docs/models/components/Role.md:
+ id: c89eff3746a7
+ last_write_checksum: sha1:fbefe0b4be585b819f1b3e684383b669c9b89bfb
+ pristine_git_object: 427cc70846879abf61224f7614bc355968284bc3
docs/models/components/SalaryEstimate.md:
id: 1c66ede3c4bb
last_write_checksum: sha1:26bc300c61120ba5f5f88c9478f60873f5e15cd0
@@ -1699,8 +1912,8 @@ trackedFiles:
pristine_git_object: 7197448a3f2194cb1af60152491a095ad84dba94
docs/models/components/Section.md:
id: ebbe9a3249fe
- last_write_checksum: sha1:8d91f50d3cac2ca619e2f626b85a4345388723b9
- pristine_git_object: fe99b03936bcd6b4698d3325873596a0bd826e7b
+ last_write_checksum: sha1:0895b4592ca055b94ed1c70b39902f3097a35c7c
+ pristine_git_object: c2136afef77e1a3888e7ddaab3beddcdea3f8e35
docs/models/components/Security.md:
id: 3878f0f84029
last_write_checksum: sha1:1a6bb97b4d469d6908cd2db39bc62fccf683d5e4
@@ -1711,24 +1924,44 @@ trackedFiles:
pristine_git_object: 218142fda2c6e966412fecb225ae4b8cc4d384c6
docs/models/components/ShowEmployeesStatus.md:
id: a72b2b5b5aa9
- last_write_checksum: sha1:a38880ed46dcf797f5aa30dc008cabc9f72256e2
- pristine_git_object: c422daefa4d0c3136b4877c0c9cf7b8d59efc1a5
+ last_write_checksum: sha1:35f96826ecec65dc318c40cda5681094a2da847b
+ pristine_git_object: bd216410b89fe82ef39872326f94442c1c440324
docs/models/components/Signatory.md:
id: b69c25b1bd12
- last_write_checksum: sha1:6d1cf40515b397d9d89784a84215c687b96f3066
- pristine_git_object: 40961c9e78614449daf533660e72e25ed25db7df
- docs/models/components/SortOrder.md:
- id: 56cf7ad0ad0a
- last_write_checksum: sha1:8b8b0686d0a04e5885262fda023b96de3d7fa3da
- pristine_git_object: 6977f48b00e57cdd925098323bb799a88162e17e
+ last_write_checksum: sha1:3089fb5f7d3af3bea85cd537bcd5b7849d2fdd5b
+ pristine_git_object: 4d79198390ec9b916e8dae46f54352b0a0205c6f
+ docs/models/components/SignatoryCreateRequest.md:
+ id: f56ce1c4b674
+ last_write_checksum: sha1:ce40d0f4df93aa8137407ae0bb757737ab3c83f6
+ pristine_git_object: 69b57f5ae6b42b0638af234e5254a532614e35e7
+ docs/models/components/SignatoryHomeAddress.md:
+ id: da545e067198
+ last_write_checksum: sha1:e463f6089438b2a678b5a4f1356bcde0ee4f6717
+ pristine_git_object: b3cf894696b7b83aded9ea3f4a216a470c767bd8
+ docs/models/components/SignatoryInviteRequest.md:
+ id: 34e3131bd6af
+ last_write_checksum: sha1:f54a69c10c07a5bc66c2998e0172c039e6b3bd36
+ pristine_git_object: d666ed585754f4e58f1945b42c20d9e2ba106ae2
+ docs/models/components/SignatoryInviteRequestHomeAddress.md:
+ id: 1feed19d27ad
+ last_write_checksum: sha1:0f99359e2899f45682aee87f7c4f7cce88ab658e
+ pristine_git_object: b209a8a02439b77a429e711b2ba387f342cd02cb
+ docs/models/components/SignatoryUpdateRequest.md:
+ id: fa301c3616ab
+ last_write_checksum: sha1:a19e1f7ac43f63335366de37731172af9a992b29
+ pristine_git_object: 2b0ccab955e3cba092f0cf79decfab0f4f0da7ec
+ docs/models/components/SignatoryUpdateRequestHomeAddress.md:
+ id: 8895e33eba20
+ last_write_checksum: sha1:cc18b48c6182869deda9421124f9426880090c82
+ pristine_git_object: 61c6803527122ef524bc74092ceb8908b2758219
docs/models/components/Source.md:
id: 851a72141717
- last_write_checksum: sha1:dea794670d6eb4e652c312da10256cb04f01e1a7
- pristine_git_object: cbd25b88fbfd1d4e3b1f7f55c6404149cdc71488
+ last_write_checksum: sha1:8a09676dde7963d01194ca1b7f17705491593458
+ pristine_git_object: 215e932173cca0b6ba2f597f724ae652e87b9caa
docs/models/components/SplitBy.md:
id: bfef8245179f
- last_write_checksum: sha1:ab068b518f564accbb2cdf0c77e473727031a7c1
- pristine_git_object: 9290118fdbb224a7cd470b011bfd6071154dc563
+ last_write_checksum: sha1:700df282b2a15cce61a4985ed88bb7857130cac4
+ pristine_git_object: deb306d45f85216dd20d05bd292bd5aac138761e
docs/models/components/Splits.md:
id: 550db2269fbd
last_write_checksum: sha1:3e75aa61b73e2b2d6d1f1965ac0921a33038d7c0
@@ -1739,20 +1972,20 @@ trackedFiles:
pristine_git_object: e3b3ba515434bd5d564c3c81dbbbf484ba859f4d
docs/models/components/Status.md:
id: dd05f949cb61
- last_write_checksum: sha1:6526a6ce94e8f8a25577022acf1b2b8d8d9f7959
- pristine_git_object: 046b6a028a0bcf5775ef79198c634e97a21605a7
+ last_write_checksum: sha1:5857709d76ecaaf997caa000e34a04ef9d1fcc1d
+ pristine_git_object: 1f14a956e020394eb1162080e84d6fe0ee8d1aea
docs/models/components/SubscriptionTypes.md:
id: 1b70918affab
- last_write_checksum: sha1:ea3672e1c39baf0768dbdfe40735309574399adf
- pristine_git_object: 098d39ab2f46f314051de8d3b8fcd10f648c13f0
+ last_write_checksum: sha1:55bf647a8bff25c9feaef6087383e63519f98a80
+ pristine_git_object: c77d06d0345945e2724886d0b7fe5d53ff8da893
docs/models/components/SupportedBenefit.md:
id: 5a54fc450697
last_write_checksum: sha1:a63acd983d30b778d722d55f40572a3d3aec159f
pristine_git_object: 848bc05f1d146ab8c7e50afca8349c4022ae69b3
docs/models/components/TaxLiabilitiesSelections.md:
id: 574c7499d396
- last_write_checksum: sha1:7298d735bc12e8e2ba6ebe0450aa5a622290de31
- pristine_git_object: 3e2a481b21d91706aeca1fb784d71d2dc9f46cc4
+ last_write_checksum: sha1:d3f751fe9dd8231e61fe9d883fca6642e80e7980
+ pristine_git_object: c0288e306626db5e7a8df599987bb18183eff822
docs/models/components/TaxRefunds.md:
id: 52eb6abeb81a
last_write_checksum: sha1:9acd5216bfbaf7e196e9eca31010415e4b51b15e
@@ -1775,12 +2008,12 @@ trackedFiles:
pristine_git_object: 3e78bf332c3388a4deedf86dcfa9e6186acdf844
docs/models/components/TaxRequirementMetadataType.md:
id: 3700c55f678d
- last_write_checksum: sha1:0ce1cd736f67ffb00aac4616558c7ba93d3f358a
- pristine_git_object: f80366931d7eef8d55f9cf7079a2d97bdf386d6f
+ last_write_checksum: sha1:1ac953219fe780250ed6211c4bb36d115617c586
+ pristine_git_object: 7ba821299899ba9bf6fd45bd41fc156280c44cc7
docs/models/components/TaxRequirementMetadataValidationType.md:
id: 408228c09cda
- last_write_checksum: sha1:359ac8b3c5b374f79c75f24854728b26e84147ea
- pristine_git_object: b8249acd0802f4e96470facf9efb7a06e3b1e2f0
+ last_write_checksum: sha1:cb76e9b220fb0d99f02824eac942df1b8ccd2b6f
+ pristine_git_object: 1c2da207ca5f422f5a423c3d2d9dc340f98a5a5f
docs/models/components/TaxRequirementMetadataValue.md:
id: 61fb3b23d321
last_write_checksum: sha1:96960cb2a7cf971c20e749ffd5de3eb97d757f5c
@@ -1815,8 +2048,8 @@ trackedFiles:
pristine_git_object: 7ee7723e8e3af9ed195975a0189ed5cc5eec5382
docs/models/components/Tier.md:
id: 98d4b73b6dca
- last_write_checksum: sha1:f4e3b22590ca9a647ebcbf82ba52baf06d79fe31
- pristine_git_object: 0345ee360c53f6dee7a8bb1e02836cc4d56cffc5
+ last_write_checksum: sha1:529a2fd1e638f14c91a61cb6ef94b79ecd0188ab
+ pristine_git_object: 50c7bd85bb5e338051fdbab08e604982346290d9
docs/models/components/Tiers.md:
id: b80514056c9b
last_write_checksum: sha1:13f3643cc683e4d5d19590e79a83a6237cbee42c
@@ -1839,12 +2072,20 @@ trackedFiles:
pristine_git_object: f7c57755cafd3041ac52373b4cb9f901f1df7d8c
docs/models/components/TimeOffPolicyRequestPolicyType.md:
id: 70215835cb0b
- last_write_checksum: sha1:6f8078a3e5af9f905f38d3459e37f4a546e1e608
- pristine_git_object: ada1934d92b8e34dfad552e8b31bdf9e21bf025d
+ last_write_checksum: sha1:b9ad2eadf63a6755cce4b9cb07791bef3d720ec1
+ pristine_git_object: 9aaee38241825b6fa1a76e69bb0fd4a66d59bc67
docs/models/components/TimeOffType.md:
id: 0b3a1fa17465
- last_write_checksum: sha1:24aedddb4995a57f223742b7f1f325683ee72227
- pristine_git_object: 83bafa795a3e6da53bb43c00e5d006d12bf53239
+ last_write_checksum: sha1:49a6310cfe833046fd42e7ca59a6b343349c1c99
+ pristine_git_object: cca5be8cd66368e9b4f2599c92b37e491369af35
+ docs/models/components/TokenInfo.md:
+ id: 694443f587fb
+ last_write_checksum: sha1:7e25940105921f59dc529b8aaae494bdf1e84389
+ pristine_git_object: 25fed0f4d2d0f28f8b222fef98fc79bfa10fe6f2
+ docs/models/components/TokenInfoType.md:
+ id: 2b691ab10736
+ last_write_checksum: sha1:aeb554a462494c7cd498e28790b7d3de682e6af1
+ pristine_git_object: e9786eba414ab18dc48a53bab598fde2a38ea341
docs/models/components/Total.md:
id: f90105637d62
last_write_checksum: sha1:d71376dbdc0a9a037ff7849a9bdc61186560357b
@@ -1859,20 +2100,28 @@ trackedFiles:
pristine_git_object: 07ff479d3d44790bbf4e1ff29706928886d87e46
docs/models/components/Type.md:
id: 8c0a5144d92e
- last_write_checksum: sha1:6c75689931eb5d4e2ceac6c06d9d0a1ef587e10a
- pristine_git_object: f9be4e3ddf752038a0f51fbc9896d0a4200221e5
+ last_write_checksum: sha1:07fb0b0b3988fde45cf5bcaec62576718cb5bb67
+ pristine_git_object: 8b53d728598704a2a5662b3c8c21767ea79bffee
docs/models/components/UnblockOptions.md:
id: 4db5714d9d73
last_write_checksum: sha1:20d77f76e4af75c1521955b7ac2d93c8e8ac1686
pristine_git_object: d7c9177e34888314d9a26ad4796cfeb8e9d503d2
docs/models/components/UnblockType.md:
id: 1ff49f602777
- last_write_checksum: sha1:238d43715b639ca28e439240c23341e40d66472f
- pristine_git_object: 38c864afb331e623f4579d132025aed191a58ee9
+ last_write_checksum: sha1:972f0b5d9d1ab55416bfdff68e9709729fd54d53
+ pristine_git_object: fdb89ef3240990e618bf50175240f01cf1c747f2
+ docs/models/components/UnprocessedPayroll.md:
+ id: c8a763b152c8
+ last_write_checksum: sha1:479c9ef5537d28d919ed737645f825db47fb9aa1
+ pristine_git_object: 2fc86b825389f72756ae6978aaad9d2cde606b00
docs/models/components/UnprocessedTerminationPayPeriod.md:
id: 59bd05949566
last_write_checksum: sha1:3daeaa54706429e19f6b4ac8e0bc3d8c9c026b4a
pristine_git_object: c277e7c052761af01b3839d20e263eee401ec16b
+ docs/models/components/UpcomingEmployment.md:
+ id: df11bd4656b6
+ last_write_checksum: sha1:6df7b3a979ea95da71d6b5ae3f60b8382a0e2867
+ pristine_git_object: 4687da53463288eff8c6c4053610a1453600cde0
docs/models/components/Validation.md:
id: 7df579e163f7
last_write_checksum: sha1:4b1f7bbaefce7dc745739a8fbe5a223424d440bd
@@ -1891,56 +2140,56 @@ trackedFiles:
pristine_git_object: b5c14491365af97a578cf2ac487954e79af8a031
docs/models/components/VerificationStatus.md:
id: 117e470ae72c
- last_write_checksum: sha1:aa1b718a5716dce18deb999f26a9fea9953777d2
- pristine_git_object: 8dfe691b34f18e549a003416a04e9b3b9deea78d
+ last_write_checksum: sha1:7a4814e1fde39f3e4a0b4dd3b897b58e15b258e6
+ pristine_git_object: a173ef12b8162f640aeabd99ecd3851738e29ee0
docs/models/components/VerificationType.md:
id: 752770a96807
- last_write_checksum: sha1:907d9d2a8140d385bb5769ae82bc1276485e0bde
- pristine_git_object: 0dc9bcb32e87ef2b3961e1017760da85f9c21518
+ last_write_checksum: sha1:b4a183f5e6cb90e688a9cd25a19b286a8481dba1
+ pristine_git_object: cc4fad1a10ba1c41320a8f53c78133a617ff98ab
docs/models/components/VersionHeader.md:
id: 7c4f94fa7e65
- last_write_checksum: sha1:ccc68de3f7fc265d19dafc8f305a221a7baf26f1
- pristine_git_object: 2dc203b78dbfc6885de844478c978f2e53c765d0
+ last_write_checksum: sha1:57cdb2cf5e46097ea6251653a71de285ba2ee0be
+ pristine_git_object: 3fd6556a1448929f9138c3d1df2fee00eed32311
docs/models/components/VeteransDay.md:
id: 974931980e5a
last_write_checksum: sha1:73d3d96fb7c9c816147d21ace1db262f400be08d
pristine_git_object: 5b2a8c80e7ea1932b10545cef17136ffb1d8d3c7
docs/models/components/W4DataType.md:
id: 97d3d3454df8
- last_write_checksum: sha1:3619756ca0e726d9cbbdfaa48cc7d9b351ce452a
- pristine_git_object: d54e9018926f6ee885f7acaca5f0c631bf6da98c
+ last_write_checksum: sha1:e7893001b8c4d1fcbec4991f543f177cd5a16b95
+ pristine_git_object: 9e6f8eedaa8fb6a379ad3cb5900732d7b70cb684
docs/models/components/WageType.md:
id: ae6c7aa17a55
- last_write_checksum: sha1:ef67e65243f2c8eacf204ed6fe47f872350e92a7
- pristine_git_object: 081620887f10da07121c423e151cec499f200244
+ last_write_checksum: sha1:e6823b7c7c276ab968dd563d98b5b9618e4db991
+ pristine_git_object: 11f2dfc9781a0f6407c4d8f5488e17e1e039d439
docs/models/components/WebhookSubscription.md:
id: 1307d98a814a
last_write_checksum: sha1:8246f6b96724164628e91b91aa2e2c0fbb29a252
pristine_git_object: fb6f69b73cb86a9d8b2ce5f932af7e291dbd3f76
docs/models/components/WebhookSubscriptionStatus.md:
id: ae8d023a9cf5
- last_write_checksum: sha1:667bc28781a7d336da9f3cface7a050343a65306
- pristine_git_object: 04f1717b7f87622593d6cae539e73c82ea2e9145
+ last_write_checksum: sha1:fe82973045d888adc8a616fd4191d4bcc88d3213
+ pristine_git_object: 19c8a8dc3323fa4c94286b6f556f3379079e3203
docs/models/components/WebhooksHealthCheckStatus.md:
id: 8bf6f8ef40e0
last_write_checksum: sha1:70ccd1086ece78f8b36f14b04b0793364837b96c
pristine_git_object: a13d521a5343fd4e0b45fc5d0270ba0cfa50a715
docs/models/components/WebhooksHealthCheckStatusStatus.md:
id: a596e55a6fb3
- last_write_checksum: sha1:93a1c0142bd0e0a468e71066f9f7e1047f5b4c3c
- pristine_git_object: 8f67d90b33e78f75bf61b5f8595f9a4970727257
+ last_write_checksum: sha1:33f2eaddd456f810fb52a49458209a0d6ac5d2f1
+ pristine_git_object: 82158e7148fd964b748144b0b3b4489a2deb4e66
docs/models/components/WireInRequest.md:
id: d20946ab03fb
last_write_checksum: sha1:49f6d4b61613b34a2d81ffbf1643ddaaadc6d605
pristine_git_object: 1107ec446fa0aee11204607b666b6a37179d2207
docs/models/components/WireInRequestStatus.md:
id: 2923fed105a5
- last_write_checksum: sha1:d1065461730ba94ca83b0034462b1601a07fc38f
- pristine_git_object: 5ed7d34c43dc2c5df359b18070c8f5c08691c3f8
+ last_write_checksum: sha1:5e9b874d1b2cefeed499228b9d41ad5886d3c9c0
+ pristine_git_object: d199c03ba53b09481490505b710df26dd60ea3e8
docs/models/components/WithholdingPayPeriod.md:
id: 5d2bf1ea400d
- last_write_checksum: sha1:ae7018091f9ff7672bca0d9d2c527c7487f29af6
- pristine_git_object: 6340d69e0a87d683428078b1880177a40c3c7de8
+ last_write_checksum: sha1:a9cd5c9f48ef989e28e708a3135b3e6b3bdcc1e4
+ pristine_git_object: 690cfe0663df69efb2f09a98bf5117b2fa550df4
docs/models/components/WorkAddress.md:
id: 3dab06c7e632
last_write_checksum: sha1:c1ee04a24845c026a96fe03c079fa367e5734a82
@@ -1961,86 +2210,74 @@ trackedFiles:
id: 69a6517f0cb0
last_write_checksum: sha1:ab09875904f413e31bd84a26ab815ab64ff1aba5
pristine_git_object: 3ad2874f10c2aa6f86b58562aeb68f6c115bdfec
- docs/models/errors/DeleteV1CompanyBenefitsCompanyBenefitIdResponseBody.md:
- id: 3305bca5a094
- last_write_checksum: sha1:a8290cff9dda8236847c526d86f243b36b0ce738
- pristine_git_object: 19cc9474012f78f2d835ecc711c88e31db54a21d
docs/models/errors/Errors.md:
id: 607310e85338
- last_write_checksum: sha1:e15052e841b083ed113ebd994a26be59fe5d17b4
- pristine_git_object: 8835522d301c3b4233b3df4f018756af24588be2
- docs/models/errors/GetCompaniesCompanyUuidContractorPaymentsPreviewBase.md:
- id: 47ef69851752
- last_write_checksum: sha1:bc0ec512bab6dea5bc2151b5b2244f3516a1f03a
- pristine_git_object: 1912294d1325f5f604ce1565909e8d48c6aea6ae
+ last_write_checksum: sha1:d109e36aced698732ee63f0c1b269e398a594c2a
+ pristine_git_object: b0d0a11f57ecf5d93c2b43f18820523f826b0c14
docs/models/errors/GetCompaniesCompanyUuidContractorPaymentsPreviewErrors.md:
id: 54bf907ac004
- last_write_checksum: sha1:19f6698feb182be93a63aed8a5f1c547fe5b6fe4
- pristine_git_object: 78a3da0fd4cda79c96a37766ed259c487e864dcf
+ last_write_checksum: sha1:6b7f7d07ed0e728f4d37bee2e053a019cc2531b2
+ pristine_git_object: 3907d918d10554692abb332d5b164d471b0a2da6
docs/models/errors/GetCompaniesCompanyUuidContractorPaymentsPreviewResponseBody.md:
id: 24a538f1e521
last_write_checksum: sha1:8dc76c793ab3e1c3de17f18fc4fd09ea7eaacd60
pristine_git_object: 5fa3f78df51f0908b1e60ca6f33dd87e9e7a268c
docs/models/errors/Metadata.md:
id: da0ca4518929
- last_write_checksum: sha1:18fffb590654bbbefb154372890fbe63d45c3045
- pristine_git_object: 1e53ebaca642bf78ab0eb11339fde568e053de16
+ last_write_checksum: sha1:ecf397c38912094ff1511daa00d7bf8da9cb3a60
+ pristine_git_object: ce078ae492f87115afbe7c6275a1bda3edf0a35f
docs/models/errors/NotFoundErrorObject.md:
id: 85bd5de8b5dd
- last_write_checksum: sha1:0e2c4dc393be88ec13cbeeb7c128ef50eb10b67d
- pristine_git_object: 6079d510d1f034ef0f5d255b59768a179f07859f
- docs/models/errors/PostV1CompaniesCompanyIdPeopleBatchesErrors.md:
- id: 5c4ce38fb06a
- last_write_checksum: sha1:e84eb2c621947e895ed7e9b680dd3aa76623c02a
- pristine_git_object: e4fcc8b10f831f87418737b43750abb655d256c2
- docs/models/errors/PostV1CompaniesCompanyIdPeopleBatchesResponseBody.md:
- id: d986d56ec9ee
- last_write_checksum: sha1:32b9ae6051f65b484e58cd2035ceaaea62ada134
- pristine_git_object: 1e38d07a0d308ff5f0292d5c8b9db8e5a3cda8b0
+ last_write_checksum: sha1:eb8d94dbce552d0b050e8bc221a84aca25beb527
+ pristine_git_object: 32a21dea9066d4af0c515f490cf8165d276d3060
+ docs/models/errors/PeopleBatchConflictError.md:
+ id: a8277313d18f
+ last_write_checksum: sha1:a83eda4daaf5accdfaae549a0adec582e1dc712f
+ pristine_git_object: baaa5d48ec344e35884d985b24fce162a32c419d
+ docs/models/errors/PeopleBatchConflictErrorErrors.md:
+ id: 8f454e5a5cdc
+ last_write_checksum: sha1:6cb638ee49afbadc0288c4a6748bc21e0ca710e0
+ pristine_git_object: ae0cc55b8d385f6e0b4e75df87e8ff697769ee18
docs/models/errors/UnprocessableEntityErrorObject.md:
id: fc120bfc5173
last_write_checksum: sha1:e902ab0b86de25a90d3dc31840a3aee0d54c5b41
pristine_git_object: e756c731e9dc1ebc63e5ac69495877f5105c2b07
docs/models/operations/AccountType.md:
id: 191c7d6b0ecc
- last_write_checksum: sha1:9186612cd8a1d6842071217fe1b7a0f2bfbb8365
- pristine_git_object: 82496dcf7d47fcd1d700d630731acde33c618fc8
+ last_write_checksum: sha1:6807fac9d4a80412ecb09fe63788fca8e38a7fe9
+ pristine_git_object: 3ac47c5c273b78e1db8f0ab0d345b176d3e52147
docs/models/operations/AccrualMethod.md:
id: 6326e7b50917
- last_write_checksum: sha1:62dc8a2866defe5302de01880338041aaf96bde3
- pristine_git_object: e1452305d941af64cee1d04165032e0a86e72464
+ last_write_checksum: sha1:8575e5cf39fcd7a5f2f01256688fdc3225d872c7
+ pristine_git_object: e4691abcc8ed8c41936b006717413fe7997d5749
docs/models/operations/Aggregation.md:
id: a539893d2af2
- last_write_checksum: sha1:63ba9a4ea4ad3505ad2d55f7167f2bdc12c811ab
- pristine_git_object: 5b259cd7ef3a790565de79cebe47ff7e47266e6c
- docs/models/operations/AuthorizationStatus.md:
- id: 051b644d1f5c
- last_write_checksum: sha1:e09a7746dcf77a6b9ed34c64ae1fd954e3d4b227
- pristine_git_object: bf006c1df78dc35b20aedd04d69cf77bc9ce87f6
+ last_write_checksum: sha1:12671501067e9d2dfb93e727aafec14a3d53056b
+ pristine_git_object: 3cb628f110d81ed6f886bca430cbcf91c48c8279
docs/models/operations/BankAccounts.md:
id: a8f13c34682c
last_write_checksum: sha1:da65edcb83a127f11701957a00a2759fbdaae788
pristine_git_object: dabff53afd828ac178233b3783b6752151bb49ad
docs/models/operations/Batch.md:
id: fb70d60a5d4a
- last_write_checksum: sha1:774de0bb43206cf7847db1ee274620d131e64b58
- pristine_git_object: d12cfca1c176b868ea65816180753e2efd26cd22
+ last_write_checksum: sha1:e08ca08b023066a98b0631dd7b716b76581fd811
+ pristine_git_object: 2da5e31d31c2a0d293e5b8ccb6868f7e71b1b13b
docs/models/operations/BatchAction.md:
id: 71466b7fca28
- last_write_checksum: sha1:162547975fef093d6de1ebdbbcdc79521ea5da61
- pristine_git_object: ad2d649e9df0cbc3dd69fb14acbf6b1f788220bb
+ last_write_checksum: sha1:5ba4dfb2d43f609485b6d63088f186f134fcf26f
+ pristine_git_object: f7bbeb63918bc1d17dab33255889e1bb9e715364
docs/models/operations/Benefits.md:
id: cac377aa7d5a
last_write_checksum: sha1:21e16ad303aad820f4469b7eecbc0c7416125675
pristine_git_object: cef3d6e284deca6f6e4cc2df14a92f97a2437c45
docs/models/operations/CatchUpType.md:
id: 4a73230fb9fa
- last_write_checksum: sha1:83e51b763ea78526bf643c8b533928c6bd92b729
- pristine_git_object: 019ae78cb5fdeb0fa852330f015337fa45b4a8a8
+ last_write_checksum: sha1:0f183acafe27d783e6c4cef1cb814792e20f8620
+ pristine_git_object: b6bf41aa9b3afec10b122ada96ca3676d03d1710
docs/models/operations/Category.md:
id: 0f6b25018d46
- last_write_checksum: sha1:71b0196e15533cbd682f75b09d23f64148e0e4cd
- pristine_git_object: efaf6d9a1e0d3f103f36e588a481828e78a86fea
+ last_write_checksum: sha1:c7839df3b0cc8136bb0594e6ea4ba0bdf96771f5
+ pristine_git_object: 16190826a3c8e474aeb3e9b69d238ed3f7007b0f
docs/models/operations/ChristmasDay.md:
id: 2b33b0dc8037
last_write_checksum: sha1:a068692813599ef7b1c9e8037038ea50ced28ee2
@@ -2051,20 +2288,20 @@ trackedFiles:
pristine_git_object: af3056af35bfdec06f1c2ca01b53345a3ff5a345
docs/models/operations/Columns.md:
id: 95ba4a0c4c33
- last_write_checksum: sha1:48a2f81e8d8feecf8464685faa6365070ff55371
- pristine_git_object: 40a71dd0dbeedeb2831f1b6bd484a9c7985d91f4
+ last_write_checksum: sha1:4895906498954157a526181adb6d422baeb14a72
+ pristine_git_object: 3cdf5b29249b060bccff2f6fe541a5076bf487dd
docs/models/operations/Company.md:
id: 13239a2cfea6
last_write_checksum: sha1:f548f9a3866c47686c05d5ce184317833c7d33af
pristine_git_object: 420fc999a74f506d828f37d955678d91f90e4aff
docs/models/operations/Compensation.md:
id: fa5c7101e83e
- last_write_checksum: sha1:0c42f61fcba18987c1dfe96b2e68c60ef294dac1
- pristine_git_object: d566e0e7baecd0fb799daea965655b98d4725aee
+ last_write_checksum: sha1:1b1997df7c59be9b56121e2696495457b05da67f
+ pristine_git_object: f91eaf7954c959417bf44e0d9b08613d6997dd2f
docs/models/operations/ContractorPayments.md:
id: 7ce862b192f1
- last_write_checksum: sha1:bac86d459723d1c518d8e9feb5dc233db4e6e2ef
- pristine_git_object: 65ceb5ca74cb676ee54927ddaf87c0fcde868ce1
+ last_write_checksum: sha1:c4061a731ce8ee064f09a83386bd17cfd0f2330c
+ pristine_git_object: e7a283d555120fdae551be2a403f434ad55f43af
docs/models/operations/Contractors.md:
id: 42fcf2af79e4
last_write_checksum: sha1:b6510b9cabbf2f3a33eb37f4e18cbb6a9effc7c1
@@ -2075,12 +2312,12 @@ trackedFiles:
pristine_git_object: 22d065569d8889a155501003842f29bff8b6ffdb
docs/models/operations/DateFilterBy.md:
id: b87b70b7efac
- last_write_checksum: sha1:8eab9ec5c66d97a996b34b297ec5a845e014de37
- pristine_git_object: d46c7d39022de813b68891a20bb25418cb2b56e0
+ last_write_checksum: sha1:f2496fc0051d83c0126561a7d9073bd52e83ee5c
+ pristine_git_object: 45420c5ea0fad6b7ff2e353ee45abf431a209180
docs/models/operations/DeductionReducesTaxableIncome.md:
id: 7e0e7157ee89
- last_write_checksum: sha1:124f3e443d83a5aec0ace6bbf162865c7887b0f5
- pristine_git_object: 0e715da11c1f53b3110f7bd9fd88eddd026a3b29
+ last_write_checksum: sha1:e3c72476aa531a240ed959bde065e830bb7b0283
+ pristine_git_object: 62213a3f07ed8ec623e7733b041630f963d0cb5e
docs/models/operations/DeleteDepartmentRequest.md:
id: 225a5dd67efa
last_write_checksum: sha1:511d7c078f47d014204f5c56a4493594cd94955b
@@ -2091,20 +2328,24 @@ trackedFiles:
pristine_git_object: 563d00810d4929bb26522cef435cd77bd0adccf1
docs/models/operations/DeleteV1CompaniesCompanyIdBankAccountsBankAccountIdHeaderXGustoAPIVersion.md:
id: 0c70e4b5766b
- last_write_checksum: sha1:4ee18dbb078fd988e7dee47e210a101a78dfba21
- pristine_git_object: c1b92f6c8f3168750bb644c7058dbaf8878b88d1
+ last_write_checksum: sha1:7ac41da37f53da7d353205b6f4235eef59e31712
+ pristine_git_object: 6b52c372794b4f22a046c4fd6cd84af0fe4c6008
docs/models/operations/DeleteV1CompaniesCompanyIdBankAccountsBankAccountIdRequest.md:
id: 639ccfb6ce6c
- last_write_checksum: sha1:084528ead3620e0d5e46ad693bc6628dd259c3a8
- pristine_git_object: 60deb8bd870499d615b1a71004014c774ccd6910
+ last_write_checksum: sha1:e04fff25b51eeaab0004e1dd59d2eb989b07b8c5
+ pristine_git_object: 92f2886210263c31e2f3f8391374d0051dd0d12b
docs/models/operations/DeleteV1CompaniesCompanyIdBankAccountsBankAccountIdResponse.md:
id: c268369130a4
last_write_checksum: sha1:37f4745e1e2a8a4bb941a39ca6c05af7ad879567
pristine_git_object: ddc838129633c42b20ebeb28438ec67b25764964
+ docs/models/operations/DeleteV1CompaniesCompanyIdContractorPaymentContractorPaymentHeaderXGustoAPIVersion.md:
+ id: 9a21974b23bf
+ last_write_checksum: sha1:9bcdf1b5abebf61d293ddb9e63174f4f59eeef9d
+ pristine_git_object: f8f514938da0a8b4a1b086b3d97395c99fccdc22
docs/models/operations/DeleteV1CompaniesCompanyIdContractorPaymentContractorPaymentRequest.md:
id: 2b489316e731
- last_write_checksum: sha1:b7543936910675540cb020bc5efc5b28bbe7183c
- pristine_git_object: 5484ab68f9af9a085b85611b4b6e619a057c2ebe
+ last_write_checksum: sha1:f8840ac39de9433eb8d6cbe77a56f41369ed482f
+ pristine_git_object: 6cf170be27902281b35f169e7ca32e2974f834f5
docs/models/operations/DeleteV1CompaniesCompanyIdContractorPaymentContractorPaymentResponse.md:
id: 1660a446eed9
last_write_checksum: sha1:8ae3c6ea5fc2b81a0eca56f17b8b9474a33f8dbe
@@ -2119,8 +2360,8 @@ trackedFiles:
pristine_git_object: 0077b00b1ddda2c3393a5d6b12d71d16a8237e98
docs/models/operations/DeleteV1CompaniesCompanyIdPayrollsHeaderXGustoAPIVersion.md:
id: ec50f2c0886b
- last_write_checksum: sha1:4cbd9a0a15adbc92f0fec03dad825d0d478cd7ab
- pristine_git_object: 9a0410502ed65e4fc87eb4a47ad937e0d5c0835f
+ last_write_checksum: sha1:6571c7a489caccf6dfce0b22e8d67d391718bbf8
+ pristine_git_object: 6b4fad44a4f445a9862883d1b5a90bda4651c4d0
docs/models/operations/DeleteV1CompaniesCompanyIdPayrollsRequest.md:
id: 80c761a49606
last_write_checksum: sha1:4ce4b13596097118d1f02def9f5c8459df26d22e
@@ -2131,8 +2372,8 @@ trackedFiles:
pristine_git_object: dd32a55486f9b8172e2ef5523d29dbf7386dcc5a
docs/models/operations/DeleteV1CompaniesCompanyUuidHolidayPayPolicyHeaderXGustoAPIVersion.md:
id: 7d3103fa5da6
- last_write_checksum: sha1:5344826765f694492e7a4a88595b295a200770a0
- pristine_git_object: 971da7566a104ccb3070c2694e7d8766e80ad863
+ last_write_checksum: sha1:148b5d965fa51d960d724015c58d9e177a961d93
+ pristine_git_object: ced3ea821a18006358d20b1597e197d33cf83fa3
docs/models/operations/DeleteV1CompaniesCompanyUuidHolidayPayPolicyRequest.md:
id: 8c79c5682961
last_write_checksum: sha1:3cbe3d701e1cb5e2bf90ee01755bf9ad7f509ee6
@@ -2141,10 +2382,14 @@ trackedFiles:
id: 8c78441a6a4a
last_write_checksum: sha1:8db893c664d3679be8ea172c32605354bad06d02
pristine_git_object: d75b3a56cbce529c5960f8d6896e27d728f10300
+ docs/models/operations/DeleteV1CompaniesCompanyUuidSignatoriesSignatoryUuidHeaderXGustoAPIVersion.md:
+ id: f6bf442b3e6b
+ last_write_checksum: sha1:6ae2ae7c9a414e0238a367b6f13f322051926a6a
+ pristine_git_object: c3e20a4924262b461e29f3b8752bae29a6491382
docs/models/operations/DeleteV1CompaniesCompanyUuidSignatoriesSignatoryUuidRequest.md:
id: 5042a285b865
- last_write_checksum: sha1:eea9cdcd8ae513ac3453f6b111892fee51e86d92
- pristine_git_object: b81e58569ecaf16a409dc3358a8da88f8d98c5c5
+ last_write_checksum: sha1:be5f53912018c06fdb18bd5c72de24cb57d29ad5
+ pristine_git_object: db63e0d6a22ceb9882c3ce5134188c90ad8b1271
docs/models/operations/DeleteV1CompaniesCompanyUuidSignatoriesSignatoryUuidResponse.md:
id: 5ff7408c87c0
last_write_checksum: sha1:0fce22d35e827da13bc4e64a24cbbec718e0996d
@@ -2157,18 +2402,22 @@ trackedFiles:
id: 3279e52376db
last_write_checksum: sha1:c278922a4c6664be4592a18fc14aa7cbadbe1d0b
pristine_git_object: 996f2f2cc0a606cc039c0bbd7514822923b253f5
+ docs/models/operations/DeleteV1CompensationsCompensationIdHeaderXGustoAPIVersion.md:
+ id: fa4068d0fd89
+ last_write_checksum: sha1:4437c3c0f38da0819a744645656cdd52768ed81d
+ pristine_git_object: b597cd29090299ad500add9d455e4527e7335375
docs/models/operations/DeleteV1CompensationsCompensationIdRequest.md:
id: 5be4f8b22137
- last_write_checksum: sha1:cb08497cd8ebac4c937851af091c04bd38640e41
- pristine_git_object: eb3244f688ed4cf355c29b4b64af77b5ef4957d2
+ last_write_checksum: sha1:656a202b27f94cf3cfda718e24c8e4ca9e1451cb
+ pristine_git_object: e93cb575dfe9e2d660c162ffbecbdf6ed613de27
docs/models/operations/DeleteV1CompensationsCompensationIdResponse.md:
id: 09c09271c828
last_write_checksum: sha1:7ca946564a8ac603025ceafab1f09980da72af7f
pristine_git_object: 19cd3081d73e2898bb90087ddc79f16ddfbc9021
docs/models/operations/DeleteV1ContractorPaymentGroupsContractorPaymentGroupIdHeaderXGustoAPIVersion.md:
id: 9f1bb1dc323f
- last_write_checksum: sha1:b288e07252b0a878d637d32687a9fea28df1b5da
- pristine_git_object: 4f1b1f17243603fafe4cb4e7f3565a1260edfab6
+ last_write_checksum: sha1:20e83e56a70d87c1f1f7dc28b5bbe5e56be0fa13
+ pristine_git_object: b84187c577678a77780ae0b60e202605ff12fa0b
docs/models/operations/DeleteV1ContractorPaymentGroupsContractorPaymentGroupIdRequest.md:
id: c7fe8e2c439f
last_write_checksum: sha1:c0cb6a895830b2120d433d9d571b8885daa43cf2
@@ -2177,10 +2426,14 @@ trackedFiles:
id: 8e24b36765e5
last_write_checksum: sha1:74e61c4178574e1aff44fea1cbf5691ed99d55e6
pristine_git_object: 9cd8ed6d5e518118650387bc68e5f63880ca89ac
+ docs/models/operations/DeleteV1ContractorsContractorUuidHeaderXGustoAPIVersion.md:
+ id: b6f9ca421cc3
+ last_write_checksum: sha1:5262fad5b4b9a62efa74f3adaa8fc437339bca37
+ pristine_git_object: 43b54dee37bdc8ec3b559bc41384f7e62a986a2d
docs/models/operations/DeleteV1ContractorsContractorUuidRequest.md:
id: f79964c9b138
- last_write_checksum: sha1:bfad8bb19b7d844d2944fa7359b256521e7c52dd
- pristine_git_object: 3fe5cdb520afbb8f9e733235d8cad7e79ed0f01c
+ last_write_checksum: sha1:d0a109a5a5c72dd28f0b4e37347761c9c8c6a846
+ pristine_git_object: cb2049489a8ec9e3a93a30d3e81b7c84129bf36e
docs/models/operations/DeleteV1ContractorsContractorUuidResponse.md:
id: a9680f113d38
last_write_checksum: sha1:417a3bf603066b45d5da86eebbcff285d0095eac
@@ -2195,8 +2448,8 @@ trackedFiles:
pristine_git_object: 7b4996cddf7e0766eed34e2a9476d960c673b6d7
docs/models/operations/DeleteV1EmployeeHeaderXGustoAPIVersion.md:
id: 0ee0d1ea3de1
- last_write_checksum: sha1:dcbd2424eb00fd8ed81036632cd1ce4a4b83ed00
- pristine_git_object: e90c2ee3fe53595b1af876f0109ab39b7648733d
+ last_write_checksum: sha1:729efbd6a992719018627ef3dd42590e4ae822c8
+ pristine_git_object: 4dd63ee873f097e0b09c30d70e784adc41f20544
docs/models/operations/DeleteV1EmployeeRequest.md:
id: a1d73071731c
last_write_checksum: sha1:20e40c49b73a82fdbcc2efb8ee775d4c70ebd447
@@ -2213,10 +2466,14 @@ trackedFiles:
id: 518e0aa6eea0
last_write_checksum: sha1:fd192d7598a12775525879090eacdfba6747dc1f
pristine_git_object: cd8e7694baefd487113f49a85576f9bb8c30604a
+ docs/models/operations/DeleteV1EmployeesEmployeeIdI9AuthorizationDocumentsDocumentIdHeaderXGustoAPIVersion.md:
+ id: dac5b3dfe0af
+ last_write_checksum: sha1:47e6c75ddb9f47709aa0710c8e40652184c3d88e
+ pristine_git_object: 59a080a7328919cbd7625798c43e85c4970a1496
docs/models/operations/DeleteV1EmployeesEmployeeIdI9AuthorizationDocumentsDocumentIdRequest.md:
id: efbf7bc9c73b
- last_write_checksum: sha1:87ac6ff87984d9fef8ccbb11083db5fa78a7fc61
- pristine_git_object: 9d846b5eaa1a02ca3c8cbe9335a6475850ceba5d
+ last_write_checksum: sha1:db388abff73826305f24eb7104a2047a2e7e649f
+ pristine_git_object: bbbb88592276fd38048431484ebad55c999d9f52
docs/models/operations/DeleteV1EmployeesEmployeeIdI9AuthorizationDocumentsDocumentIdResponse.md:
id: 2dd8d1625f13
last_write_checksum: sha1:7c47ae6566e47b06514706717f822a9353c8c9f8
@@ -2247,8 +2504,8 @@ trackedFiles:
pristine_git_object: 93e6648c31164a2cf0106053e6980252444e07a4
docs/models/operations/DeleteV1HomeAddressesHomeAddressUuidHeaderXGustoAPIVersion.md:
id: 9d24e3f57cef
- last_write_checksum: sha1:d1d4bc667c1ac264ee767f13142e312a00261655
- pristine_git_object: e7df6bf804266bd17f0962c52d66adcdbad6dc91
+ last_write_checksum: sha1:104a35933c440dd9c2397f6b8af3b51a72f5c5d3
+ pristine_git_object: e026e6fae5938541c45c2e73cc9c0cfba1b77bae
docs/models/operations/DeleteV1HomeAddressesHomeAddressUuidRequest.md:
id: b3774aca97c1
last_write_checksum: sha1:5f2b44b629260abbafde6904e0f92c20193b19f3
@@ -2267,8 +2524,8 @@ trackedFiles:
pristine_git_object: c81fbf50fa1ae7de730338db6aab81bac9751065
docs/models/operations/DeleteV1RecurringReimbursementsHeaderXGustoAPIVersion.md:
id: 839ac1975301
- last_write_checksum: sha1:d865f0b77463ab7f8535badbcaeec4f6260da1f7
- pristine_git_object: 6b22a4e2d77b6796fc249a107b3a57e3cddcbf0a
+ last_write_checksum: sha1:725e7bc17322503ce203007eab9ce392f7b85d13
+ pristine_git_object: 71b3bbc616fb68242f9c3ab2c98da28bf12c54e0
docs/models/operations/DeleteV1RecurringReimbursementsRequest.md:
id: e3ca6280bcb7
last_write_checksum: sha1:e16f3f9df05b68953a53f45763a777db1ed16784
@@ -2291,8 +2548,8 @@ trackedFiles:
pristine_git_object: 0066c49e64917487a29bd337c57ebe66e90c1033
docs/models/operations/DeleteV1WorkAddressesWorkAddressUuidHeaderXGustoAPIVersion.md:
id: 789645d02430
- last_write_checksum: sha1:65c4ca2cbfa4446f3b95bf6e43922d39357b27e2
- pristine_git_object: eb09f224506a0da724e42ca8c811d1d5fc990c3b
+ last_write_checksum: sha1:0802433dc9fa0b91d0744447790c2df419530bd4
+ pristine_git_object: 0f35185e623f029c92f43a159385fdba24966e2d
docs/models/operations/DeleteV1WorkAddressesWorkAddressUuidRequest.md:
id: bf8280ddebb8
last_write_checksum: sha1:ea734fd63382917371d946b22876b26a6917da3d
@@ -2313,18 +2570,10 @@ trackedFiles:
id: 7ef6940f7bc7
last_write_checksum: sha1:5d737516801f0027fcecc6253a91f8b16a582bb7
pristine_git_object: 4e755819e1aa81e0f799fd42335d4f9a106b32a2
- docs/models/operations/DocumentType.md:
- id: 36f9218931a4
- last_write_checksum: sha1:730def49198d07a6a417f1276879d4db4240df5d
- pristine_git_object: 5d01a73e5ce3db1c5806c9c3519c6645077fd122
- docs/models/operations/Documents.md:
- id: b3388ee0066b
- last_write_checksum: sha1:ad0a0a1244fc2a4a656006d8fdb8bb7e76ee8b44
- pristine_git_object: bdfb891869cee3c0002f338c9ff52f6a2746d195
docs/models/operations/EarningType.md:
id: 184d15d39103
- last_write_checksum: sha1:d195947bd731d353c6d517214ef21f8916b82acb
- pristine_git_object: 2193a65a652634e872eb0ff621fe17f2506c3812
+ last_write_checksum: sha1:6be8d52741155d37fb91c5b39bdd647e5d363a6c
+ pristine_git_object: ea04d281310d1c223e835d235381ba16133f1f8f
docs/models/operations/Earnings.md:
id: 61f6d397595c
last_write_checksum: sha1:bc63405a09c89ae058b529a27e7c6e8af4a69369
@@ -2339,28 +2588,24 @@ trackedFiles:
pristine_git_object: d8aa07ecca142e276010fb7eae132e54c0bf9b5d
docs/models/operations/EmploymentStatus.md:
id: d4129d4ee9b4
- last_write_checksum: sha1:a3326228611f6102d8a21b001b0d130e2ca57488
- pristine_git_object: 94bf4f41dd5c422b9772bfc068376645585481af
+ last_write_checksum: sha1:52ff8fffb94f834bcd8f7e35f132cfbc64bb4a05
+ pristine_git_object: 42ed0380670844906626efea41456b46972e4ac8
docs/models/operations/EmploymentType.md:
id: e8e384195748
- last_write_checksum: sha1:5421941217a3404b6121a7c908b4a2c62c92d6eb
- pristine_git_object: 03d993e71055a3f08434e355a1788e28db98cd41
+ last_write_checksum: sha1:f3b0428e08c0acc1ab9f3dbb5d8e919b26a64360
+ pristine_git_object: 3a6c8d42233ba3a84dbe6de486b3ca6d91070b88
docs/models/operations/EntityType.md:
id: 8a8fa61053f4
- last_write_checksum: sha1:fb4c51257cbf11c345b21f6fc21679aedc52adee
- pristine_git_object: 0930ef1ea58e20d7d78ed6abf362676ae9e5bd1a
+ last_write_checksum: sha1:1b8306ff727a4a1f12c363b8e50aba8ec8bab0a7
+ pristine_git_object: db5f9b5079227e14f7693cfc27da8a2b76b9feba
docs/models/operations/Errors.md:
id: c3e5b328c610
- last_write_checksum: sha1:74e9327b6c2f7015a45fd24b37ec1ce2624d7ff4
- pristine_git_object: 758d0f3f4a86bcd7cf06983304914fb50bc71eca
- docs/models/operations/Exclusions.md:
- id: 7b73096b78b4
- last_write_checksum: sha1:bf4ecda83c1eb2945cf3e1703b0592283d4a1936
- pristine_git_object: 20dff204b801cfbf8f81e8b9f7b757feddfea496
+ last_write_checksum: sha1:9797e990d0771853557c6f61d3690218d7e7586c
+ pristine_git_object: b9bf3593d6cb033be924aae665a2bc5d3855b7a3
docs/models/operations/ExperienceLevel.md:
id: 4076fb44469f
- last_write_checksum: sha1:cd507104bf16f7830ff5f271c9a1d71bc345d61b
- pristine_git_object: 4955b9e70e9347ea9de6420e1eb8c6a9295866c0
+ last_write_checksum: sha1:0b41f9f3cb1eb80cebf83268dca557d2b656acfb
+ pristine_git_object: d34c41fbe2dad88329b7a8acc80a8cb00f9a35df
docs/models/operations/ExternalPayrollItems.md:
id: 3a79f1fbfccf
last_write_checksum: sha1:8a6b87e859c3a780b00d3dd7eddb24ed5a1a09ec
@@ -2375,24 +2620,28 @@ trackedFiles:
pristine_git_object: 2844d11f57e3d8556447c57782c19c1f1449f380
docs/models/operations/FileType.md:
id: 9f7b4928e630
- last_write_checksum: sha1:5db636a356e724336fcc7dd3ca41971b89fc1a58
- pristine_git_object: d69a414f645db860dce03f251b6a0c3c485f07f8
+ last_write_checksum: sha1:0f5570119983ca76737e067ff8faeba7d776ab1d
+ pristine_git_object: 5365d38163c1654f11e8f4f7643cb81cf3916d48
docs/models/operations/FilingForm.md:
id: 17d1d66087ac
- last_write_checksum: sha1:1d470844d54a38dbd0c28cbdfda8f84e16402acd
- pristine_git_object: 2090c1a37c38c0a98886f34f464fe38a952dd227
+ last_write_checksum: sha1:5fef4e6dc7c0d7805d4680d792ad9459bee84db0
+ pristine_git_object: 7fe3880d6ab5d7f34be11cd5a6133540f1d2751d
+ docs/models/operations/FilingStatus.md:
+ id: d6342cf91545
+ last_write_checksum: sha1:7ec8dc2160f6adc3a6484480fdb2b0df177ba065
+ pristine_git_object: aa499e1bcea9a28fe97157deab0bd3b4c54fbb81
docs/models/operations/FlsaStatus.md:
id: 521ffcf778df
- last_write_checksum: sha1:7bf7ee1c331b016eec0129a5978df5556c7cfd3c
- pristine_git_object: 1b6a29bb933e4c444d4c786c052cfc19160f4760
+ last_write_checksum: sha1:1f81686b4409343368c8986b6a45422f09c98c96
+ pristine_git_object: 49c45d6924d3297cb5831057fcb50d5073c55e9c
docs/models/operations/Frequency.md:
id: 5516f4fa7be4
- last_write_checksum: sha1:7de57ea308cd4634dd1f1a65da312dfdbbf8b4ff
- pristine_git_object: a55b5ba7b381f3e616fb9095006eb21faa1dbab8
+ last_write_checksum: sha1:b81809d7ecb5514bd66f9f7c6078cb97997a78fe
+ pristine_git_object: 9c24cc1ec78ea925a7681d83aac6cc9866bf1fcf
docs/models/operations/GarnishmentType.md:
id: 9ced29af887f
- last_write_checksum: sha1:12f87b616ea7586744cdeb643ee78f0b7575727b
- pristine_git_object: e96ded8467793ae79158316d3daaebc806242fb7
+ last_write_checksum: sha1:c516fcfee61e23affc6477b2c3019b20936a801e
+ pristine_git_object: 0cfc0ce9b93ea6ee54c31275ee19e2c436daddd4
docs/models/operations/GetAchTransactionsRequest.md:
id: 0aa2de4a2f19
last_write_checksum: sha1:f09f0a5e9aa38004a908fda59786d7ffb8236aef
@@ -2443,8 +2692,8 @@ trackedFiles:
pristine_git_object: 32223bb134fafb43a9ad160b27e32b92643c6df3
docs/models/operations/GetCompaniesCompanyUuidSuspensionsHeaderXGustoAPIVersion.md:
id: 9bfbbe6a9894
- last_write_checksum: sha1:41c182e81508005b2b5224795f64fc648e82256d
- pristine_git_object: c5f07ee7145168d77973ab55bfce2ae9da220a8f
+ last_write_checksum: sha1:1157ff4f2e874ea07b19195d93627e90bfc10963
+ pristine_git_object: ac4232d98a47bb0aaeafa39d0eda8ee2c02ea442
docs/models/operations/GetCompaniesCompanyUuidSuspensionsRequest.md:
id: 096235f56331
last_write_checksum: sha1:29c93f72a50bcdabb1463952a637735b62a70a99
@@ -2471,8 +2720,8 @@ trackedFiles:
pristine_git_object: 243c5b8e1a3fdf8894bfb4cbd8733de14299f665
docs/models/operations/GetCompanyNotificationsHeaderXGustoAPIVersion.md:
id: ebac81b33ccc
- last_write_checksum: sha1:25067ea55adb7918de7c7214fc447337b1bc7500
- pristine_git_object: 6bb6bad75b820d4b8b2b2b90d254b366248d5259
+ last_write_checksum: sha1:1afec3bc5a7a2d9382ccf707495b34db72eabdf8
+ pristine_git_object: d93af367d935050c83945654030da424cfafd21a
docs/models/operations/GetCompanyNotificationsRequest.md:
id: ee6e9c165a35
last_write_checksum: sha1:537bad789e259ef5f7fa17ef62dc1d0a4f402c7a
@@ -2497,14 +2746,18 @@ trackedFiles:
id: e49c31746ce0
last_write_checksum: sha1:faf762942ed8eb5589c32fab9be89315acb16ace
pristine_git_object: 9dc4e5cc118e0ea842271624abc324a3733e4d14
+ docs/models/operations/GetEventsHeaderXGustoAPIVersion.md:
+ id: a069e92a3864
+ last_write_checksum: sha1:d9860ec29f18f639c41ed2142940a047c03424ba
+ pristine_git_object: ae84ba7504754a2c52a8bb36fd35586bc550749b
docs/models/operations/GetEventsRequest.md:
id: e6280d90fe7c
- last_write_checksum: sha1:2e0908386269c85a63823cd9d29625c95011ed41
- pristine_git_object: a7cf4ac810a26bcdba9dc2052da823f8882215b6
+ last_write_checksum: sha1:5cf910538b333719eb130fce563f6811a2c00beb
+ pristine_git_object: aa7a6c30ebcbd0fd7251f62bd1a02fae8d712f8d
docs/models/operations/GetEventsResponse.md:
id: c441cfe55d03
- last_write_checksum: sha1:aeb2ca79bbf2cd4f22570aa0e08146815155690e
- pristine_git_object: 4009f7e8e38a425498b0d9c2788b1a0c35d63ed6
+ last_write_checksum: sha1:9b2a27d4eafc55cb85fe9401717b248bbe1fbb96
+ pristine_git_object: b8dea1a5706501e06c24172586d76f72bcd84786
docs/models/operations/GetEventsSecurity.md:
id: 9abc2da821bb
last_write_checksum: sha1:d0c7b292fb1b20ef4333a94e6ddb301236eb7b44
@@ -2623,12 +2876,12 @@ trackedFiles:
pristine_git_object: 1d750dfc36ce198b536a5f7d8f257a07927bde72
docs/models/operations/GetV1CompaniesCompanyIdBankAccountsHeaderXGustoAPIVersion.md:
id: 8d313abd058e
- last_write_checksum: sha1:c786bd5a1d75d4b1ab6f31479093a72d45908794
- pristine_git_object: 695432df3d23ce85d61d7805ba52ef91e59d5412
+ last_write_checksum: sha1:8b4c4640081687d74b3ffd6e27924cd7aaeace2e
+ pristine_git_object: f8c5629099d9818392158d48ce70ab2246990099
docs/models/operations/GetV1CompaniesCompanyIdBankAccountsRequest.md:
id: 0172c7c55327
- last_write_checksum: sha1:0a4e40a33525dd20d42da199b2e604fbd96175a8
- pristine_git_object: c4756d3440dbb7b1f3b5e9c4209dae6a35fe1f44
+ last_write_checksum: sha1:bdd8acd4e07fcb141aab6becfd01ee52e4259bf6
+ pristine_git_object: ae7cc1e379cafbb459c5b767e2f056bc5340d317
docs/models/operations/GetV1CompaniesCompanyIdBankAccountsResponse.md:
id: d7938e615d22
last_write_checksum: sha1:48828075ade69368087845092ee299dda072be5c
@@ -2641,18 +2894,22 @@ trackedFiles:
id: db5edca40ad3
last_write_checksum: sha1:14ea444ca2f160f06b06c318fa95fbec00eda61f
pristine_git_object: 396a7ca8f370229a44027e48f51a5bba0ba6989d
+ docs/models/operations/GetV1CompaniesCompanyIdContractorPaymentContractorPaymentHeaderXGustoAPIVersion.md:
+ id: bdca758e795c
+ last_write_checksum: sha1:378429567d217b1f5d239caa50bf998d1fa160f8
+ pristine_git_object: 5ffdc4bf1c105d652f79ccca4f6eee9138e288a8
docs/models/operations/GetV1CompaniesCompanyIdContractorPaymentContractorPaymentRequest.md:
id: cf719e651903
- last_write_checksum: sha1:62c2de2d2b2ff0c7bea605761c7489be7d57b217
- pristine_git_object: a8819e6401c4d341d8d4d5b8a645e16858290357
+ last_write_checksum: sha1:4e1bac962387506308bca2ba653794348c12f373
+ pristine_git_object: ff7fec0e02e84dffbd36440c6824d66d09710cd8
docs/models/operations/GetV1CompaniesCompanyIdContractorPaymentContractorPaymentResponse.md:
id: 0edb4e31fb7b
- last_write_checksum: sha1:7d7ac6dfd97c3e9e490f18229950b137e9e4b2d6
- pristine_git_object: 0e9611cfbb6f312276cde7d2e935494d258d18b7
+ last_write_checksum: sha1:e15d6b1c9d9d37521dccc133ea3a72f21b6a4e49
+ pristine_git_object: a2c233698d569264d6687d97c3d30b85bd2c1016
docs/models/operations/GetV1CompaniesCompanyIdContractorPaymentGroupsHeaderXGustoAPIVersion.md:
id: 653ecda6972f
- last_write_checksum: sha1:3388e81473b88d2f243e96a62f4d6881e236cbd2
- pristine_git_object: 7081f2c3a65ff11d199edc0dec4f0f4cb9cc4547
+ last_write_checksum: sha1:5763cd0af906de7fedc04887f71413b6d9f3ce64
+ pristine_git_object: a888e13e817180032b3c422013a8ac413e69c095
docs/models/operations/GetV1CompaniesCompanyIdContractorPaymentGroupsRequest.md:
id: 75b0550b74c1
last_write_checksum: sha1:bbd88beb414a98c02c23669ae2a2a1c809185be3
@@ -2661,10 +2918,14 @@ trackedFiles:
id: 8a810e763279
last_write_checksum: sha1:d61be1e197fe5f6c884cd4f66f72623d2df1a78a
pristine_git_object: 8e8ce10020c1c7c51f678625d519803837ab20ca
+ docs/models/operations/GetV1CompaniesCompanyIdContractorPaymentsHeaderXGustoAPIVersion.md:
+ id: df00ea92a072
+ last_write_checksum: sha1:b1f398707be92dddeb3376b48d960340fa32c01d
+ pristine_git_object: 405e507483b8ccf54dd295adbd2055b616c15340
docs/models/operations/GetV1CompaniesCompanyIdContractorPaymentsRequest.md:
id: eb8d11df3ee0
- last_write_checksum: sha1:f6ed003558f7fee893a0ef21fc064fcbb783c179
- pristine_git_object: 2446d11d2b2b8cb5686eac4c365f7f9b7d44ebfa
+ last_write_checksum: sha1:46c7a0221e818d800b63c3f2cece755e2734a9d9
+ pristine_git_object: 30dbbe74d4055939dae4e2e63402fe916afbd442
docs/models/operations/GetV1CompaniesCompanyIdContractorPaymentsResponse.md:
id: 8bbfbcdb6055
last_write_checksum: sha1:7df04f117a14911b764f91bb31b2dcff2c774c4f
@@ -2675,8 +2936,8 @@ trackedFiles:
pristine_git_object: 1b04de20a150880064079f24898de5f51b9b6e15
docs/models/operations/GetV1CompaniesCompanyIdContractorsPaymentDetailsHeaderXGustoAPIVersion.md:
id: 64c8646b5e09
- last_write_checksum: sha1:79476b4a54885546cdf1b9af5037bc8c0ee2bc79
- pristine_git_object: 5233cec8af5ce9552b05e586ce2d6b532b14e165
+ last_write_checksum: sha1:03768b111f8cb7d34cab0d1c9cef95fed07330b2
+ pristine_git_object: 9e9e2b84be45f86500216363f06a38b363e991d0
docs/models/operations/GetV1CompaniesCompanyIdContractorsPaymentDetailsRequest.md:
id: 0f4c000da73b
last_write_checksum: sha1:3ba7bf4bd4917eebcca647ae8b16c3a7d3b013fd
@@ -2703,8 +2964,8 @@ trackedFiles:
pristine_git_object: ed34d173fa946ba5882c1bad0f23afeb078f1665
docs/models/operations/GetV1CompaniesCompanyIdEmployeesHeaderXGustoAPIVersion.md:
id: 83d3b930dba8
- last_write_checksum: sha1:6242c30a6cc70bf35c88a296a9ac6cd1e69846c5
- pristine_git_object: 3c4f82b4e5e38c8f4d88d084d9f70274b86e65fd
+ last_write_checksum: sha1:5834a388dcbb53e83dbf08028f11338149b92866
+ pristine_git_object: 363990a163c01e4ae11ce579cff7f6a547f0cf57
docs/models/operations/GetV1CompaniesCompanyIdEmployeesPaymentDetailsRequest.md:
id: 70e084a3e864
last_write_checksum: sha1:a162611125cff428e482f30d1db6aa71d7d7d51b
@@ -2729,22 +2990,30 @@ trackedFiles:
id: 31144abce6ec
last_write_checksum: sha1:40c4ea0f60bed96d8e440cef6c4a266a2fc813ae
pristine_git_object: 9be1752a0d3a60943450b82e94238c598f494c82
+ docs/models/operations/GetV1CompaniesCompanyIdLocationsHeaderXGustoAPIVersion.md:
+ id: a31146a66e2f
+ last_write_checksum: sha1:4eee6b17ab5263d71058be06998ba6397b0e5ce2
+ pristine_git_object: 944e68d80620cc3378cac79899db4beb15d1b903
docs/models/operations/GetV1CompaniesCompanyIdLocationsRequest.md:
id: dab021bdf121
- last_write_checksum: sha1:9af8a9c4cbf72596aac4e8c2a2cf5cec9aa444c3
- pristine_git_object: 904af4539486bf5865d976c9a10975ec27ca012c
+ last_write_checksum: sha1:4bc0111fbcfaff201cedaa333ceb81b984978d05
+ pristine_git_object: 201fa582abf00fc348c5ec8c5076c3e7132ad005
docs/models/operations/GetV1CompaniesCompanyIdLocationsResponse.md:
id: f05bdfe26d1b
- last_write_checksum: sha1:1944ebeafd6ec764b69892b3d57e025c8ac0b1ab
- pristine_git_object: 5d8c3a750d3285f4b004ab57a306a0e3257d5049
+ last_write_checksum: sha1:e345f8a36a470d7e7b378583320b34de962b4534
+ pristine_git_object: 326ba22316c54fe113f2f81732bbe9dda521155d
+ docs/models/operations/GetV1CompaniesCompanyIdPayPeriodsHeaderXGustoAPIVersion.md:
+ id: 37d0f928dcda
+ last_write_checksum: sha1:3ca5168320ae653b91e73751a1a8416fdba00a62
+ pristine_git_object: 2cc656c86cdbb3785b17d04b23917e311682ff70
docs/models/operations/GetV1CompaniesCompanyIdPayPeriodsRequest.md:
id: 7ff4cd7c45f4
- last_write_checksum: sha1:0b6c5d5d3d5fb58daaf74d94a437abc0bda74a7e
- pristine_git_object: 1de9e379429b5301cc07e064ffc2a66da6e1c044
+ last_write_checksum: sha1:8c4b83fcca71195b8bcef30c109fd77c3cdc80bd
+ pristine_git_object: 0c6f6de1aa03f9553119870e7a60d66f3c9e041c
docs/models/operations/GetV1CompaniesCompanyIdPayPeriodsResponse.md:
id: 1e97dc2e2c12
- last_write_checksum: sha1:8604dd5fa634bb85140d2d48d916dcfeadf742e1
- pristine_git_object: 1d5b8c9e7192f428df9767c2a41dc5871cba4993
+ last_write_checksum: sha1:ca998f428d57f0b9b96dca2142357c27fee6cf93
+ pristine_git_object: 4ce4b2a78e299cf8501cf33849d77bde023928c1
docs/models/operations/GetV1CompaniesCompanyIdPaySchedulesAssignmentsRequest.md:
id: c74126a4fa99
last_write_checksum: sha1:339c6332a2950fb1e8afb61433dee6f80297e3b8
@@ -2753,34 +3022,42 @@ trackedFiles:
id: 61ed0394b320
last_write_checksum: sha1:c04bbba81fbceccbdfaf01336322a0085f3b2559
pristine_git_object: 3ff845f7e21a61416eac8c1400af65cd0b43faa8
+ docs/models/operations/GetV1CompaniesCompanyIdPaySchedulesHeaderXGustoAPIVersion.md:
+ id: b6dfae53ec9d
+ last_write_checksum: sha1:f0f589a4b39c9d116b4f65db5e9a7541d0792051
+ pristine_git_object: f8967f04df20885731b18c4d60d8c45ad522c0de
+ docs/models/operations/GetV1CompaniesCompanyIdPaySchedulesPayScheduleIdHeaderXGustoAPIVersion.md:
+ id: 212c488aeb42
+ last_write_checksum: sha1:70e608605935b2aed1c3b619176ba1364c901ef1
+ pristine_git_object: d0accd4587fba0591e7a4d243536b8fa3f3507c5
docs/models/operations/GetV1CompaniesCompanyIdPaySchedulesPayScheduleIdRequest.md:
id: 307118a895c3
- last_write_checksum: sha1:29bd4dcdf97c364061b0ca0d64c4169b008aace0
- pristine_git_object: fb4fd748710183b835271bfc7229c18b4f02d41f
+ last_write_checksum: sha1:c3ce0f650cc8c438b83e955ad204b1d71f78da84
+ pristine_git_object: 0cff584d702eff095f2425527f1cbfc2c521c160
docs/models/operations/GetV1CompaniesCompanyIdPaySchedulesPayScheduleIdResponse.md:
id: 77a6e15b5f78
- last_write_checksum: sha1:02e8e6a2cce99adfdba75aec3d1105c07d13d78d
- pristine_git_object: dbbac13052bc6c461befb69cb4ad2bb99d389dd2
+ last_write_checksum: sha1:8be4fb10abcadea1043f8f1b4d46dc4c16cf19c7
+ pristine_git_object: c4b70b40d7d368232b7c24144358d95f63530a4c
+ docs/models/operations/GetV1CompaniesCompanyIdPaySchedulesPreviewHeaderXGustoAPIVersion.md:
+ id: 33aae381a7cd
+ last_write_checksum: sha1:899b5089e241831def9cc2feecb1c4aaf2aa2be1
+ pristine_git_object: df4c473e3b1e592117a1f47bc60b98f5cf775061
docs/models/operations/GetV1CompaniesCompanyIdPaySchedulesPreviewRequest.md:
id: 30f0114598e4
- last_write_checksum: sha1:5bf6de85e5e21f4a01685a2fa212fced94654654
- pristine_git_object: 702af7450aeb66af024e0b0e09dceddbac5d20eb
+ last_write_checksum: sha1:bad682560a4022750c9b581aefd4c81c7934d487
+ pristine_git_object: e15578a8155484b3cf72a7f5ed8efbd686742dde
docs/models/operations/GetV1CompaniesCompanyIdPaySchedulesPreviewResponse.md:
id: 1554fe3909c9
- last_write_checksum: sha1:2f323f37d575de912a8ddae3354dcbe458511035
- pristine_git_object: 1b0126d3d46c4bcbf2d847f9d94150acbe589014
- docs/models/operations/GetV1CompaniesCompanyIdPaySchedulesPreviewResponseBody.md:
- id: 8c1aa5425555
- last_write_checksum: sha1:be79f1867a4d88db29a6183d9b9d91996c1b7e65
- pristine_git_object: 78fb36eabcac225842c0bf9eff16f8d489d63091
+ last_write_checksum: sha1:17d4c361f1b3a3dbeda348d19ff9e0fa13023166
+ pristine_git_object: 78bbec10d7c26206d989abff3127bdb14f916e18
docs/models/operations/GetV1CompaniesCompanyIdPaySchedulesRequest.md:
id: de20993bd10b
- last_write_checksum: sha1:711a2d834307b016eea7afb32f64679a0b3f8973
- pristine_git_object: 49ea3d2bdf0e33b821305a1a40b493cf51b393c5
+ last_write_checksum: sha1:5048d10fca99b06ed75f231b5c7300c3176498c9
+ pristine_git_object: 0f160e8c449b1822626ccb93dace63205ac39ad1
docs/models/operations/GetV1CompaniesCompanyIdPaySchedulesResponse.md:
id: adee5caaa2ba
- last_write_checksum: sha1:c4ab239eb33900670fc3f02d1956c6108898446f
- pristine_git_object: 48eaeda4d65fe237c8bcdcfa95259f7c04988fd2
+ last_write_checksum: sha1:a1324db26e79afd0de1fbed9b4a52ddc1a5dc476
+ pristine_git_object: 5d71293820e231d5845350d9f6c3c37c62950634
docs/models/operations/GetV1CompaniesCompanyIdPayrollReversalsRequest.md:
id: bb087fdd3ff8
last_write_checksum: sha1:c951e4e466bd96e36f908e0c17b4d6030e46ed80
@@ -2791,12 +3068,12 @@ trackedFiles:
pristine_git_object: 8e78581f30c00f6ad7c761672b34f145622457ba
docs/models/operations/GetV1CompaniesCompanyIdPayrollsHeaderXGustoAPIVersion.md:
id: d6f6fd9ccf50
- last_write_checksum: sha1:eb9326b5e9b0fc6ebc4b99f3be9ee9b8d76c1022
- pristine_git_object: 449416403282561db6f8c556c20da968a02434f4
+ last_write_checksum: sha1:1a00d0ac97082fccdef95a0192bcd0bca6dd00dc
+ pristine_git_object: 72d351eb2659fea5a1150b2f886b5c4cee26252a
docs/models/operations/GetV1CompaniesCompanyIdPayrollsIdPartnerDisbursementsHeaderXGustoAPIVersion.md:
id: 590a9a8d664a
- last_write_checksum: sha1:5d40f4e1a8735618d9a764a83db5fb54bb429877
- pristine_git_object: a21c2e4b0abec2f9f56b55b84285f251b8bed977
+ last_write_checksum: sha1:904168303af5dc0f0efb99b30cfe682716e99fef
+ pristine_git_object: c64f3e11e8cb8fd02b1bebdb57d877489cb3919b
docs/models/operations/GetV1CompaniesCompanyIdPayrollsIdPartnerDisbursementsRequest.md:
id: 46107c379f6c
last_write_checksum: sha1:f2b5cb0e28998546d2a118dd55af0e5b579a8bbb
@@ -2807,12 +3084,12 @@ trackedFiles:
pristine_git_object: 68dbb16d967ea3148b17df0a55c53cd0e9fac0c5
docs/models/operations/GetV1CompaniesCompanyIdPayrollsPayrollIdHeaderXGustoAPIVersion.md:
id: 1e9dda84c69a
- last_write_checksum: sha1:88f6404cc56dc0ded35422d24f702c2e77659c00
- pristine_git_object: de8ad3d6110babf2a66fd6b253878ee71f86aa0c
+ last_write_checksum: sha1:7772f791a0e7957a3201e2ea06f287f24fc7f887
+ pristine_git_object: 68dfd6c90d877cc9015ba2149cd9e45a3c98921f
docs/models/operations/GetV1CompaniesCompanyIdPayrollsPayrollIdQueryParamInclude.md:
id: 8ca73a4b2346
- last_write_checksum: sha1:9cb28f436ab9ec6b6e5c48a1120daa358c71f4f3
- pristine_git_object: f29e9ebee693d5b2a3ad1e5d415470893bf35d10
+ last_write_checksum: sha1:ede174e8c2bf417be7961f861297dde265dad2b2
+ pristine_git_object: 164107bb154e13038e961b3251615428aa3900bc
docs/models/operations/GetV1CompaniesCompanyIdPayrollsPayrollIdRequest.md:
id: e1853df6e4ed
last_write_checksum: sha1:257694c362abcd5d84046613167ba26e6cd8f874
@@ -2823,16 +3100,16 @@ trackedFiles:
pristine_git_object: 04587d10ab0961f678847a89ed208162c2250caa
docs/models/operations/GetV1CompaniesCompanyIdPayrollsQueryParamInclude.md:
id: e3cd792f8ad6
- last_write_checksum: sha1:b5bd8c1d418cdea02d419c2d398a4f043af1e94d
- pristine_git_object: a8884d47370d291eacc93c34b4483b2dd65e2e26
+ last_write_checksum: sha1:885627d4f6646974e80174970e7a0214b84d6faa
+ pristine_git_object: be2b4a7f307767c027397b26f8d962a0c9c39b69
docs/models/operations/GetV1CompaniesCompanyIdPayrollsRequest.md:
id: 82e5a165e4cd
- last_write_checksum: sha1:e938f49230659715738b2a1b6f819790f1f52ae1
- pristine_git_object: d8ca3d09a48098d46b146bd96324b9f6da3b1653
+ last_write_checksum: sha1:1c2ade990f8d47219e59e2efeeb15fd23f1d9571
+ pristine_git_object: 23577d532dae64d8d5e115359bc8f967e5759c4b
docs/models/operations/GetV1CompaniesCompanyIdPayrollsResponse.md:
id: 9919e264e26d
- last_write_checksum: sha1:6a2a29d1fe0ad850a6d64edb76b00b53f0ea38fd
- pristine_git_object: e417892247f5192d43920e5f68d334d451df8161
+ last_write_checksum: sha1:7a067abd64be01479b4ac917faa441cfaa421540
+ pristine_git_object: 7f6c1b4754a2008d212b0652088faca81f606878
docs/models/operations/GetV1CompaniesCompanyIdUnprocessedTerminationPayPeriodsRequest.md:
id: bd8107ab9a82
last_write_checksum: sha1:19466b8a4c6897658b25b3881b9b24386a2a58c0
@@ -2841,18 +3118,22 @@ trackedFiles:
id: 8261fd11d36c
last_write_checksum: sha1:b05cbde72bdb32790d6c8c5f3cef54edd50184a2
pristine_git_object: 92cb9172cb6830d1906e54f0d817ac58af852cbb
+ docs/models/operations/GetV1CompaniesCompanyUuidContractorsHeaderXGustoAPIVersion.md:
+ id: bbf8de99f1a5
+ last_write_checksum: sha1:c05b4140dfece754320cbde23dbd4f4783f6e606
+ pristine_git_object: 958be09ea5fd12c4de2dd805d8ba76821ef238e4
docs/models/operations/GetV1CompaniesCompanyUuidContractorsRequest.md:
id: df590f5cfb44
- last_write_checksum: sha1:86dba3b88a9b2984f7e11f022efaf02952b3530d
- pristine_git_object: bf21aaccbec3fc46239a9300a6b1114982ca99e4
+ last_write_checksum: sha1:06493c59249607ba9b0c8ff814fc71f1021e3b9f
+ pristine_git_object: 01d95479d5f425d60a062c4b0d9cd07a0b7f238c
docs/models/operations/GetV1CompaniesCompanyUuidContractorsResponse.md:
id: 9ca24eb0ea7c
- last_write_checksum: sha1:d3ca1ef826aa0ce715a0cb9c8368e60c58fdc4ac
- pristine_git_object: 5e275b38424a4629fd5e4118b982c2a0ae440239
+ last_write_checksum: sha1:19d24eb5c543e666f6414058b7289175ae42448e
+ pristine_git_object: e7fc1cc300d31a57c3ea2a0fa6cfd432b8dc4736
docs/models/operations/GetV1CompaniesCompanyUuidHolidayPayPolicyHeaderXGustoAPIVersion.md:
id: 0368ed0ab639
- last_write_checksum: sha1:1e9458b6fd358d68f9b0c3a68b2fd6e36aa7fab2
- pristine_git_object: 3d64553679d08341bee005c97d64b11f7f2b03bc
+ last_write_checksum: sha1:bb0b578a67c97dfc037bbff04224f2aa63c13df9
+ pristine_git_object: 520bc6c62d882b3487321a2e539a91389dd72d57
docs/models/operations/GetV1CompaniesCompanyUuidHolidayPayPolicyRequest.md:
id: a6c71c2f95df
last_write_checksum: sha1:4eed9b4ad51efd2ec0bf77c6895b061d0baea71c
@@ -2861,14 +3142,18 @@ trackedFiles:
id: 511fccf76340
last_write_checksum: sha1:2477212475be1129aff71e7783c5eb2e8c01df5d
pristine_git_object: 9af80f4a8f627be1a80157b5a58b3bc8a59d03e7
+ docs/models/operations/GetV1CompaniesCompanyUuidSignatoriesHeaderXGustoAPIVersion.md:
+ id: d2941e52380a
+ last_write_checksum: sha1:c9ba35c392edb4acbc83ffaff0919386215cf71e
+ pristine_git_object: 182ed64f0308576cc962e5c37c3f88d37fc5cd45
docs/models/operations/GetV1CompaniesCompanyUuidSignatoriesRequest.md:
id: 99a788e4745d
- last_write_checksum: sha1:7e64257dfd926236aee3e8f96d3a989a39e01666
- pristine_git_object: 59c5006cb8ec21c83cb0979b20aa8b46ddb5490a
+ last_write_checksum: sha1:e59e641f53a05f212253561f0ef56c589394e38a
+ pristine_git_object: d663e119ca91bd3faec3dd0c784f277a2b30dc8b
docs/models/operations/GetV1CompaniesCompanyUuidSignatoriesResponse.md:
id: 6f324970bfae
- last_write_checksum: sha1:ec6b31564782dce05d770dc93356e2a38fdc3e21
- pristine_git_object: 1287c638a1f5016b5b5927d2f36029417ad654eb
+ last_write_checksum: sha1:7c292dffbf17ed17021b5f3e3a3891de28c779e1
+ pristine_git_object: 185196db791491cd72c0550622d876d239bb821c
docs/models/operations/GetV1CompaniesCompanyUuidTaxRequirementsRequest.md:
id: 80204602e739
last_write_checksum: sha1:fec3d3070f270ed28bf3fec9b1f255a11eb46295
@@ -2887,8 +3172,8 @@ trackedFiles:
pristine_git_object: 5deeef50faa8ddde6e49a49024d8e242ce542298
docs/models/operations/GetV1CompaniesCompanyUuidTimeOffPoliciesHeaderXGustoAPIVersion.md:
id: 54ac3f7f0e41
- last_write_checksum: sha1:bb2a30e0e25fce3334bb37b8cd9a3fb652867c74
- pristine_git_object: 396c0778aed0f3a967b1880a3beacd9716c5b831
+ last_write_checksum: sha1:779a8c3e08f27d8b3484462f80d107b344ce39ac
+ pristine_git_object: df9df3b7277548f78ab030f4295043764c1c85a6
docs/models/operations/GetV1CompaniesCompanyUuidTimeOffPoliciesRequest.md:
id: ab9d54a363be
last_write_checksum: sha1:9e3cbe961ea906d816c729ce2732656fb36c0f22
@@ -2897,22 +3182,30 @@ trackedFiles:
id: 283a2a7b4891
last_write_checksum: sha1:5f2398a9e6989d76af44c27ddad6375f42e84ef1
pristine_git_object: e19bb7fd6f2926bdea7e9892684ab2309b99d628
+ docs/models/operations/GetV1CompaniesHeaderXGustoAPIVersion.md:
+ id: 34a5614005f9
+ last_write_checksum: sha1:c28cdd849da3e6f2a0cdc9e0ef6f83778083e546
+ pristine_git_object: 198e604b10b432acf8712d89bd3c2641f414403a
+ docs/models/operations/GetV1CompaniesPayrollBlockersCompanyUuidHeaderXGustoAPIVersion.md:
+ id: ac8bbaf4305d
+ last_write_checksum: sha1:e1c443b2cd940a9e0575b97d5747189cf706e42b
+ pristine_git_object: 790f9f37fdb039e6843835afdbfbc3cb330bd52c
docs/models/operations/GetV1CompaniesPayrollBlockersCompanyUuidRequest.md:
id: 3de49ea9cbe1
- last_write_checksum: sha1:67f9737e411bb4831d1a580b251bd765e9c4e9da
- pristine_git_object: a47cc660f1fbc111cb5138d5385be67fce6d13b9
+ last_write_checksum: sha1:9bbbcdbccd1fea125e914992f65a9fa8790f51b6
+ pristine_git_object: 205699585829b1f3fe1d11a26618ca8f5b4fb334
docs/models/operations/GetV1CompaniesPayrollBlockersCompanyUuidResponse.md:
id: e8be0f85f7b8
- last_write_checksum: sha1:02aa623d8b147279b0b7c40e9fc21d8bb341de4b
- pristine_git_object: 456d9900c5b8dea39670fe93ce2b1ff137f1886c
+ last_write_checksum: sha1:5d697d30f685b8fa73ab6046008a8ff80d551ff7
+ pristine_git_object: 9a2b4720439666117663762665c928d162bec579
docs/models/operations/GetV1CompaniesRequest.md:
id: 6415242b650e
- last_write_checksum: sha1:7857e7f4984bda649c6afd678dae8f1d79499ecc
- pristine_git_object: 580d9990be22c2746777b366d4cc0ac202ac66f7
+ last_write_checksum: sha1:e2c9c6a104c64b8b27d4c0ec89792346a0dca32a
+ pristine_git_object: 6e2ad32276a44899c2518bb2c19dad6dd596ce38
docs/models/operations/GetV1CompaniesResponse.md:
id: 3af5aadb9476
- last_write_checksum: sha1:0ffe7d8e6f7b18ba9bee85ec53a9757429d64217
- pristine_git_object: 14b7749700c7ae71e758ae413a001de5e6466d7d
+ last_write_checksum: sha1:363fef63d6b2b38ccb4ca9a2912140caccafa316
+ pristine_git_object: e53602384caf8c7ac3c6412b6e5ba712856ab6cd
docs/models/operations/GetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsRequest.md:
id: 5c186b70e199
last_write_checksum: sha1:bfffd9d3b2e5c2bc0d1ceea7edb01e1d31a2648d
@@ -2923,8 +3216,8 @@ trackedFiles:
pristine_git_object: 6f7f4f469c3e65148306fe9c4485738a7993280f
docs/models/operations/GetV1CompanyBenefitsCompanyBenefitIdEmployeeBenefitsQueryParamInclude.md:
id: 555a99b96903
- last_write_checksum: sha1:3313e3af20f12aea0b4ac5e7995dbfd12ed828ea
- pristine_git_object: d5dea648889dee7c1696f1ac5569d7e75fc3e750
+ last_write_checksum: sha1:101ffe37a85d7d62a1b93563c05eb36cf94f5e38
+ pristine_git_object: 3e6b1aaf7835592c0e0c33137a441240b2d432a4
docs/models/operations/GetV1CompanyBenefitsCompanyBenefitIdEmployeeBenefitsRequest.md:
id: 7128800f1a6f
last_write_checksum: sha1:f0b2bdac95ba9a23f32b062252ca41cea54549fc
@@ -2935,8 +3228,8 @@ trackedFiles:
pristine_git_object: c4da613e69f51b8603d88bf0467bba9bc4f097f5
docs/models/operations/GetV1CompanyBenefitsCompanyBenefitIdQueryParamInclude.md:
id: a3cdb2d2265b
- last_write_checksum: sha1:911cce8e3c7e1ecd26d56851dec87c7c72279dfe
- pristine_git_object: 3f1306614c45de0e70dde85c1bc37fdc16e9f583
+ last_write_checksum: sha1:62e87fd55810a7002c75dd983ca712594f787c41
+ pristine_git_object: 34acf295a38023b9e6a0db67ebf47ecd56c781b1
docs/models/operations/GetV1CompanyBenefitsCompanyBenefitIdRequest.md:
id: 7a402d542126
last_write_checksum: sha1:39fbf746405e44312e0f4e80b9a9f67654fe7411
@@ -2953,14 +3246,18 @@ trackedFiles:
id: b326251112a8
last_write_checksum: sha1:ccc5f695c73b0134db0a8b18dbbfd532dec754ab
pristine_git_object: bfbca6fd1c00cd0742c416111655a59f6d6261c9
+ docs/models/operations/GetV1CompanyFinishOnboardingHeaderXGustoAPIVersion.md:
+ id: 4ba7a7d713dc
+ last_write_checksum: sha1:796849ef1f53b261e29d072dfdfcaba54abf39f8
+ pristine_git_object: 55898c096fe0b099c630740ae40d35b604562f8a
docs/models/operations/GetV1CompanyFinishOnboardingRequest.md:
id: ddebb45f22a9
- last_write_checksum: sha1:e8a149af3784d9b8bcbefc38fa42e1023d88eef5
- pristine_git_object: 012ebb138f4e4ed5271d94e81b2e3241e50966d4
+ last_write_checksum: sha1:284ffbed5beffc0674fc8d68b6040f91fe2f5073
+ pristine_git_object: 387d5e5827ed4a1af453947a65a9b7814581a55e
docs/models/operations/GetV1CompanyFinishOnboardingResponse.md:
id: 3f52377acc70
- last_write_checksum: sha1:8bcffa0eafc35de915a29c2d6b783337226a84af
- pristine_git_object: cef61486ec3ae655b771261cf57472dd3d3529a0
+ last_write_checksum: sha1:ee2b4481e01439c5dba861c830ea1cdaf5357a91
+ pristine_git_object: b6809c7e5c06a8936994d220bea1ba17c80013ba
docs/models/operations/GetV1CompanyFormPdfRequest.md:
id: 2e05f774d621
last_write_checksum: sha1:659f40f56645f98f1deb70ab313b8829b450aa26
@@ -2979,44 +3276,60 @@ trackedFiles:
pristine_git_object: ec55546e4127c5b31aa925f9115e58ffafbae4dd
docs/models/operations/GetV1CompanyFormsRequest.md:
id: af4c3a21fea7
- last_write_checksum: sha1:486d92fdc050d2856ab6e73741c0bf3b0ba763df
- pristine_git_object: b1a6028817b2f4584644969e752c8ad289b171e0
+ last_write_checksum: sha1:21a06b25dfc46fcf51eafb31040e32ec52cba5df
+ pristine_git_object: f927c8edda965314dc06f21ab259592c972d7500
docs/models/operations/GetV1CompanyFormsResponse.md:
id: 2e0a4329d876
last_write_checksum: sha1:55ece5ffb0828044995187ceff5d705dffa9d65f
pristine_git_object: 29a3d40ba2533ca5db9936726d6d41c93e43329f
+ docs/models/operations/GetV1CompanyIndustryHeaderXGustoAPIVersion.md:
+ id: bc19564db861
+ last_write_checksum: sha1:e64654e06680680935f12bf61f8e115eb3e56ed9
+ pristine_git_object: 31bcbfc68db8106f84c75690ceb5224ba46b5820
docs/models/operations/GetV1CompanyIndustryRequest.md:
id: 7f19e772f30d
- last_write_checksum: sha1:9ef5b40e649f1d3af3cb36eb68dfc986daf99084
- pristine_git_object: 258a18a05038b5e884d0b026cd736e9615b3a667
+ last_write_checksum: sha1:39169952b430f42c3f18dca11e9fdb2596a70c24
+ pristine_git_object: b6a7b04f592d62ab2fca8dcb65287b00f3951a7c
docs/models/operations/GetV1CompanyIndustryResponse.md:
id: 724db0239d57
- last_write_checksum: sha1:469098364d66b50098d7161a74e98bf97558da7a
- pristine_git_object: ca01feb1a4adaf2c17680043ab24faef34ea2ab1
+ last_write_checksum: sha1:45d96531329d75de9ff32d1b0efc9c6342a35139
+ pristine_git_object: 39240f39702505b6efee3fe65ea96cf9ff3dffb9
+ docs/models/operations/GetV1CompanyOnboardingStatusHeaderXGustoAPIVersion.md:
+ id: 3447d20406a8
+ last_write_checksum: sha1:31be643490ed9cae0ac13b1dacd547095ce2fbfc
+ pristine_git_object: de16c2d40b1e01a0951092a1953b3ae707a84f6f
docs/models/operations/GetV1CompanyOnboardingStatusRequest.md:
id: 85feafbfed12
- last_write_checksum: sha1:c16e5b4f7fcdd90c119e58137d34f3929f03274b
- pristine_git_object: ab199f701eb311b1dabef5294090725e56a0f265
+ last_write_checksum: sha1:71b5190a2e7302f895a3dabe2262328a46aa9944
+ pristine_git_object: 3292469c35aaf76b948d5edaf781111bc352ef90
docs/models/operations/GetV1CompanyOnboardingStatusResponse.md:
id: d6eb5cb8dc0d
- last_write_checksum: sha1:7ef011474a2fef7db0ab76325edb308fb2f87e77
- pristine_git_object: bf61045c320b1a1efb8a50aa5b4bf64262d706cb
+ last_write_checksum: sha1:ba0004687693db506d5bd47fc1fe99db3f6b8bfa
+ pristine_git_object: ea9e0a137cc5db78dd6576110188dd86a7e3b84e
+ docs/models/operations/GetV1CompanyPaymentConfigsHeaderXGustoAPIVersion.md:
+ id: 6969153b3269
+ last_write_checksum: sha1:84e55af8b12805932fb991c17e0a5154ae0b0c29
+ pristine_git_object: bb43c7bc174b862770ab7cccf52baee9c4a79110
docs/models/operations/GetV1CompanyPaymentConfigsRequest.md:
id: 4ecc04be93e7
- last_write_checksum: sha1:2d9f99d47ca7b8f6d81547bd9ca3ad3bf872afb9
- pristine_git_object: e26ac7e938897ebd4a4fa861c9a98980c56e87f3
+ last_write_checksum: sha1:01570945d4eaa154b18cc7ba161c2a915bf67291
+ pristine_git_object: be896f8d0007e007bfc1003c07813c8c5f05f278
docs/models/operations/GetV1CompanyPaymentConfigsResponse.md:
id: 8925d582b9db
- last_write_checksum: sha1:2a291904a1bf74ad5b1f0276256b5834f51118e9
- pristine_git_object: 9a5d671bfff3b019db11c2e7299bce61aa291977
+ last_write_checksum: sha1:6fed90d24f67d83a8e5e242e3f9758af834142f9
+ pristine_git_object: e802f352db51adf996a05f4898b07637d8730805
+ docs/models/operations/GetV1CompensationsCompensationIdHeaderXGustoAPIVersion.md:
+ id: cede571362c9
+ last_write_checksum: sha1:4622399604c8241d362685a38e1a536386317461
+ pristine_git_object: 7c34ec289325540a846ca9b8a6194f19e3530b31
docs/models/operations/GetV1CompensationsCompensationIdRequest.md:
id: 89875530528e
- last_write_checksum: sha1:b8bfee62f556860df2f360cd5132a0a17a896b31
- pristine_git_object: 684fcd7a440f95b16059180132bd8152465c2592
+ last_write_checksum: sha1:711bcbb76c26f744e4821eafc57a172adb9b871a
+ pristine_git_object: 29d6d25ecf5b132503c5806e538056126a98032a
docs/models/operations/GetV1CompensationsCompensationIdResponse.md:
id: b27490127e8e
- last_write_checksum: sha1:85289971b867d28b5461098f98a8e22dbea19eda
- pristine_git_object: 29be922047a4378b5848fe1f6f36738608d1c18e
+ last_write_checksum: sha1:a520b43c12fc61bc70c79a3e3a18f89aac301868
+ pristine_git_object: b1931a0c6e1dadc99ae598eea2ae264d0f28be77
docs/models/operations/GetV1ContractorDocumentPdfRequest.md:
id: 5dd0465bedcb
last_write_checksum: sha1:9e7f6a40683a044c437dcf80a84b35898be14de3
@@ -3067,8 +3380,8 @@ trackedFiles:
pristine_git_object: 7121978f9011b6ef9f6ea2e5c1653785898f4111
docs/models/operations/GetV1ContractorPaymentGroupsContractorPaymentGroupIdHeaderXGustoAPIVersion.md:
id: 7646220febbd
- last_write_checksum: sha1:923ab75a923d3b15dc3f53a2549070254987485c
- pristine_git_object: 60992e637e24b590518306bd1a3e0e60e9a4a14e
+ last_write_checksum: sha1:8aa49e1f1721bb3d626100bfcda611e4b05f0fe7
+ pristine_git_object: 188b335c8d6b41ce0fc3e590a5bd64e8672d5984
docs/models/operations/GetV1ContractorPaymentGroupsContractorPaymentGroupIdRequest.md:
id: 65524fd5dfcf
last_write_checksum: sha1:23901a013f7e4fa9170b87395889acfbb41bedfd
@@ -3079,8 +3392,8 @@ trackedFiles:
pristine_git_object: fc344be0843e3f24d5a8c6d7cb31664e6330353a
docs/models/operations/GetV1ContractorPaymentGroupsIdPartnerDisbursementsHeaderXGustoAPIVersion.md:
id: e1d1a6574a20
- last_write_checksum: sha1:3f5534a580f1e30db0ae325f287e2087c54885f5
- pristine_git_object: cd231f22ea332037afd42b9c90e7f5d78ac57bac
+ last_write_checksum: sha1:6f3f534f76f43589eac856ed7dbfe38b330b8b65
+ pristine_git_object: ec83ea01fd6d4fb37289ae6b1c5b3dac053243ee
docs/models/operations/GetV1ContractorPaymentGroupsIdPartnerDisbursementsRequest.md:
id: cfc94efa23b1
last_write_checksum: sha1:34053502e7ec7a07fd8c7a12c31809e7700493f1
@@ -3121,6 +3434,10 @@ trackedFiles:
id: 9610b68a415b
last_write_checksum: sha1:c1399a78afebf12c6707119c453fbe37aea9a8e7
pristine_git_object: d18f4ab1332b68b48dcb0f3f944f4e4f0d53bca0
+ docs/models/operations/GetV1ContractorsContractorUuidHeaderXGustoAPIVersion.md:
+ id: a6a7a0e5f9fe
+ last_write_checksum: sha1:226fb35cce4877e3110c161091d6a7af7a188c93
+ pristine_git_object: d9c8df9fedbb896edaa7c9c5225faeb58cc37da2
docs/models/operations/GetV1ContractorsContractorUuidOnboardingStatusRequest.md:
id: 649c3c12898c
last_write_checksum: sha1:a37b70649a741497e8451f71c8c88f08f9ef21e7
@@ -3139,12 +3456,12 @@ trackedFiles:
pristine_git_object: f2047935f35d394ddf88fd0fcc6f2bfbc21755f1
docs/models/operations/GetV1ContractorsContractorUuidRequest.md:
id: 0ddb9d7d23ea
- last_write_checksum: sha1:5ce330f5a31f57752129ec4b7ec5c7e598cef62f
- pristine_git_object: c134e14403ff8aac8b4cf2690f12711ca12b228c
+ last_write_checksum: sha1:f54e0b41146c6cff9e280fcfb41b9d6fc39df431
+ pristine_git_object: 0820aaebf80795a685e224e893191dd5effbb2a3
docs/models/operations/GetV1ContractorsContractorUuidResponse.md:
id: c0af627968dc
- last_write_checksum: sha1:41ec04b61e9bb60982ea8a297a580e6c592944f8
- pristine_git_object: 7e453b134529c86f14a3a89bf72733ca5429e13c
+ last_write_checksum: sha1:e66406b0c3620f76cdae7c0221bd0cd9b57860de
+ pristine_git_object: ff23c408885d7c82fb24307d7c20a81816fe5dc4
docs/models/operations/GetV1EmployeeBenefitsEmployeeBenefitIdRequest.md:
id: 6c14342416ff
last_write_checksum: sha1:c1ec83ce215a6ad30835b9abfa2fea170f92cdd2
@@ -3199,8 +3516,8 @@ trackedFiles:
pristine_git_object: b5b81cc9b40f39da63a33c22c0d6051729cac6ea
docs/models/operations/GetV1EmployeesEmployeeIdEmployeeBenefitsQueryParamInclude.md:
id: 03e522ca8f70
- last_write_checksum: sha1:4b8358ed5f613f195a8bd82af227d9e713d540f3
- pristine_git_object: cfaee2b0031ec80f91a95060a044d369eff9f1dc
+ last_write_checksum: sha1:cdf3ab3af785fa8a63972f7f62bd35283c866bf4
+ pristine_git_object: 49679ef0ff1a500365eacf66109ea73a7538287b
docs/models/operations/GetV1EmployeesEmployeeIdEmployeeBenefitsRequest.md:
id: 0fc9d0b5cf4c
last_write_checksum: sha1:ce8f140bdab4243af21fafb399f8bbfbcbd8609d
@@ -3211,8 +3528,8 @@ trackedFiles:
pristine_git_object: 6c908f58c1844956c9a91ea31407c4f5bc3d00f0
docs/models/operations/GetV1EmployeesEmployeeIdEmploymentHistoryHeaderXGustoAPIVersion.md:
id: 1faff9c36d50
- last_write_checksum: sha1:6de4f4b80627c3cbf2b49546b24e73bb08ab4c55
- pristine_git_object: 86d66e26b7b998b24e8646f954801ca5b1da0a64
+ last_write_checksum: sha1:ced840bb2ba9cdef8bb68ee4d460908d375b3414
+ pristine_git_object: bf4cdeadb705be0de328f71d4c250b8c10eed36b
docs/models/operations/GetV1EmployeesEmployeeIdEmploymentHistoryRequest.md:
id: 3da834b7d912
last_write_checksum: sha1:853e2dd87cbf8a9cbffad26cb2c77ad31a40c1cd
@@ -3221,14 +3538,18 @@ trackedFiles:
id: 5d589957d73a
last_write_checksum: sha1:1fee9cf2b12fea2e740c72cb3b8ac4926f66b76f
pristine_git_object: f07003a7d39c1bd4e3eca0c80ace2dac296f8a5d
+ docs/models/operations/GetV1EmployeesEmployeeIdFederalTaxesHeaderXGustoAPIVersion.md:
+ id: f3dcf2b802cf
+ last_write_checksum: sha1:d76053347f94c17760a30b458ae1ef1bd6e6ad6a
+ pristine_git_object: 0ca69f2a4a964c0ebdf1a3c54c65be3c86e93419
docs/models/operations/GetV1EmployeesEmployeeIdFederalTaxesRequest.md:
id: 8bd62f785daa
- last_write_checksum: sha1:7cfba4c2b927809178373703ebc35e9c4bb21f41
- pristine_git_object: 9fa75d70e29a38df3045fc9388f0dc9d6e93ffdf
+ last_write_checksum: sha1:e0740fd5eeec748f314887cfd8f55a15ed9452c5
+ pristine_git_object: 4954da2ada060d70107a70c771921a5f6c18729d
docs/models/operations/GetV1EmployeesEmployeeIdFederalTaxesResponse.md:
id: eedd6e510107
- last_write_checksum: sha1:57d77c9c7e417396071a62f14dcdbaadc6933a78
- pristine_git_object: bb39fbbdf76a95058f782a8f4bb5c2a16e5aefe5
+ last_write_checksum: sha1:63169658db3211e111d81b0e78fab311f79a94fb
+ pristine_git_object: 93c97b713badfc01b06dfd4dcb5381b53b27f641
docs/models/operations/GetV1EmployeesEmployeeIdGarnishmentsRequest.md:
id: 88cde5277238
last_write_checksum: sha1:7b0d8eab2f3b4a726fb8410f32fb888d2edb0d91
@@ -3239,8 +3560,8 @@ trackedFiles:
pristine_git_object: ccded2fb19484c57f3d6732d02560e8d109c8996
docs/models/operations/GetV1EmployeesEmployeeIdHomeAddressesHeaderXGustoAPIVersion.md:
id: 5601138e0c3f
- last_write_checksum: sha1:dc67b4ea6f95bd06193cf3879a129668ea207e9c
- pristine_git_object: 42c145379533c119a31cadd799b95ac881a97271
+ last_write_checksum: sha1:3f065171b4b6b5a2ec4f98926c101a4ae3778bfb
+ pristine_git_object: d5690d2af9c488fb0d40f96f66d5cb23e4cab549
docs/models/operations/GetV1EmployeesEmployeeIdHomeAddressesRequest.md:
id: 0157cd814280
last_write_checksum: sha1:c1f6816c975e492a01891a561c42269ca142e274
@@ -3249,34 +3570,46 @@ trackedFiles:
id: c0feb32cfe5a
last_write_checksum: sha1:de8392f952ba13b5972fef7a7bd89a72f883fed4
pristine_git_object: f2d486705037a0bce1d6478ca53d4bea8c5f1b7d
+ docs/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentOptionsHeaderXGustoAPIVersion.md:
+ id: d330dd490503
+ last_write_checksum: sha1:9e9babb7e03d456e956ffd9e60b80634a01d4325
+ pristine_git_object: 16f510c40c097d0f45ebe7e1819d5912a074a784
docs/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentOptionsRequest.md:
id: fa793dc54d40
- last_write_checksum: sha1:a3c2918b825720db59a430d1f79d686a8a9017aa
- pristine_git_object: 53d65ca68ed943c8c471c0cd4360f8f40abf4c30
+ last_write_checksum: sha1:3b13d205d1e73fdf94e8e68f566e17f819707a76
+ pristine_git_object: 8624c75d756569d9468e254d6227d3937291d133
docs/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentOptionsResponse.md:
id: 8b2fde8ff257
- last_write_checksum: sha1:d708a9c2ac01d35a65ac2918d08f30caf4dd617f
- pristine_git_object: 31c79a648b0e75d0b9bab1b5d2b55bad097b882a
+ last_write_checksum: sha1:08e39855e6b8845be194a92151f14eeefc24a3c5
+ pristine_git_object: 59da6b8533494e6f4205a5ffe7c7347387684422
+ docs/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentsHeaderXGustoAPIVersion.md:
+ id: e038071ec3cc
+ last_write_checksum: sha1:88cda643a727fc879df9790ed598a735a738ef69
+ pristine_git_object: e96c28f18a5a946b6a5d29d402392f674cd28c25
docs/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentsRequest.md:
id: efa67ef06856
- last_write_checksum: sha1:d84cbf4e33802855173d6c5fcb040f1fef682cee
- pristine_git_object: e71a44b3015e4d8c2a66573ced66edd23bece926
+ last_write_checksum: sha1:e684199adee27893ac4793603bb82effe7937812
+ pristine_git_object: 9dc05894893a3fb4a675464738df4590c0474378
docs/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentsResponse.md:
id: d0d7c2c3d6da
- last_write_checksum: sha1:3c0c3c46c25de5171f00d6f9c752735aef632a48
- pristine_git_object: 9d0f1542bf42270bdbcbf1706f1d14cf8d2ebada
+ last_write_checksum: sha1:ef4ed1af001b1cd59409357537f38584b3936474
+ pristine_git_object: 25038bcbc7e681991eaff4fffa24dc40a755f119
+ docs/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationHeaderXGustoAPIVersion.md:
+ id: c70d3207bb87
+ last_write_checksum: sha1:a5f1e4e2b3b0558c3ceb29802704dcc2b9f77e99
+ pristine_git_object: c9b6ea47601a3194ae802a4ef2132170cd0d2a53
docs/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationRequest.md:
id: 09567009ace3
- last_write_checksum: sha1:ed2e218de8c045126ca218051a8a2b2ca1a07688
- pristine_git_object: bd2a053f92fa2f58bc61e6aed3f3d1711c68cfbe
+ last_write_checksum: sha1:46271bd16db2b80347d5c2de4a68be2e2e690f11
+ pristine_git_object: 93a43399319eed1de89d2b6e0fe652828bdfe815
docs/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationResponse.md:
id: 71300e30b071
- last_write_checksum: sha1:2d866cbfe3efccea23bc8d2294438b97f51b4bbf
- pristine_git_object: ea757893c1d9cb407007a02881283b8739392702
+ last_write_checksum: sha1:d8231ff2d0cb1f3b39d7c6c1560f802d6c92c556
+ pristine_git_object: 6b2ca7b5e8cd1a7afe7099de8c3597da53e30076
docs/models/operations/GetV1EmployeesEmployeeIdJobsQueryParamInclude.md:
id: d31820478747
- last_write_checksum: sha1:b2b1dc2766d62ead3d2e5ddb3fdc3638bc87308b
- pristine_git_object: 58faacd7a49546d065518deb5198e1e079e5eca1
+ last_write_checksum: sha1:094a9e4dc451823e1de8e8ebc1c7daffab37fcc3
+ pristine_git_object: a14dc6966167afc2ed78eb07fa9d619283b0fb81
docs/models/operations/GetV1EmployeesEmployeeIdJobsRequest.md:
id: 4ccb7ce0653f
last_write_checksum: sha1:a775f20186919c305d4a5ed24dd722d2ad2f7518
@@ -3287,8 +3620,8 @@ trackedFiles:
pristine_git_object: 1dfa7dc61a3f3844119a190135b534c83545cdb0
docs/models/operations/GetV1EmployeesEmployeeIdOnboardingStatusHeaderXGustoAPIVersion.md:
id: 7a275ff6ae99
- last_write_checksum: sha1:8c45d281f43e2531ad6e8b7532e573167f5df497
- pristine_git_object: 8d2e9f30a8d94a5ffdf37daab87da50d2ba48a2f
+ last_write_checksum: sha1:e2ae378dfa0cd356de8136df1c74113a4ec2cf7b
+ pristine_git_object: b53cb5aae25e9c0a79d69ccc3b69712982ef273d
docs/models/operations/GetV1EmployeesEmployeeIdOnboardingStatusRequest.md:
id: 21ee9d101266
last_write_checksum: sha1:825f8275f0af138c7d3f718708194744c2bdef69
@@ -3297,30 +3630,30 @@ trackedFiles:
id: 6f9da2c167f9
last_write_checksum: sha1:20417d2e401cc9bec666870a185d6b0fd0ed0453
pristine_git_object: fe6048b2ce578313ed198af4a4140c09445f1c81
+ docs/models/operations/GetV1EmployeesEmployeeIdPaymentMethodHeaderXGustoAPIVersion.md:
+ id: 3afcaca6c337
+ last_write_checksum: sha1:f88a1317a0e05b35be97904863551a61c97ef8b6
+ pristine_git_object: 425c7f3348e8cdf604852fea86303353ab2b84b8
docs/models/operations/GetV1EmployeesEmployeeIdPaymentMethodRequest.md:
id: a9fe129cab0e
- last_write_checksum: sha1:56f39b3aee349c5d91ff69f5f2bb859cbd93919f
- pristine_git_object: 23141fb67b0f4b1df90967bc35c5a3f8a783e892
+ last_write_checksum: sha1:769f164f50df4cf22843992901323027b0092836
+ pristine_git_object: 52e3b2d7c905b0f62a6e1c9437f590b16296aeb3
docs/models/operations/GetV1EmployeesEmployeeIdPaymentMethodResponse.md:
id: cb014f88dc13
- last_write_checksum: sha1:1c56af8ad5e40ea92885ec154ccaa3fb134655eb
- pristine_git_object: 999ac0837b9ac4842d7521989b6df4c93046487a
+ last_write_checksum: sha1:105759f2fae9258887bf475816ad2909cea7c22a
+ pristine_git_object: 5d8cc1d270713563d3d1d99d69c3d5ca544b991e
docs/models/operations/GetV1EmployeesEmployeeIdRecurringReimbursementsHeaderXGustoAPIVersion.md:
id: b89e3f3e3aa5
- last_write_checksum: sha1:863b8615a0fcb9e01130457947bbd7af06e2d91f
- pristine_git_object: f8f89992452ab9e54e67df3ae8a1bd80843c6af2
+ last_write_checksum: sha1:7654a13c3d008630a306557b68849f8632b40cac
+ pristine_git_object: e8368822c40050201aa9b66cb5fed7e3026242bf
docs/models/operations/GetV1EmployeesEmployeeIdRecurringReimbursementsRequest.md:
id: 9ad72e34c976
last_write_checksum: sha1:df872ce2c6d7f6647881862cae73b446d990d238
pristine_git_object: 180e97d659e386b6187a354d39802098be071f91
docs/models/operations/GetV1EmployeesEmployeeIdRecurringReimbursementsResponse.md:
id: 1a0986d0617e
- last_write_checksum: sha1:c42de8ff0b2ff1ac8aacf01b98ad1872cf68e67c
- pristine_git_object: 57286a46d850cc409e1242497d9bf751e7c1c00f
- docs/models/operations/GetV1EmployeesEmployeeIdRecurringReimbursementsResponseBody.md:
- id: 97d8d5b43b0e
- last_write_checksum: sha1:2a9c3441db2dcf720fa6e6726fd736e43be19003
- pristine_git_object: 986ccdaac6ef046ea8be944305c3371c3dbc634f
+ last_write_checksum: sha1:e2688e909d300a003de1b4008d0149d23b42f6dc
+ pristine_git_object: 7c7fbdca92a4d54599d1aaa8bb79c20acc609236
docs/models/operations/GetV1EmployeesEmployeeIdRehireRequest.md:
id: 1a01842d74a1
last_write_checksum: sha1:efca9eddd2a2d613021002c7013f7fd4ba420f32
@@ -3331,8 +3664,8 @@ trackedFiles:
pristine_git_object: 7c9d719b05a7b1278ffaad57e14a42c48cee7b4d
docs/models/operations/GetV1EmployeesEmployeeIdStateTaxesHeaderXGustoAPIVersion.md:
id: 208a5a623ddd
- last_write_checksum: sha1:be0f4097344d823c880cd097e1ce7d64c797af69
- pristine_git_object: 152ddc0a4702a2580ff400882338ba9d730da8f0
+ last_write_checksum: sha1:f95992df53325a9f812ac399123f6ff0774b6060
+ pristine_git_object: 3ae37dc64e2816a655120681fd3468dbfb0a8779
docs/models/operations/GetV1EmployeesEmployeeIdStateTaxesRequest.md:
id: 5d7761df8041
last_write_checksum: sha1:b637016f14771cf4447082c9a17d0e6e9442e140
@@ -3351,8 +3684,8 @@ trackedFiles:
pristine_git_object: b7e0a1a4f0ad33171843fa6f499d2469cc33e98a
docs/models/operations/GetV1EmployeesEmployeeIdWorkAddressesHeaderXGustoAPIVersion.md:
id: 90d6079ced2e
- last_write_checksum: sha1:9891d42ed644dfa754b01615a038aaf4ee5806ef
- pristine_git_object: 2ae3c3e466bbfd1f51965b223db510b4d1554a8a
+ last_write_checksum: sha1:2c38299e9cc8b14a2b484d5e9a4adb096616c222
+ pristine_git_object: e36db4dd480492f10e46a664aa28862cafa0a925
docs/models/operations/GetV1EmployeesEmployeeIdWorkAddressesRequest.md:
id: ea939daf6cdd
last_write_checksum: sha1:25d8afcf27cd3bb059dd0477e5561fd60c8165f0
@@ -3363,8 +3696,8 @@ trackedFiles:
pristine_git_object: 79dae027a92430572eaea0c30747d5d1802d38f1
docs/models/operations/GetV1EmployeesEmployeeUuidPayStubsHeaderXGustoAPIVersion.md:
id: fb4093abd69a
- last_write_checksum: sha1:05abb157ec24cc67df5c7ac900544a4856ba8990
- pristine_git_object: 48abbddbd97509dee14e9d14eec158e894a067f4
+ last_write_checksum: sha1:944b19a2e882df632d96b167644ea6999553003a
+ pristine_git_object: 03ead16394765c4eb97961ee44d641493fb6e01f
docs/models/operations/GetV1EmployeesEmployeeUuidPayStubsRequest.md:
id: bc115faf77cf
last_write_checksum: sha1:0f95581ef8164d30c63867007f518fb237ed26fb
@@ -3375,8 +3708,8 @@ trackedFiles:
pristine_git_object: 4c3d8bdc4890847ba8ac35fda8d1bc2ffa7c7481
docs/models/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearHeaderXGustoAPIVersion.md:
id: 321b7cfda0be
- last_write_checksum: sha1:13c00cdc31a5534688d46660e56fd8430d1e7cb5
- pristine_git_object: 094c0ca3699b6ec1593a077d7a8a435e5cc6847f
+ last_write_checksum: sha1:b1b017849bc7b9c3975ae4138ce36578bda5cb9d
+ pristine_git_object: 2936495ac901e1220f62e0d8a085c7824a0d799d
docs/models/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearRequest.md:
id: c84fdaf66194
last_write_checksum: sha1:7cf9f987eb11ebfe6b5f13b61ef59059f4301266
@@ -3387,8 +3720,8 @@ trackedFiles:
pristine_git_object: ccab9a1f6e14a6b0f83ff3bc1104a758187ab63c
docs/models/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesHeaderXGustoAPIVersion.md:
id: d3efe5b10d44
- last_write_checksum: sha1:5b7487bb7253891d89e678189e19f95ff1d2b11c
- pristine_git_object: 51707318c55bdac053ae4498bd9d747222faefd7
+ last_write_checksum: sha1:f7cf9771564cac6ff99dbcd075ffe8b8a6e2e583
+ pristine_git_object: 3246942bade4101bddc17e91634cb64462f39316
docs/models/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesRequest.md:
id: 6fec461c7a29
last_write_checksum: sha1:13ddf94127332657e90805d68df873312a1deac0
@@ -3399,8 +3732,8 @@ trackedFiles:
pristine_git_object: b75f3fcee6b1bc7785936b3ea308e6925cde07a2
docs/models/operations/GetV1EmployeesHeaderXGustoAPIVersion.md:
id: 854609ca3aa1
- last_write_checksum: sha1:803473582485a472d185362af2fece1ae70b2721
- pristine_git_object: 9d72780dd0f584497295625f114d9deb8e6fb63c
+ last_write_checksum: sha1:12614123dead61ac33a394167e4cdd4ab8ee4de5
+ pristine_git_object: e977264a7775fe7768f27cb5e8057b04129ac090
docs/models/operations/GetV1EmployeesRequest.md:
id: 223f04be7236
last_write_checksum: sha1:add7b9f8902062aa7f9b0242233699cda171e1c4
@@ -3451,8 +3784,8 @@ trackedFiles:
pristine_git_object: 20a4280c86e3d009d9ec1844084dca5276a229b4
docs/models/operations/GetV1HomeAddressesHomeAddressUuidHeaderXGustoAPIVersion.md:
id: 7cd47041a3b2
- last_write_checksum: sha1:792f27b5f0cec9cef53a931404d8e803fdcbd2d1
- pristine_git_object: bc7240868d6257f3a4d1617e325dbcfe13a07e34
+ last_write_checksum: sha1:cc7ffdc9c77d580e85e2b18f9705bb7b1e797e19
+ pristine_git_object: 29b72092f2d6e487066ada8da55935fa0ed5cd31
docs/models/operations/GetV1HomeAddressesHomeAddressUuidRequest.md:
id: a588fb324a01
last_write_checksum: sha1:fb49c506a1134ba759654c764f553c30d768d780
@@ -3461,22 +3794,26 @@ trackedFiles:
id: c9252a2ac245
last_write_checksum: sha1:4524ee2005826acd98cca68acc4b8d540da85098
pristine_git_object: b684f8f1ef99644f1f5534f64ae537a438f1b334
+ docs/models/operations/GetV1JobsJobIdCompensationsHeaderXGustoAPIVersion.md:
+ id: b2edad0431a5
+ last_write_checksum: sha1:e453ff026486e19d9cf51f566d777b41e88ecb4c
+ pristine_git_object: 81eda97c74c666d6134fe3d5fa437a7da7ec8f77
docs/models/operations/GetV1JobsJobIdCompensationsQueryParamInclude.md:
id: 2deb69ba53db
- last_write_checksum: sha1:81b1c2f8c4c7392a98873381c3f6341f62ef4547
- pristine_git_object: ce47502935fa48f49e7184f970733c66abe542f2
+ last_write_checksum: sha1:7c194c1a5f2eb2d742f6d0a89bd9d900ab00956a
+ pristine_git_object: 24450bb461032db8e065cf41c1e76051c8feba04
docs/models/operations/GetV1JobsJobIdCompensationsRequest.md:
id: c4065884a077
- last_write_checksum: sha1:9f496d6010b890331c69c526ba443939a8e452fe
- pristine_git_object: 5640e6d5a795ae15c39072a7cc080962104b6b49
+ last_write_checksum: sha1:1526ef02d9d669355179f81da45b927287adf12d
+ pristine_git_object: 0e1015df1a5e0430453b452d7ea58108748e5082
docs/models/operations/GetV1JobsJobIdCompensationsResponse.md:
id: 7c3c4f6b4d43
- last_write_checksum: sha1:e9efe8faf9d6f9afad26d12419e2472f0b153b3e
- pristine_git_object: e1936775fd13aef27be59e01e47ef35efb60533e
+ last_write_checksum: sha1:c46761babe7c9a396c80cfc7312bf403825a041a
+ pristine_git_object: 17be532611a08b861ce20e4229fe864e9ad28be7
docs/models/operations/GetV1JobsJobIdQueryParamInclude.md:
id: 11a257b7ba9a
- last_write_checksum: sha1:0fc5ce370fb4ce4192ee07013ffb3a328cb74370
- pristine_git_object: b43f00ea934254498844f18d6ea69dab949e828e
+ last_write_checksum: sha1:b23b658db22516cd48a745d5f39f56820cb93117
+ pristine_git_object: bcae6ba13571a6820e3a165ebfe463af8c7aaec2
docs/models/operations/GetV1JobsJobIdRequest.md:
id: bc457dd1c163
last_write_checksum: sha1:1bb904a91432080cd65c55c6d5e21e29476ae73d
@@ -3485,18 +3822,22 @@ trackedFiles:
id: 574495194c85
last_write_checksum: sha1:54841f10cba4a5355b5b8493d93a78b1e00c4dbd
pristine_git_object: 85af9315dc48b46d437e70792121537daa4a943e
+ docs/models/operations/GetV1LocationsLocationIdHeaderXGustoAPIVersion.md:
+ id: 7ea1628d9b8c
+ last_write_checksum: sha1:47f1a032a117ca0a5b620ca0aeaf562bf143439b
+ pristine_git_object: fbe8567f77b2b24016f8a376c3ccef5fc5a928da
docs/models/operations/GetV1LocationsLocationIdRequest.md:
id: 12731a8d9ad2
- last_write_checksum: sha1:f48e2696dd1a06da11928be67ca6e744558effe4
- pristine_git_object: 5f500297104e922d8aefe4a9a0f65a77150835c6
+ last_write_checksum: sha1:0660ea35c98d5fc734d39aa88adf7c91131062d4
+ pristine_git_object: c976fd9ade93c153cc2ad808295bb8c442e2b274
docs/models/operations/GetV1LocationsLocationIdResponse.md:
id: bdd481d12727
last_write_checksum: sha1:af273bb281aa82e3c2a5a97f759b2a9b7dea9551
pristine_git_object: c995c217db2443e3be872aba04c495191327f7c1
docs/models/operations/GetV1LocationsLocationUuidMinimumWagesHeaderXGustoAPIVersion.md:
id: 7a7b0e55c653
- last_write_checksum: sha1:136210dc08c55f34fa233c405ca469990547af04
- pristine_git_object: c7252b90d6edc492b973095fad00088019b1d92f
+ last_write_checksum: sha1:4b668db63ca25598dffd8ce139185da91bb580c7
+ pristine_git_object: e4e2035c00ae1fbc8feba7bd10ab807859a62abc
docs/models/operations/GetV1LocationsLocationUuidMinimumWagesRequest.md:
id: 718a87d3c1d5
last_write_checksum: sha1:cc359d7503916f0e0d7e447974d5d17a2a4a5a92
@@ -3505,22 +3846,38 @@ trackedFiles:
id: 7e7e378145d3
last_write_checksum: sha1:dc30b3d7e7f84315677bead0a0583727ecc82765
pristine_git_object: 9eaaf9252de00ab86f01e5a0b5d8bad3e4932b61
+ docs/models/operations/GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessMetadata.md:
+ id: 7f84386ceb02
+ last_write_checksum: sha1:6979879301284f62a581e16e595a0c2327f03ac8
+ pristine_git_object: 99ddc715cd37d52280e517e5c92310ac9a9c7cd4
+ docs/models/operations/GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessRequest.md:
+ id: c6dc994bc139
+ last_write_checksum: sha1:39b5a2402763fa0c72ca9f60118c0324548c8728
+ pristine_git_object: 1090a3ad49d81566864beb99d9d72c47319fe5b0
+ docs/models/operations/GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessResponse.md:
+ id: 47955a2e8280
+ last_write_checksum: sha1:b3c1d8807693ab0fb4890b510e61a5b0f7eeb0f8
+ pristine_git_object: d80cd99eec72a94fbbdca3640424dd3792a887e8
+ docs/models/operations/GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessResponseBody.md:
+ id: 6bc9b76c00fe
+ last_write_checksum: sha1:22eac3f7651577550b0f5bbd13ce5ca0a71c93ff
+ pristine_git_object: d16bf9442743ae7a92ca1dd1f10e14d53bdc467c
docs/models/operations/GetV1PaymentReceiptsPayrollsPayrollUuidHeaderXGustoAPIVersion.md:
id: 78f4e1efea9c
- last_write_checksum: sha1:66b3c8dffdfa1303a44ece97eeb88657bf476cce
- pristine_git_object: 21a4b33d65155965949d3c65c530672237d3bc07
+ last_write_checksum: sha1:23bd1c3049e7ac9eeaf117671c8eadd1f241d38e
+ pristine_git_object: c21b9feca8c5b6889241cdd8883ba29407eb82a6
docs/models/operations/GetV1PaymentReceiptsPayrollsPayrollUuidRequest.md:
id: 6e06e82f2048
last_write_checksum: sha1:4a96318945cb8c3733b89e7f58e4dd11a8fb2518
pristine_git_object: 6dbb99dc3179371dcc0aec62551c6fa761cc91b5
docs/models/operations/GetV1PaymentReceiptsPayrollsPayrollUuidResponse.md:
id: 62ff13fc9167
- last_write_checksum: sha1:e77420447d8efd4a02b2fc3b693826342016c3e0
- pristine_git_object: 2348399478114808dd4848d11d7a6d7a7940596b
+ last_write_checksum: sha1:114113a4ff89bba647b47a1f556470e8641bfe83
+ pristine_git_object: 832b1b98bcec2df013d782772d5bde2cd0742011
docs/models/operations/GetV1PayrollsPayrollUuidEmployeesEmployeeUuidPayStubHeaderXGustoAPIVersion.md:
id: 8a945c5bf738
- last_write_checksum: sha1:31c6782273d470a0677b1d30bdd36c631acf096e
- pristine_git_object: f5280b6d20214b932b49e943fe3dd64715ed638a
+ last_write_checksum: sha1:5df2aba98ca5f3c583d17f6c6db92047f20f1fb7
+ pristine_git_object: 6994b0b33ce9a2b2ff536e9c246373bf20aabbc3
docs/models/operations/GetV1PayrollsPayrollUuidEmployeesEmployeeUuidPayStubRequest.md:
id: 317daebb40ee
last_write_checksum: sha1:d7bae9ca1815a150f07615a1c479ff94b3fdf900
@@ -3529,54 +3886,34 @@ trackedFiles:
id: 70436998cc59
last_write_checksum: sha1:5b0fea692e1fe3202e78a5b95a08e1f0faa4ec7e
pristine_git_object: 0ad86f8893afaa3ecec0aa9179f43f912f923f03
- docs/models/operations/GetV1PeopleBatchesPeopleBatchUuidErrors.md:
- id: fb0a604ba067
- last_write_checksum: sha1:b889a50b4542c0a2c1e3d5b14da791817158a7c3
- pristine_git_object: 367f52a583b910e3e1efd92b74eca7716e83cb4e
docs/models/operations/GetV1PeopleBatchesPeopleBatchUuidHeaderXGustoAPIVersion.md:
id: 42d07f9707ca
- last_write_checksum: sha1:87f1759735dffafcc46b141c29b849933cf42eb1
- pristine_git_object: deb5042c797b0129ced5eaeb7607af5699d9b2fd
- docs/models/operations/GetV1PeopleBatchesPeopleBatchUuidPeopleBatchesStatus.md:
- id: 189f8646dc0e
- last_write_checksum: sha1:fc09cbfb342aea0fb26ff63a9ed367d4aeda1f0e
- pristine_git_object: dac421c4a96d9c64b4fb88726b8b383f5e56a6c5
+ last_write_checksum: sha1:2b73612430299d7743caa78bfeea3f5df1303952
+ pristine_git_object: 371b9443c235a9c425fb4b2d32cb5579afd0cd33
docs/models/operations/GetV1PeopleBatchesPeopleBatchUuidRequest.md:
id: 60f403a9fb05
last_write_checksum: sha1:c70b2ff33b369c9f81bd5c8dbcecae9dffca9cc7
pristine_git_object: 8c0c6537d840cdf480a43c79553d54ba4c75d56c
docs/models/operations/GetV1PeopleBatchesPeopleBatchUuidResponse.md:
id: f2cd611363cb
- last_write_checksum: sha1:9c1960f7d2766c79a32355195a32c92c27a422b4
- pristine_git_object: f090d3d392c6e1d7ecd2f6996f8b9fdc9da531e5
- docs/models/operations/GetV1PeopleBatchesPeopleBatchUuidResponseBody.md:
- id: 12bbd4329043
- last_write_checksum: sha1:fba08c9cfcd4a8b37749eecc6414f0751e5a415a
- pristine_git_object: 3a369ad7bb91ff358d427f360b9c6f68aa30582e
- docs/models/operations/GetV1PeopleBatchesPeopleBatchUuidStatus.md:
- id: 7e659f4f7af6
- last_write_checksum: sha1:73418e3410d868cb5931e651f44875522fd71900
- pristine_git_object: a577f00cc9bb13d67fa0fab0ac949709bf9cb3bd
+ last_write_checksum: sha1:2158b4d17cb331da9c2009e5cfcc032daada4175
+ pristine_git_object: d2a90b33b6421524716996bf7674e1d945d79334
docs/models/operations/GetV1RecurringReimbursementsHeaderXGustoAPIVersion.md:
id: 6f28a0f972e7
- last_write_checksum: sha1:832b7f0591b5c80242164bcd02c6ecf3a81e1983
- pristine_git_object: 20dc023edd956f08d526ee3f5ffe5fab79ce9cb6
+ last_write_checksum: sha1:24dbacc73a80b366640fb87dc27c50d40afe2fc0
+ pristine_git_object: ff1996d84cd5341ef8b99f67caacf230cefd3046
docs/models/operations/GetV1RecurringReimbursementsRequest.md:
id: ff693c549051
last_write_checksum: sha1:99042a2e1047f668776f7218c98d1b965438c70a
pristine_git_object: 5270be546f7d690a53dc71f89a8bc4cd4aedaf85
docs/models/operations/GetV1RecurringReimbursementsResponse.md:
id: 3b7c658bcaa1
- last_write_checksum: sha1:b9cc0e96d60ba15e4c6f909471d5b132b5fb413b
- pristine_git_object: e57d84437cf37508c804489ece4a6d7e01b600cb
- docs/models/operations/GetV1RecurringReimbursementsResponseBody.md:
- id: d350eb1b4320
- last_write_checksum: sha1:71295f193b03766012c7d5f3740ea9f9f2f35022
- pristine_git_object: 8383b9b54f445143c3ffcadef2ad842a4d7d327a
+ last_write_checksum: sha1:95802b852f1dd1476b3b91b29db58eb3eae5d612
+ pristine_git_object: f83ff34dd106c70a4554ffc1de65586fce4c26ec
docs/models/operations/GetV1SalaryEstimatesIdHeaderXGustoAPIVersion.md:
id: cf52b36d4793
- last_write_checksum: sha1:a0b5a196ef20dfab4bbc0584092e630c7a9f9fbf
- pristine_git_object: 1b2d26c0100f747a11b6efad73438d422cd277b1
+ last_write_checksum: sha1:c04d5da109c76f4023a08a2c511f3c75881955ef
+ pristine_git_object: f5e697ef87fa4275b886568f92af05e857ac5ca9
docs/models/operations/GetV1SalaryEstimatesIdRequest.md:
id: c45300ded3b4
last_write_checksum: sha1:df16d5cdccee45a53ba15a4bb6189e0ee2a9c066
@@ -3587,8 +3924,8 @@ trackedFiles:
pristine_git_object: 703a094bdc29c17367b9663ae6dc4e7733fd3f4d
docs/models/operations/GetV1SalaryEstimatesOccupationsHeaderXGustoAPIVersion.md:
id: 414ddd9210e4
- last_write_checksum: sha1:cca5e846e2e259dc767ac95f306a94f2788ba4b7
- pristine_git_object: d4014a453c683c41c687a608f06c55a33a17e967
+ last_write_checksum: sha1:f4c668153c539b231cf15f0fe30d4f2822b2305d
+ pristine_git_object: 07eaf6123966f268ac06a5c7aaaa10e1cc9184a6
docs/models/operations/GetV1SalaryEstimatesOccupationsRequest.md:
id: 57dc9ae32720
last_write_checksum: sha1:e5c380de640cd2fe50d44e26316dcd40ed057666
@@ -3607,12 +3944,12 @@ trackedFiles:
pristine_git_object: 3232aaff75d9b7f9e1b62fa966b2b6f9ecc9066f
docs/models/operations/GetV1TaxLiabilitiesResponse.md:
id: 0024ea8fc7bb
- last_write_checksum: sha1:590a591c466ff77d1d2ac75c299b0f29cd4a147e
- pristine_git_object: 9d9cef61282a78d8064684d7d0e5935c1c988259
+ last_write_checksum: sha1:a93c2502d053675de055c7e22041f1d2d2279190
+ pristine_git_object: 6528a5af8fc3a535f7cb1915d16a0d4e4b766e9e
docs/models/operations/GetV1TimeOffPoliciesTimeOffPolicyUuidHeaderXGustoAPIVersion.md:
id: 4c75a355ff3b
- last_write_checksum: sha1:c5d256834ad60281f97c9a7c1aa374b9113c8e4c
- pristine_git_object: 6b1b73ba206c8dfec1565572833b39a108a426ef
+ last_write_checksum: sha1:ad229bf233391ac5e89d045c087eabe633a23514
+ pristine_git_object: 942ba5ae8f826e3b3e282ab629e6199aa34cdd0c
docs/models/operations/GetV1TimeOffPoliciesTimeOffPolicyUuidRequest.md:
id: 95b31cec3b42
last_write_checksum: sha1:13d7336a4c95593cfee2f900366a77cbcc8efa67
@@ -3623,20 +3960,12 @@ trackedFiles:
pristine_git_object: d2ce7b70649adcae92b60701045e6f653dd6e3eb
docs/models/operations/GetV1TokenInfoRequest.md:
id: c32d316bb9fa
- last_write_checksum: sha1:2409cb3e7f6780632b5ca0ce1274ec0d098e339f
- pristine_git_object: 21610582b69ec08f7b93ff72a2c7628b5bc1b011
+ last_write_checksum: sha1:3822cebca8058a6619703bd043698215ed95ff5b
+ pristine_git_object: 6bd0fb01076177cb85b076482c9fdc6fff1b920f
docs/models/operations/GetV1TokenInfoResponse.md:
id: 9237706ba00d
- last_write_checksum: sha1:764defbcdbecbbf6affdb04f7efa5810a5d44032
- pristine_git_object: 7a151fc1077526eb1d297891965e88fb89e8b05b
- docs/models/operations/GetV1TokenInfoResponseBody.md:
- id: eba3e950e027
- last_write_checksum: sha1:2975af8c5e478288abb0915eb1c2b14064a7de9b
- pristine_git_object: 56c9523035a0b66a2e1898414ed98608a640b173
- docs/models/operations/GetV1TokenInfoType.md:
- id: 2baa39a10481
- last_write_checksum: sha1:58fca4b55e98f13a40b3d8a966838071cbc8003b
- pristine_git_object: e2b52e7006407628e37f7ccda0a6bf127a09d934
+ last_write_checksum: sha1:af559ce2221cc2acbee3fbf0c2559ed46e9fcd63
+ pristine_git_object: 8e195ffffcc089b310cb2217bb3317b53f9294a8
docs/models/operations/GetV1WebhookSubscriptionUuidRequest.md:
id: b69fa09d793a
last_write_checksum: sha1:cdb2f4217924e33d3cd60e68d698647516d9f53d
@@ -3675,8 +4004,8 @@ trackedFiles:
pristine_git_object: cca147498b384aae769d7cc5240da67eb132437b
docs/models/operations/GetV1WebhooksHealthCheckHeaderXGustoAPIVersion.md:
id: 01a68d773c90
- last_write_checksum: sha1:075285abcfe3b341b9b16e57929fef4c3f8ea9a5
- pristine_git_object: 4aa48839f5f89f9e8d0d8a59a73399921a6ac15d
+ last_write_checksum: sha1:9b59809bb77ebb48c8eaae6ba1eb47ec1e7c61a7
+ pristine_git_object: 0a66beb4ffd65ac0990610fd3f0fe4f08a24e2ac
docs/models/operations/GetV1WebhooksHealthCheckRequest.md:
id: dd3ce29ed0d1
last_write_checksum: sha1:12aa5dfbbfc2145f41870330b6f6af0b344a0787
@@ -3691,8 +4020,8 @@ trackedFiles:
pristine_git_object: 73cb4c2b66ffcbd02fae8af567253e50ef2b2299
docs/models/operations/GetV1WorkAddressesWorkAddressUuidHeaderXGustoAPIVersion.md:
id: fc3155859067
- last_write_checksum: sha1:f62a027c3d2593f8e702eb9a8b3657f2773b234e
- pristine_git_object: 6b9e7f2efeeb80fca6981192a14e1b1e80458c36
+ last_write_checksum: sha1:5d43f24473c2d4d0b5712ba8b68711e5177b1936
+ pristine_git_object: 905e8d3e96bc990cef97f7a07844633a962aa280
docs/models/operations/GetV1WorkAddressesWorkAddressUuidRequest.md:
id: 095d69f139bc
last_write_checksum: sha1:24dfa29a86bdefb8249d7c491c99036a0c32ae25
@@ -3719,32 +4048,32 @@ trackedFiles:
pristine_git_object: bc05192b7a20a4689c40878ab146d05966310fdd
docs/models/operations/GrantType.md:
id: 0e2887d6280f
- last_write_checksum: sha1:9fa5ee8bd1bb601d82e128bb5a9c10c06fc67d0a
- pristine_git_object: 26cb8ef7d71f5b17639d14f51849bd9ab92bad65
+ last_write_checksum: sha1:1f75de53bd3ee7b1c5bda44d48240f758a42ef5e
+ pristine_git_object: d585ef17be152d2a590a932f230afb4d0a5f834c
docs/models/operations/Groupings.md:
id: dfab284cb48e
- last_write_checksum: sha1:3e64cfa13774bf10f2e6950073abcf2a484fac51
- pristine_git_object: 1938738dccb7c25cd836cac8dc7a6130aecbfd13
+ last_write_checksum: sha1:488033641dd57be312b251ff60947264b60126d0
+ pristine_git_object: 2261b004dd5b3b2c0bf70f6b9f500117edadb9cb
docs/models/operations/HeaderXGustoAPIVersion.md:
id: 476ea3a8f656
- last_write_checksum: sha1:d5a0c6f5037c1f4b9812741ac0922a203c03882d
- pristine_git_object: 1b66c2e6979e8144c35fac5bdecfb1d2fcd6a944
+ last_write_checksum: sha1:76a365f6ecbd8711c5855d8eba2d15df53ef277f
+ pristine_git_object: 35362d95e9c30854da5cf188cff441d0fb66e6a7
docs/models/operations/HomeAddress.md:
id: 77eef11c1fda
- last_write_checksum: sha1:d544490c086f225f7c1dffaa7d12bb21abd1284c
- pristine_git_object: 177d4d47adbbfa9a0df3e3ae902da34e3ad7ca05
+ last_write_checksum: sha1:a3f81303eb493454a5dc43580e9f789bc9795590
+ pristine_git_object: c9186e4da82dc8d6d3de9726590ba0e5a8cf45c2
docs/models/operations/Include.md:
id: 323eb1b543b1
- last_write_checksum: sha1:90d8adcbe532826e317cdd75e4e7b029a1f41ecf
- pristine_git_object: b553da44361a5d7fee3b235c445add0d7944a233
+ last_write_checksum: sha1:34889d7e0a8d1b4e0f483a018a25fc562805fd3c
+ pristine_git_object: 3ce3ae7f0f53bafd4887bc9de54a8c6524d707d8
docs/models/operations/IndependenceDay.md:
id: 30e5759a1ae4
last_write_checksum: sha1:75b27e4c8d9474e37a0d803c8d1ced751d839ad4
pristine_git_object: 660f5e3d1182c67ca7640ba7e9f3615441430430
docs/models/operations/IntegrationType.md:
id: 11fc10c62dbd
- last_write_checksum: sha1:8fa7453a03ace749024a9e3cddc2eda0d144f7da
- pristine_git_object: 660a592f497bbd4443bde09174444dc75e607ad0
+ last_write_checksum: sha1:bedeeae899b6ec292d2151a0b9fd8c5708123417
+ pristine_git_object: 77e5cf603d1eb86c6c3f2c04e4cbd425f1e09842
docs/models/operations/Job.md:
id: 46d1cd44094e
last_write_checksum: sha1:726e34e8db592fc0d6a9399fd0003b33b1b2d35c
@@ -3759,28 +4088,24 @@ trackedFiles:
pristine_git_object: e019802e31233ff14a36924881392289f4f45dd6
docs/models/operations/LeavingFor.md:
id: c618c6365ad0
- last_write_checksum: sha1:aea0adff0431aa36eb38a4bc55b568f4af691f92
- pristine_git_object: 9ae170287608cfdad6bc9b803aeae0d7ce0252dc
+ last_write_checksum: sha1:d8c701712bdc31612e33fd839531d2dfbb67fe21
+ pristine_git_object: 841a9d0224521061db05b8b4f005f4f6489a8a77
docs/models/operations/LiabilitySelections.md:
id: 4ea76ab68eb0
last_write_checksum: sha1:6912d372e2abbdefd55f907e04fd0fd84e0b4110
pristine_git_object: a68591a2bc8266c42a021efbec373c1cc311f50f
docs/models/operations/LimitOption.md:
id: 34b919293817
- last_write_checksum: sha1:363b0774d47a7cc4c76adc35196ff82513520f62
- pristine_git_object: 5faa943093d719dfccd347a0dd4d906f141cd683
+ last_write_checksum: sha1:aa121f294bbb34c78bb54b07a6a27fae988e3649
+ pristine_git_object: 2a9340a376feec4b16220ddfb4be59e4e8ba3456
docs/models/operations/MemorialDay.md:
id: d09755b914b3
last_write_checksum: sha1:df85d934c3453b8b54c6c38fd13b634296dd9c0d
pristine_git_object: e627598661af5f078ef093ab20a330d8d3344f80
- docs/models/operations/MigrationStatus.md:
- id: 03c171b6357b
- last_write_checksum: sha1:2fc384b8f75a8338f9845eda73e5806ae12d4500
- pristine_git_object: 6c49cae3d8d72f66a4861fff9cb45b113e87f528
- docs/models/operations/MinimumWages.md:
- id: 6e490306e19b
- last_write_checksum: sha1:ed70cc0d3cf9b7a564af459275174c4390879591
- pristine_git_object: 491587d7602186a38a4da97685c4cea45af4d500
+ docs/models/operations/Metadata.md:
+ id: f15bc0be9b59
+ last_write_checksum: sha1:b0aa7a538fa758e36cff6acbde754167f7801e5a
+ pristine_git_object: e62bb912f5db815a6b504f8ca743ead7c4c138cf
docs/models/operations/MlkDay.md:
id: 13a600e7960e
last_write_checksum: sha1:a2d473ccffe52ca396601d4c78a9839e5ded8c67
@@ -3791,52 +4116,52 @@ trackedFiles:
pristine_git_object: e6e277bdefdb364f618d68743470034b7ed063e9
docs/models/operations/OauthAccessTokenRequest.md:
id: b5c3c4554e95
- last_write_checksum: sha1:2093e45ca7e82f421f9ef68030369c1dbda885ff
- pristine_git_object: 40a49e6e42b80c5ac42567c36c27ea1286b1da73
+ last_write_checksum: sha1:48ec73723630e512d490a53da014d44e84920dac
+ pristine_git_object: 8a4e9f658bed1b45ea1ffc4d0a210e5306c91621
docs/models/operations/OauthAccessTokenRequestBody.md:
id: b31223a28af3
last_write_checksum: sha1:78249604e7ea7d07502bae337288b9170032bf05
pristine_git_object: 3b369e94bda355dbc996a578436db73c4289394f
docs/models/operations/OauthAccessTokenResponse.md:
id: 4d04b7814913
- last_write_checksum: sha1:5ff97eec9ec3728517413f258b839bb704859159
- pristine_git_object: b75ab320a992d97f7aa91e01f90b00b2425054d4
+ last_write_checksum: sha1:c602c78e5cc8c7a92c2c9928792b53f0ef5199fd
+ pristine_git_object: a15a00dab2b668690db1c3f0012fd7b576f505dd
docs/models/operations/Occupations.md:
id: cb47d54be024
last_write_checksum: sha1:5222484c1e86a48982533809c10d4d7f3ea75fb3
pristine_git_object: 9b494c76828aa99bd974d21b8944ba1853535495
docs/models/operations/OffCycleReason.md:
id: 4315151782b6
- last_write_checksum: sha1:c9c6a7605e2c014382199e21bcb1dac88206021b
- pristine_git_object: 8ce1e29928cf857b320dadf4f7fba204d29506f0
+ last_write_checksum: sha1:72d14e7045456e1aed3f7d3ebf588ff4df839e5c
+ pristine_git_object: 0e1ddf9ef943a66243b3f2c16ff15d58f3daa485
docs/models/operations/OnboardingStatus.md:
id: f71dae225894
- last_write_checksum: sha1:5f2cbfe7c5b9fa236e622a8d76e30326cc09c4f0
- pristine_git_object: 65d83ed4db0fc58052f0eb46bc4301cbdbaa4df9
- docs/models/operations/One.md:
- id: dd07ece0a93e
- last_write_checksum: sha1:171910fdcf7b8de4c01fd9bb79d49d8b6876347d
- pristine_git_object: 0d9023bc8c63fc213095dad3336b8d81c89dcedf
+ last_write_checksum: sha1:37d1e05dfa1c8d79f195c76b6becd0ddb8199008
+ pristine_git_object: 76e7f4280fb17733aefd51a716866968ff761311
+ docs/models/operations/Options.md:
+ id: ca4ffc1fc0d4
+ last_write_checksum: sha1:daad3426a0474f0faee5151cc22f2bcc2c3f3bda
+ pristine_git_object: c5849e71bb92c94559ea717891ead7f9df5cc911
docs/models/operations/OwnerType.md:
id: 8a964aff3876
- last_write_checksum: sha1:8ec9dca657b24c9b7cd94c9ff8e96f6575574535
- pristine_git_object: 37f080f9d010def066a472af04fcb0b8d01d5ed9
+ last_write_checksum: sha1:f48a51af519a675b6e4394b204cfe249cd0d6e70
+ pristine_git_object: 46f53824ca799935123bc15d423cab22990c4a43
docs/models/operations/PatchV1CompaniesCompanyIdPayrollsIdPartnerDisbursementsDisbursements.md:
id: 360c17de45c3
last_write_checksum: sha1:f2829c23fea9185c9c6bd86c2a440a21c6f17d4e
pristine_git_object: a757f12f3102f2cada1d69ecab55b9aac4bea1ef
docs/models/operations/PatchV1CompaniesCompanyIdPayrollsIdPartnerDisbursementsHeaderXGustoAPIVersion.md:
id: fa4c297f5be2
- last_write_checksum: sha1:75c51c28ba8f084abb1aba71742946a43b86badf
- pristine_git_object: 731c558c69b842a053447f12ccfc57bd0160774c
+ last_write_checksum: sha1:2cfb004ab868a1f7740f3af2b3eff9f2e48e6f97
+ pristine_git_object: 54199ffa1552a8605ff2e6dfb223e4a150a7b7ad
docs/models/operations/PatchV1CompaniesCompanyIdPayrollsIdPartnerDisbursementsPaymentMethod.md:
id: 11293437aa4a
- last_write_checksum: sha1:817654908c1d061ae8c3ce73b604943fc1e5d967
- pristine_git_object: b71244eb328c04d0817d3b7e0682f1cbd6dbcd18
+ last_write_checksum: sha1:28ed0d0ed1ed778c18379e511b7d9578d28d0306
+ pristine_git_object: a3586cf396b8219847da8cda7adcf71b13afc203
docs/models/operations/PatchV1CompaniesCompanyIdPayrollsIdPartnerDisbursementsPaymentStatus.md:
id: 4c12e17f0e94
- last_write_checksum: sha1:3c3f2a76e76f256e96ad2e639494478d25c4c946
- pristine_git_object: 6f6014f71a477e08c1d7877320f002414154ee37
+ last_write_checksum: sha1:b54cc4fc75711bad52fff7eae45fe4a69d28cb70
+ pristine_git_object: 62265e1f4059f74c96736ef5ed69fd939eeee6a6
docs/models/operations/PatchV1CompaniesCompanyIdPayrollsIdPartnerDisbursementsRequest.md:
id: eb0b6aae5434
last_write_checksum: sha1:1066181ef7235abe3f20a298baf2cd690d354c1a
@@ -3851,12 +4176,12 @@ trackedFiles:
pristine_git_object: bac3b625591c4d838a5186129293ed2b0451477a
docs/models/operations/PatchV1ContractorPaymentGroupsIdPartnerDisbursementsHeaderXGustoAPIVersion.md:
id: 4e08c8b6832b
- last_write_checksum: sha1:eebf9e0568fa9ef62a025eede78c2d03186cc458
- pristine_git_object: 30d2a81772de4b4cdb7f6b8d5636f1feb1b715b2
+ last_write_checksum: sha1:4aabe9bd7a034333be06fff3d0f37ef731f511f3
+ pristine_git_object: 2da995e3c39ee11d6ffa960e91eb5cb453eff40d
docs/models/operations/PatchV1ContractorPaymentGroupsIdPartnerDisbursementsPaymentMethod.md:
id: 041d5a811531
- last_write_checksum: sha1:059f9dc0c91727afb18612a082a644ad0edbc0bb
- pristine_git_object: cd288ccff7aa5d1691a399f6fa72dfb26174d0f1
+ last_write_checksum: sha1:d23f19a02f0365e4cef807a32de0e9c7ed2a4ead
+ pristine_git_object: f425ba05df85f6b3c2f64b09e18b3620039f9a84
docs/models/operations/PatchV1ContractorPaymentGroupsIdPartnerDisbursementsRequest.md:
id: 0a87e49ab660
last_write_checksum: sha1:b5d2efe002ccc9749fafb3a9090423782c8e7921
@@ -3871,8 +4196,8 @@ trackedFiles:
pristine_git_object: 1c5a3eb4cac90daacdb3f9ffae19a5d21ccdf314
docs/models/operations/PatchV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearHeaderXGustoAPIVersion.md:
id: b217d913fa8d
- last_write_checksum: sha1:b271f6190d2770e20d784cf7c921fb1d9976dc6a
- pristine_git_object: 5c3b5f4c38159b63c179e4383f3c3e847f936664
+ last_write_checksum: sha1:a5295d021edc580ba6220630faed025395357562
+ pristine_git_object: a79503be103f13f97a8de674ec4113ab566ded28
docs/models/operations/PatchV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearRequest.md:
id: cfa9e00db0ed
last_write_checksum: sha1:ab28e41d2765e669c208bd58a71b83a19ab62832
@@ -3881,42 +4206,38 @@ trackedFiles:
id: 91294fa2115b
last_write_checksum: sha1:0029726021b5c71128ac6d9a8c34c1e9223cf707
pristine_git_object: 338975b13ceb75aaa29a620142f4a9922c3cc2ae
- docs/models/operations/PayPeriods.md:
- id: a5ab03104dea
- last_write_checksum: sha1:5afbeb52929e41475c845841ec4fdbaf3ec338df
- pristine_git_object: cfd7dd57bfda35d46eb4dd34fbb69a3027609eb8
docs/models/operations/PaymentMethod.md:
id: 85346656d764
- last_write_checksum: sha1:d26b5d150854935b97f1b1b18ca60083aa2e16e7
- pristine_git_object: 264c106e90d78c2688c8d647f6ff705c5018aedb
+ last_write_checksum: sha1:5b5ec16b10f2202e49e427cff6b5e3c4d3278596
+ pristine_git_object: 909b526bfe66d7cc15dd226d27e2b33d281cfcbd
docs/models/operations/PaymentStatus.md:
id: b67e8f253129
- last_write_checksum: sha1:e830cde1573f54da802b82b901c7fd81bd431a37
- pristine_git_object: 9c88733abca14ff1b925fb2f76dd466fba044b61
+ last_write_checksum: sha1:fbb4a66919b31c1612634bc94ca2a74279e5cf5b
+ pristine_git_object: ef5df2041cff92a6d24b040b15f8a1904e326375
docs/models/operations/PaymentUnit.md:
id: 81303be323ee
- last_write_checksum: sha1:69088498d77c48f364c18e9805ab538baf58f7fe
- pristine_git_object: a5eaa828252a382bd90ac678016cd87f90f12ea4
+ last_write_checksum: sha1:1bc45a21ae2ef37c070ae678783b73e8e1582cf1
+ pristine_git_object: d4b55f78a3e9fbc19bbdbacb3e97ead8ffe20667
docs/models/operations/PayrollTypes.md:
id: 2a7cf7741ad1
- last_write_checksum: sha1:902275ed81ec8ceb5d3135ed7b85bd039bdf081b
- pristine_git_object: 041e2d9ce38c0a7431a9589bc297ca8ceba35a3a
+ last_write_checksum: sha1:7fe2236af267290a0b1e9389289805a50bb8017d
+ pristine_git_object: 1c4eda85dce9b6b8934e3f9d16276a3144386c2a
docs/models/operations/Person.md:
id: 16b771638557
last_write_checksum: sha1:5392d8585926436993ed224a647956e3dcb28180
pristine_git_object: c2ef52322e2372b0f301b9244bb3844266f75c50
docs/models/operations/PolicyType.md:
id: 1e6bb251a610
- last_write_checksum: sha1:7951e70d0abb324ac7d5c642ae4c99cf825eac1f
- pristine_git_object: ef2689f69c07b692eeafff401fe433be5bc054ca
+ last_write_checksum: sha1:0df097d2aae052c53000ba1060d9db44316ff3d9
+ pristine_git_object: ed0234ad87b3a0ed14900b11f1e103cd81b30c7c
docs/models/operations/PostCompaniesCompanyUuidReportsEmploymentStatus.md:
id: c5e53b70d194
- last_write_checksum: sha1:e7fea967189717dc5a90ee739e62c14aa2a38499
- pristine_git_object: 2886e806f5cd14682e5cfe636bb5220fc1b1b7a6
+ last_write_checksum: sha1:012ef6a3495fa172ce11a96ff050bac21350c914
+ pristine_git_object: 718decfbc02116d5428df9bad41eff7d819a8f00
docs/models/operations/PostCompaniesCompanyUuidReportsPaymentMethod.md:
id: 55e71349a6b3
- last_write_checksum: sha1:2cd2785f9a4bfbfe60bdf77cc782f378355654c1
- pristine_git_object: 653093e435d62dd3ea798d4740901ed20615193b
+ last_write_checksum: sha1:0efd3e019c698b8180109c82fd298968dfc07304
+ pristine_git_object: 988f1662a7f02e5d3f30d3537f8bed1904c9a084
docs/models/operations/PostCompaniesCompanyUuidReportsRequest.md:
id: df6f4ad25780
last_write_checksum: sha1:b8a2502f21d6e57f54f516b3f5255db059846554
@@ -3931,8 +4252,8 @@ trackedFiles:
pristine_git_object: 696469d3c02f20c31985ea800f9ed1f2f230fafd
docs/models/operations/PostCompaniesCompanyUuidSuspensionsHeaderXGustoAPIVersion.md:
id: 264655494a1d
- last_write_checksum: sha1:96181a6372d12a347e858af8a720f273692caf33
- pristine_git_object: c1dceb21fe8b4e6ff4112c32a1395c35fae70db5
+ last_write_checksum: sha1:1879fc96d6ac62a2798aa0ae4eddabf9e0b7321d
+ pristine_git_object: 302c723c226649046d873c129e128660006b8ece
docs/models/operations/PostCompaniesCompanyUuidSuspensionsRequest.md:
id: ba322e9c8164
last_write_checksum: sha1:4487cc715db77d46b1427bdd7da7770dee00a853
@@ -3997,6 +4318,18 @@ trackedFiles:
id: eeac41dc60e9
last_write_checksum: sha1:7fb96d416a5797d99fcf88533c4d7172800dc088
pristine_git_object: e0bb7cb0bf3b0923d6d48e8ee42f3506ce0237d6
+ docs/models/operations/PostPayrollsGrossUpPayrollUuidHeaderXGustoAPIVersion.md:
+ id: 377d90f142f2
+ last_write_checksum: sha1:3d7a58815eac80be21496ebe53fccba76962e273
+ pristine_git_object: 18c0f1781926fb5c90e373f5f2bfe749941acd94
+ docs/models/operations/PostPayrollsGrossUpPayrollUuidRequest.md:
+ id: afbcd7daa41f
+ last_write_checksum: sha1:e8a476c82162f9f72b69c082e60704e77f130278
+ pristine_git_object: bf5e27482e5605ffe2116d38623b2fd443b25969
+ docs/models/operations/PostPayrollsGrossUpPayrollUuidResponse.md:
+ id: 69a8121fc452
+ last_write_checksum: sha1:bcbbb258aeb4903041dcd15f95b553a6fab9c985
+ pristine_git_object: 1b1173162c97415a7d6b77d74bdcce484b18d2e9
docs/models/operations/PostPayrollsPayrollUuidReportsGeneralLedgerRequest.md:
id: f85f89827f61
last_write_checksum: sha1:e5819154305409295fd1f14eaa454f404bec4f42
@@ -4035,16 +4368,16 @@ trackedFiles:
pristine_git_object: 51c58143790dac33d54264428bafc6b9009b61c2
docs/models/operations/PostV1CompaniesCompanyIdBankAccountsHeaderXGustoAPIVersion.md:
id: d7339584aaaa
- last_write_checksum: sha1:13ceb5d810025912e470fb0290ede478449bef20
- pristine_git_object: 3090756b53ddecf63fee0dd83d7dfceda43678e0
+ last_write_checksum: sha1:f7b1b28f15c897d38257fb4b19ac73058e6bc97d
+ pristine_git_object: a44a0ebd45c858696c69c885b22aa50a21f6b128
docs/models/operations/PostV1CompaniesCompanyIdBankAccountsRequest.md:
id: 2484340c7064
- last_write_checksum: sha1:e4ba0130d46454f795ba9e65c9c1082472c8fdf2
- pristine_git_object: 125bd85cbc03b303663f9b49ffc71d6a41189cb8
+ last_write_checksum: sha1:18fed5cb748ef3fa891f410d2344f567c173a622
+ pristine_git_object: 1972fdd03d63db87320f70e6c2d65d88a4a4624e
docs/models/operations/PostV1CompaniesCompanyIdBankAccountsResponse.md:
id: 64fc00a1f8fb
- last_write_checksum: sha1:3eddcc04755bf25611bbc3bb66ce7e4e61088cfd
- pristine_git_object: 1cdb58f0af71ed81a787126019aa4963c38b0eb5
+ last_write_checksum: sha1:34e2c4140da5b76edd97d3cc8caeb59834f67b13
+ pristine_git_object: 41aceac1e0032e44e38e5f0d251d801185c5697d
docs/models/operations/PostV1CompaniesCompanyIdCompanyBenefitsRequest.md:
id: 6b54bf03865b
last_write_checksum: sha1:0defff6274587e20e04e97b30231f3ed3745d231
@@ -4059,24 +4392,20 @@ trackedFiles:
pristine_git_object: 04678e8377698fb219da32b3ddcf663b0fdaa697
docs/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsHeaderXGustoAPIVersion.md:
id: 1593717bf416
- last_write_checksum: sha1:d5223ff2e9de4661320c1a251c38fd898548689d
- pristine_git_object: 0ad030d4e017aea8c3ac1f8d099d6666e524726e
- docs/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsPaymentMethod.md:
- id: b7606f14e9b9
- last_write_checksum: sha1:c97cc4d3a6b3deca938521c3f2383e59e8b25030
- pristine_git_object: c647c1374ccbc19152cf2f34d47d520a60962b6e
+ last_write_checksum: sha1:cd195a39c56b922de929760d0475bcfe6711b7ef
+ pristine_git_object: 8e05b0b39ea6df944759c8c83add5de0ab2c10a3
docs/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsPreviewContractorPayments.md:
id: 6b61e470f4e7
- last_write_checksum: sha1:805ed436d15c677e450f7b3a1f10239b53dd7390
- pristine_git_object: 9eeae3b7a604c4bc75dc868737701c43fa1725f8
+ last_write_checksum: sha1:dc2ca501981550eec3dd056e34130d432d688e5e
+ pristine_git_object: 118c7022049d8871c7bcd94acc54857f7b9a1165
docs/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsPreviewHeaderXGustoAPIVersion.md:
id: a368eac1eaec
- last_write_checksum: sha1:7679dad62ca47b9aeb6432924686e71b106ffc65
- pristine_git_object: a79dbba655b80007517e78cce745fe38d57286d2
+ last_write_checksum: sha1:cfcb0d6c608d85bcd900b486dd6067a4a477c440
+ pristine_git_object: 088e5a06656ce7f452e91d4a57d9a714126a4876
docs/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsPreviewPaymentMethod.md:
id: a37aef74f713
- last_write_checksum: sha1:72da69101607bd506c35034e59d6568f92e1d666
- pristine_git_object: 1a7ffb7004e0cdadb327c143630aabd61f342a3c
+ last_write_checksum: sha1:1d0fee81ab8b4af8ff17815755ab292fa8b83618
+ pristine_git_object: b9a837cccd07507457d11880ba070b1f5c674f2f
docs/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsPreviewRequest.md:
id: 1883487b0640
last_write_checksum: sha1:74ccb1394dce1f89b7369933713cebe8a18e0f15
@@ -4095,24 +4424,24 @@ trackedFiles:
pristine_git_object: 3a323aa09f4a699cd7df472cffee13d56816d297
docs/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsRequestBody.md:
id: ef06a3f9b0aa
- last_write_checksum: sha1:bc3ea9dbd28b8ed55acbc0a120ffea1540b383a0
- pristine_git_object: 7a99774ee89cf4c4e57fb4e7fe5451b3f2dee66e
+ last_write_checksum: sha1:c63f4a5f6777bb2212103593136a2c65a9e22611
+ pristine_git_object: e316fac80a42bd0a629367bcfb059aca9140525d
docs/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsResponse.md:
id: 835554da692c
last_write_checksum: sha1:1e050b52fe4cb1cc843a987825130c760431d1c8
pristine_git_object: f8d6b6deb9c4f8e6407c2229b09e799819de2f8f
+ docs/models/operations/PostV1CompaniesCompanyIdContractorPaymentsHeaderXGustoAPIVersion.md:
+ id: 79957b0d2c82
+ last_write_checksum: sha1:af42d97b20bf393e45c3e49b502285335ddf6faa
+ pristine_git_object: a99c041eb2b68833c5ff5cdc5601a511eba011b0
docs/models/operations/PostV1CompaniesCompanyIdContractorPaymentsRequest.md:
id: 402e483d649d
- last_write_checksum: sha1:16df1b25291939b27c3a73377f597eb752cac61b
- pristine_git_object: dd2e1ca1b27e3c144aff3f18e423936af1ab4c5d
- docs/models/operations/PostV1CompaniesCompanyIdContractorPaymentsRequestBody.md:
- id: 9f81e1e4175c
- last_write_checksum: sha1:458b8ea338df4d7561744830c2fe902cd694e1a1
- pristine_git_object: 087932472180f036c437c199e895b6fb00408c5b
+ last_write_checksum: sha1:ad49b798ee1955408a4b6bb2c3af32de8cb6dbce
+ pristine_git_object: 037c8fccd01479d87323d8c640910b63022a5163
docs/models/operations/PostV1CompaniesCompanyIdContractorPaymentsResponse.md:
id: f07626d304e2
- last_write_checksum: sha1:f889375c683d07d9829646a221b4b1f890fc5c49
- pristine_git_object: ddc3bb15a0eb22cfd74df4c27089ecf8063a2523
+ last_write_checksum: sha1:8119c048d5d44a5a49e3e360489439c2d7ed603e
+ pristine_git_object: 851ae5cc157ae16c470b4bbf222fac9533e3eb9b
docs/models/operations/PostV1CompaniesCompanyIdEarningTypesRequest.md:
id: c506216aecb3
last_write_checksum: sha1:9b7688f5c64f7458c9ee0e69e29462b59b6f2992
@@ -4125,18 +4454,18 @@ trackedFiles:
id: ff66c436f870
last_write_checksum: sha1:61ef07aeaeca7218dbcd612a12b7997bb3e42f55
pristine_git_object: 7d65879f8be0b0beec357e1ff22f211f2758bc2f
+ docs/models/operations/PostV1CompaniesCompanyIdLocationsHeaderXGustoAPIVersion.md:
+ id: 9ebd9887c8fb
+ last_write_checksum: sha1:8a4b1e03b21bd32f525b325fa9c5a25a4a4b7914
+ pristine_git_object: cfa6816fd81f01d23d1cf2f069c910a3585a80e2
docs/models/operations/PostV1CompaniesCompanyIdLocationsRequest.md:
id: 64a1793d8721
- last_write_checksum: sha1:46d091130a0fbe8d4d948054259226a5bcf6ffaf
- pristine_git_object: 8e26478f225cc99e604f6c2badbe98abab6e084c
- docs/models/operations/PostV1CompaniesCompanyIdLocationsRequestBody.md:
- id: e83bda27ab71
- last_write_checksum: sha1:3fdf1d3d8daec7d3fe72e4d64d6d80ca067a120d
- pristine_git_object: 1285be791062311327b87f8e7f377ed0892a3857
+ last_write_checksum: sha1:b17b0a98ebace7dd1a4d0dd94ca3b430e36b9056
+ pristine_git_object: 97ed5b75d23e67ce5933c2e4c24f9f9278e0c3cb
docs/models/operations/PostV1CompaniesCompanyIdLocationsResponse.md:
id: a9ea569bfd31
- last_write_checksum: sha1:374df48bda3941b0b31117ef8b75ada8cfe5fa69
- pristine_git_object: 3e8ed3d639bf97335f32a324b00864b08aa4c038
+ last_write_checksum: sha1:7870f50787ed8034de8fca1ed92f5d44254fce79
+ pristine_git_object: 85469e49d35a3cc177592f2bc789b2d80d6bed3c
docs/models/operations/PostV1CompaniesCompanyIdPaySchedulesAssignRequest.md:
id: 2f01b76a2754
last_write_checksum: sha1:613b31a51af65f9fbf0dfdffe583c5e3f9a49386
@@ -4153,22 +4482,22 @@ trackedFiles:
id: c6405a4963ba
last_write_checksum: sha1:cdc15371357e50c0f0a2276c58af855c9b0994a5
pristine_git_object: 1fca108006decd539439c9f2b901e3dbac1b0d74
+ docs/models/operations/PostV1CompaniesCompanyIdPaySchedulesHeaderXGustoAPIVersion.md:
+ id: 0835e6921eee
+ last_write_checksum: sha1:a8287977393b34e21a3ebfcd912cac664666a598
+ pristine_git_object: cd29dbc6ffb4a747a6a3fe1c638916f49ba503f2
docs/models/operations/PostV1CompaniesCompanyIdPaySchedulesRequest.md:
id: 230016b3bbf3
- last_write_checksum: sha1:f46f705aeeb18c45f0e3d3e6a0ebed1908f445d6
- pristine_git_object: 7fbb5f90da44c25d31478e36bc18604c5f2886b2
- docs/models/operations/PostV1CompaniesCompanyIdPaySchedulesRequestBody.md:
- id: 09f679c4d8ff
- last_write_checksum: sha1:1ceabbe48d7910a29b033463f22eae6570e407c7
- pristine_git_object: 078741525f04cd120c2199582f0f226ead05059d
+ last_write_checksum: sha1:39abd08394a5feca690102dbfba2cf5a91a60aa3
+ pristine_git_object: 0d40459e445e11c728c2f9a072be594e31004c0a
docs/models/operations/PostV1CompaniesCompanyIdPaySchedulesResponse.md:
id: 316af001c8df
- last_write_checksum: sha1:0b7316353622ae375ec1476baaca01b9fb786801
- pristine_git_object: b52c026ec148c7aa931550940a5d168c46722092
+ last_write_checksum: sha1:bfc5f3cb24d9d8d973311fe595caddc29f62429b
+ pristine_git_object: c1b02f3248bd4d21b6bba60ebee7252560c3b1b1
docs/models/operations/PostV1CompaniesCompanyIdPayrollsHeaderXGustoAPIVersion.md:
id: 6f666b6c7e9e
- last_write_checksum: sha1:81e4f968808ffced18be5265822a3b7c5cc38d5f
- pristine_git_object: 4b8cb18566ef0550886d86faf12c5fec594e6af8
+ last_write_checksum: sha1:0e800cd8914b14dcbcc34c31b6581d343e165824
+ pristine_git_object: 4d27b5c3ef2d893d66fcf1fae61376af34118b4c
docs/models/operations/PostV1CompaniesCompanyIdPayrollsRequest.md:
id: 1f1bd7f6cc61
last_write_checksum: sha1:72e65ac85f2c5d46835bd4f3a9c181ea1ae0d7b8
@@ -4179,20 +4508,16 @@ trackedFiles:
pristine_git_object: e3c08e3dc01ebebbbed6188d051eb50f2a51c91b
docs/models/operations/PostV1CompaniesCompanyIdPayrollsResponse.md:
id: fe7fa931c9b7
- last_write_checksum: sha1:80944a560e0189203d915df798eeb332d07f5295
- pristine_git_object: 0c48bae5710cd06ac72c5efd9516189f5ff06ea7
+ last_write_checksum: sha1:83c0498d9cd17c772a3d6e4af2b535ec94d4fa0c
+ pristine_git_object: 215698bb64e042835142bc81509ba966b32c11cd
docs/models/operations/PostV1CompaniesCompanyIdPeopleBatchesAccountType.md:
id: 1a311dabaa6a
- last_write_checksum: sha1:00c426de5655b7a0b0ddfbbe24e342f6a78b4c1c
- pristine_git_object: 542ea8b53d10aaa468ff82b9a625181afbbc8769
- docs/models/operations/PostV1CompaniesCompanyIdPeopleBatchesEntityType.md:
- id: c020774b6877
- last_write_checksum: sha1:3bd2347ee05c09d90a02265165c0f7c5923a6836
- pristine_git_object: d8aec356079a2f5d82a8f0843b6be555c962076c
+ last_write_checksum: sha1:8cc8d38c4b2142d0b8088d53d45f421afeb20ec3
+ pristine_git_object: 00d4709e94b2e3d0c0f945038e07c1d848dc6502
docs/models/operations/PostV1CompaniesCompanyIdPeopleBatchesHeaderXGustoAPIVersion.md:
id: 2b0bbc48cdf6
- last_write_checksum: sha1:866f84f4dcd164e79eb39cf27abfe83f3b2d0824
- pristine_git_object: 5e603b0eedbeb5fe6baf188242908d87aab8614a
+ last_write_checksum: sha1:c29b3de5444f1c77192ad53811275ebc20151605
+ pristine_git_object: 0594251887d6a459d840886a936f10d0eec60f9e
docs/models/operations/PostV1CompaniesCompanyIdPeopleBatchesHomeAddress.md:
id: 4e45264368aa
last_write_checksum: sha1:93f73b0e877bd60127a008eed55f953b9de7f536
@@ -4201,10 +4526,6 @@ trackedFiles:
id: b0c405e450ad
last_write_checksum: sha1:0b687c01178adf265e8a1c3228397f2faecaf62d
pristine_git_object: 5e857913102acc87994cd537e2828e66abdb6026
- docs/models/operations/PostV1CompaniesCompanyIdPeopleBatchesPaymentUnit.md:
- id: 2ee5970bd68e
- last_write_checksum: sha1:25b21485168397a68c4762e2b0ec74195f017781
- pristine_git_object: 03c0e44d69454becaccd9b5162199db65214228d
docs/models/operations/PostV1CompaniesCompanyIdPeopleBatchesRequest.md:
id: 5b1c63c0c0cc
last_write_checksum: sha1:79e8c2eefea91cb41d3cefcf499ae1745d24a231
@@ -4215,32 +4536,24 @@ trackedFiles:
pristine_git_object: 08dc4bd9d48c9e84eab6c3cfeb31566f85eeb3b4
docs/models/operations/PostV1CompaniesCompanyIdPeopleBatchesResponse.md:
id: 9271271dbbc1
- last_write_checksum: sha1:b33e9d3bd98c9b4015fe8a3641b82a28e038c202
- pristine_git_object: c870b990181536108732e829218edbfa606761bb
- docs/models/operations/PostV1CompaniesCompanyIdPeopleBatchesResponseBody.md:
- id: 2a831dbba226
- last_write_checksum: sha1:14634ab53fc89e5f0dc4dd02590bf340cf8fb5e1
- pristine_git_object: bfc32cde7a6e79ccb85227251de6e90011aeff83
+ last_write_checksum: sha1:47dfc433a2ed10ecca44d21f3a2623bb056b9122
+ pristine_git_object: 49fd2791e0852dbc726e5c9082188bf056e215df
docs/models/operations/PostV1CompaniesCompanyIdPeopleBatchesSplitBy.md:
id: 551f3ed8351e
- last_write_checksum: sha1:b5d15d14e43ca9bf02952afd263902a7dcf2bd25
- pristine_git_object: c97d28ea94cf8ed2e871583898e6d5e2cbc4621d
- docs/models/operations/PostV1CompaniesCompanyIdPeopleBatchesStatus.md:
- id: b2fb648c53f7
- last_write_checksum: sha1:32468a62579a59ca44a2e5cbc3f8db8847b1c94a
- pristine_git_object: a10d71398efb4d4386cef52b1416011464b08fe7
+ last_write_checksum: sha1:a52b3eff3f1d74c502285bcb23a1df94b838d2df
+ pristine_git_object: 83c45f7b899a82eef6a32b8b6be541542e64a7f8
docs/models/operations/PostV1CompaniesCompanyIdPeopleBatchesType.md:
id: 45e145bbc851
- last_write_checksum: sha1:942a47a8ee1ad43bc71355239fc3949c5f7536a7
- pristine_git_object: 70fafa850c25196263d0493a0e0e4ba9ac5f67dd
+ last_write_checksum: sha1:743f943678abbeb6a94f94890619d53777840a20
+ pristine_git_object: a8ab658d206e11cffc9cf95642e4083a7cea259b
docs/models/operations/PostV1CompaniesCompanyIdPeopleBatchesWorkAddress.md:
id: bb97c9796bff
last_write_checksum: sha1:b7fb3cd7844620183ac530cb3f67a086de623122
pristine_git_object: c8bf8f78710cc048b1f3564936c5a5178cf50f7a
docs/models/operations/PostV1CompaniesCompanyIdReportsEmployeesAnnualFicaWageHeaderXGustoAPIVersion.md:
id: 88cd827f016a
- last_write_checksum: sha1:22f288c8f69be17cb0d358c185a264d00ed755de
- pristine_git_object: 0f57de9e7bf27896095fd1e584e119798fccbcd8
+ last_write_checksum: sha1:b956ff706d487804c2dd9bc684f238a723125d9a
+ pristine_git_object: f04accdeffdcdf6b1afda2d5edca5543680a6166
docs/models/operations/PostV1CompaniesCompanyIdReportsEmployeesAnnualFicaWageRequest.md:
id: 44837b161581
last_write_checksum: sha1:01fe79bfb7407fc8f680d7688b3aabce1dfce32a
@@ -4257,26 +4570,22 @@ trackedFiles:
id: 85f4ac9ce360
last_write_checksum: sha1:0bec62d458d5aa6aef336e02a78076077eaa177f
pristine_git_object: c1b358a1d021e48ef5142eb10f0707b97abd7cf8
+ docs/models/operations/PostV1CompaniesCompanyUuidContractorsHeaderXGustoAPIVersion.md:
+ id: 835962959bf6
+ last_write_checksum: sha1:69f4b8264dc6c293be7461c202be92eac507fe51
+ pristine_git_object: d72eaf7167e34d2224e03c9d116b6008562564ca
docs/models/operations/PostV1CompaniesCompanyUuidContractorsRequest.md:
id: 955827f44089
- last_write_checksum: sha1:080c5b9b7bf2cb1132d4fb419ee6d076b8bb060d
- pristine_git_object: 0b140e8035cf1fb0cbc573f5e32b1ba76fb395e0
- docs/models/operations/PostV1CompaniesCompanyUuidContractorsRequestBody.md:
- id: 76ef9ed56c94
- last_write_checksum: sha1:0dcd14ce0780c7e1c74f5f11bb9039289e8df0f7
- pristine_git_object: 228f1e603dab7ff8dcd0e972f70a8be97235b327
+ last_write_checksum: sha1:2f911c79088d7845a5918c6d1d00e604405dc122
+ pristine_git_object: 64876de144f8a3ab06444676b2ec63e77373afc7
docs/models/operations/PostV1CompaniesCompanyUuidContractorsResponse.md:
id: 9dda80a2d6d6
- last_write_checksum: sha1:b5e2764349975886b2a6ef091fc7b53f2eebf620
- pristine_git_object: 68f84fa7f53a2a4f2e7f89f3f10c78b8eb157efb
- docs/models/operations/PostV1CompaniesCompanyUuidContractorsType.md:
- id: 134376c3e9b1
- last_write_checksum: sha1:c30f4c4ddb6fc7637c003971d587eef859646ed7
- pristine_git_object: ed66489f68eedeb00860a42b5639669d7ef0dd46
+ last_write_checksum: sha1:c04f6b2edaadc0de724ca492fa85516613e1893b
+ pristine_git_object: 1eeef94ac1d9634b1769980938d0cdad5083c910
docs/models/operations/PostV1CompaniesCompanyUuidHolidayPayPolicyHeaderXGustoAPIVersion.md:
id: 025d37c55a0d
- last_write_checksum: sha1:490162a374d37d6efd529d55522377e09993d472
- pristine_git_object: 3a1b69803a6a607c5d78640a639cee312b228ce4
+ last_write_checksum: sha1:314b1ed80e0aa8912de57aaa0330315f9e291deb
+ pristine_git_object: c1e3ebb0b0bfc2f821fce22bdff54a4806b3f274
docs/models/operations/PostV1CompaniesCompanyUuidHolidayPayPolicyRequest.md:
id: 992f3e0d4ca7
last_write_checksum: sha1:dc32853ede5f4065330911eed4fc6fb818f7e5e6
@@ -4285,22 +4594,22 @@ trackedFiles:
id: 00b8a143e512
last_write_checksum: sha1:210886b0eb87fc30c9a5eeb910d569549f70a458
pristine_git_object: 7f1012b6b119578c7fcd5d53a6e870d89def78bb
+ docs/models/operations/PostV1CompaniesCompanyUuidSignatoriesInviteHeaderXGustoAPIVersion.md:
+ id: 4ca629b426d8
+ last_write_checksum: sha1:4745ff3a213285272506c6b6ff8bf5a50248e799
+ pristine_git_object: a9055415995c647df10227fd8158ff0a7c02e605
docs/models/operations/PostV1CompaniesCompanyUuidSignatoriesInviteRequest.md:
id: f3b2383e7446
- last_write_checksum: sha1:823b6b0d8cce14357a06abaa0a0569219f0b8c03
- pristine_git_object: cd518b35394ffadaab715696d47a2a376f4b08b7
- docs/models/operations/PostV1CompaniesCompanyUuidSignatoriesInviteRequestBody.md:
- id: b100c6daa970
- last_write_checksum: sha1:2374ac66fa9e9a4992c30a8997cbdfa179779872
- pristine_git_object: 6ad6b9e60bba7fb8f41ca1a1e71a66d41a1f92b3
+ last_write_checksum: sha1:a6ca2528e20076e469badb0390f4f2c5d0290c4b
+ pristine_git_object: 8790dab06e358009ccbafcbf0e827e377621377f
docs/models/operations/PostV1CompaniesCompanyUuidSignatoriesInviteResponse.md:
id: f1444bdf53b5
- last_write_checksum: sha1:8c727683615b63fa7358f67bac7ce03ffa08e9f8
- pristine_git_object: 896a9032b307d7068703fb4f4f9ff461cf02e83e
+ last_write_checksum: sha1:06397041a1836b910b0d221c56c1c79ff39ad982
+ pristine_git_object: 4217f6bcd275e9cffb6db51f656aed4fcfa61bea
docs/models/operations/PostV1CompaniesCompanyUuidTimeOffPoliciesHeaderXGustoAPIVersion.md:
id: 609c02e5402c
- last_write_checksum: sha1:991a36cbaa7a982e82527375389d0c5655735876
- pristine_git_object: 9f36939f1f2cfd8e94e78f22664d24d28c280690
+ last_write_checksum: sha1:8b336066fe9643bdb8a6d06cf0dc101942b67880
+ pristine_git_object: 94c7d7be7cdb143b0e35dcea723fbb4f6248231a
docs/models/operations/PostV1CompaniesCompanyUuidTimeOffPoliciesRequest.md:
id: d1ee4a87725f
last_write_checksum: sha1:1c22d2fe3ea834c3079c18fb35e98792df0c576e
@@ -4309,46 +4618,46 @@ trackedFiles:
id: 20f61fcfbef5
last_write_checksum: sha1:c6738cacf90af3a96d232f3dc776998010645d27
pristine_git_object: ea280264fa55fcdfe6d8d582f1803c9312616314
+ docs/models/operations/PostV1CompanyFlowsHeaderXGustoAPIVersion.md:
+ id: ab816f3c239e
+ last_write_checksum: sha1:ecabd14f61efe1f3a483f96685932ee923393e72
+ pristine_git_object: f7717b7239e4707c83ed3e7281978b02735bd647
docs/models/operations/PostV1CompanyFlowsRequest.md:
id: 41641b3b0a9e
- last_write_checksum: sha1:cdd50f2eafceeafaf70c00752da6d475a4bc7672
- pristine_git_object: 248577089b39ed4576559fe9c4399e2757658413
- docs/models/operations/PostV1CompanyFlowsRequestBody.md:
- id: a50962333b16
- last_write_checksum: sha1:1f1489dd7764ba467af71cc1acfb7dab1554281f
- pristine_git_object: fdee9deba93b23e0e9a73775923e0c24af6f797a
+ last_write_checksum: sha1:9f916889013ada5efd4ba9b60e85312ac3cbce72
+ pristine_git_object: 4965fae58650768625ab6f2b0b7e8fb48c5d600c
docs/models/operations/PostV1CompanyFlowsResponse.md:
id: 4474a38843b7
- last_write_checksum: sha1:35ef078e1197fa220f4d035faed63821163bab5a
- pristine_git_object: 5e5f4df4595af11db105a9945e4810e475ce0376
+ last_write_checksum: sha1:b46ce1bfe484a1f028ed474cfc3001b9833995b2
+ pristine_git_object: 8493090c4176c72731772b4b93110f35a9eaba56
+ docs/models/operations/PostV1CompanySignatoriesHeaderXGustoAPIVersion.md:
+ id: d6fc3b29f430
+ last_write_checksum: sha1:792d7d1de8bde5c791b2c84abef4eb7ce59480fc
+ pristine_git_object: 2f730a1c4433903d8a54cf6f5cf55dc10814203b
docs/models/operations/PostV1CompanySignatoriesRequest.md:
id: 99b80c3073ec
- last_write_checksum: sha1:b97ab72a94916f7b2e51aa23152d279ac18af5b1
- pristine_git_object: 8e3ea9b4d0174bdfe9ccda41a434b1ef81a09670
- docs/models/operations/PostV1CompanySignatoriesRequestBody.md:
- id: 1792e3669101
- last_write_checksum: sha1:cc659baed5586edda7c3936eaf12eb9a73d09b2e
- pristine_git_object: ce67b9054122904c41509ad6db76e26c94e5b616
+ last_write_checksum: sha1:d3d4ce7399a80aa1eb0c12b1bf2a78d48f510bca
+ pristine_git_object: 9a5dd743ac40ac5ef3c7111d3998ba4fc0913691
docs/models/operations/PostV1CompanySignatoriesResponse.md:
id: f0abb6e36894
- last_write_checksum: sha1:de69edb9820a1b48e48c852e2a0ad88d54e90640
- pristine_git_object: 49cc4867a791cb34c71d132efa988e20395ef6cf
+ last_write_checksum: sha1:d81d3292392004758f0bc20d8a99304ec2cc6581
+ pristine_git_object: fe46ca502bdac9256bbbac1830c86c0bdb2b9415
+ docs/models/operations/PostV1CompensationsCompensationIdHeaderXGustoAPIVersion.md:
+ id: a44a05a42ed9
+ last_write_checksum: sha1:a778a760bbd6af22a160ff1e6ddeb52175ba9dbf
+ pristine_git_object: a375078218b4896b018f7ab45a47eecec57b0463
docs/models/operations/PostV1CompensationsCompensationIdRequest.md:
id: 24043faad237
- last_write_checksum: sha1:c73d61f91104b9f27f3f2a13521f3ca2ed6c92e9
- pristine_git_object: c59cd77d81de1f4b8223aab5c06d1023c6822bef
- docs/models/operations/PostV1CompensationsCompensationIdRequestBody.md:
- id: 9e77bcd75fc4
- last_write_checksum: sha1:95948a94ea9b0a066bc7a49345af3c870a21e86a
- pristine_git_object: 3e6b607ce97be4669098142ba0eee5404dbf9721
+ last_write_checksum: sha1:5e8fb643ccd5f2b82414e537071e18d930926af3
+ pristine_git_object: 3f1665eeeb2fb9b6b9af1fa2fdd1e2d2eac79833
docs/models/operations/PostV1CompensationsCompensationIdResponse.md:
id: e016310a0d7c
- last_write_checksum: sha1:cf04cb6ffb287347e6df180d702525d9ec9350bb
- pristine_git_object: 080d031e7321712060db8cbd1f01a1d4ce0b9615
+ last_write_checksum: sha1:ffa060bc80a8e6f2e8fc592724762682db0b585e
+ pristine_git_object: 68d9cf14df01a3a01356a19dd047e7d2f02f1f67
docs/models/operations/PostV1ContractorsContractorUuidBankAccountsAccountType.md:
id: 0912b65e1311
- last_write_checksum: sha1:18c74599db7044aa8c5d368b4003437940f32e02
- pristine_git_object: b13fa700b5194b6b0ba3276bbc86f0086aef7114
+ last_write_checksum: sha1:94cb4aacfc33ef560cf68ac4599d46d7dbee1f32
+ pristine_git_object: ae7c192d0528cd809e1437b594ebe7f3f609dc56
docs/models/operations/PostV1ContractorsContractorUuidBankAccountsRequest.md:
id: b6c922b64bc3
last_write_checksum: sha1:fa7deb1bfc68a0eb090bc9be12e2931087a5b68c
@@ -4387,8 +4696,8 @@ trackedFiles:
pristine_git_object: 10a3cbb34571441e96a5b8c21622f32f7a4db63c
docs/models/operations/PostV1EmployeesEmployeeIdEmployeeBenefitsType.md:
id: 4484afd2d866
- last_write_checksum: sha1:c184745390b5c1851fa72945413711d377d782cb
- pristine_git_object: 5c40181a2a857f31c0914180c7ce2d26d5cfdc5f
+ last_write_checksum: sha1:a1e7992867bbf89622dff892a6ca4f18c92936c7
+ pristine_git_object: 7fb85fae21b20013ebe2ae28fed0ee1db05d3bd2
docs/models/operations/PostV1EmployeesEmployeeIdGarnishmentsRequest.md:
id: 1c2bf1544962
last_write_checksum: sha1:9deea5fe5d51e7c742cceac4bddc247eccdeeb84
@@ -4403,8 +4712,8 @@ trackedFiles:
pristine_git_object: 0a5d74760247c317840816a002fa29123fde5d32
docs/models/operations/PostV1EmployeesEmployeeIdHomeAddressesHeaderXGustoAPIVersion.md:
id: be6dfc9c0acd
- last_write_checksum: sha1:98895612ff3387e1530b626320aabcdaabfa06ba
- pristine_git_object: 1198fefefa01fb4ed5e569ddb77ea6748d3767aa
+ last_write_checksum: sha1:ee7ea6fb7fc353416c5c52663f4a373c2eaac6d4
+ pristine_git_object: 0c422a606eaf882ad9746f4354dbde3cccb5416e
docs/models/operations/PostV1EmployeesEmployeeIdHomeAddressesRequest.md:
id: 57ddfcc7561a
last_write_checksum: sha1:b94fd46e398143b32b1ea53abc88ab589c135750
@@ -4419,8 +4728,8 @@ trackedFiles:
pristine_git_object: 2dba62b7f4e0c2a9b8f1fe37869eda2ede02759b
docs/models/operations/PostV1EmployeesEmployeeIdRecurringReimbursementsHeaderXGustoAPIVersion.md:
id: f45d0ce7022d
- last_write_checksum: sha1:cade7673e68d5bb0cf011d33cce584e69cfd747e
- pristine_git_object: 721d192ee31ee02ec1def712dc0cdeacf6962766
+ last_write_checksum: sha1:7c86be3948f2712599bb6e9a6fa4704254ef864e
+ pristine_git_object: 1f504d7bc9f272c3589b985033228f6724716533
docs/models/operations/PostV1EmployeesEmployeeIdRecurringReimbursementsRequest.md:
id: 9d5329790c4c
last_write_checksum: sha1:00910bdf426dae8845db0deadb95e552c953f36a
@@ -4431,12 +4740,8 @@ trackedFiles:
pristine_git_object: a5e9327704d0a01a4944245004858398068b0e68
docs/models/operations/PostV1EmployeesEmployeeIdRecurringReimbursementsResponse.md:
id: a1fc98e77331
- last_write_checksum: sha1:83a182e6f4bd97d9868ae6e0ad134310ad0f71dc
- pristine_git_object: f78f93737dcc580c6211879cdcef31213fe58312
- docs/models/operations/PostV1EmployeesEmployeeIdRecurringReimbursementsResponseBody.md:
- id: 43f14b92404b
- last_write_checksum: sha1:d1bf91c83aaf3c83920143f5a36af87ebf8e9454
- pristine_git_object: f34a1641100c92d6737dc0b256dd14e8e111cede
+ last_write_checksum: sha1:38233eb9fd7f1d56b0299070a4f4a99dfaf6d42b
+ pristine_git_object: d22e263232e66f36131a8200523f04424460f11e
docs/models/operations/PostV1EmployeesEmployeeIdRehireRequest.md:
id: e0482c9dd505
last_write_checksum: sha1:880209e8d4aa6de736314459da16836dfb50d4e3
@@ -4447,8 +4752,8 @@ trackedFiles:
pristine_git_object: 8b777dcb393c99ff863111651dd3acb0e277d38c
docs/models/operations/PostV1EmployeesEmployeeIdSalaryEstimatesHeaderXGustoAPIVersion.md:
id: 5ecce335a11e
- last_write_checksum: sha1:55c1c40d5f2c79c987707daa8f2bb8d9cded42d4
- pristine_git_object: c964ea08aec4f76c15c833448fcf8fe4ace0371a
+ last_write_checksum: sha1:8d4f47810f03d624746684c5ff6ceb01fe7bfd5e
+ pristine_git_object: 7c6cae0964f50c47daeef9afc026cf245af9b708
docs/models/operations/PostV1EmployeesEmployeeIdSalaryEstimatesRequest.md:
id: 29b13310e43d
last_write_checksum: sha1:7dc742f1909e41575b10d19ecdcc706c9b3c885a
@@ -4475,8 +4780,8 @@ trackedFiles:
pristine_git_object: 89770f9d5ef7c7d2ad295cd44e9bf0db731d2419
docs/models/operations/PostV1EmployeesEmployeeIdWorkAddressesHeaderXGustoAPIVersion.md:
id: dea465391c32
- last_write_checksum: sha1:9f9fd7cd78a75faf6446caeeae90abc21f123a4b
- pristine_git_object: 6bf259698a164799fc3aaee12ef219f9ca3c1245
+ last_write_checksum: sha1:d79011b687b7f794eac5e1ff647ae609717c0b25
+ pristine_git_object: 44eeeac43297565440c19b1a388cb4067fc7efd9
docs/models/operations/PostV1EmployeesEmployeeIdWorkAddressesRequest.md:
id: 2642f48d6bb3
last_write_checksum: sha1:25952ea526ca4cc063b10b3ea6fc98b485f983dd
@@ -4491,8 +4796,8 @@ trackedFiles:
pristine_git_object: 2d2c1f0396c294217086059e8dabaae58c45d95f
docs/models/operations/PostV1EmployeesEmployeeUuidSection603HighEarnerStatusesHeaderXGustoAPIVersion.md:
id: 56fe5f22711f
- last_write_checksum: sha1:9bb03a30203da92fa71f79ffb3a8f3a321fea10d
- pristine_git_object: ff8b1e05b7ff34902b3fc8f80d5de35c2835152d
+ last_write_checksum: sha1:84fcd3d6d208ee8babda67e421991731a510cae8
+ pristine_git_object: 2e2da89943f2bb9f6886e974665fdc6d5340ccd2
docs/models/operations/PostV1EmployeesEmployeeUuidSection603HighEarnerStatusesRequest.md:
id: edf077bfc210
last_write_checksum: sha1:c705bdd3c39aa12a2f137b14892d5fc716c12771
@@ -4503,16 +4808,16 @@ trackedFiles:
pristine_git_object: 2bbfb3b408525dcfb4a7e69dccf1439a342b753b
docs/models/operations/PostV1EmployeesHeaderXGustoAPIVersion.md:
id: b4901d3110b3
- last_write_checksum: sha1:c85c690e0dc9d298933e542e122eb113520db663
- pristine_git_object: 565f7191d1de9c2874e0c824e1a13b9cc435ad76
+ last_write_checksum: sha1:28e0d80136dc67d6f58192f5a6b4af14a7528b96
+ pristine_git_object: 3d30ceb65840e97f238067c2eff372f59c38cce4
docs/models/operations/PostV1EmployeesRequest.md:
id: dc96571f8c71
last_write_checksum: sha1:384099d75cbe6b12cd48c9e4c82cd2c71373066c
pristine_git_object: 6b13bd651b034a5f835c91e4cb249015149f76ae
docs/models/operations/PostV1EmployeesRequestBody.md:
id: bc8b8dd0fbd8
- last_write_checksum: sha1:ad5c98c282fde33abbfee6a318c909bfbe1271f1
- pristine_git_object: 967246975f6a96c0e91a9e0212adeed742c54113
+ last_write_checksum: sha1:6087ec5ed08ef68de47a835a1354d03073dd7508
+ pristine_git_object: 71bc5faca52d7097fe6c09e9f7d6ba031602b0ce
docs/models/operations/PostV1EmployeesResponse.md:
id: 55fe60aa308a
last_write_checksum: sha1:4a156fd169e62a113d81ea2506873a338579ac29
@@ -4569,18 +4874,18 @@ trackedFiles:
id: 6fa91b563914
last_write_checksum: sha1:fc767ac3a6a2808b2277da4ad4b3c81aeb7765a0
pristine_git_object: 4cd14e4a1ff448b00d37afd3d4347707c49ad948
+ docs/models/operations/PostV1PayrollsPayrollIdCalculateAccruingTimeOffHoursHeaderXGustoAPIVersion.md:
+ id: bc59ec1f14b5
+ last_write_checksum: sha1:e543abeacb3c56d1001ec4780789f3d4566d3c4d
+ pristine_git_object: 8afbf95104e3ea9a358e32136895992ec6580003
docs/models/operations/PostV1PayrollsPayrollIdCalculateAccruingTimeOffHoursRequest.md:
id: 60fa62ad0255
- last_write_checksum: sha1:9afc71ddbd12e44632255687903d107f3f74f8f7
- pristine_git_object: 7225920c34695aa24379407a4dd15cc09a289a6a
- docs/models/operations/PostV1PayrollsPayrollIdCalculateAccruingTimeOffHoursRequestBody.md:
- id: ab5b6fa73338
- last_write_checksum: sha1:8a1f2e0e549f5e0c7151f95a315dfa81fa667b52
- pristine_git_object: 8b1c4e981d370db41cdcde252925354cbdd08d5e
+ last_write_checksum: sha1:08b31c63824d7240b1ccb36d335677b8a055f209
+ pristine_git_object: 27e23ea968e33c0be7787a6dd4c0b32072d15ccb
docs/models/operations/PostV1PayrollsPayrollIdCalculateAccruingTimeOffHoursResponse.md:
id: d03263e47df5
- last_write_checksum: sha1:e5434d0a13f2048ae46e327bd4f7fdb17fe2b401
- pristine_git_object: b256fdad3c1ad3c2dd2948a42c070ce8b4a775c1
+ last_write_checksum: sha1:06cab21b236276f754813b5ea4250bc4f6140dfa
+ pristine_git_object: 0f71b474960402e84595d544cf6256ae06434049
docs/models/operations/PostV1PayrollsPayrollUuidGeneratedDocumentsPrintablePayrollChecksRequest.md:
id: 8792981e04f8
last_write_checksum: sha1:88679402ad8453b88ff334cf506f23ba44ed5b0c
@@ -4611,8 +4916,8 @@ trackedFiles:
pristine_git_object: e4ceb96dd7e0763716a5c6620d44ad604059f855
docs/models/operations/PostV1SalaryEstimatesUuidAcceptHeaderXGustoAPIVersion.md:
id: d26ee87fe3db
- last_write_checksum: sha1:37f1285c223776ede3d1d12fd5f99a0775eac76a
- pristine_git_object: 1bbe4eaed0e47a0b8edfe15b1108bf13610cbea0
+ last_write_checksum: sha1:4d000d14d5b9d1190124212a4bf28ad567787ddf
+ pristine_git_object: bc8f46f6e2792b03c0574d0094d02a7f96e9fba5
docs/models/operations/PostV1SalaryEstimatesUuidAcceptRequest.md:
id: 368015e8cb52
last_write_checksum: sha1:beb7322a53abec1a863f7151e58faf92f724e42e
@@ -4675,12 +4980,12 @@ trackedFiles:
pristine_git_object: 1e98127dec7add3af2a182f146d9c73be489e733
docs/models/operations/PrintingFormat.md:
id: 487bf12560cc
- last_write_checksum: sha1:1acd0b49acaba0791e0af92386c848014a98cb0f
- pristine_git_object: 2eed9948b0e78c62d20c99ebd3561a01aec7aefa
+ last_write_checksum: sha1:52638b2b5a125772ce7ef9039942b0de283c545a
+ pristine_git_object: 671396e82e40e8a74ac5fde1a1089bf42a47e1a3
docs/models/operations/ProcessingStatuses.md:
id: fb254459e9eb
- last_write_checksum: sha1:d53c6edc50d8f6eb78a2e882b87d35a3ba9fa93b
- pristine_git_object: ae4a9f0f2f8318d35186fe4304dffaeb418b3160
+ last_write_checksum: sha1:ddcf744dd4313c6e56a7532cc0959e81e3a3b594
+ pristine_git_object: 1140348bcbca29588888fe548a24d99063000ec7
docs/models/operations/PutAddPeopleToDepartmentRequest.md:
id: 2b9a863c52a7
last_write_checksum: sha1:34420df9ad0a925ca8faab6299abe91d327acbe6
@@ -4695,12 +5000,16 @@ trackedFiles:
pristine_git_object: 3c5bf85d1e551e6577e5342f35b8b720803ce167
docs/models/operations/PutApiV1CompaniesCompanyIdPayrollsPayrollIdCancelRequest.md:
id: b2f9c2fc64cd
- last_write_checksum: sha1:95707d193ea07bf76fffd52133861d3935ccfcc1
- pristine_git_object: 4242447dfb9074f23f61e0ddedf4c78064857625
+ last_write_checksum: sha1:f5ccd060055126d28e3a2c3a3d7cbe9c350a2a5f
+ pristine_git_object: 7bd8c0a064148e06aff6ccecf42a7b1a9ddd4a6b
docs/models/operations/PutApiV1CompaniesCompanyIdPayrollsPayrollIdCancelResponse.md:
id: 972fabf6dbb3
- last_write_checksum: sha1:43873891febba67e6c076efe09b6dfe885f76b46
- pristine_git_object: 4316dabde0d56ae17951b5aa6261273b79cd418c
+ last_write_checksum: sha1:5c3e50243b863334bd3e235909a73a12cacb9cbf
+ pristine_git_object: 88afbdd4f26772bde16523c39088f6b02c02f911
+ docs/models/operations/PutApiv1CompaniesCompanyIdPayrollsPayrollIdCancelHeaderXGustoAPIVersion.md:
+ id: 1a0d8196d16d
+ last_write_checksum: sha1:b35c810f656d68dcb2f8a14435bc54ce529a3459
+ pristine_git_object: 9c45523e9f31daaf6dc9abd98efa3adf11450778
docs/models/operations/PutDepartmentsRequest.md:
id: 047a12ea6e5e
last_write_checksum: sha1:ec411affbcf49437da35f75003a5859fd879143a
@@ -4733,18 +5042,18 @@ trackedFiles:
id: 372bfef4cccd
last_write_checksum: sha1:46db97a8d80e358024c9a0b5652eaa6216bd412e
pristine_git_object: ad3547d44f97b5e27057554c220e3cec487d22d2
+ docs/models/operations/PutV1CompaniesCompanyIdBankAccountsVerifyHeaderXGustoAPIVersion.md:
+ id: c7da3d21b0a2
+ last_write_checksum: sha1:b694a54e4357edb5ed9926823cf8500f7b91dd83
+ pristine_git_object: 201359ab38c1615dcfe950dee7e403669e4aa953
docs/models/operations/PutV1CompaniesCompanyIdBankAccountsVerifyRequest.md:
id: 80eaac7738f5
- last_write_checksum: sha1:4c8bc58cb06d04fadeb19fbe11d27f3e1964e4e7
- pristine_git_object: e4967dd186ddfa29589b48f353414627d788eaea
- docs/models/operations/PutV1CompaniesCompanyIdBankAccountsVerifyRequestBody.md:
- id: c94510c0970b
- last_write_checksum: sha1:7e27c976fea57dedfeea0f3f3f99f1fba43cee54
- pristine_git_object: 5074843b07b065ceab8f7dc7ed8055d8f521111f
+ last_write_checksum: sha1:2eb21c89000319ac69e5411ce5e8086c8a02e5fa
+ pristine_git_object: d693cc17900ef0054965e604408736c25ba826e5
docs/models/operations/PutV1CompaniesCompanyIdBankAccountsVerifyResponse.md:
id: ff6d569d04f5
- last_write_checksum: sha1:e7e0979d145d966c3505a7f15368322c0d4b64bf
- pristine_git_object: ee65e1ea39715e8a6eb5457590a22c4a90e2fce1
+ last_write_checksum: sha1:3c435bf541056f89823c069f3f6ccf44522ad66b
+ pristine_git_object: 1960b86b3df49e1a1a10c792dc5af2a7c5a67629
docs/models/operations/PutV1CompaniesCompanyIdEarningTypesEarningTypeUuidRequest.md:
id: b6a349a67bc1
last_write_checksum: sha1:3c07f94baf1750275eaab245ca945d9744085975
@@ -4769,54 +5078,82 @@ trackedFiles:
id: f2ac895b8625
last_write_checksum: sha1:6672d70877fe6b23da0ba5ecd39fc2396709a996
pristine_git_object: ca76e74f5cb7e427cc4e57ed07490a37bbe6522c
- docs/models/operations/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdFrequency.md:
- id: 632bee4577e0
- last_write_checksum: sha1:7ec90e6350fbdb26f158e4835629878dd11338fb
- pristine_git_object: e0e890c31f93b8ca34c5f8e01c4e53266062369a
+ docs/models/operations/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdHeaderXGustoAPIVersion.md:
+ id: 04d12140fc79
+ last_write_checksum: sha1:256c7d13d59544e2416dab33270fb34d2c4551a8
+ pristine_git_object: 3dad93ac084cbbe3e1932511f193313aa4795218
docs/models/operations/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdRequest.md:
id: debbc68dae47
- last_write_checksum: sha1:a2236d0eba5aa477bee59265956db1a29f8692b0
- pristine_git_object: 80bd39dafadf3a57b2f3fad9d993672ff68b3bb0
- docs/models/operations/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdRequestBody.md:
- id: 87f39a60f084
- last_write_checksum: sha1:f5aad86378f31d84defa42805927746bdf24e692
- pristine_git_object: 97b6732217d7ddcecb55a0bda99fa7423b8b90a5
+ last_write_checksum: sha1:0b854e2e7c82441e819f4b611d80035a03549953
+ pristine_git_object: ae7be67ce53d14f934cd1df0d8ea6fc569d5b675
docs/models/operations/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdResponse.md:
id: 66da2996e1ad
- last_write_checksum: sha1:84abf665f1c0ab26549ab85daf28ae1430c3743d
- pristine_git_object: 21f25828bd6743d4491bddd192184da991b08a2a
+ last_write_checksum: sha1:806c2525590e536dd29f2236df70cb62482a69d7
+ pristine_git_object: 56d7df3cc39d68bdec3bfa3ea02c9afcdf02cfde
docs/models/operations/PutV1CompaniesCompanyIdPayrollsHeaderXGustoAPIVersion.md:
id: 0ac3c86b55e7
- last_write_checksum: sha1:ae2bba65e83eb5d3170ebcb6b0537e515988766d
- pristine_git_object: fb715491f121cf2274f799d20c76b9170a18dc07
+ last_write_checksum: sha1:e2915f76683c87bcb19448c3de6635150ea80a41
+ pristine_git_object: b15b6bc2ed3e56e633ae9c3d8370b67a4aae0de5
+ docs/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdCalculateHeaderXGustoAPIVersion.md:
+ id: 9f550cff094c
+ last_write_checksum: sha1:2004d7d36d165fea64dac8a060c713bb695fd226
+ pristine_git_object: 48ba5049682440251ec3df4f37114d49d3777d31
+ docs/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdCalculateRequest.md:
+ id: a2af4f5bdd1b
+ last_write_checksum: sha1:cc726c937da95a5b258b630ae0c9f7c847c18f05
+ pristine_git_object: 1e7b726179555f17f0f5858370f27a4606258063
+ docs/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdCalculateResponse.md:
+ id: fa825a4f30f8
+ last_write_checksum: sha1:cc34ddb530fd5c2294664803e1a5615ec460dce8
+ pristine_git_object: 39275e911fc8aaf0f86c30f7dc8b67c843ad01e5
+ docs/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareHeaderXGustoAPIVersion.md:
+ id: 6d316328427e
+ last_write_checksum: sha1:4208d293b17408b0eb70dc5cce32b66d988c77bf
+ pristine_git_object: b824c08b831fd151fa2026778a089b55128bac34
docs/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest.md:
id: e792b3b21cbf
- last_write_checksum: sha1:33a4e00ef888b69fec8573d62f939481869bcca6
- pristine_git_object: 8e3b1a5556e47f0f80e1201de45c85f36698e1d2
+ last_write_checksum: sha1:755d7be34c546754059f0da59eeefbfdca00fed0
+ pristine_git_object: 37f934b828302814887c986101e21ed75a273db2
docs/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBody.md:
id: ebab6168954a
last_write_checksum: sha1:b21f363b9b8fe4c2dc743b936de9aff9475be958
pristine_git_object: 1193dc0ac2fceb7a4c7fc1dc1fab8b60cc965eef
docs/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareResponse.md:
id: 5346d9650ca3
- last_write_checksum: sha1:54b52436bae04a3627792b56d676d2156588cae0
- pristine_git_object: 4903064d0f3257b0f09a82dc4cfcfab5249845a1
+ last_write_checksum: sha1:39fb2e43f5f0ebd2dd4e47534d13f207f72a7445
+ pristine_git_object: 9fc61fd885610582e327900702c68d642f3bf618
+ docs/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdSubmitHeaderXGustoAPIVersion.md:
+ id: f79ef0963e88
+ last_write_checksum: sha1:f32957698cfce73e995c09c23ac3f1dfcc71f151
+ pristine_git_object: eef24c93f392f1db3dcdf90b1e70bd2bc50e4054
+ docs/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdSubmitRequest.md:
+ id: 30783718ff7e
+ last_write_checksum: sha1:cc2eac61ea237ca6ba39ec7cb3d17f7e0ae3924a
+ pristine_git_object: ea07d0265e9242344df2dae0a24670665b3f7322
+ docs/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdSubmitRequestBody.md:
+ id: e34f2be820fa
+ last_write_checksum: sha1:34aa7e7781f5be26f75d1af348f63b8d9c9cd32a
+ pristine_git_object: 07335241502cbc4c8037f4ef401be1e8366479fe
+ docs/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdSubmitResponse.md:
+ id: d75ab0c123e3
+ last_write_checksum: sha1:839a2e1bbd94e83664b65699b7c60db7e2d83686
+ pristine_git_object: d70d64eba384506cca5e6c95578dd755087e3261
docs/models/operations/PutV1CompaniesCompanyIdPayrollsRequest.md:
id: 1bc3ecaa35a6
last_write_checksum: sha1:a29f363fab95311d52d3edae8563b745ca9e532f
pristine_git_object: d87d98adf960d083011a543b2e9bdb018fdee86b
docs/models/operations/PutV1CompaniesCompanyIdPayrollsResponse.md:
id: 2ec78cb49edb
- last_write_checksum: sha1:04252cd2091ce6a6803d816a0badaa0b51cd261d
- pristine_git_object: 41e5a7eba6d313dccd3c94c05aea72f1cb65021c
+ last_write_checksum: sha1:d3ec3eb720a50f35eaaa187acefeae14f7aae0a8
+ pristine_git_object: c610add97a4394620d9ad21ce596a678fb775956
docs/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyAddEmployees.md:
id: 2ff2166d21d2
last_write_checksum: sha1:e5027daaabe7369dcb5935ce6cc0f70a00ab836c
pristine_git_object: 430b8afc1df5a537f0d0bb27e2dda40bc2b90e72
docs/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyAddHeaderXGustoAPIVersion.md:
id: e36fcab485fc
- last_write_checksum: sha1:c51204f7706f30c978923ed6937c6219a3e532f3
- pristine_git_object: 757d16f3735852bc9085ef678baa408bb290d747
+ last_write_checksum: sha1:89890ebb41b3ebbb61170b825a50d0b85fe39ebc
+ pristine_git_object: 5f697a6b131de733ce13393826cce72afb6a8044
docs/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyAddRequest.md:
id: 95f16ba7219b
last_write_checksum: sha1:4aef5f1474d288715ed4beffbfd07bc9d96317aa
@@ -4831,16 +5168,16 @@ trackedFiles:
pristine_git_object: 9bf68cf0a774ad40d6be43c905bf51cd2fe9855a
docs/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyHeaderXGustoAPIVersion.md:
id: 9873d7490278
- last_write_checksum: sha1:820e75c41258c690c007fec119886ab7ce2eb247
- pristine_git_object: 3a7b0ea4fdaeef7b936d7acd93916f4d4d717830
+ last_write_checksum: sha1:06ef0bf040e1143703676331982d7a612f0d2576
+ pristine_git_object: 13c720154cb9beb787263b9de4133dcca7e8882d
docs/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRemoveEmployees.md:
id: 63e5116c5275
last_write_checksum: sha1:ecc94d6fa8a449739dae3b5db757cbd0926d3694
pristine_git_object: 0024a995aefbd222321c22173fcd01bc65e2088a
docs/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRemoveHeaderXGustoAPIVersion.md:
id: cea5b942ea48
- last_write_checksum: sha1:074a42e397fbbb62c88fe16743e286eb5216ae78
- pristine_git_object: 9a7662188c552d56c50eb75a0a704f7235db7db5
+ last_write_checksum: sha1:aad0326f8eaed236161532c243f1dd3e400c23d2
+ pristine_git_object: 3e532f72359674856aa946237ffc60831d50ea76
docs/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRemoveRequest.md:
id: 0a5f9cc65300
last_write_checksum: sha1:b38941b89d5ad1ee3044946c9d624f900c0f364b
@@ -4865,22 +5202,18 @@ trackedFiles:
id: bb4f53c54dc8
last_write_checksum: sha1:a3bdc7192e17f277532073f8d8fd86b70fffd638
pristine_git_object: 0c988bf74bc1d3c1c79bd4118de3edab93651d35
- docs/models/operations/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidHomeAddress.md:
- id: df1fa5361997
- last_write_checksum: sha1:e45d39717e41bae44e7fbd9703790059d704d574
- pristine_git_object: ce3b148215fa884f3a73f6829d7243d99adfe9b4
+ docs/models/operations/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidHeaderXGustoAPIVersion.md:
+ id: ac9b7ecd6ba8
+ last_write_checksum: sha1:885bbd6c3de2b34ae7e664b9c568a636dcb321b6
+ pristine_git_object: 986e6f00dc6afee94adb8e52e67ce2f0413e73ff
docs/models/operations/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidRequest.md:
id: be4f2d3b4736
- last_write_checksum: sha1:cd54f8ab6588fcfba943928988ff08fac6aa6fa4
- pristine_git_object: 24d0076a8f003fbe9e190421b0444b36d484db46
- docs/models/operations/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidRequestBody.md:
- id: 7c7a8596d8de
- last_write_checksum: sha1:813cb71935e13337c9597bbbb094a69de25bcbdf
- pristine_git_object: 0850abf18469a7d9478a4d17808f46ae8aa67420
+ last_write_checksum: sha1:78848c5bc56a1f1a315e17f2429bd16a081dea4e
+ pristine_git_object: 3b1edb2ee6dddb0fd5afa98918353595d30f2996
docs/models/operations/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidResponse.md:
id: f22fc9eda580
- last_write_checksum: sha1:fd64dad54c92653dbf3689d3ae7a3f4fee3cd2ee
- pristine_git_object: 419fc70e0262cbe491455aedff37c24ab2ced547
+ last_write_checksum: sha1:7593654de722ba27d78ad0e579f4a4e54d72b68a
+ pristine_git_object: 49a43d946e74629fa1f8f965dee8c3b99e73f4f7
docs/models/operations/PutV1CompaniesCompanyUuidTaxRequirementsStateRequest.md:
id: 68bca344ef9e
last_write_checksum: sha1:03097c480f457cb633d1dbccad083774291f747f
@@ -4893,22 +5226,26 @@ trackedFiles:
id: 9d6433e63414
last_write_checksum: sha1:6128370c851f9da7a67ee1f35845afebc157d9ad
pristine_git_object: 6fcf33a59e90161037144a7c85383c22ca2eedac
+ docs/models/operations/PutV1CompaniesHeaderXGustoAPIVersion.md:
+ id: 613f77aef2d6
+ last_write_checksum: sha1:a96f40a994a77afd4cfb82327edcdf62822e4072
+ pristine_git_object: 05db4677e49431442ac3bfaf93d8ad37138716b4
docs/models/operations/PutV1CompaniesRequest.md:
id: 8796725e157d
- last_write_checksum: sha1:56430aebf73255b8d3810f2139b4fc639589bca6
- pristine_git_object: 5079e2cefac65e16b9530cdb760fa4f60cbbe02e
+ last_write_checksum: sha1:6919f370334159e470d08e8d61e4a9864dd852d6
+ pristine_git_object: 92dfc34fd05b4cd38a0249f05de369181f3f48df
docs/models/operations/PutV1CompaniesRequestBody.md:
id: 7711e9fd7f78
last_write_checksum: sha1:e296b498a1e2acbf75323733c68bc00bcbd29302
pristine_git_object: d704aaa668985772d449b3a8f2dc780df308f653
docs/models/operations/PutV1CompaniesResponse.md:
id: 9d08a5643a8b
- last_write_checksum: sha1:a11f5d13eb3c859463023ce0855f9f9620f52d73
- pristine_git_object: 07168df361e9a87c505abe9a9ee3660c5f975a29
+ last_write_checksum: sha1:0bc7f1382a0d0d0ef9054bf2a918596bb52f2f3d
+ pristine_git_object: 2fdbf620992feece0f589ca9164e676b09e6d9b4
docs/models/operations/PutV1CompanyBenefitsCompanyBenefitIdCatchUpType.md:
id: 7e724b6a9123
- last_write_checksum: sha1:b6c784fa04ac650feeec4e462eea3845073184fd
- pristine_git_object: f609515315f2b1a46cd561d3fce10a4d0f38d7a3
+ last_write_checksum: sha1:cee6ec67a16756d0812ba490f9131ed294fee28a
+ pristine_git_object: a7a8b270b10dea5a3731cb5017f56e359330c7c6
docs/models/operations/PutV1CompanyBenefitsCompanyBenefitIdContributionExclusionsRequest.md:
id: 13b1e66fd68b
last_write_checksum: sha1:cd1b66e52f3ba1696cd809dbe4d733555b217190
@@ -4939,8 +5276,8 @@ trackedFiles:
pristine_git_object: d032b6de331d77232c55b64fb13c779d4b601d62
docs/models/operations/PutV1CompanyBenefitsCompanyBenefitIdRequestBody.md:
id: f1fdf40de0fd
- last_write_checksum: sha1:857fade6d24792a5f93c61a66edc734baa01e67a
- pristine_git_object: cd679b7b1f3454492f46a5bad7f35e9e68bfc35f
+ last_write_checksum: sha1:45e62769c3b5583f7f84764457aa75d46d3f119a
+ pristine_git_object: 4e957cb256d70d09e50cc0658c72a2f40600d297
docs/models/operations/PutV1CompanyBenefitsCompanyBenefitIdResponse.md:
id: b8a089dfdf4a
last_write_checksum: sha1:fe0409dd42b04979122f67f879ecf1b2ac4438ac
@@ -4957,50 +5294,42 @@ trackedFiles:
id: 7c596c60908b
last_write_checksum: sha1:cbd03e846fc3e43b039b067dc774e6648db8566c
pristine_git_object: 29ebd76e7e190fc3c32efc6db29be3699f362047
+ docs/models/operations/PutV1CompanyIndustryHeaderXGustoAPIVersion.md:
+ id: 596f22a0f78a
+ last_write_checksum: sha1:ae6b9de27e962fd18f60947c6f81fa796c32cb84
+ pristine_git_object: b6f685cd87b41987a31795ec92ee6d9c2d35ba3d
docs/models/operations/PutV1CompanyIndustryRequest.md:
id: 04eebd165cbd
- last_write_checksum: sha1:8a4d32b52bdc94b08338423299815a7787e1e971
- pristine_git_object: 6af1eec57a87c160a6b0bf44fb2e845b204a4ca7
- docs/models/operations/PutV1CompanyIndustryRequestBody.md:
- id: d7b4e3cec764
- last_write_checksum: sha1:9eeccfdf77b19b1e96cbd93dc4534fcf906f8c1d
- pristine_git_object: c3f677815232a0521ed4c02b28bf47c63dac59ac
+ last_write_checksum: sha1:468e314c9d7a458dd469e2ac425b9269125bd9e6
+ pristine_git_object: e9f2a20539f9a6fc666d3fe3922fdbbf0d5baeca
docs/models/operations/PutV1CompanyIndustryResponse.md:
id: 5ab14ee20311
- last_write_checksum: sha1:ae99195bdb111f7e3b08b6451c7165ce3bb8917d
- pristine_git_object: f6f9f7e8376231e83b694ab93e3d41fb937387ce
+ last_write_checksum: sha1:de7f76f5dbd5ea42056386d38c71299fe2423848
+ pristine_git_object: b7b706b8213b9d5b217565937a1bf77a477d771c
+ docs/models/operations/PutV1CompanyPaymentConfigsHeaderXGustoAPIVersion.md:
+ id: 271b0a98957a
+ last_write_checksum: sha1:55c40c0c7eee0a408618f3e46efbd52f6a418ab0
+ pristine_git_object: 8c37f15ef5101338cc964382aeaaf1c2cf1cc554
docs/models/operations/PutV1CompanyPaymentConfigsRequest.md:
id: 04f3f552db65
- last_write_checksum: sha1:7075d278a6034ad31c81b4f33710a80094905081
- pristine_git_object: 2d1883b1b0e0e06cc0b00743ce6349effc216bad
- docs/models/operations/PutV1CompanyPaymentConfigsRequestBody.md:
- id: 363ef431817f
- last_write_checksum: sha1:67d4e1a75cfd9f68a66eb919a0e3da89bd9d8fbf
- pristine_git_object: 45095f59e2391975032eeab221ece0a5caae7031
+ last_write_checksum: sha1:dbbaf51526bd64ca2c3743bd5dc6014a5aa9ff3c
+ pristine_git_object: 7350e8d38ffc30a6e1d5df1679c397b6b4baa867
docs/models/operations/PutV1CompanyPaymentConfigsResponse.md:
id: b9afe22977f6
- last_write_checksum: sha1:963a2477f3b8e88fc21156b43e04fad99ee9611a
- pristine_git_object: 744cbb3d99e752ad6de76fb0186461b261cdf875
- docs/models/operations/PutV1CompensationsCompensationIdMinimumWages.md:
- id: 6df9ed327bfa
- last_write_checksum: sha1:59ac130ec08685276241247dd2df2ec942eb8e8b
- pristine_git_object: 6b0a64b7c3872fbdf1b3f03548981d1bbff89672
- docs/models/operations/PutV1CompensationsCompensationIdPaymentUnit.md:
- id: af4387c822d5
- last_write_checksum: sha1:e3b5583c51d541d860fbd972debcf94231c6b294
- pristine_git_object: 5a8f770059dd623b6b37d185eff27e0e1af50bd4
+ last_write_checksum: sha1:eccbafa91ba93e1ed330acfc179fe65eb34cfb4b
+ pristine_git_object: 48113b8f89ac783c5931d3609e2d8a0764d8e50c
+ docs/models/operations/PutV1CompensationsCompensationIdHeaderXGustoAPIVersion.md:
+ id: f9a9afa02336
+ last_write_checksum: sha1:4081d75decfe51d25e54b3dd1a842255f859c5fb
+ pristine_git_object: 041a7a93473759fc29710abf86a5a791a4d883e8
docs/models/operations/PutV1CompensationsCompensationIdRequest.md:
id: ac14094c6f62
- last_write_checksum: sha1:8b50770e7b3df3573d600dbeefa1b7bfb86e07b0
- pristine_git_object: 27f82a2afc4c0a881983a942431fa7346fbb0934
- docs/models/operations/PutV1CompensationsCompensationIdRequestBody.md:
- id: 4eef15b0e3d8
- last_write_checksum: sha1:a19035b4911605590652e9122b81ecdcd6f6e9ed
- pristine_git_object: 40694c78eff289d667585d71cb7e7c419f4bc609
+ last_write_checksum: sha1:e60e9a43dc42056d9cfb14a217bd0c435a783ef7
+ pristine_git_object: f3de5d8253de4cf6df45e623f51eb6e99776f4dd
docs/models/operations/PutV1CompensationsCompensationIdResponse.md:
id: c308decd2507
- last_write_checksum: sha1:a183580bfc94fb0fa4ff7d8c93ba5a5f6174cdac
- pristine_git_object: aebb2f020e671b48d8fc6fa08d1991b9733079b5
+ last_write_checksum: sha1:7b725c12afcf8426a17679aa05677e88999b13b7
+ pristine_git_object: 8a85489ca86c58084f2bc504f1a55bfa6829581d
docs/models/operations/PutV1ContractorDocumentSignRequest.md:
id: 30260c3359d8
last_write_checksum: sha1:605bf7d9663b1f4813b7fefd788fd989c31c35d0
@@ -5015,8 +5344,8 @@ trackedFiles:
pristine_git_object: 28ff0d573c7e8cc2c7435342d7b9e3c46e229b53
docs/models/operations/PutV1ContractorPaymentGroupsContractorPaymentGroupIdFundHeaderXGustoAPIVersion.md:
id: 12a37a894508
- last_write_checksum: sha1:d4dd855169f6d852602d899e93d171686451148d
- pristine_git_object: c9def77d577d29a7c16a6935fe28cd618f7d5c92
+ last_write_checksum: sha1:89d3f1a9597829c818a9e40f6ab8ba860a9acd88
+ pristine_git_object: 913006c7d798ccd53ff2c268eac7f29885d0d826
docs/models/operations/PutV1ContractorPaymentGroupsContractorPaymentGroupIdFundRequest.md:
id: 20932d8ecf0d
last_write_checksum: sha1:5354be3a9842db37d6130c5ac5553dad6064be9d
@@ -5039,8 +5368,8 @@ trackedFiles:
pristine_git_object: cd3e1ec368350a8f865e5a96bfc2d3695624132c
docs/models/operations/PutV1ContractorsContractorIdPaymentMethodType.md:
id: e967c464ee54
- last_write_checksum: sha1:07eaade8402d6908d06bc05d1c869c81c6775438
- pristine_git_object: 81b10ac6aa9ddc049349df036cf107ccf296d667
+ last_write_checksum: sha1:9324babc8706a8ce42b829fae085ea4ef47d84d4
+ pristine_git_object: ab67c0ea8a70b003462e0531f47159d65e793d91
docs/models/operations/PutV1ContractorsContractorUuidAddressRequest.md:
id: 7cf55e544273
last_write_checksum: sha1:b161dc09142a1326e2d546159df9bbc4d58a6bc6
@@ -5053,10 +5382,14 @@ trackedFiles:
id: ed77aeff1003
last_write_checksum: sha1:abbcdab33f790d03fa1d9fc3bebcd18fcbecf870
pristine_git_object: 1cfcf44257292a310550eb773d017fcc3c837436
+ docs/models/operations/PutV1ContractorsContractorUuidHeaderXGustoAPIVersion.md:
+ id: d81c2c77ab98
+ last_write_checksum: sha1:e03667d669f6fdff667ffff57bdf47a9029dc7b1
+ pristine_git_object: dfa6f90e44be7520ad04d6006f42a1c6e309b98e
docs/models/operations/PutV1ContractorsContractorUuidOnboardingStatusOnboardingStatus.md:
id: 4bb18e06de25
- last_write_checksum: sha1:faf00c05fcdbdd0f69410268cbab501fe94852ea
- pristine_git_object: 4fe932cbc670a7c61354d31a023ce3cfaaa0b9e0
+ last_write_checksum: sha1:d91fa3d93743a5158228e9b1dda96a9e37310709
+ pristine_git_object: 57caa67bc5039ec678d0c3fa37893b939ff2549f
docs/models/operations/PutV1ContractorsContractorUuidOnboardingStatusRequest.md:
id: 94ed098ce002
last_write_checksum: sha1:fad9d4ffb1277b54ca0f432e067cfb65b6401e0b
@@ -5071,36 +5404,24 @@ trackedFiles:
pristine_git_object: 12b96b0db708f575609809f71f202bcb4577ca20
docs/models/operations/PutV1ContractorsContractorUuidRequest.md:
id: f050aeb5a8a0
- last_write_checksum: sha1:ed867a437a27dc5d684b4314758c71bb09692cdb
- pristine_git_object: 735f510598be826005ae06034c8d8f02adb07771
- docs/models/operations/PutV1ContractorsContractorUuidRequestBody.md:
- id: b50d8a57315d
- last_write_checksum: sha1:3e64033bd4afdceb498d65e18d65ad74a2dbb923
- pristine_git_object: f7c56a86daec8e9233e108e35489030a2243f4df
+ last_write_checksum: sha1:8d22290e7fa6f0fc6da9ce637948d104dbf8734a
+ pristine_git_object: 730826110c33534dbfec208af9fa0962cba115a4
docs/models/operations/PutV1ContractorsContractorUuidResponse.md:
id: 222a9c33728f
- last_write_checksum: sha1:fd022cdd6a2c1376295f102e0f96066ab955479c
- pristine_git_object: 6ddc1f198d90cf30d549ae33a07a7f32cdf0bdd5
- docs/models/operations/PutV1ContractorsContractorUuidType.md:
- id: a658d7574ef4
- last_write_checksum: sha1:1bffeb9ecaee43cdcba63ac5661fc8827e8c87eb
- pristine_git_object: 58c909bfaa02bc9163a2b012bf4e80bf9a05cfb6
- docs/models/operations/PutV1ContractorsContractorUuidWageType.md:
- id: 5d44f55e1d8a
- last_write_checksum: sha1:e6cebf3c516961e12c3a878ae52e84976d375e8b
- pristine_git_object: f43fea5689cd04d9641012848670d5c757959284
+ last_write_checksum: sha1:faa7e721a5c666725452ad3a692aee013214b59e
+ pristine_git_object: 0b49cc2c18b394e476cc1d00c28390f1f63f1fa8
docs/models/operations/PutV1EmployeeBenefitsEmployeeBenefitIdContribution.md:
id: a5fe0e425f46
last_write_checksum: sha1:046d1ccba92ca8123196c9b2d12e0079b711178e
pristine_git_object: 176155b728b49918c99da0bf055b02fd60657d9b
docs/models/operations/PutV1EmployeeBenefitsEmployeeBenefitIdDeductionReducesTaxableIncome.md:
id: fd3b44f09a44
- last_write_checksum: sha1:0d8a92c9024b48f45757f26a8c729f63de3b69ef
- pristine_git_object: 129202c14e13b235e93f6b5996322c604a32058b
+ last_write_checksum: sha1:f26695bcccb6f6f3698985b5494d95120c5f88a3
+ pristine_git_object: 16259d7cfc5f5459cbf4eebd239fc087b058c35d
docs/models/operations/PutV1EmployeeBenefitsEmployeeBenefitIdLimitOption.md:
id: 31f0363e3d36
- last_write_checksum: sha1:8e06cd2118b3553864fe01021691c1bb621650f7
- pristine_git_object: fcc493f99d087be088a766ef0cd71264d5620eb1
+ last_write_checksum: sha1:b846a5d4c516cae717ec4dbf886f083e1f1afcd1
+ pristine_git_object: 41552aac7b744ca6ea9dd075a0c705dd3114ba1d
docs/models/operations/PutV1EmployeeBenefitsEmployeeBenefitIdRequest.md:
id: 6caf4c7cccab
last_write_checksum: sha1:227c0adf17be5294ffbacc83075b85e64259737a
@@ -5115,8 +5436,8 @@ trackedFiles:
pristine_git_object: 2b67143e9aad156f87352eed3eba0853f571dd53
docs/models/operations/PutV1EmployeeBenefitsEmployeeBenefitIdType.md:
id: ed6c8bb558f1
- last_write_checksum: sha1:f00b779b53608a30f3d5356a68026381c6f8686d
- pristine_git_object: f011c23541a425637f76d136b5264747bba3074a
+ last_write_checksum: sha1:e67daf464b2444811eaff626ab187a76af097a34
+ pristine_git_object: 852fd3c33f6b0af7d57afb38d79c73fecfa522cc
docs/models/operations/PutV1EmployeeBenefitsEmployeeBenefitIdValue.md:
id: 60323c51bad0
last_write_checksum: sha1:296b85d32798ff67d9cc63554860cb464c48c055
@@ -5135,8 +5456,8 @@ trackedFiles:
pristine_git_object: a24b908de8392cef2107c07859962eea0bf45910
docs/models/operations/PutV1EmployeesEmployeeIdBankAccountsAccountType.md:
id: 1bfacb37fdbd
- last_write_checksum: sha1:2756932075525cf6093de9f634538a8a51ed6972
- pristine_git_object: d1e5b80c00bcc3d48805fe52975b668259fa3645
+ last_write_checksum: sha1:7603183cd3c624d3f9b48fedd148970bbc75c371
+ pristine_git_object: 0b6f49199a8d9ed6529bb230351cd80e2859cae9
docs/models/operations/PutV1EmployeesEmployeeIdBankAccountsRequest.md:
id: 2e8d2e3226c1
last_write_checksum: sha1:34259af9473fd341354338d81c04edcfb846d777
@@ -5149,70 +5470,74 @@ trackedFiles:
id: 1cd2a8a1602a
last_write_checksum: sha1:5c04374f72fce01858380f5d0dd3fe35a1db8258
pristine_git_object: 4bc2c2c28cd1786e1f5805ec0660cfdc31817631
+ docs/models/operations/PutV1EmployeesEmployeeIdFederalTaxesHeaderXGustoAPIVersion.md:
+ id: c5872c729a6b
+ last_write_checksum: sha1:ca48c244dc6af3c6bcd530dc0a9954fc294aeb94
+ pristine_git_object: bd612af592b6387d4bddc42a3ea41236f5864b88
docs/models/operations/PutV1EmployeesEmployeeIdFederalTaxesRequest.md:
id: 555650f6fd11
- last_write_checksum: sha1:880175a4c8b4b9decc748bbe1409f8652417f537
- pristine_git_object: f6842f105f3bde610a022a66c80c31b48266975f
+ last_write_checksum: sha1:914d0b673a41dadd12cdba809bb47044d4829c21
+ pristine_git_object: a3dae5606a4164deeae1b411aded87c8e6778d89
docs/models/operations/PutV1EmployeesEmployeeIdFederalTaxesRequestBody.md:
id: be2c064a21c8
- last_write_checksum: sha1:713fe1966faf846dda0cb16738701a4eb3fc8405
- pristine_git_object: e55b7637fbe956283fa644b23a1a868e47984f86
+ last_write_checksum: sha1:b501ae5baf02cfdb2808c72f0ad3d21096e26bab
+ pristine_git_object: 867453ae187a1b006e5bce2798edc425178060d6
docs/models/operations/PutV1EmployeesEmployeeIdFederalTaxesResponse.md:
id: ee4e9de7fe64
- last_write_checksum: sha1:58d91ff6f82e093694f1e0fe8011a0686a6551da
- pristine_git_object: bb6697f283f95fcaf2664ad9235f4023d878c540
+ last_write_checksum: sha1:819367563de333002e8c0bba4678aecc383ea7ca
+ pristine_git_object: 24e4dfada611b4d80adbc06fd035444587204cf2
+ docs/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationDocumentsHeaderXGustoAPIVersion.md:
+ id: 35ae4d01b5e4
+ last_write_checksum: sha1:6fb7489c7c53e6e160abf93583035feb155a475e
+ pristine_git_object: b7748afa6438f4b7c233f25ba893b463a35d3a52
docs/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationDocumentsRequest.md:
id: e85c12768963
- last_write_checksum: sha1:1d0e8990957070c360a94b5ab150b4255cd58b8c
- pristine_git_object: aa41c6dfd9467ef3b278c8fe0138cf3f906ada18
- docs/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationDocumentsRequestBody.md:
- id: "125450196700"
- last_write_checksum: sha1:678250438991a962020e01f621f200c8af9b3070
- pristine_git_object: fce05b5bfc9179b21fca97e9d6a8ccaf8bf91e6a
+ last_write_checksum: sha1:9bb6ba8694954233bac37ec8fdfae1122249bd03
+ pristine_git_object: ca36050d265b78dd51c5f4e4366c635874cef391
docs/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationDocumentsResponse.md:
id: 4b8144f0fb47
- last_write_checksum: sha1:9ae793de908215409112bbe66af90b1b9f35bc42
- pristine_git_object: 691437f8c1e74fb192f73feaba19dfa29b086c63
+ last_write_checksum: sha1:9a53d26f644c8823e66d4020f42ea8c9b7657b83
+ pristine_git_object: 237a746971e14fc137bcc5f1bc04c2a271376ebb
+ docs/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationEmployerSignHeaderXGustoAPIVersion.md:
+ id: 2d1032519fe7
+ last_write_checksum: sha1:4c86e7e6c347f3f0bc3d4be614f9ef2950c33883
+ pristine_git_object: 7e0a96b8af3ee4558067314b5f13a36d6e6dc2d4
docs/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationEmployerSignRequest.md:
id: 0cca022eafd4
- last_write_checksum: sha1:a2563e0c4398002a0b842c1380bedf86869de810
- pristine_git_object: f2617228ad5fd442b6ab3d298bf6436eacd20cf6
- docs/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationEmployerSignRequestBody.md:
- id: 7218713bbdc0
- last_write_checksum: sha1:676c787ebbf3d677860210ce758e3b3dc48cb179
- pristine_git_object: 25c36c6137c43133604be4305fa255e061c33517
+ last_write_checksum: sha1:c78acbf841168837904049a9ebbe028d300a7043
+ pristine_git_object: 67fe899f4235ffea57089e81a7a2b6de16389df9
docs/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationEmployerSignResponse.md:
id: 407f51617e65
- last_write_checksum: sha1:9a6ba34ad0ca98cf4c0fe315dc9d0b0dac481603
- pristine_git_object: e5cf065e6c95500d1c68f72a7876bd1b1726b62f
+ last_write_checksum: sha1:34e06eabe8d06866201a73d5b7ce9870a0ed3716
+ pristine_git_object: 9c95053db49ad01632061339df634c5820286530
+ docs/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationHeaderXGustoAPIVersion.md:
+ id: 8b29b367288a
+ last_write_checksum: sha1:da3cbbf6af6fedfa542671f82b56e3fa2aac4ea8
+ pristine_git_object: be5f0cab33990c8bc93e00bb50cbfc0a0f748b66
docs/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationRequest.md:
id: 88aa9d379207
- last_write_checksum: sha1:68c57d3124a966ee42b766077a8cc0827c461649
- pristine_git_object: c0c65185cb0f7e02f8b9c6f59eb59c8509798d82
- docs/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationRequestBody.md:
- id: 4e52a79a6af1
- last_write_checksum: sha1:362c3b37080c4d7448a383f0176a8a4d817565a1
- pristine_git_object: 7b2276f832f190330ca9888ce589d7397f3c0b3a
+ last_write_checksum: sha1:ac1935fa780813d0380ab7207bea5a7107b20bd6
+ pristine_git_object: 4e9c62d9b2e461eabaabf22ef583e66702930c01
docs/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationResponse.md:
id: d3060025fff6
- last_write_checksum: sha1:a9012394f6127273a1acaa7b9dcd858759024ffb
- pristine_git_object: a13a172d00c3daecf64a3eb3798dfae343796b2d
+ last_write_checksum: sha1:bedf22d5dc76d1fde8a77278868e51593b4b3a1c
+ pristine_git_object: d65aee77a2983d0e62a5a01686b4880ead325913
+ docs/models/operations/PutV1EmployeesEmployeeIdOnboardingDocumentsConfigHeaderXGustoAPIVersion.md:
+ id: 235337fc08ce
+ last_write_checksum: sha1:dacffbcce3b26d01f2e44ebf27567ad782c2f751
+ pristine_git_object: def24f42eb4ee009ed5bca35445bc180f3063c9a
docs/models/operations/PutV1EmployeesEmployeeIdOnboardingDocumentsConfigRequest.md:
id: 9555e5da278b
- last_write_checksum: sha1:e50ac433b43982bd90aab04b3a6a09fcd9bb539e
- pristine_git_object: d2b33473f89bd693bddaa39ed9e9dff2278ae34b
- docs/models/operations/PutV1EmployeesEmployeeIdOnboardingDocumentsConfigRequestBody.md:
- id: bb7bb6b32b07
- last_write_checksum: sha1:c46bf2b0e931cff75439433b6ca660622db9b895
- pristine_git_object: d71c6ed38a69f6778a8e2c13094226d717283905
+ last_write_checksum: sha1:84834f098665e1073f88c87a8936d4be65316ea4
+ pristine_git_object: f0fcc564e86443fe2c9a1a5af3d8801463507882
docs/models/operations/PutV1EmployeesEmployeeIdOnboardingDocumentsConfigResponse.md:
id: 690d208b235d
- last_write_checksum: sha1:68a753e55053909fec1474b18823e442ec62ca74
- pristine_git_object: 1ef3ace1818b51b54ad552154e041208b638b031
+ last_write_checksum: sha1:58f2f5ce487d16e18fbc11cb16a84b7608dc348d
+ pristine_git_object: d269d39b397de9871e1db7b6a637f9cf680fd7f8
docs/models/operations/PutV1EmployeesEmployeeIdOnboardingStatusHeaderXGustoAPIVersion.md:
id: 1d09174b0e82
- last_write_checksum: sha1:6ac25c3e034b1681b554f15829eeb646dbf6a564
- pristine_git_object: 1acb36294e055d8e8fe1303f41e1f9605ab3f69d
+ last_write_checksum: sha1:33dc8b24d9223c5f40c563af97532e3efff2912b
+ pristine_git_object: 3e9233b528ea4998941e085f9c8803c299acb7d2
docs/models/operations/PutV1EmployeesEmployeeIdOnboardingStatusRequest.md:
id: c3ad674b4f6d
last_write_checksum: sha1:7081db47ba1b4ad1f5584f039f60acad7899ed31
@@ -5225,18 +5550,22 @@ trackedFiles:
id: 2786e85a3822
last_write_checksum: sha1:1468b50a003144cb1a7dcb609837a9d42905c360
pristine_git_object: 4dfcd7e95badb3aac5eddc08df62dd263ac165a1
+ docs/models/operations/PutV1EmployeesEmployeeIdPaymentMethodHeaderXGustoAPIVersion.md:
+ id: 81c68ac62f83
+ last_write_checksum: sha1:5b99cbc9cb9c4ba354697fda23611460cdbae292
+ pristine_git_object: c1152e7f6faf9f71f3270175829fedb6c58cd40b
docs/models/operations/PutV1EmployeesEmployeeIdPaymentMethodRequest.md:
id: 3d1545424e1a
- last_write_checksum: sha1:b8df4e4576f30bdce7583d40edf5a1e8867203fd
- pristine_git_object: 897199ce5940cf789219c23c1b1e2bc7f5b76c57
+ last_write_checksum: sha1:c8e9a03a4ceba58806d2041d27972d2bff5b23d6
+ pristine_git_object: 305b3708ddbca01654c03322bf657fe9a5b9e74d
docs/models/operations/PutV1EmployeesEmployeeIdPaymentMethodRequestBody.md:
id: 78b24ad35d94
- last_write_checksum: sha1:347fce953f708c0fc9f5a43c74a64c8474232b1f
- pristine_git_object: 160aa9c08140b797d2937fb9688a9fd758ca00cf
+ last_write_checksum: sha1:c60c92facc7ed14f65fc70c1bf2a9eeed1a9a644
+ pristine_git_object: 8bf62c46fcf6c58342c7eb0e8985172ec40ce9a4
docs/models/operations/PutV1EmployeesEmployeeIdPaymentMethodResponse.md:
id: aa2612ebfc90
- last_write_checksum: sha1:880d6ebd1934e834fa73c57ac3391452bf56af91
- pristine_git_object: 9f0eb70b0a5acf47114cdc645dbc05df3de0cc92
+ last_write_checksum: sha1:4ba3d6ad95e3136b7ae82eddcf787fe65ff1ccdc
+ pristine_git_object: 2fc662b2c645a14fa3d18a82671e6450e6f6cd47
docs/models/operations/PutV1EmployeesEmployeeIdRehireRequest.md:
id: 11288aaac420
last_write_checksum: sha1:9a1f05cd0e7b47dcf647b02e0d36599348cd9c4d
@@ -5251,8 +5580,8 @@ trackedFiles:
pristine_git_object: dcf208f38fbf9468c082da2598962e34236573ce
docs/models/operations/PutV1EmployeesEmployeeIdStateTaxesHeaderXGustoAPIVersion.md:
id: ba3d35f1c8dd
- last_write_checksum: sha1:34ebb9f9b5abb50930d4063976a1f71e7b2632cc
- pristine_git_object: 1f00ecb8a982f3c86065f863bf0afaf9a5e31897
+ last_write_checksum: sha1:d8c3afa57bd28248e81387d4e8645d3905ff386f
+ pristine_git_object: a5addbc8d63e3c0293abf6cbb95ec6cb3666b14b
docs/models/operations/PutV1EmployeesEmployeeIdStateTaxesRequest.md:
id: f212b4e82069
last_write_checksum: sha1:93806d9f094669fa06c1db7664d16c3f10fa435c
@@ -5263,8 +5592,8 @@ trackedFiles:
pristine_git_object: 73b6ffdaa7aca38eac669b08b3a62a81b552f90c
docs/models/operations/PutV1EmployeesHeaderXGustoAPIVersion.md:
id: 628f72f1c5d0
- last_write_checksum: sha1:589cdb5c637977288e9cf6df4a920ae34bf8ee98
- pristine_git_object: 545a3f695c2fcbf67e3b00dcbff5a7bac39a6763
+ last_write_checksum: sha1:8f0b9db4163a8c1720f04b12e4299ac12ac541da
+ pristine_git_object: 085c63644916c7bf5ce59cf0a8f3899d6d1ed3f7
docs/models/operations/PutV1EmployeesRequest.md:
id: ce97f0d160e0
last_write_checksum: sha1:a9a4ea3529b65d66699c5983cfdffbd00fed3dd1
@@ -5301,26 +5630,22 @@ trackedFiles:
id: 5b9af6ed41f3
last_write_checksum: sha1:05c5a0682d1fbd1bfad0606b4d89806777abc630
pristine_git_object: 1793aa6e377d1610a86996b5d67a3e6261233b89
- docs/models/operations/PutV1HistoricalEmployeesHomeAddress.md:
- id: baf1151f218e
- last_write_checksum: sha1:fd36e851d8bb141a1092bce904e94cd2ae3bf4f1
- pristine_git_object: f9bfe2eff136e3e34b62af95093de06ad4233cf5
docs/models/operations/PutV1HistoricalEmployeesRequest.md:
id: ccffa533d6a4
last_write_checksum: sha1:1874d5132ffd832e6836487d257b34bf50b93023
pristine_git_object: bbc92cc2184d1a81981efe99ab863416adb8451d
docs/models/operations/PutV1HistoricalEmployeesRequestBody.md:
id: 4915b0bb75e8
- last_write_checksum: sha1:ab140bfc8039e14d613d946f5b53dc0259bfb076
- pristine_git_object: 60542c8c5fe309a08cbc3c03018ed1d3c0837630
+ last_write_checksum: sha1:2c4f40f709eee9e884d5735a91b8ee5947d122fd
+ pristine_git_object: e8e817af9be73469f447e0e71036e0a813bdbbab
docs/models/operations/PutV1HistoricalEmployeesResponse.md:
id: 36f4661feb1e
last_write_checksum: sha1:e628884f43855b0f61bebd2bac48c894bc37da3e
pristine_git_object: 1168faa566d9cf0cd7097057c58bef7ba828c27f
docs/models/operations/PutV1HomeAddressesHomeAddressUuidHeaderXGustoAPIVersion.md:
id: 36c005a32333
- last_write_checksum: sha1:97a77b306912fe50850cf13044dd4544421e1d63
- pristine_git_object: 0cd44a3f57ef98132c58813a55d249b566821ea5
+ last_write_checksum: sha1:f70c3e33c245334d769b8dc4fd31f2e57cb83b76
+ pristine_git_object: 76c21c05663f7f61d7963dc435f71bd32c36cb9a
docs/models/operations/PutV1HomeAddressesHomeAddressUuidRequest.md:
id: b58baa235abd
last_write_checksum: sha1:67d747cf3686dba51c40a2742eaf1dc060709d4e
@@ -5347,8 +5672,8 @@ trackedFiles:
pristine_git_object: 9b9584e4c450a1e0d24570c62023e96500b0cea2
docs/models/operations/PutV1LocationsLocationIdHeaderXGustoAPIVersion.md:
id: c4f3095c1323
- last_write_checksum: sha1:87c4013e83ad9a21f5feff4704d5ea5298428c1d
- pristine_git_object: 3a3ba356b586fd3067934e8a6855cd7c6d6bd679
+ last_write_checksum: sha1:f575d2a6d0859d5dc1e3e84a91eab546a0089c8c
+ pristine_git_object: 928c707fe92bde587f0f83fc32613d91d17f512a
docs/models/operations/PutV1LocationsLocationIdRequest.md:
id: fbf2ee3bbfd8
last_write_checksum: sha1:d79cbfb549ad678aab18cbdfa6ca5ddce37f9c5d
@@ -5361,26 +5686,10 @@ trackedFiles:
id: 773f6f2381dc
last_write_checksum: sha1:f1ebbd523b3a80a4eacda7d0e70ce0282173b6b1
pristine_git_object: 44c7258e465c3cf176e7bf4de338feeffb5299b4
- docs/models/operations/PutV1PartnerManagedCompaniesCompanyUuidMigrateRequest.md:
- id: a3fe2c6ab1fa
- last_write_checksum: sha1:57a1c2591c0f654d64c44a7fac129866898a30de
- pristine_git_object: 85181535e5755e7d5d889048e48e365282560c91
- docs/models/operations/PutV1PartnerManagedCompaniesCompanyUuidMigrateRequestBody.md:
- id: 8f907edd4da7
- last_write_checksum: sha1:17c034a70905c9fa99c31e67fed3b29aacff7f14
- pristine_git_object: f5aa00425d500707b3904dd6b62e5d4d6f7d2766
- docs/models/operations/PutV1PartnerManagedCompaniesCompanyUuidMigrateResponse.md:
- id: 90d8e80f4a7f
- last_write_checksum: sha1:5ff6aa9036fdc71b8829a528b0adc80c908e8424
- pristine_git_object: d2d4052e3c4a3421e6be5022903e60810d6cd871
- docs/models/operations/PutV1PartnerManagedCompaniesCompanyUuidMigrateResponseBody.md:
- id: 48ca47136198
- last_write_checksum: sha1:629a039e8766fac7e153faabf47a3b3dc6222cc3
- pristine_git_object: e162ca4070054629f5645bdf25a2c647682435c9
docs/models/operations/PutV1RecurringReimbursementsHeaderXGustoAPIVersion.md:
id: 58addb85c433
- last_write_checksum: sha1:25e610b5e7b51287468b7ff682c670fe30c336fe
- pristine_git_object: 73e6f0fa5c8cca347579b414bfd38e958758b21a
+ last_write_checksum: sha1:681c2d811de90c12949ef4fb7887a051dadd6961
+ pristine_git_object: 78c6eca9b35c103e4132394939da950036275042
docs/models/operations/PutV1RecurringReimbursementsRequest.md:
id: 64531d496a80
last_write_checksum: sha1:b9603091fca25eb13bca0ccea1946c712c539918
@@ -5391,20 +5700,16 @@ trackedFiles:
pristine_git_object: 24db2d32cb25fd7e2c014a50db51a88287373918
docs/models/operations/PutV1RecurringReimbursementsResponse.md:
id: 579adab83b47
- last_write_checksum: sha1:e49afd67f63fec60374155bf4819575d9603a753
- pristine_git_object: a3b06c4912c4cc8605c7b88a1ca40a14d641944b
- docs/models/operations/PutV1RecurringReimbursementsResponseBody.md:
- id: f118a6d660a5
- last_write_checksum: sha1:a4980f4af76f5674ab0d8976d7800ec096e8e848
- pristine_git_object: 752f725887289de7b94a582509769f2fe72ea313
+ last_write_checksum: sha1:964b0c2affa6481426ea25a79db8cb3244c77c8d
+ pristine_git_object: 8bbcdac6bd895983850e5f26386d858156e6bfc8
docs/models/operations/PutV1SalaryEstimatesIdExperienceLevel.md:
id: 3f1c37b0c713
- last_write_checksum: sha1:9a101f468ce1929f7dc32659257c63875b505296
- pristine_git_object: 9c41aa0739b47a479a3e38a16dfb29e75e243646
+ last_write_checksum: sha1:d3498b4f67cfa9a6441021bcd11bab64e3fe48ee
+ pristine_git_object: c97834815da7259315118819aa54759faad42b4a
docs/models/operations/PutV1SalaryEstimatesIdHeaderXGustoAPIVersion.md:
id: a0288bacf6f6
- last_write_checksum: sha1:3abe4db8873b5b465f4b73e7b2f46e47f598f21d
- pristine_git_object: 7ac9ff888fd896f9225e722afd307f9dd31c37b9
+ last_write_checksum: sha1:4bb7850dffb9354d6beffc8a5e1ad1d5296adc22
+ pristine_git_object: 4e254871759f90b4726cd030e3f094afa954368f
docs/models/operations/PutV1SalaryEstimatesIdOccupations.md:
id: f11e3b8a1559
last_write_checksum: sha1:57f173d2c9adb9ec09d8ca5c70e48681bffa98f4
@@ -5439,8 +5744,8 @@ trackedFiles:
pristine_git_object: f977b7d2715bf54a154bf43f736971cce0c9cd1d
docs/models/operations/PutV1TaxLiabilitiesResponse.md:
id: 303e648d0c57
- last_write_checksum: sha1:ae7b97c98031aab2932118d4295192ad57644e8f
- pristine_git_object: 5009a3aef03d449c2b3a9782d08689e4d1c5bd02
+ last_write_checksum: sha1:80eb298330db2507107524d96c849dffd79dc3d7
+ pristine_git_object: fb1c23b4acbfaea0be0708893db66940c7d7aff1
docs/models/operations/PutV1TerminationsEmployeeIdRequest.md:
id: f2d8ddbb7695
last_write_checksum: sha1:5082000d7b2c96ca8d84f4ce49c5bef23c874581
@@ -5459,8 +5764,8 @@ trackedFiles:
pristine_git_object: 8a23a01fe9256ea24a82b3cd419f54795952bdc9
docs/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidAddEmployeesHeaderXGustoAPIVersion.md:
id: a9a1d1cbc4fa
- last_write_checksum: sha1:2259776ee89dd9468bd812558e2add3ad7bfb449
- pristine_git_object: e208e334be09ffae73084dba18c090d78759e3f6
+ last_write_checksum: sha1:41e8fac334222a21057cad8f62dc0d8980467810
+ pristine_git_object: 6741fa0fe83c73cede67b04b73beaa65f128c6d9
docs/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidAddEmployeesRequest.md:
id: 51891d41ccc0
last_write_checksum: sha1:79534f7eba31215f5550be66df97ae2ae9fc61fa
@@ -5479,8 +5784,8 @@ trackedFiles:
pristine_git_object: 824605072bcfd5f2dceed714b7ecf3c9a0fbdd01
docs/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidBalanceHeaderXGustoAPIVersion.md:
id: 1446ed080e9d
- last_write_checksum: sha1:2d2bc2d0d008fef62acf46801ec21b161a767da2
- pristine_git_object: efb7be684894ba61d93253fcc095c1c238f693d0
+ last_write_checksum: sha1:4d74929f4a61fdd1d4b9f619383072914269f573
+ pristine_git_object: d1a1b89a81260b1afb0d6070defafb579b6e4282
docs/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidBalanceRequest.md:
id: 4e39252d6744
last_write_checksum: sha1:4df2069bda99af88dd7e0c6c6b46e132063182c3
@@ -5495,8 +5800,8 @@ trackedFiles:
pristine_git_object: 8019c864698cec3ef1a8ddcad6b702a3398188d4
docs/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidDeactivateHeaderXGustoAPIVersion.md:
id: 6552c3fd278d
- last_write_checksum: sha1:f749ae4552c42f4b11eae6d45091123c778e834e
- pristine_git_object: 1b643ad129c565c1f8cdde572b8b2a571aa76047
+ last_write_checksum: sha1:fff5be16242e168115283725d2d266429a822f3e
+ pristine_git_object: 10ec5ec881d404e00ac0f99d709ca08de1535cef
docs/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidDeactivateRequest.md:
id: 58f37ffd8bc2
last_write_checksum: sha1:6f097683be987800be14642fa799480493fcff23
@@ -5507,16 +5812,16 @@ trackedFiles:
pristine_git_object: eceb11ef40855ddce8dd2533bf0415e70a28463d
docs/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidHeaderXGustoAPIVersion.md:
id: 473285ebb1c9
- last_write_checksum: sha1:2a0e5a8393affff70b4538f164c59f263c099fcf
- pristine_git_object: 48f53db9eb5cac004ea5629fa0827116b9e751f7
+ last_write_checksum: sha1:195ff3c3cd3128f17afa915025aad963527476a4
+ pristine_git_object: 1549d645b24c24406eeb1f11d74b0dd47de2cd40
docs/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRemoveEmployeesEmployees.md:
id: b4d0c2f7d01b
last_write_checksum: sha1:ec642d1994567639ae3eccf6799827ba249e4fb6
pristine_git_object: 543c57988d33476d639c108e6a6534f664f81529
docs/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRemoveEmployeesHeaderXGustoAPIVersion.md:
id: fba38443cbde
- last_write_checksum: sha1:9aac73f90bf8d848867cee3b0dc25ce7b2496635
- pristine_git_object: f81540d7b12f7a662e06893c8bcee5f25c6f564e
+ last_write_checksum: sha1:fb99c13a7fe1b13d974522aa0dcb09fc2bf07e63
+ pristine_git_object: 670f43731ba774e542798dc93c242a9fcebf37fc
docs/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRemoveEmployeesRequest.md:
id: 5be688eba6aa
last_write_checksum: sha1:41053d0991451fc31ead6b1b02617093a8d08237
@@ -5575,12 +5880,12 @@ trackedFiles:
pristine_git_object: 4d8d8da8ad725b7d31738ce440147d214cabc181
docs/models/operations/PutV1WebhookSubscriptionUuidSubscriptionTypes.md:
id: e9d54b239864
- last_write_checksum: sha1:2031c0321f3ce5171189d2393a66d5708c12908d
- pristine_git_object: 1579e2529d9999364c4ef743edc70c56ca3dbcf6
+ last_write_checksum: sha1:0e90155c8eb810d8aceafd81d03de3aba338fed7
+ pristine_git_object: ad4bec59cb3d016c2bd29acd22eaf000eb8dfe27
docs/models/operations/PutV1WorkAddressesWorkAddressUuidHeaderXGustoAPIVersion.md:
id: 3df3bcb6dee7
- last_write_checksum: sha1:f3960d92fcf075ba149ebb77aba88349ac764e7e
- pristine_git_object: 0da28a25248dee319fa6c02ae200a2b9e62a491f
+ last_write_checksum: sha1:c22e5a056cd2ff4748086865ee27bc25e8345e27
+ pristine_git_object: 2eb400c47e58dddf3d2fdebd384fbc7147f45264
docs/models/operations/PutV1WorkAddressesWorkAddressUuidRequest.md:
id: b014f5af1b21
last_write_checksum: sha1:69d1322e559d75fa3ede60cc9c0ca035407142db
@@ -5605,22 +5910,30 @@ trackedFiles:
id: 42d7e1705bac
last_write_checksum: sha1:7eefdf7a2a0f15a540d291a77d3b3ba0051bc8fd
pristine_git_object: ab1d93907dc2ceb309b726ee622ad9b8bc97adc3
- docs/models/operations/QueryParamFrequency.md:
- id: a9cb57798f15
- last_write_checksum: sha1:01f7dbd5b18a0c1c0a2a0883a656bbfaf887f59a
- pristine_git_object: 0e770df7c0dddd05bc1b4870a7b18e461dac4f9f
docs/models/operations/QueryParamInclude.md:
id: 98e9203d317e
- last_write_checksum: sha1:3c6b65514d88701e5485c9a595ae8d9d5adbc070
- pristine_git_object: 433bf334cbba2f180c2f71a7377aaa245ea2b888
+ last_write_checksum: sha1:9dc28b5164ed5f5d1feb64c942b3404eb98492d8
+ pristine_git_object: c5967c5e725ce7d53896d064586171e1a98502df
+ docs/models/operations/QueryParamPayrollTypes.md:
+ id: c9d44e722c3f
+ last_write_checksum: sha1:65c37f7fd310cbd7faf787805d400d24bd079bea
+ pristine_git_object: 3e6445ba04ff8cbf713786140f699e2f3dc96859
+ docs/models/operations/QueryParamSortBy.md:
+ id: 8201d46ec4f8
+ last_write_checksum: sha1:4e6d4f6a169e23dc3bf10f416602cb0658168a0e
+ pristine_git_object: ed663c2222f7c69e56f6a9285d35f7f0bf6b5f1f
+ docs/models/operations/QueryParamSortOrder.md:
+ id: 1edaa821e97c
+ last_write_checksum: sha1:a6d559527009f0e7956feef089aff81a4144ef09
+ pristine_git_object: f10091e39e882bfd68504a4f0dd2f6020557f1f9
docs/models/operations/Reason.md:
id: d055568e6e8e
- last_write_checksum: sha1:bf21072c7cd7a99d5696f43fc374aeb3e24a6135
- pristine_git_object: ac049ff7dd78e7cd4d4864b32e43d99e8d1cb0fd
+ last_write_checksum: sha1:13db6ab724b2199b7c9daa4737f87cbf299240e2
+ pristine_git_object: fe8f8e857ebb1deae8b89324dab0088d744e5ffc
docs/models/operations/ReconcileTaxMethod.md:
id: 53e053f075e8
- last_write_checksum: sha1:adb17b8f29d03a124984c96355628bd6a0f072d4
- pristine_git_object: 38662ebcd3a9b2e640dcb2d105dcf1f94ef1b3c6
+ last_write_checksum: sha1:70d09115a79404abe6414cb6559d07ae756346ef
+ pristine_git_object: bdcfe283f6a9d030969c9a884dd78b77d32a3103
docs/models/operations/RedebitRecoveryCaseRequest.md:
id: cff61c9970ab
last_write_checksum: sha1:b3c4d2d7677e94ff5f823690a214b1f76bdb50f6
@@ -5629,14 +5942,14 @@ trackedFiles:
id: 7a190abe8a1b
last_write_checksum: sha1:5eed6620be1bf3746bff6dd4ed0a32aaaa4ed8e3
pristine_git_object: 507f5707fde53eec0065bbdbc921928899ceaaf9
- docs/models/operations/RequestBody2.md:
- id: 6a49e6bb1dd2
- last_write_checksum: sha1:2ef3d12ca84a509653ab85f26e08a0a46461c2ae
- pristine_git_object: 0dd7fd214f985c0516871e539f42b76526ee74e9
+ docs/models/operations/RefreshTokenRequest.md:
+ id: 289300f807c7
+ last_write_checksum: sha1:ea5cacfa16b3957e0169a28ac37406d65e7072da
+ pristine_git_object: 6c7aefa297a1b9e6fe765f85c4e80b6c124becdf
docs/models/operations/RequestBodyGrantType.md:
id: 6f4b80b4a1f6
- last_write_checksum: sha1:500051f69ad2270cb9bf8f12c336e2d3e811c7e1
- pristine_git_object: 4e97ec02623f27674ccd0474ce1bbb8c75357fdc
+ last_write_checksum: sha1:c9ebb419c07c72f0a8e45a4aad77f1beeed82ca1
+ pristine_git_object: 4492212ba90cc2322ac2e767f989b32c5ad085a4
docs/models/operations/RequiredQuestions.md:
id: ff41beac0ab1
last_write_checksum: sha1:48bae59e65bb285ef4317b2f09b0722d1596f23d
@@ -5649,50 +5962,38 @@ trackedFiles:
id: 8655124c3d81
last_write_checksum: sha1:bc4f97cabd49d02d0d49cc1a707e1b511ff5c21d
pristine_git_object: 57f10dcca3054d37a79a2d818cf57883ab25ea3c
- docs/models/operations/Resource.md:
- id: 3f48d994e502
- last_write_checksum: sha1:df71b1f50c89b4acf558911a529aa09b1267023d
- pristine_git_object: 0fdc067f19f04076be54d0777a65b381250bbf0c
- docs/models/operations/ResourceOwner.md:
- id: 00962c4111e3
- last_write_checksum: sha1:e05db6b51e411e70720257d8773de11b355f49e4
- pristine_git_object: 6f19e720105f0b59e7acee38166825de2c3c4aea
docs/models/operations/ResponseBody.md:
id: 66b1653d36a8
last_write_checksum: sha1:fc9626fd6a267852ee80b5e08857980d60152fad
pristine_git_object: cebff776862b66de6880d5eccdc665d2bcabe41b
docs/models/operations/ResponseType.md:
id: 1bbf1571aa73
- last_write_checksum: sha1:97e8ce9886ef703cf93e61498a9f9bd927b39915
- pristine_git_object: 6cb42575a18eae9e7170243dd64536dd1b02f003
- docs/models/operations/Results.md:
- id: eab2fa1a9f6d
- last_write_checksum: sha1:0038d3f2c45dec8fe688d8a3169ef0d35c3e9944
- pristine_git_object: 20a5f4024f35a95278f8abcfaf4a8ab5ad7623c5
- docs/models/operations/Role.md:
- id: c8f64a823189
- last_write_checksum: sha1:fac773cdab652a67d4703620892e191340337f63
- pristine_git_object: d9efee9e68dd27db5e4c26656b6b12edbf8eba44
+ last_write_checksum: sha1:700ad0e0273c0b2b58376c3c57c243ac6d4a7681
+ pristine_git_object: 184bfb594e4fdeb7139ec7a829f7dd6bf70f65c5
docs/models/operations/SortBy.md:
id: 7bdd49024e4d
- last_write_checksum: sha1:8b9710ed84b4f77060b048733e6699f449c5436b
- pristine_git_object: 2bee57030912e8601aa6f729b8cdb4e738af1714
+ last_write_checksum: sha1:64c9f377443dbd0376bf89622ce0cf417ec7ca46
+ pristine_git_object: f192dad309aaf8ef0a38729ce1c6812ecb707039
docs/models/operations/SortOrder.md:
id: aeb074b97615
- last_write_checksum: sha1:6b4006fc030d24fc526b7929adf20448d6e05d05
- pristine_git_object: 74f505004a21f78d3dad2be1ffa48d6d12766038
+ last_write_checksum: sha1:023b88a47a2274648f42c6419a9c2de17cb8df4d
+ pristine_git_object: 373cbd6b9a08e85670c494c132582aacf9303ed9
docs/models/operations/SplitBy.md:
id: 82d51c93eb4b
- last_write_checksum: sha1:82617398d6287be00275b27e585f0dd9b81e84cd
- pristine_git_object: cb7cbb52049f7e806e21195f6161c34ed6f4d1c1
+ last_write_checksum: sha1:c20ec62daf9a32a137b9dd8763c4ba6438711633
+ pristine_git_object: 4bb095b7e1a14c113cfeba518f4e3e0db3d6b939
docs/models/operations/Splits.md:
id: bb8e1a530be5
- last_write_checksum: sha1:4fbcce032392b22eb5ce4d755c825f87545cb6c0
- pristine_git_object: 061fb95fa696d3280699fbb90c4efc57dbc1ab89
+ last_write_checksum: sha1:c191d9d68548c22affb603ce49d73946d915c971
+ pristine_git_object: 44c373b83b71413434d42b03efbb71e832c6d096
docs/models/operations/Status.md:
id: 4c05b42545a0
- last_write_checksum: sha1:050b348002940afa04cae003035c1361138a3e95
- pristine_git_object: 427e54c62a6d413d38d535157c7fad877025264a
+ last_write_checksum: sha1:1160ffca53048b7a171f785fd8b1fa09bedeaddc
+ pristine_git_object: ddef6a9f32328aa56e11bb87280dc0f992d87b1f
+ docs/models/operations/SubmissionBlockers.md:
+ id: bd77cbde02be
+ last_write_checksum: sha1:29125101c6bbe5b687027248d50daf3b302541f3
+ pristine_git_object: 8c7b4a210df4a74470aa3a1bb2edc943958ac94e
docs/models/operations/SubmitInformationRequestRequest.md:
id: aaaf97070ff5
last_write_checksum: sha1:b64bf9877e0e45b2077a83b92835591b69e31100
@@ -5707,12 +6008,16 @@ trackedFiles:
pristine_git_object: d609733ca94981ecd583cf04ea5bdb28986ea922
docs/models/operations/SubscriptionTypes.md:
id: f7fa74935662
- last_write_checksum: sha1:ea3672e1c39baf0768dbdfe40735309574399adf
- pristine_git_object: 098d39ab2f46f314051de8d3b8fcd10f648c13f0
+ last_write_checksum: sha1:a63a3d2e1402862931b09a6a9e08e5c1a66ef97f
+ pristine_git_object: 6c8de0488fa81e83e1926ad31c19d5a840ea7480
+ docs/models/operations/SystemAccessTokenRequest.md:
+ id: 11a6e4bf3a9a
+ last_write_checksum: sha1:49ea0cd266f24538f6d73c7fa667f723d1741804
+ pristine_git_object: 3cedc74c50269dd7781ddb63dc183d6d2bec2ad9
docs/models/operations/TaxPayerType.md:
id: b04679a8168d
- last_write_checksum: sha1:9fe0f059d7cf4b6f04cba0519e1518ea92e8fd07
- pristine_git_object: 6fa7658014f7fbceabf1c9f18784b64fc0b10a38
+ last_write_checksum: sha1:297cac152ff05bcfa652377802063c92eb8c37d8
+ pristine_git_object: da8f215620fd4b22c360689272a7283969612ab0
docs/models/operations/Taxes.md:
id: fa15a6d117d1
last_write_checksum: sha1:bd99585ba3f44f858a7adb92691ce1cd046e54fb
@@ -5731,8 +6036,8 @@ trackedFiles:
pristine_git_object: 66d0eb738abc5918f2ed5f937000df919664baae
docs/models/operations/Type.md:
id: b7dc6280f202
- last_write_checksum: sha1:29d3c640061b017c0d87dd984a7889e82d35bdaa
- pristine_git_object: 4d925fff924c3900acfb97df8f383f9547e5c71b
+ last_write_checksum: sha1:b21db844b26f7bc77456b3731e0636dfcd6a36d1
+ pristine_git_object: bde57d6cb58a1109f1d92680c7fc450767846205
docs/models/operations/User.md:
id: d5c050e7021d
last_write_checksum: sha1:ab8491cbd018f1ce12afb9a8a7a22881edbb07fe
@@ -5749,246 +6054,250 @@ trackedFiles:
id: 1224301ff362
last_write_checksum: sha1:5a4736026a7a9a1b5ff58a61a8af936019872569
pristine_git_object: f0d95c958a6730fc1e80cb8aed1b51c42ac5a78e
- docs/models/operations/WageType.md:
- id: a6f58eb8e0b0
- last_write_checksum: sha1:5f41ba31b764f7553592afe375474073299f5f9a
- pristine_git_object: 7a06901aa5325f5bcb880481245bcfc797dc9754
+ docs/models/operations/W4DataType.md:
+ id: db40fb984205
+ last_write_checksum: sha1:a98000af20713a94d5950fe7937b2948c2a7f98c
+ pristine_git_object: 74d9702bd4cc3e551ce0a5fb9233ca87c1cf955a
+ docs/models/operations/Warnings.md:
+ id: 7a545b8b088b
+ last_write_checksum: sha1:d8a055af33bc46162af3180a6d631a168c3c62e8
+ pristine_git_object: c070cccabc2827de42f4b15375ab9770f473f790
docs/models/operations/WithholdingPayPeriod.md:
id: 54f08c6e4bca
- last_write_checksum: sha1:56bf684c7a0be8cdbef0168caeb5a6eb19ec415d
- pristine_git_object: a8f6d9dbdddf8f8f2db187a1cdf2cb0438e15e0d
+ last_write_checksum: sha1:3a9ce1daec7f87ef9f104edbfedd26575e75e0a1
+ pristine_git_object: 520694a7d6d27c961056998cdf10c82b80c203c6
docs/models/operations/WorkAddress.md:
id: 05f0e3199709
last_write_checksum: sha1:c1ee04a24845c026a96fe03c079fa367e5734a82
pristine_git_object: 237119a846216d75433304481a30f42bf6a626da
docs/models/operations/XGustoAPIVersion.md:
id: 76cf4043b26f
- last_write_checksum: sha1:6bfee3c0a108eea1cd629055934ebcb686941172
- pristine_git_object: ec7307cc594728de797a47e315fa2abd2b605873
+ last_write_checksum: sha1:f1a4379ce05e5a2c3e0e816ab528befd2df5d0b0
+ pristine_git_object: 7d1afe13731b4bfba2c51b2b1fd8feb78adfb8e8
docs/sdks/achtransactions/README.md:
id: a8c4e4abd4a5
- last_write_checksum: sha1:95eaba450d7d53f283bc70b27139b0877b2be2b5
- pristine_git_object: 18772f8b644a029f19be3941ef12f78695ef5b68
+ last_write_checksum: sha1:30b52c7db9902aa1f1ca8c9e1ac3cad9833fc486
+ pristine_git_object: 4f707811d312a00d138d649717e914abb92d4aed
docs/sdks/bankaccounts/README.md:
id: 510ffee224ea
- last_write_checksum: sha1:24db90e6163e7b06bd1b8c600cb7ecfb1ce134c1
- pristine_git_object: aa409c5eaa7a9be85ba9b6f9b62cfbea6c1ea062
+ last_write_checksum: sha1:ce60390b4eb5b67575d200bcdfb5c6aaa886d52d
+ pristine_git_object: 89d0861f073e86753a5f200d8731752465395d3e
docs/sdks/companies/README.md:
id: 67e8a49afa67
- last_write_checksum: sha1:b867aa6fd63d001aca851b75181e904894340822
- pristine_git_object: dcd5e4f1185aea8271bdec1ca558ccd34120c65a
+ last_write_checksum: sha1:47bfe3e3f53fcbf9637d0924597444877eb13073
+ pristine_git_object: b3848ef0a6c61ad04ce14d9b61b16c2bac92d415
docs/sdks/companyattachment/README.md:
id: 49c4e919caa2
- last_write_checksum: sha1:30ef9993f221365ccd1b443e4534d99e16b0fbea
- pristine_git_object: ea8abff81f81f1fb4daa2b0ce6b7b51304210ebb
+ last_write_checksum: sha1:75e11999e0ae3f50b3686bd70296875a62fb0715
+ pristine_git_object: 436e0744a265f07a223883ee7c429a772974c8dd
docs/sdks/companyattachments/README.md:
id: 105a968c3402
- last_write_checksum: sha1:f4be14a73f1b382bdd356dd1f7b7e56c9521548f
- pristine_git_object: b6b65e7a0d26b313c9c11ade4c4d64d89f300f8f
+ last_write_checksum: sha1:d6b0dd769095c8bd8c52e55dd6c5b5a5e2e3d37b
+ pristine_git_object: 95eb7145b9f116681248bbb647417d6879afb99c
docs/sdks/companybenefits/README.md:
id: 68640bb09ef2
- last_write_checksum: sha1:2fdd3c981d2b542d3b99a9bd94ff142a25d88211
- pristine_git_object: c89153edd5f5cef38c06721ed2c2884c2635cd58
+ last_write_checksum: sha1:e8a4da2abfc1f9bb8a4e0922e539b3e639c918ce
+ pristine_git_object: 7c6e0a82f136cae3476f6c70526d432b3052e4d5
docs/sdks/companyforms/README.md:
id: 950fa696807e
- last_write_checksum: sha1:aa5361ce3f9332e279932dc68eed722d4d873157
- pristine_git_object: 44dfaf13b06a3644e7e27c18d3378f864c2e4a60
+ last_write_checksum: sha1:c0dc42fc9cec50e59dd1d02b31e342e237be48bd
+ pristine_git_object: f498cc8cfbfb79297de4ee0c591b9d15eed5bd79
docs/sdks/contractordocuments/README.md:
id: 7ffd676ff41a
- last_write_checksum: sha1:960cf9e04a3e38badc0a250a78ad306b511467ac
- pristine_git_object: 018656b04756b6c0c02a395585e0a66f8a9c253b
+ last_write_checksum: sha1:2aebc964981cd6a25ef6f962ab637c04f320b5b8
+ pristine_git_object: 17a15025489d0021800f49fd799af5840d0d985c
docs/sdks/contractorforms/README.md:
id: 77174f8899fc
- last_write_checksum: sha1:42af90fd7a3686e8ec7accc7630b74409fab4aa6
- pristine_git_object: 787ff48d6bad4360dc4a9c9cf214a12d1f5b61f5
+ last_write_checksum: sha1:14eb25092a6f23472c90651b55989deb74c9485c
+ pristine_git_object: 0318ea84bbfebd1ab254e5329e26dc17ba8d6ce7
docs/sdks/contractorpaymentgroups/README.md:
id: 827b7ed15692
- last_write_checksum: sha1:8b671039b7292b1e25f79a453ba561b4aac0b309
- pristine_git_object: 497885676530dcc18802868eb0be21a1c45d7a62
+ last_write_checksum: sha1:9ea04b603955370f68163e5a602037fb50f3d93a
+ pristine_git_object: 7b31ab6cfb447184feefa37489d576077d56da04
docs/sdks/contractorpaymentmethod/README.md:
id: 6d90189ab4bc
- last_write_checksum: sha1:c148b349428443b3d83a66cee80598612a40cdc5
- pristine_git_object: b94a0e5e3bac07373a920852d1f8ba55117a847a
+ last_write_checksum: sha1:d53eb8445551399ca4a2b22ceea2102572207542
+ pristine_git_object: 3c856a6b337df32453ce0c4538f5c8af871c4dc0
docs/sdks/contractorpaymentmethods/README.md:
id: 8e60120cdd11
- last_write_checksum: sha1:4e9e31ea1cf4e9fbf3749934da8223dcd47c6216
- pristine_git_object: 0ab548511a4c4810d5871ab055b4392f56517871
+ last_write_checksum: sha1:89e4eec572ceb530aeca2798ab134cc489b8f6c7
+ pristine_git_object: 97e0eeb65da2e160870d85a7e1f2255763a73060
docs/sdks/contractorpayments/README.md:
id: 2636bdbff20f
- last_write_checksum: sha1:8419b63a7098ed0bdfc4572da17bb13ea9915252
- pristine_git_object: 1e4c0a0fe45e1a04d4ddc722d3007cfb18454864
+ last_write_checksum: sha1:3e3269674407efc54a3fbeaece8507d21a32f085
+ pristine_git_object: 3be8e7d7bb20bf4212835a7aeaf0c41fcd04ac40
docs/sdks/contractors/README.md:
id: e5de017cf9e6
- last_write_checksum: sha1:d9d794b310950ff1ef4c63db37ec25bc2f8bd329
- pristine_git_object: 230a2ae852720e4c5001746159085374696cb745
+ last_write_checksum: sha1:513a38806316c67833d61b89cc13a15b6ccb9f83
+ pristine_git_object: 65131e0fab3416eb6ccd9802fd8c62f21e9dfad5
docs/sdks/departments/README.md:
id: 12342c54f2cb
- last_write_checksum: sha1:1c339fe1ced2ef9a2ed085caea92761622dc2a9b
- pristine_git_object: 2b37130c86f1eb018b0ba0b5e61351d61301aba7
+ last_write_checksum: sha1:6242f0b9794e9d16b5029804cc38a437644f81e7
+ pristine_git_object: 22458d2b699bcdb01dceee358f3a27ae56f45129
docs/sdks/earningtypes/README.md:
id: 8fdb58368538
- last_write_checksum: sha1:b01ee8f5dd6e8d4b2693a021916e99410e7726f7
- pristine_git_object: 307f4d84dd267c3c964b2fea8f0132cdfdf67008
+ last_write_checksum: sha1:1c02dc2f6217dc50846ad186b447f420bdf88b91
+ pristine_git_object: 5aa90dde404e518e3a9c3eb8d76308552da096e3
docs/sdks/employeeaddresses/README.md:
id: 9dcdcfde936a
- last_write_checksum: sha1:43f031b33619e9151a9e06fda1251d73c294eb31
- pristine_git_object: d281d27eeb0e8ac52214b874c7eb1f368451ce52
+ last_write_checksum: sha1:887062975a3a4fdf658f3ced3ceaacd784699d47
+ pristine_git_object: a8ef117972350532c00903e2bce5fcdbe5f51e43
docs/sdks/employeebenefits/README.md:
id: d8dae69d12b6
- last_write_checksum: sha1:2b08bcd29058fb6489237a5378a26a83c78ca031
- pristine_git_object: f33271cc3d0a10930528721ca2c5b18c0f98bed3
+ last_write_checksum: sha1:460292bc778d01d23772f5ff65667a56034b74b6
+ pristine_git_object: 2af8398f3921ace375fd55604a1469038327c645
docs/sdks/employeeemployments/README.md:
id: a5c0a62c8948
- last_write_checksum: sha1:8e0f0caec5b841ca0e1551af21ed999f9b07a04e
- pristine_git_object: fa9dda992e6f1cc4e091498ec8e74773b7c22ffc
+ last_write_checksum: sha1:254a188cd9f1ce8659e628f5622b736fb72240ca
+ pristine_git_object: 236d21d7ed291d4d933caa7e8aba9b4c39707da8
docs/sdks/employeeforms/README.md:
id: 6e8cbb9eb9f8
- last_write_checksum: sha1:5336d9d016922df2d7e4593c966819274d004e4f
- pristine_git_object: b7f90ac7490de495fb8b3d939d60607d11a4e3d5
+ last_write_checksum: sha1:1df19430e6899d45562c30c4a7f4e19726e86d44
+ pristine_git_object: dce7e92d0db49624d52144809c36a2f2f0f32448
docs/sdks/employeepaymentmethod/README.md:
id: 3d8a3fd0cae6
- last_write_checksum: sha1:9abd6d271605865aac8b5735ca067fb4aa0ecf5a
- pristine_git_object: b5407a941becafab091887077e9b44b744bed1e4
+ last_write_checksum: sha1:bb1c8c834003f55282ed8b066340fa3bede25f2e
+ pristine_git_object: e2a013ae562085334d6cf2094950ef3437b35aec
docs/sdks/employeepaymentmethods/README.md:
id: 805c32ccd865
- last_write_checksum: sha1:87181abfbe24d3c80c06c714726d5a4c50eb7c73
- pristine_git_object: 781fb295acb90de5f7c5f37bd22b96acfcb256c5
+ last_write_checksum: sha1:80a65f7801196020dbaadf228892f895a2012f56
+ pristine_git_object: b922290ec494c335c9a182ab1d03efcb73c7a8eb
docs/sdks/employees/README.md:
id: 3adbd327ce9d
- last_write_checksum: sha1:474bc1992a59c90178f01043286fab63797f6b5a
- pristine_git_object: 773e33b0e3867f40154a856329077c86299c6dbe
+ last_write_checksum: sha1:e733b66b08675903914f8957ac0c54b2cb98447c
+ pristine_git_object: e3a823bb8ae52d5fb3aff852b7ed4ff14e5736e3
docs/sdks/employeetaxsetup/README.md:
id: 65804e377e2e
- last_write_checksum: sha1:034b2fdd168bfe84bc0810c0a3a6573832d517e1
- pristine_git_object: 6d24e0e43c6a34e5869c1817d5786b932b5f24cf
+ last_write_checksum: sha1:2a5362762831e7923ab3d8f14ec39fe5d0d8a0e1
+ pristine_git_object: 901ea6b99a2f0e77cb38e4cc9c041fa1ad9014f1
docs/sdks/events/README.md:
id: cf45a4390b9b
- last_write_checksum: sha1:011bac552972e5d568ffef2fe3f647607459b297
- pristine_git_object: 75e50beb721cbd72231140b94a429e42bbc3d8c8
+ last_write_checksum: sha1:1a7d467004ccf69d71008fd8f6432ed8685e1817
+ pristine_git_object: 6f7e27900843dbfacb1b4cc299d6744bd4b4e55f
docs/sdks/externalpayrolls/README.md:
id: 3ef919744e64
- last_write_checksum: sha1:64f28695f2ced488fbb627b7165dd847cf049edc
- pristine_git_object: 853d071e27becb832efa096d07884cefd6e4f5fe
+ last_write_checksum: sha1:246ddb178673caf8d42fdb58d2d1f95cb6ad0360
+ pristine_git_object: 5bfbebef594dd1d3085b487154c6f782a12f7b88
docs/sdks/federaltaxdetails/README.md:
id: d3272089b17e
- last_write_checksum: sha1:5466e76b67720383f9cef41bc03c24f07bdc03ec
- pristine_git_object: e096e77fbd6bf86b69a1930a0ebe872fabd810de
+ last_write_checksum: sha1:cee866131ce77ba4f4852ba132d03bbcb720906e
+ pristine_git_object: ce46e96917b077b7b8bcabef27a74c2c2bf5cdec
docs/sdks/flows/README.md:
id: 1e486772e924
- last_write_checksum: sha1:4df697c5507c511a6df00bc6ce5b338957d4348f
- pristine_git_object: bf464e98c3f42ae87f17a803ca23736f5c19c4c5
+ last_write_checksum: sha1:53d886a3d968534ce3d67252f37b7571e85f5bcd
+ pristine_git_object: 705f309d97e8f837b09de6c24549a7b59d045b5d
docs/sdks/garnishments/README.md:
id: 6758c2e254f5
- last_write_checksum: sha1:1272a50de15e6b00227177dc534363b2b0888767
- pristine_git_object: 0e91a7569be1b053d8e3dc42e2815e699e41d3fb
+ last_write_checksum: sha1:d27c1210286dce5889a51b8f2107f7c5d397de87
+ pristine_git_object: b5b4b996d23b85556ab55e1b37502c62341cd28d
docs/sdks/generateddocuments/README.md:
id: 5072871eb0eb
- last_write_checksum: sha1:ee12d5aef6ac0a6500acfc7d9d45b44e55b776e4
- pristine_git_object: 67bd29f4eddc825bf5a00d02b054243c47e6250d
+ last_write_checksum: sha1:0aae9bebfec590d68d785ac538a0afb4ee5bffc2
+ pristine_git_object: 57576f57e6c83bf94452bbd3ae4558163adaba8c
docs/sdks/historicalemployees/README.md:
id: 38adbb7622ee
- last_write_checksum: sha1:170701daba5d90ac8688e397267801255b9e650d
- pristine_git_object: 5abfbbf17045977ae4e1009a02ae45b391ab78be
+ last_write_checksum: sha1:42706cdb2ba43e1bf23d30799bcc8fae278ce19f
+ pristine_git_object: 89f14457acef6402962d72d03e0a6afc60f20042
docs/sdks/holidaypaypolicies/README.md:
id: c837724d7856
- last_write_checksum: sha1:ed4e3b4d283b7c18d36801f782fb81681ccb5cbd
- pristine_git_object: a1222578f731f0d6960d8a640d4d631f546190bc
+ last_write_checksum: sha1:40554e39d36bcaa129a5da053ef13b6d7a0f703f
+ pristine_git_object: 2a5bb022d894ff08e10639b055beb79ba5db4f82
docs/sdks/i9verification/README.md:
id: dd8f7cd6f284
- last_write_checksum: sha1:d77ec9eaa7c30a35f99e43d0f5d27fb43b7a9e01
- pristine_git_object: 65d24fa326f6e7dc540590f41729f4b0371f547c
+ last_write_checksum: sha1:46910188e6ba7a637551723c8d243632d26332a4
+ pristine_git_object: 1a08920c0f6026bcd35d8777875afa4c046d6e32
docs/sdks/industryselection/README.md:
id: 6633a8a37ae7
- last_write_checksum: sha1:1f4095e0cc3ba348bc1ee4ee19ab59487d1ce781
- pristine_git_object: 3b3f7448a6d8f7c9d169eff01fa83e9c6ff860a2
+ last_write_checksum: sha1:887e53887955949daa25f32a94b5f258394f9c31
+ pristine_git_object: 5c27f374fdb5e4b8e861e4a75ef697a631a063ed
docs/sdks/informationrequests/README.md:
id: e176ae9536c5
- last_write_checksum: sha1:51692392903afe2064dc5d252d70bb3bf3ff201f
- pristine_git_object: 53bf9fddd02bfe0da88328a8fcb648ed393759af
+ last_write_checksum: sha1:0a3c5ecb5d0e29ec87f8b3ce1dfd2fe1620dff95
+ pristine_git_object: 3e2a63d59dc1885b30eb06022c16974ba6d461fb
docs/sdks/introspection/README.md:
id: 9f867af7c1f3
- last_write_checksum: sha1:96ebe110df0347a5b712638a077730d30462997a
- pristine_git_object: e5a85ac4243d20ea8bf90dd5428b1112b6ec675b
+ last_write_checksum: sha1:e6f969e774c49c20923eb8b48579b2420f25dbc2
+ pristine_git_object: 55dbe00f3853f2882a4544972ee09ae1c9f07265
docs/sdks/invoices/README.md:
id: a3f76a06eded
- last_write_checksum: sha1:7238e4752f2a2ca870e64aee9effa50f4ee43e97
- pristine_git_object: 7235ca5864dfc4600084d289b15ff5b9df0097d4
+ last_write_checksum: sha1:4ece548d1864c58e57a80a3d45fc120e5928503e
+ pristine_git_object: b89b3b8957a6cfe3e2a7981d82d286a2aa1ceb21
docs/sdks/jobsandcompensations/README.md:
id: f262ef7b4c37
- last_write_checksum: sha1:8f9cb72728285f3e53a02125b87fd56db621cc29
- pristine_git_object: 92b3700179e9c14cf0ac079d6ab0d535261881a5
+ last_write_checksum: sha1:ec862be5482d1a58bcee824148d34575e2affecf
+ pristine_git_object: 381766734113fd65baed0421a2b478cb50be5e18
docs/sdks/locations/README.md:
id: 18f4bc68d8e9
- last_write_checksum: sha1:d4272b432d10ae332ecf8cb710a0b944e3565409
- pristine_git_object: d6651a7d356f9fda1a214556fc25683bfcf0e444
+ last_write_checksum: sha1:a457ebf8ea17e078d1795dcb6a09c50b709c3ee2
+ pristine_git_object: c09f4a1496a322ec229364ae6679734eb0921161
docs/sdks/notifications/README.md:
id: 271bac956045
- last_write_checksum: sha1:62fb5cf2c9dc9a1073eb4416695c26d4abd521b6
- pristine_git_object: 0a4da20484b19299819b49c51c5f115834145531
+ last_write_checksum: sha1:a94be6bafd729aa19637ad90d365899e02417296
+ pristine_git_object: 73803d6c99e7fbac9612fd065ec1e1cdbf34e4da
docs/sdks/paymentconfigs/README.md:
id: a5944d10a31f
- last_write_checksum: sha1:2350380333e5bf37ca5de9b15f241d339d11db8e
- pristine_git_object: ea0a7d2b7a53b614e85217bdd2c1c1055e990b2e
+ last_write_checksum: sha1:0e4de49d490ead3629f8ee3bb9014fdadab271fb
+ pristine_git_object: 50f1d68487fc4993d3ef5caa449941edc0a2b6ec
docs/sdks/payrolls/README.md:
id: f6fb115a2746
- last_write_checksum: sha1:edb23aaec915378d6e58fca28e73db54753f24e0
- pristine_git_object: ef2509af28e3b0d522aa4c08479d8391b2332bf1
+ last_write_checksum: sha1:fc991e986524d0dd49e097ba6644ebfd499ac62d
+ pristine_git_object: 089aa5da9d440ff9b3c5286934c8200cbd35866d
docs/sdks/payschedules/README.md:
id: c0aa724eca5e
- last_write_checksum: sha1:8d2a0ee92fb08994ae26753ca2ec53e677d06a75
- pristine_git_object: 29c8d2d48ffe50d4f1affe9f7a281b79486dd5a4
+ last_write_checksum: sha1:c3c5c8a9ff2cb255dc21d330440cde4960f88e27
+ pristine_git_object: d6660a8093d1cbe5d2a3883b9d0027a02349d2d1
docs/sdks/peoplebatches/README.md:
id: 9ac77915c062
- last_write_checksum: sha1:bcef132382dbe2b55e3e9735a6fccdcb7fb46682
- pristine_git_object: 0b4cb459a0e4e96838e224ffc27de2560a3eb42f
+ last_write_checksum: sha1:46798d2bd938a28549ee8b43b93b4a7eeaeeb71d
+ pristine_git_object: 4d2abfd6d856975aea2cbfe8aba2487d47f5f8d7
docs/sdks/recoverycases/README.md:
id: 31e46e1efeef
- last_write_checksum: sha1:4cb083d55bf5102d75eb842315a6a7961de523ad
- pristine_git_object: 1eb293fd0e4f31d72397b1a41d65bbf6615925c9
+ last_write_checksum: sha1:e3fd7e0350f08fb9912951fcb5193c056746c4f5
+ pristine_git_object: 820a81ea52da4a5719618f084ae173b36549e0c2
docs/sdks/reimbursements/README.md:
id: a5d637dcab67
- last_write_checksum: sha1:46e642913615f68086ea3d4e5c49d2463deb3324
- pristine_git_object: 42363095578a5d7819aac8db9c862e13b925abbb
+ last_write_checksum: sha1:23035f9b855efa71bf3cc9f718056e66851a5e90
+ pristine_git_object: f6d5efb583a15fb1ebcf039a915bf07dee5633a9
docs/sdks/reports/README.md:
id: 66bfd66f1efc
- last_write_checksum: sha1:9eb416905de67c75a36d743d35c2cf845a9d605c
- pristine_git_object: 2067e2a2a46b60e06297131d32f6e1aa07ed6463
+ last_write_checksum: sha1:d199ed0f9bd058235235bcb6e4aa0d61e18e287c
+ pristine_git_object: a0898be8038baa48ea14725c815edf0153cc2016
docs/sdks/salaryestimates/README.md:
id: 6793d2b9fcf5
- last_write_checksum: sha1:af6e5f6c158852091768b15d5dd43fb201e130f9
- pristine_git_object: ccd812187b38b52d8bf34670f60f4723d61ef0d6
+ last_write_checksum: sha1:eda02ead77a2cdf1d1fb08b4af84e82e8e7e9f50
+ pristine_git_object: 464ff44901e12537a11b338616b23324dbb59219
docs/sdks/signatories/README.md:
id: 70a385fb9412
- last_write_checksum: sha1:5cbe8e38ac118b1f02c378adc2be91cf75c60782
- pristine_git_object: d100f524a62dd4e939efec0ec7831c5bf67effac
+ last_write_checksum: sha1:c57fd8cf7ef51edcc1250fd76b43b144b93fba8e
+ pristine_git_object: c64ef4bbe296b76b5ad66ab307014c97d3308a49
docs/sdks/suspensions/README.md:
id: f304a2d5ba91
- last_write_checksum: sha1:fb82888e9cf21381ca3a84d97589c45af94dcfee
- pristine_git_object: 395e75c78821846279cc93d8e38ad879401c1346
+ last_write_checksum: sha1:19b571b04dd4a55662aab8febb2d14b6c9e4e2be
+ pristine_git_object: 7e82a334bd34045fe87a2a167a6b2d3b2ca86a99
docs/sdks/taxrequirements/README.md:
id: f686b8175c1a
- last_write_checksum: sha1:65a7e338ae46ce6111ceb8c9db3a8e586601ee68
- pristine_git_object: 946136a42ed3a79388aa1faf1d64001abffac12a
+ last_write_checksum: sha1:16ab87ab950e5d509e1695c2d8b2866620bff8ed
+ pristine_git_object: 33fb681fbe72f0b76fd2baf43e32980958167f00
docs/sdks/timeoffpolicies/README.md:
id: 8b8852bbde37
- last_write_checksum: sha1:339af140b5c944e72e4cf123d32545f155e0bc36
- pristine_git_object: 3647ee5b8ee54f3877639d54ef48c23196ecc95c
+ last_write_checksum: sha1:0626ee8bc7abccc562f451e2b97b7d2eadccdb0f
+ pristine_git_object: 8b4c6a960ea2a9deb85c66954192348489a11ed3
docs/sdks/webhooks/README.md:
id: e21b32d786a4
- last_write_checksum: sha1:3698c6f45245b0702a107108ec7815961db9575b
- pristine_git_object: 5c14c774506bff87f0447662065c158f41457362
+ last_write_checksum: sha1:e1ca9bc68f8fd1c1002df895e5922998a3aa225e
+ pristine_git_object: 7dfafe49eb3e6986bd432513eef0e4025aef6b70
docs/sdks/wireinrequests/README.md:
id: fb21b6718da2
- last_write_checksum: sha1:5f5813a4e7300dd741e7e9fad09f53ef1c437dd9
- pristine_git_object: 83371051ba93d756a97ae2fc5c2716383ec6be29
+ last_write_checksum: sha1:9889c9100ba948a627443bfe03a148408dfccec4
+ pristine_git_object: 60888739e05eaa55c51b12a4a78e90b058073f83
docs/utils/Blob.md:
id: 3d9a7c4ad67a
last_write_checksum: sha1:760a6261cfb9516bbfbf76efcdd9962c7724229c
pristine_git_object: 0f659807250bd74a70615ee7e9befe64fd92a66c
gradle.properties:
id: 2afbb999f001
- last_write_checksum: sha1:5c37d0fba9580b4d61a7175b7af4a46d9acb2209
- pristine_git_object: 150a2d3b9b8ccb1e331c3e08a810bf2a012a4eac
+ last_write_checksum: sha1:29e33024ef6662648bbad75686f20a2b9bbdd797
+ pristine_git_object: 9b5aced8c150c1328d1f645d20d143f57b332f09
gradle/wrapper/gradle-wrapper.jar:
id: ec27dae6e852
last_write_checksum: sha1:f725fb1467084142d74fd7cd8eab691ab3442611
@@ -6051,12 +6360,12 @@ trackedFiles:
pristine_git_object: def1f06babc037ea9ee2694575971e48c3b8a46e
src/main/java/com/gusto/embedded_api/AsyncBankAccounts.java:
id: 883aff310c86
- last_write_checksum: sha1:1da30dec12a4591e2a4904efb1308d13c994e1b8
- pristine_git_object: 3e1d5c893056d5c24253039e3b0e28e24031ad40
+ last_write_checksum: sha1:a89c85eab58d15000f8a54fff639109a35fa4875
+ pristine_git_object: 72eaa4fa2248354f1ab0e6bbc41a927e0129d250
src/main/java/com/gusto/embedded_api/AsyncCompanies.java:
id: 0a2b8daeed3f
- last_write_checksum: sha1:b8f825f2e69d07d3c1f68c105f0f12ce875283e9
- pristine_git_object: 88145bfe565dcb8af0609c4c0a36885861b1de5c
+ last_write_checksum: sha1:7f3f91d9c6558717d64fd497ab9f52bfeee0dc41
+ pristine_git_object: 0bbf3394bcc285ca914cd8230c2d953332f63b55
src/main/java/com/gusto/embedded_api/AsyncCompanyAttachment.java:
id: 5bbc25d0d0f6
last_write_checksum: sha1:fb6c179eb14ec20e9b6007641207ad41e676b269
@@ -6071,8 +6380,8 @@ trackedFiles:
pristine_git_object: 6dbbf672395ede6d3127397324ae76392b5a8664
src/main/java/com/gusto/embedded_api/AsyncCompanyForms.java:
id: 209ae3e8cbdf
- last_write_checksum: sha1:3cd9c382da1a8dc833e3718367bfe913b8bccba6
- pristine_git_object: f1f74bf716eba1bffeadd6124e495d3847448f00
+ last_write_checksum: sha1:ae204a45ad3caa4f35c321a5333c93b28183b56e
+ pristine_git_object: 1c89af520fad80cebf6adfdd32c9eb6d0e9b4c65
src/main/java/com/gusto/embedded_api/AsyncContractorDocuments.java:
id: 62df5c1523c7
last_write_checksum: sha1:35a611d67428e7c791b5428ba443e76219ae6067
@@ -6095,12 +6404,12 @@ trackedFiles:
pristine_git_object: 874910c60e4abec5e757c78260bb41f08bb08487
src/main/java/com/gusto/embedded_api/AsyncContractorPayments.java:
id: 57464af11a55
- last_write_checksum: sha1:832c87073a3bd44c202e27a29ce5a740152c9fbe
- pristine_git_object: 62c59296907cfcec54e01dab3b26168fcafb1937
+ last_write_checksum: sha1:a13eec875700476c3c11a2566cdc815bb0302f3f
+ pristine_git_object: 4357ce19685c037039c8eca59a6ee530e37191a9
src/main/java/com/gusto/embedded_api/AsyncContractors.java:
id: 648a33b01f17
- last_write_checksum: sha1:4672f5f9b79df1c94c7d43616d1ae1e10273eb04
- pristine_git_object: dced610190d829494ae0b6844286ed479fd7a3df
+ last_write_checksum: sha1:4cfd842b4be77146d866f7110bf7f163366e3fa0
+ pristine_git_object: adcd4c8f41fdfd518c84d9dce42520b5b95029e6
src/main/java/com/gusto/embedded_api/AsyncDepartments.java:
id: 313b2517a1ac
last_write_checksum: sha1:c5ab9099c4ee410d7a8eba60b6b92d21c63ec120
@@ -6127,24 +6436,24 @@ trackedFiles:
pristine_git_object: c637e48fa3c84daa8fabca945e6905c8a4e553bd
src/main/java/com/gusto/embedded_api/AsyncEmployeePaymentMethod.java:
id: b23762a4cfce
- last_write_checksum: sha1:5d0212e920e5292b6084b3c20c19452e527c6e28
- pristine_git_object: 0df3071cd9b882b8a4b0bec80deb7db42442794e
+ last_write_checksum: sha1:6eb0aed154321b752b3d9fad0d97224376176e62
+ pristine_git_object: b3d2aa2496f19f9e18833e1e0680beafeb1ac52e
src/main/java/com/gusto/embedded_api/AsyncEmployeePaymentMethods.java:
id: 8fbfa0c7b18c
last_write_checksum: sha1:92d6f2fd4ffefe9af99c9ccfe6ed8641dbbf194d
pristine_git_object: f97a3cf3c6d665ccc374ed9b86812707d0a7215d
src/main/java/com/gusto/embedded_api/AsyncEmployeeTaxSetup.java:
id: a330df0ad0d0
- last_write_checksum: sha1:0a1294b35e4e960d9a3a5f64b92a5dcc35cc51bf
- pristine_git_object: 03f08740c6b23faeb45b94f00d039a5be06be6bc
+ last_write_checksum: sha1:80844b87f858c871235bf3d91a33d7ef4a30ecd1
+ pristine_git_object: 8bbe9b72beffa745d33a55ec380a853958f5c3cf
src/main/java/com/gusto/embedded_api/AsyncEmployees.java:
id: e27cd50b1457
- last_write_checksum: sha1:7b8bbdc1d45e0ea775c95a57cc14019e3def01b7
- pristine_git_object: 2db936eac3f391e967ea7de0d1831e471e4eac98
+ last_write_checksum: sha1:1b95c3820983ec427554417f2d660e29b03da0fd
+ pristine_git_object: 4e870e6fbf7a5e82c5d702682779e0657c451760
src/main/java/com/gusto/embedded_api/AsyncEvents.java:
id: 21340fae7091
- last_write_checksum: sha1:d4021684ee2f31fb7c144eb230666c164eb903b0
- pristine_git_object: 548df18ba5c0884611a97ec4c8d706b6b6ea686e
+ last_write_checksum: sha1:42a92909ad752949f709d3222b2bd5a32d9dcbc3
+ pristine_git_object: 5f1008e6dbf6a462c737ae48f72d1de2fce90c48
src/main/java/com/gusto/embedded_api/AsyncExternalPayrolls.java:
id: 608bd79747da
last_write_checksum: sha1:481101e809d53160930519f4883f080024bc5406
@@ -6155,8 +6464,8 @@ trackedFiles:
pristine_git_object: 2f006a8e3e918ed775d6d3d4980a17c21c3cdb0d
src/main/java/com/gusto/embedded_api/AsyncFlows.java:
id: c14584f54147
- last_write_checksum: sha1:b6567e809b089f35bd96db0f12e9ed749a0a4606
- pristine_git_object: 51ad95bbbc92f58e05281bc4be470bb04ccb94d9
+ last_write_checksum: sha1:7e04565ca1fae810c54c85a083b01af4a743a5af
+ pristine_git_object: 090ef1fc2f82474cda6c77e554c634279def11c0
src/main/java/com/gusto/embedded_api/AsyncGarnishments.java:
id: e0e46848dcfb
last_write_checksum: sha1:1d5ea531216a986ef6c5a413bcb6e6fbf22f8742
@@ -6179,48 +6488,48 @@ trackedFiles:
pristine_git_object: 4859b04d1ef4e6549326b4fcbbd0b7a7dcc42654
src/main/java/com/gusto/embedded_api/AsyncI9Verification.java:
id: 482a0717c149
- last_write_checksum: sha1:00a195df1699b564e5deeb46acf0ac339361bc4d
- pristine_git_object: 01888ff4c2855fdf4326d0cc0d01537d210414e7
+ last_write_checksum: sha1:bb8816b0106f34de1752263a0ce8df47bcea4cbf
+ pristine_git_object: 640217edb6ae0b63335c88a65362d04c11b7de03
src/main/java/com/gusto/embedded_api/AsyncIndustrySelection.java:
id: f283fe3224e1
- last_write_checksum: sha1:458fa8bda97eef93fd65fe44b8b74dea90b0389c
- pristine_git_object: e3b9a280dabeb798f30396b12578aec97c7a6a7a
+ last_write_checksum: sha1:b1168f9edcdc4a60c5706abeaf8cf6bf08a8d038
+ pristine_git_object: 5b894099f764639544c2a8fcb91f122b7b69365d
src/main/java/com/gusto/embedded_api/AsyncInformationRequests.java:
id: 2d21db82fafc
last_write_checksum: sha1:a6ac2af8fd14bd0480c678c7b8b5d0e5845e493e
pristine_git_object: 73958e5b95c5ea86aeb20d1025b9fa58a4b70e6f
src/main/java/com/gusto/embedded_api/AsyncIntrospection.java:
id: f10d3976b2c1
- last_write_checksum: sha1:c2737b09ff934ad2172b65e1fed3f5e75990d85d
- pristine_git_object: 3c6bb4fb49a928e35f415e00fc5e717c2c7953b0
+ last_write_checksum: sha1:6f8252e5fd82f9de50440841b8bcfe591cd4d58f
+ pristine_git_object: 86a9fda9d02327edab9461384a1fef4ae15e49eb
src/main/java/com/gusto/embedded_api/AsyncInvoices.java:
id: fcb4e1e369ab
last_write_checksum: sha1:1c461259002a8beba429d0bd84c2a83129a48245
pristine_git_object: e646bc6fa6f5aaa75a94a3447b5f0c20102c47ad
src/main/java/com/gusto/embedded_api/AsyncJobsAndCompensations.java:
id: 6ece00508c2d
- last_write_checksum: sha1:67ae567af780759c89607f564be7071510f9114a
- pristine_git_object: 7d7921bf382aa6b0d34871dbd8897dbd57f3e68e
+ last_write_checksum: sha1:d6708d5131f80dbadc70decb8c13dc4528052e3a
+ pristine_git_object: 4fc39507b9b07b50cacc3708c4142f764c95e4e0
src/main/java/com/gusto/embedded_api/AsyncLocations.java:
id: 30cc4a1f3c6f
- last_write_checksum: sha1:358a9403877048ea3c666fa6110c9c8710eaa846
- pristine_git_object: 1092f52dd846d633490b8e710a0f83c3d2a1b723
+ last_write_checksum: sha1:dda8889084b0e44be12e96757e7d9397c4474351
+ pristine_git_object: 7729b98c244cd680224cac8dc5ba60b12302d322
src/main/java/com/gusto/embedded_api/AsyncNotifications.java:
id: 8147d6c05c67
last_write_checksum: sha1:3119d9ba300ff51d319938dbd79c85599f971d46
pristine_git_object: 34e4c31de27242eda546990375e37745cba4b4a3
src/main/java/com/gusto/embedded_api/AsyncPaySchedules.java:
id: d424f0aaf749
- last_write_checksum: sha1:ab16db5c2f5908ea316969f260128bde0b5d0c2d
- pristine_git_object: 456213935b2e3fcda205043f8f5763d3bc4ec6fa
+ last_write_checksum: sha1:dd011a27d1201fabb2b77a5253a6b9933b58c4b2
+ pristine_git_object: 2a22a0c209204391475f08375b930c81b63d0348
src/main/java/com/gusto/embedded_api/AsyncPaymentConfigs.java:
id: 584b57bb5ff2
- last_write_checksum: sha1:d6dba27786b5fbe6dce537ca2e3b16cdc94d25cf
- pristine_git_object: 19e53faa4baad3670fa3de5eac7e4a76ec53f151
+ last_write_checksum: sha1:a0e09bdb5725c07c05febb68cd0f1dcf15521afb
+ pristine_git_object: 55a83f5c3f8b845ee5264ac625ab7ce240b3ccaf
src/main/java/com/gusto/embedded_api/AsyncPayrolls.java:
id: 46742a304ad9
- last_write_checksum: sha1:3ab9423fb216ddd75d3efcaff409e25df0b3c270
- pristine_git_object: 5bf37dafb697f25093656a3058dcd634e92c9663
+ last_write_checksum: sha1:db3ace0ed093201ad8bf59c91c17accc52e4490b
+ pristine_git_object: 7823615432763bc3abc03ef05ffb842a9fca3440
src/main/java/com/gusto/embedded_api/AsyncPeopleBatches.java:
id: 9ab3c92785e7
last_write_checksum: sha1:b7169237cf66ff1dd1683d99003c9993c6f9b29d
@@ -6243,8 +6552,8 @@ trackedFiles:
pristine_git_object: 24ff31b2beaeb1d37d49be42fbdfc13a4e613ce9
src/main/java/com/gusto/embedded_api/AsyncSignatories.java:
id: f4faf674cdbe
- last_write_checksum: sha1:6777b9efedd3701c13f5a2e50ec1d62180510202
- pristine_git_object: 8281dd131a6ef79baa57d02343d22ecb445b6976
+ last_write_checksum: sha1:50a0b5ea699c784daef3dac637190f5861f30477
+ pristine_git_object: e53d9ed9064b6b9d862c22faa47c4dfdf750bc43
src/main/java/com/gusto/embedded_api/AsyncSuspensions.java:
id: 47c9e5fe08da
last_write_checksum: sha1:67181b06eb53e857add8fdc75f34601cbde4154e
@@ -6255,8 +6564,8 @@ trackedFiles:
pristine_git_object: eed525a166e09cbde5e67d380d30f626db2c132b
src/main/java/com/gusto/embedded_api/AsyncTimeOffPolicies.java:
id: a21f1e7496e7
- last_write_checksum: sha1:2124ca650d0c288337b6a487b201f6bf811769f0
- pristine_git_object: d2ebb09cb312746b05b88b88e0cb7d35320204c1
+ last_write_checksum: sha1:10be05b47ba3ee49a59d9ae61d5585567b27526c
+ pristine_git_object: ecb394beb2c203dd89292b7f2fe4cded149c349d
src/main/java/com/gusto/embedded_api/AsyncWebhooks.java:
id: ee3b4808d295
last_write_checksum: sha1:686e76415f2bb90c66466bfbff6c7ddce948ddf5
@@ -6267,12 +6576,12 @@ trackedFiles:
pristine_git_object: e4577507fbee40636bdf04cfe95600f2cb2c5e8b
src/main/java/com/gusto/embedded_api/BankAccounts.java:
id: e0bd67741e1e
- last_write_checksum: sha1:a6347f9868132095ad80fbccbf9939a793524473
- pristine_git_object: 9bba483c2faa4f78d601462a949e5faa404fd890
+ last_write_checksum: sha1:970768567e817e34207d7bbf1c0a61827a08bfc2
+ pristine_git_object: a8b48dc848d24b5b8dba636e4ba8bf779d1a8d87
src/main/java/com/gusto/embedded_api/Companies.java:
id: 52fb35e90cef
- last_write_checksum: sha1:b96baa137823f3822365b42b81d9cda2e3b17479
- pristine_git_object: 36f1a62730ae1fc8d78b5e19f165cdbf96701b3f
+ last_write_checksum: sha1:5ec042171aa0791f8ede46c0e0897c15f91b27a6
+ pristine_git_object: e1c31e9eb42bbee1642b7a0d02fa05092ec1ef72
src/main/java/com/gusto/embedded_api/CompanyAttachment.java:
id: ba842dd466c4
last_write_checksum: sha1:21bc6c9d1b0139102121ab38924adcc55bf473c0
@@ -6287,8 +6596,8 @@ trackedFiles:
pristine_git_object: 06d7ee858bb8899dcb39064dcb5dc1f74e01b49a
src/main/java/com/gusto/embedded_api/CompanyForms.java:
id: a2472178be8a
- last_write_checksum: sha1:51142a5199a917a702b056c198c81dbd81990eea
- pristine_git_object: 24d1f291daac5dcbfb1f86e032cbddb6239d8095
+ last_write_checksum: sha1:d090a0d13daac20b4810158fa5298bf66da18157
+ pristine_git_object: 46875d343bf6b696affe0835d14db3675f6ac463
src/main/java/com/gusto/embedded_api/ContractorDocuments.java:
id: 9c315c13115a
last_write_checksum: sha1:3c31709ea6858868e944c7098e82ab73bbbd4ea6
@@ -6311,12 +6620,12 @@ trackedFiles:
pristine_git_object: f8aa399dae1218617e38d36aa221b87fd1885cf8
src/main/java/com/gusto/embedded_api/ContractorPayments.java:
id: 02e0fb52881d
- last_write_checksum: sha1:3aa1133bec78a40573708e471922d84d545e87c1
- pristine_git_object: ad888408875d6e39073dfa38f094fa7259d6d4ff
+ last_write_checksum: sha1:d32a1de05085073c7172cc7d7675b9af287c5921
+ pristine_git_object: 92843cc2f4f3098aa0d3cef0d0e0382c7e7b5b5d
src/main/java/com/gusto/embedded_api/Contractors.java:
id: 2fbaadc4514a
- last_write_checksum: sha1:21f8d73c14db3f32c59fe95501f1795ea00e804d
- pristine_git_object: 8ebe064531fcb89c63ca43799f41691be219afa1
+ last_write_checksum: sha1:908cb5bde3f3da0271a0a550df922802b03d8a58
+ pristine_git_object: 98e87808b864372ac3547294feb2c07ebf6cf0b2
src/main/java/com/gusto/embedded_api/Departments.java:
id: 0e6cd7cac4d3
last_write_checksum: sha1:470f82c798ba7e30ab991836a6b7ded6c7f68739
@@ -6343,24 +6652,24 @@ trackedFiles:
pristine_git_object: 7fdc05ace623751a32631bea041d287c7bde237d
src/main/java/com/gusto/embedded_api/EmployeePaymentMethod.java:
id: 8018a1fc129b
- last_write_checksum: sha1:747d2554eb229d69c16a62d30462c3768c55bc4f
- pristine_git_object: 37c4bf9bee596cf0facda824b9383fabdda33ed5
+ last_write_checksum: sha1:2e4c2e7f5aad6d9f1fb1905dcc84e3ca693dcdbd
+ pristine_git_object: 81d382bca59b513815dcbb575ae289acbaa8d45b
src/main/java/com/gusto/embedded_api/EmployeePaymentMethods.java:
id: f71457f4f913
last_write_checksum: sha1:1656987a5c3c860556a3e502e382cc5996f9a416
pristine_git_object: c9cacded0c237b5cce7c005a8c47b80ed9af2ebf
src/main/java/com/gusto/embedded_api/EmployeeTaxSetup.java:
id: 1da3f94992e6
- last_write_checksum: sha1:ea050be84c7efa03cbaf3b231ab23dfc6a315800
- pristine_git_object: 7de0ea0630e2af92cf57a78c25cfca1f35a7a7db
+ last_write_checksum: sha1:89e60c8f25e7f32204667bb1f6245b045819a802
+ pristine_git_object: 68306e1f8a13288ab3e01ba5a78a6b01f815e83c
src/main/java/com/gusto/embedded_api/Employees.java:
id: 091ea013fe8d
- last_write_checksum: sha1:853815b83fbffe3c9b15788236e23cad8cfde098
- pristine_git_object: 67445febf3e7403ea6d25b2983f813da6ad28128
+ last_write_checksum: sha1:1ea36f21a93cdfb1e841b4e813dc02bd71ba0f26
+ pristine_git_object: 2c727e8274964ca4f69dd69c3ab8a44d2e4d69f6
src/main/java/com/gusto/embedded_api/Events.java:
id: dd3ce72881a8
- last_write_checksum: sha1:a943dea5c269d2ee141089eddcab2ffb811af2c2
- pristine_git_object: cac8a77cf6f5dc8e24e785d78113bd9995e006b4
+ last_write_checksum: sha1:f4fd99505b1b82903094b16d48ab226a69f0018c
+ pristine_git_object: 45e68586df9f9f3663c18520672cf24d79225e59
src/main/java/com/gusto/embedded_api/ExternalPayrolls.java:
id: c39139cf3725
last_write_checksum: sha1:5fbfc7a8ceec399bbc73bbf8cea9b3069fd23f22
@@ -6371,8 +6680,8 @@ trackedFiles:
pristine_git_object: 3d2a5d0093c5551d28ec0b77e3e7d7868ca68fa8
src/main/java/com/gusto/embedded_api/Flows.java:
id: c3e13244c264
- last_write_checksum: sha1:c073bc344a6ee978becaf97df2496d5c820f0c59
- pristine_git_object: ac2133b1fc98349c124c024b23fdb41196e1d028
+ last_write_checksum: sha1:ed361cc44a3b6696ed2467ce530b710b18267d47
+ pristine_git_object: ea72b0632b15e369494ed56a2a38b8742d8c7c4f
src/main/java/com/gusto/embedded_api/Garnishments.java:
id: 3a3970182f32
last_write_checksum: sha1:f5df518af0e3db84c0c8bbaecb3e8aaa31197cbd
@@ -6395,48 +6704,48 @@ trackedFiles:
pristine_git_object: ef77ed92fef3c4d76a658763a92b1837014aad9d
src/main/java/com/gusto/embedded_api/I9Verification.java:
id: 4b3a7855cc2c
- last_write_checksum: sha1:9766bae35b1faf02316dda84270e53aee2fc35d3
- pristine_git_object: ace9a17c26eb0bf5c5287c8fd061dcaa786d263e
+ last_write_checksum: sha1:148c690c1454ae232c996a55734af17f3651e353
+ pristine_git_object: 314f5ae80005bcfe277c8b682aed749ce8ad5391
src/main/java/com/gusto/embedded_api/IndustrySelection.java:
id: 7f2973151c17
- last_write_checksum: sha1:4c8a3937a79a14aa22ee51804dfd700ddade7639
- pristine_git_object: b0eb0c19315d2597f92e686c9d97f097205c72c7
+ last_write_checksum: sha1:a857f9fc2e0cd87ee039a41b876d5776d4659a7a
+ pristine_git_object: 6884cc8953a09d772be99781712fc49d19403934
src/main/java/com/gusto/embedded_api/InformationRequests.java:
id: 77a240b100a7
last_write_checksum: sha1:c69b47cdde787de8fbb747034af5f5982b69098b
pristine_git_object: 8e1375d94a2f52cdcf29292fcda77335e805a74b
src/main/java/com/gusto/embedded_api/Introspection.java:
id: 09598fc172f7
- last_write_checksum: sha1:ffce992ec4f904ce57f5395466b22f6cc1624943
- pristine_git_object: 3f978d96ac9f7799f655246d378a8e15e0a3f737
+ last_write_checksum: sha1:1abc8e30627b8d76f96ff80e1d4b3c46eb6cbcdd
+ pristine_git_object: 6153d594787810fd57b55e8348a666e9af400341
src/main/java/com/gusto/embedded_api/Invoices.java:
id: 299cce4d02f9
last_write_checksum: sha1:e87ff2f38b59ca0447eb70d2d5153c1978a52282
pristine_git_object: 64c392a99bdfdaeee6f72c9466eaba132e3b8319
src/main/java/com/gusto/embedded_api/JobsAndCompensations.java:
id: 71e096333824
- last_write_checksum: sha1:11b317692e9b04b5ba33db1d1ac8353e18bc43df
- pristine_git_object: d1de6c49e95b67f7b8703524c498863055b2bf65
+ last_write_checksum: sha1:d5307518f738393a50f3eacdc5f330785ee09b02
+ pristine_git_object: 2c1ec8799889e27f280b0c267e7678cb79ea15f7
src/main/java/com/gusto/embedded_api/Locations.java:
id: f42d3fab934c
- last_write_checksum: sha1:726eccc623ac5b8611c50acb5c7c478f7e41415d
- pristine_git_object: 2d63232b49f7862cdd0de4108f4d4be116b4b49c
+ last_write_checksum: sha1:93e95954d1997c6871d20c03e9cece7986e70a71
+ pristine_git_object: 80ac2801102f4ad8c82149ef03a1860be353788f
src/main/java/com/gusto/embedded_api/Notifications.java:
id: 0518c78960e5
last_write_checksum: sha1:0b505b0adeccd5350f807c5b6691dda673fb7f6f
pristine_git_object: 5570ddce4fe44ca3c49ab4c4942f40838e0a2354
src/main/java/com/gusto/embedded_api/PaySchedules.java:
id: ab9f9e17ccc8
- last_write_checksum: sha1:0b6516b6a7b592bce4299bb2b197316bbaf5db59
- pristine_git_object: 8d0d98ff939278f50ecfd50fd5e7eaba20c3bd31
+ last_write_checksum: sha1:8153692a7d0569882699144151ca0eec5bb43d89
+ pristine_git_object: 354e099cf8079209bbc9dee4a91e2ecb1c62ea06
src/main/java/com/gusto/embedded_api/PaymentConfigs.java:
id: a66112143396
- last_write_checksum: sha1:aee4ef4d5a543ff774a45552c436dcecac9d334f
- pristine_git_object: eadc89508018e7eaf150d87527add290b0c34697
+ last_write_checksum: sha1:bb8af71318f466d88716ad53c5cdc5a938a06272
+ pristine_git_object: c4e3f7d12ce0404608cb25124d2c32947cac0f6e
src/main/java/com/gusto/embedded_api/Payrolls.java:
id: 06d373d55255
- last_write_checksum: sha1:ce1aab41afb67126537586a0088d1470261977a3
- pristine_git_object: 2836186030149feaeebc8af9869fc1e017320f11
+ last_write_checksum: sha1:84d8661124b53d72f4c60bd6e1fc71882ebf5a9d
+ pristine_git_object: ce83d3849fc293eaac82aa2c715aacceae75dce1
src/main/java/com/gusto/embedded_api/PeopleBatches.java:
id: f744eb3b14b2
last_write_checksum: sha1:5313709295b77a81a90de311e53851d1987e2c8b
@@ -6455,8 +6764,8 @@ trackedFiles:
pristine_git_object: a22fbe8ee97d741deda6415e8e4098e2e013bca8
src/main/java/com/gusto/embedded_api/SDKConfiguration.java:
id: c282180d7aa3
- last_write_checksum: sha1:fe7309df0f2e3e4224913ece5da5ff23f0f142a3
- pristine_git_object: c255e1271bfd33b17dc8f8718f5c982507c21232
+ last_write_checksum: sha1:992e12f3b1a14a0e60da5927c9896c8e54f97dfb
+ pristine_git_object: a5825c15872c852105a68f0af8c8e1478ed5426b
src/main/java/com/gusto/embedded_api/SalaryEstimates.java:
id: 34e62c9ddacb
last_write_checksum: sha1:94a3ef803e42aba150c70fdc88881e52068877e7
@@ -6467,8 +6776,8 @@ trackedFiles:
pristine_git_object: b3d6e0b24dc7a482da14a597a5a68014a3c7bb62
src/main/java/com/gusto/embedded_api/Signatories.java:
id: 05bf27d0c53b
- last_write_checksum: sha1:5f35c63537af8404236f2752f409ebad1a61b283
- pristine_git_object: f522c2efc94bf2316606ea60d6a7483e5210cb8b
+ last_write_checksum: sha1:516f811a236c96f6310465ec3bc7afae8c26e062
+ pristine_git_object: 67b90f77348524af3747afe9b24cc2306118e7b3
src/main/java/com/gusto/embedded_api/Suspensions.java:
id: ad1759787886
last_write_checksum: sha1:2be69a689e234c887365565faf68287d943f8216
@@ -6479,8 +6788,8 @@ trackedFiles:
pristine_git_object: d01ca4a168988fc9444d8be917b8df210e00229a
src/main/java/com/gusto/embedded_api/TimeOffPolicies.java:
id: cc093b9ba3de
- last_write_checksum: sha1:7c88a520dc8d7dcbe88381672f13ad646c5b9266
- pristine_git_object: 6c0ce3bfe4f596dd3b4974b1ea0f4e3774e10a83
+ last_write_checksum: sha1:7ce7987cd1596f760cd6cb9bbe1876918870e3a5
+ pristine_git_object: 614c717238026fbe5fd50d0b3f9914fb49ba4fd7
src/main/java/com/gusto/embedded_api/Webhooks.java:
id: d2df3199a4f7
last_write_checksum: sha1:813f8f315cc2493786e8f307f411a968d0ab9790
@@ -6497,14 +6806,6 @@ trackedFiles:
id: c14b4809f7ba
last_write_checksum: sha1:362b8ff396cbfdeb7fed5931f997f5b364bae1b8
pristine_git_object: 03bf7b6a2c0487dff92f80b272ea599ec28f5104
- src/main/java/com/gusto/embedded_api/models/components/AccruingTimeOffHour.java:
- id: 585d7b4dcaef
- last_write_checksum: sha1:8eeaa8398a95db7841d7cc2dec54fb1c9691e617
- pristine_git_object: a299c41c58e3461f5f1fc0758314d89c7133f4f9
- src/main/java/com/gusto/embedded_api/models/components/AccruingTimeOffHourObject.java:
- id: 42cd5325e3b9
- last_write_checksum: sha1:f905cbf969ac8586b89564fce00539fbca562ea7
- pristine_git_object: 39b0ad66ed4836c84e91fb25718faeefafb1663e
src/main/java/com/gusto/embedded_api/models/components/AchTransaction.java:
id: 063f79e2cf4e
last_write_checksum: sha1:7011fa3352f1b4fcd4460c8fdeea661365dc99ea
@@ -6539,8 +6840,8 @@ trackedFiles:
pristine_git_object: b166e43580bdb1ca67cf73a9d588d513678f6e39
src/main/java/com/gusto/embedded_api/models/components/AmountType.java:
id: d4c1543d1d62
- last_write_checksum: sha1:9694278e1fce915bc801947cc1f8b3f9885fd365
- pristine_git_object: ec2e165ef251f3e394700cd8772238a7202a4f1a
+ last_write_checksum: sha1:cadc5a39bc4947bfe69c0ce7109912fd2e0b4784
+ pristine_git_object: 0b8607410e4247ae31ec71ee173506393345b537
src/main/java/com/gusto/embedded_api/models/components/Answers.java:
id: b9fd46a198c8
last_write_checksum: sha1:ed87b2c840d1f5052181ff5460f04a7b06bfc98e
@@ -6645,6 +6946,10 @@ trackedFiles:
id: 4ab355b70e7c
last_write_checksum: sha1:895745b47e9ef663d940c3518eb7a5612b02fb6b
pristine_git_object: e0107ba1905d7dbe0d79d9f417507cda8fb6509b
+ src/main/java/com/gusto/embedded_api/models/components/ChildSupportDataKey.java:
+ id: 4042357c1f65
+ last_write_checksum: sha1:6e1c9af0bf9e242d86dc15c165e587c1d09fdc74
+ pristine_git_object: b44bcd048fca41b945a0658f5a4ccb26f7c46e13
src/main/java/com/gusto/embedded_api/models/components/ChristmasDay.java:
id: f2c4f9331195
last_write_checksum: sha1:363b15f41a496ada2054346b9d0603dde679a2c7
@@ -6659,8 +6964,8 @@ trackedFiles:
pristine_git_object: 1e85935653cc761c3252c598da4c06de68b65f28
src/main/java/com/gusto/embedded_api/models/components/CompanyAddress.java:
id: 8e185f6ff3c6
- last_write_checksum: sha1:a02e2241b2151de233066e57eab0c92c754d655a
- pristine_git_object: 8f8a86ce07f95334ece75d43f3e49cfbbf1c61fc
+ last_write_checksum: sha1:58ab24396f64ce348eeba44b7d22bd1260078cb7
+ pristine_git_object: 56a104b0ef829cbfaedbf8036b23c5d95a7c9d20
src/main/java/com/gusto/embedded_api/models/components/CompanyAttachment.java:
id: ac21388e3dce
last_write_checksum: sha1:34a8acbbac2769488f341171fcefec2035331973
@@ -6677,6 +6982,10 @@ trackedFiles:
id: 238613ba43fd
last_write_checksum: sha1:474e2da4eddd36dd5c48c155a04e41769d4a138a
pristine_git_object: 6ebac6d17288822f067286b4afef401476cb89be
+ src/main/java/com/gusto/embedded_api/models/components/CompanyBankAccountVerifyRequest.java:
+ id: 00b684bbb35e
+ last_write_checksum: sha1:1fb71155c94c57fac6e7114a8bcf3457c3050ef8
+ pristine_git_object: b3583fec673d3ced6706e85bb8bf1dc83de5eeed
src/main/java/com/gusto/embedded_api/models/components/CompanyBenefit.java:
id: bfb79893e990
last_write_checksum: sha1:ce49d73f95a1fafdb7a50d7853f4781631a8475b
@@ -6721,14 +7030,18 @@ trackedFiles:
id: 330dcb6b9094
last_write_checksum: sha1:55961ab0a4a8d42e45deb777f0b0c6b4e8019706
pristine_git_object: d66b715a64e6439922484d0a65bc3e7ef6a5bbea
- src/main/java/com/gusto/embedded_api/models/components/CompanyFormsSortBy.java:
- id: 369a633b0a59
- last_write_checksum: sha1:8216d43c3008f3c66a58b29e7c6e9b04fdf93e54
- pristine_git_object: 8dba9a7838a296ecde335b8f38fdf43ef171ff6c
src/main/java/com/gusto/embedded_api/models/components/CompanyHomeAddress.java:
id: 0534afdc7052
last_write_checksum: sha1:98e93462e1a1e14b4c39d8bb1c9cc53eebc78080
pristine_git_object: 6676361b5113f04ff07e6f27c0eabde4da0fc29e
+ src/main/java/com/gusto/embedded_api/models/components/CompanyIndustrySelectionRequiredBody.java:
+ id: 11d36c68893c
+ last_write_checksum: sha1:b091ee78894556fb1a83671bd6bb78508c566276
+ pristine_git_object: 441669246cba09abcd5406e9cf8365b5760d2891
+ src/main/java/com/gusto/embedded_api/models/components/CompanyLocationRequest.java:
+ id: 3dcdccfd8d79
+ last_write_checksum: sha1:8f18c2d50e202b74194fcbd25a887c60a83d0282
+ pristine_git_object: c0d51b677268ba8b986ea973506e3c2228b3d3af
src/main/java/com/gusto/embedded_api/models/components/CompanyOnboardingStatus.java:
id: b8df6963a1df
last_write_checksum: sha1:9df27b3e05021104f45edde3f8320dbd04415b81
@@ -6747,16 +7060,40 @@ trackedFiles:
pristine_git_object: dd9c1e69061fd6490d48248095e27e7d41913f20
src/main/java/com/gusto/embedded_api/models/components/Compensation.java:
id: c55677a35d01
- last_write_checksum: sha1:0b1d5c11e43a6ce1ced57e2fdff86d445d97e313
- pristine_git_object: 61741b62ad431bc2368f4c1bb7b3e16be6e48ba6
+ last_write_checksum: sha1:41a0a19e1dd8137c7f573ffaedf63abe51f12ed9
+ pristine_git_object: 81ef72a4c82a71def34b10873b9a2d85f43cadfd
src/main/java/com/gusto/embedded_api/models/components/Compensations.java:
id: 4db3c64566c3
last_write_checksum: sha1:d4698443e9a4685a71c5b1b1c1d7a8c0ed030034
pristine_git_object: c824ec6b63a1f3041cf922f432c85c1ad98cbfca
+ src/main/java/com/gusto/embedded_api/models/components/CompensationsRequestBody.java:
+ id: 2f56bc2a0a0b
+ last_write_checksum: sha1:2d275c8e15a3589acee1b71465712ba1699dcd80
+ pristine_git_object: a12d776ff161cc508eb1b0bae3713b82c8be8d18
+ src/main/java/com/gusto/embedded_api/models/components/CompensationsRequestBodyMinimumWages.java:
+ id: 05c58e5480c6
+ last_write_checksum: sha1:d14086fe7b04e3c8ad9209e96d3420263ad91b5e
+ pristine_git_object: 3d5d29b0337843a9fca0d5a0d909a1539d738405
+ src/main/java/com/gusto/embedded_api/models/components/CompensationsRequestBodyPaymentUnit.java:
+ id: 00c9c0fff870
+ last_write_checksum: sha1:0ff82690afb41dc42807bd1b93efaea0cadbd787
+ pristine_git_object: 60e4c2a77b2034d62d3a7e63413096299d6c64bf
+ src/main/java/com/gusto/embedded_api/models/components/CompensationsUpdateRequestBody.java:
+ id: 8ab85a9e3b84
+ last_write_checksum: sha1:89edf96e5b39a22317ff8aa13e3737ac53be57b2
+ pristine_git_object: 0605dc8363207b43ba90d5c3098359742399fb02
+ src/main/java/com/gusto/embedded_api/models/components/CompensationsUpdateRequestBodyMinimumWages.java:
+ id: 0fb29397036a
+ last_write_checksum: sha1:ef8998a3c32eab40a4613dcc680e7e74facf8f4d
+ pristine_git_object: 7a549f82aa020e74fcf708b6fc1e8e7f5b3fd82f
+ src/main/java/com/gusto/embedded_api/models/components/CompensationsUpdateRequestBodyPaymentUnit.java:
+ id: 9f7c8b8c8a80
+ last_write_checksum: sha1:c304f5208ace2589b05f9b13f30e5a114bfde923
+ pristine_git_object: 788df91bcf2ba9f11c7b9259c605ca873b605d38
src/main/java/com/gusto/embedded_api/models/components/Contractor.java:
id: d9814f603555
- last_write_checksum: sha1:7877867c1ab14366e360735d1e98b4b624e2136e
- pristine_git_object: 39c711649b3c76e786f5ec746a74b926afbe7a78
+ last_write_checksum: sha1:834bbb01e4e348011aecbdef799024db97190987
+ pristine_git_object: 87ce633070a73b807a82ffd92e42358784f3dc2c
src/main/java/com/gusto/embedded_api/models/components/ContractorAddress.java:
id: 6e0457ce0729
last_write_checksum: sha1:5b39a30970bd1ddca2cd556da649321f38f60c22
@@ -6769,6 +7106,14 @@ trackedFiles:
id: 6c499bd79fce
last_write_checksum: sha1:ff0048c77dabf88937f51e95f4c4f68c4664dfde
pristine_git_object: ccdd07fca37fa65d96e2d2ecd98bf788a25f76a0
+ src/main/java/com/gusto/embedded_api/models/components/ContractorCreateRequestBody.java:
+ id: 958154f73e3c
+ last_write_checksum: sha1:e46ec724fe4f85fe1432b4267a8186d88cd50363
+ pristine_git_object: 8e6af993a0f32d33f8169643aabfe5b17eddef48
+ src/main/java/com/gusto/embedded_api/models/components/ContractorCreateRequestBodyType.java:
+ id: e46bebd9dd20
+ last_write_checksum: sha1:956b963a3de72c1680001e18031bf5ce3317723d
+ pristine_git_object: 22ec3df605a130571829d8bc68f0183d54c8a190
src/main/java/com/gusto/embedded_api/models/components/ContractorOnboardingStatus.java:
id: 2fdf1ac29bda
last_write_checksum: sha1:60f840b4bca19f9a267275a04b672642a35dbb52
@@ -6789,6 +7134,14 @@ trackedFiles:
id: 3bc77d7467fb
last_write_checksum: sha1:cd634930d96315be3f9d5ddd1eced11b7fbe0e4c
pristine_git_object: 05c638c05f5824b10181b636e5ba8ff7cc77b25e
+ src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentBody.java:
+ id: 4ed4f88ab914
+ last_write_checksum: sha1:23136ab8c4d6180c4452820ac2746dbc226bcef1
+ pristine_git_object: 5d3ecc08ee81fc7835011192dcf3fe544f9fe7c5
+ src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentBodyPaymentMethod.java:
+ id: 161a33129327
+ last_write_checksum: sha1:9dc03524d058606d88197a78ce024381989691a4
+ pristine_git_object: 6be12af68d413936f22884a9b4ba58da0ac704cb
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentDetailsList.java:
id: d280084b9a84
last_write_checksum: sha1:fd3bdfef60e552a7545e3b2d5f511d130fadba50
@@ -6799,8 +7152,8 @@ trackedFiles:
pristine_git_object: b12254c9426fd8500be484ca9c0a8f74aa384292
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentDetailsListSplitBy.java:
id: f958bb5bdb27
- last_write_checksum: sha1:483ebf1790645c9546097a2c690041aa4fce74d9
- pristine_git_object: efaae5cfbc06d2bd4c1016fff4306a8a8ca8ae3d
+ last_write_checksum: sha1:1575e9003e3edd9c853aeb9a3c50b1e9277f26ad
+ pristine_git_object: 89693fd8ae162f34c01919ce57e765d60d14ca8f
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentForGroup.java:
id: 45aa1486186f
last_write_checksum: sha1:a1841b7777e85f33256d42d49a172325a5e57338
@@ -6835,8 +7188,8 @@ trackedFiles:
pristine_git_object: e92543db23d5f1e73c59b574cdfca56ca2adb9dc
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentGroup.java:
id: 7928c639ac30
- last_write_checksum: sha1:5379739f97dd1866547a7dc98b2e69e5fd7e8406
- pristine_git_object: de8ebf52d53ce5db629f25084cc5c6721111bbe8
+ last_write_checksum: sha1:8b01f14b360e2cf68289f42765d9f80cfa1b6525
+ pristine_git_object: 2fcdb1948e83963c8b084727dbe41969e8d0e250
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentGroupPartnerDisbursements.java:
id: 3328fa8963f8
last_write_checksum: sha1:792a349bb74a6fcd9267198718f27c34b358228e
@@ -6851,8 +7204,8 @@ trackedFiles:
pristine_git_object: 1fb8c7e8fbbe7194a4f6d7b5917dcf1f477a628f
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentGroupPreview.java:
id: b4a31b4c3954
- last_write_checksum: sha1:ff58a383c3d3c1c49cdf236c72b0122d5e319fe2
- pristine_git_object: d56d889136a2f7fb21cf8f490c2d72e862455b6f
+ last_write_checksum: sha1:5ab54c7c36246d17a887eb5c3427d2d87388b55e
+ pristine_git_object: fba7fc82f0624bda9142698006258221409210ed
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentGroupPreviewStatus.java:
id: af12ec714e73
last_write_checksum: sha1:08247b06d85c593e2ffda4f1ede24e8f538f7ba9
@@ -6871,8 +7224,8 @@ trackedFiles:
pristine_git_object: dbdd6e20a461c43bad8d351d002699c78f24e4b0
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentGroupWithBlockers.java:
id: 8f70b826ff85
- last_write_checksum: sha1:820ce5c29c863e136e1978ec11ab9e7896efdd25
- pristine_git_object: 8fc366aa615e734cba42a248cd1cf600f365fe05
+ last_write_checksum: sha1:338670ceb909e0bc83d8d0b269b82f105954e30e
+ pristine_git_object: f32b1c516ed11df93961f57eff1fb65d450f7e2a
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentGroupWithBlockersStatus.java:
id: 3d8f27640646
last_write_checksum: sha1:9bc49a6525beb6d158ca2bedeb9c29eacff7527a
@@ -6887,16 +7240,16 @@ trackedFiles:
pristine_git_object: 13fac5dd84cd9812627659e90d9649378687b971
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentMethod1.java:
id: a829904638b4
- last_write_checksum: sha1:c0b93b51e13565f92af877ae94d5ae6a210ee73e
- pristine_git_object: 98f552ede9b548521e6ae8f5af276252401baece
+ last_write_checksum: sha1:eaf43c7485722c8b44ea557a6588261528d7f130
+ pristine_git_object: edf3cd1ea1d6b5bffcab6215b1bca7a2fd087944
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentMethodSplitBy.java:
id: d092ea8d1d3d
- last_write_checksum: sha1:3fc416493355a89113f40a4af24217c0f75a4688
- pristine_git_object: 6edbfc9cf6c3a922a6be705b5eb972cc1094e0c8
+ last_write_checksum: sha1:28aa8d636b7bc517bb7bbbc44bbb1c8c921680ad
+ pristine_git_object: bb4029c63e1615d6494c7ca68131a515693e0480
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentMethodType.java:
id: fc5944c137a4
- last_write_checksum: sha1:eb52b09f2cc9fd5fed466a10da9dcae261a354c3
- pristine_git_object: d158bbc4750b149f08bb5cd79d440bfa704eba12
+ last_write_checksum: sha1:76b14cd854eb49c0a6bcd328cd48b0b6b03fa694
+ pristine_git_object: 5a4a019b22dbcaf8ccc1dba01209e5dca6cee61a
src/main/java/com/gusto/embedded_api/models/components/ContractorPaymentPaymentMethod.java:
id: 5505fdf8e7d1
last_write_checksum: sha1:b3f8de63fd39b26668193830eb8c59ed77600115
@@ -6953,14 +7306,26 @@ trackedFiles:
id: 13fec84da2d2
last_write_checksum: sha1:bb428d1a4f4dc806e0f6ea37481ad429a53667f5
pristine_git_object: 543c096aa4569b6e170cf34edd25e7d5044d150b
+ src/main/java/com/gusto/embedded_api/models/components/ContractorUpdateRequestBody.java:
+ id: d716e70f4a61
+ last_write_checksum: sha1:d5d3b36be7dc021309b24d67635c00c1038e0afb
+ pristine_git_object: b2672bd9b15d8dc04ca060ce13d605c14730da5d
+ src/main/java/com/gusto/embedded_api/models/components/ContractorUpdateRequestBodyType.java:
+ id: f0a80880716f
+ last_write_checksum: sha1:a2a15ab526bdbd252ac8a856f61a4e810d3bb1a2
+ pristine_git_object: a065b06898baefab2f1dd00cd55c2871b4d29de3
+ src/main/java/com/gusto/embedded_api/models/components/ContractorUpdateRequestBodyWageType.java:
+ id: 6b63e9acb53d
+ last_write_checksum: sha1:d91bc91b09d0cfbaf92161ed7c1ac4da60f9129e
+ pristine_git_object: e75580bb1cddcf4492e045ca743882c710c81678
+ src/main/java/com/gusto/embedded_api/models/components/ContractorWageType.java:
+ id: 43b246758799
+ last_write_checksum: sha1:4e55ea79c7e9197d146c5dd61c0358b8f9fe6e42
+ pristine_git_object: 9f72f16023862cc2eaf866dde3aa534a34a0f70b
src/main/java/com/gusto/embedded_api/models/components/Contractors.java:
id: 77191fcd7366
last_write_checksum: sha1:39875de974ec54795074f83cd5fd675b45a9fafe
pristine_git_object: 1b552f82129acd108c16cdf664f714069b19be67
- src/main/java/com/gusto/embedded_api/models/components/ContractorsSortBy.java:
- id: 5b1aceaa9a91
- last_write_checksum: sha1:0c5d9002823ceeac3639a4e770f1876af2b54a12
- pristine_git_object: 25346c2e2c2bdfd9b513e4a4944ce53b8d1783f7
src/main/java/com/gusto/embedded_api/models/components/Contribution.java:
id: d2bb5624ff66
last_write_checksum: sha1:11c3a37cdee4799bd3330373ddd0b904a4a9d61c
@@ -6977,6 +7342,14 @@ trackedFiles:
id: eacc3ebf65fb
last_write_checksum: sha1:67411c34d8e74316ab43d35e6f9b9e45e94af694
pristine_git_object: afe8ff828be19ef48e68013150088ccc51b88774
+ src/main/java/com/gusto/embedded_api/models/components/CreateFlowRequest.java:
+ id: 36048d8befb9
+ last_write_checksum: sha1:57264b7d2d1f37ae821f0b0800c73310aab3f358
+ pristine_git_object: e2b97f646680efdd93c34eae2f172d7ff8f04865
+ src/main/java/com/gusto/embedded_api/models/components/CreateFlowRequestEntityType.java:
+ id: 9a14953ef4ae
+ last_write_checksum: sha1:49739cc3bc360378e8883d4f4a7929d93da68e36
+ pristine_git_object: 676631b5dd7c4e21fa775029482b305829ef6c99
src/main/java/com/gusto/embedded_api/models/components/CreateReport.java:
id: c4fcbbabe196
last_write_checksum: sha1:9548a748af84649dd1d41e739a2e2c03547db0f5
@@ -6987,8 +7360,8 @@ trackedFiles:
pristine_git_object: bd83fc58f93dd93226de7926559ad16d21d583a0
src/main/java/com/gusto/embedded_api/models/components/CurrentEmploymentStatus.java:
id: ef7019ff978f
- last_write_checksum: sha1:3b69df691dd300cc3464d808d7c3bd290d86727f
- pristine_git_object: 2d847c1b3576240acd194bb6fe043ac3f79cfcfb
+ last_write_checksum: sha1:0640a190ffa1adafe92741e6fd787f36d25df54c
+ pristine_git_object: 34fb40c37084382ec3789450bfb2b34441afc32c
src/main/java/com/gusto/embedded_api/models/components/CustomFieldType.java:
id: 64d0655276fb
last_write_checksum: sha1:061ba5eeedbe7470790e4f093dbae9aca978c18b
@@ -7003,8 +7376,8 @@ trackedFiles:
pristine_git_object: a29e4103e9ade834f0e913350f95742f95ef05cf
src/main/java/com/gusto/embedded_api/models/components/Deductions.java:
id: c3ae0b34c34f
- last_write_checksum: sha1:8a0bb7baccbbaa4337dec68a690117793217ac02
- pristine_git_object: a623df61855624a70c162d758b58ce89085b65f4
+ last_write_checksum: sha1:ebde311ecabddac63282db061816098f75b41f24
+ pristine_git_object: 1c22d3d2d432548a660910043876b34220b8457e
src/main/java/com/gusto/embedded_api/models/components/DefaultValue.java:
id: 63c8f4a69c60
last_write_checksum: sha1:fd81279ba17c156e127e9064c8c79247b4a132e0
@@ -7049,6 +7422,10 @@ trackedFiles:
id: 2dead319d1a8
last_write_checksum: sha1:f5fa4314eebe05200ce4e638fcd6eb99ea2b8f0c
pristine_git_object: 82867aa9df6921266975d75bb899d31036b90e27
+ src/main/java/com/gusto/embedded_api/models/components/Documents.java:
+ id: "605631322865"
+ last_write_checksum: sha1:914972ea3b6f83beeffc986ebffe37600da4d3da
+ pristine_git_object: 12edc1dc055fd1adb9ba087734bf0dcfff2d4415
src/main/java/com/gusto/embedded_api/models/components/EarnedFastAchBlockers.java:
id: 78667879e0e7
last_write_checksum: sha1:1753fb7e831284688621aedb367dda76a50c2ca0
@@ -7091,8 +7468,8 @@ trackedFiles:
pristine_git_object: 34e70ebb65b21707dbed041b3a8f716d7d644e61
src/main/java/com/gusto/embedded_api/models/components/EmployeeBenefitForCompanyBenefit.java:
id: 8c4b2c595760
- last_write_checksum: sha1:e15c6cf450194d8b64b9d9d587f4b3533209c167
- pristine_git_object: 29d65c8c0a59d83640f8de768da7a40ac9b7c49b
+ last_write_checksum: sha1:63f57700c38cd08c7b93878b5792f1eeb22327f6
+ pristine_git_object: 2b499b656ff1b35fa4df68e8d1700f4a038b7c71
src/main/java/com/gusto/embedded_api/models/components/EmployeeBenefitForCompanyBenefitContribution.java:
id: e9fd7b863916
last_write_checksum: sha1:bedad04fe17fc3cef0ef3b42ffe9596245d01213
@@ -7111,44 +7488,48 @@ trackedFiles:
pristine_git_object: 8fe04cccbe7847c8350a7fc582ca2a1450d1c3f9
src/main/java/com/gusto/embedded_api/models/components/EmployeeBenefits.java:
id: 9433ee7a5b9f
- last_write_checksum: sha1:9b810c7085637d229d3e9f23ce899e3931eb6e1c
- pristine_git_object: d26134e50528d0e89df6af1c3ef02a685c1d583f
+ last_write_checksum: sha1:9cf35ec59c9901a6c7f9bfd0d8d9373838c106bf
+ pristine_git_object: 56fd3065a623c68b23c42cbf04e4408f6a03eda7
src/main/java/com/gusto/embedded_api/models/components/EmployeeCheckNumberMapping.java:
id: 87318457f0f5
last_write_checksum: sha1:22d8134f5015ab8b90108f6a699f889539c85291
pristine_git_object: 4db6ef3741907f3252fccda8c8fe245dc54af511
src/main/java/com/gusto/embedded_api/models/components/EmployeeCompensations.java:
id: d00c1e76259d
- last_write_checksum: sha1:f72dba186f694d9ac7d76d09b35d08946dda9479
- pristine_git_object: 391ad8c0cba4733f5cdcf2eb517634ee973c031f
+ last_write_checksum: sha1:b19847e1baed46c6e8c629fb567a41c58adca3c2
+ pristine_git_object: 9d5f0d2ee011cffb7429c1141649e11144fc6faf
src/main/java/com/gusto/embedded_api/models/components/EmployeeCurrentEmploymentStatus.java:
id: 21e2544751a3
- last_write_checksum: sha1:ac6617239165502b0c2fc6f41f48957d1a942519
- pristine_git_object: 3aa7bc0146e1a37c5c977f64662431600c739b4e
+ last_write_checksum: sha1:4ead73a702915dbb220b94a345c2636ff2cca6ff
+ pristine_git_object: aa4227d5a6d67ad95e1ab6ca67b6daea87590975
src/main/java/com/gusto/embedded_api/models/components/EmployeeCustomField.java:
id: be98c6ccb96b
last_write_checksum: sha1:2774d23833c99c146bda34f734ef499c4ddf4c49
pristine_git_object: 0464399e556e2335ddefcaca72d2056a330bc63b
src/main/java/com/gusto/embedded_api/models/components/EmployeeDeduction.java:
id: c9707105f6c5
- last_write_checksum: sha1:9bf40db42501dc3475c394532c10dec1ffec1443
- pristine_git_object: dc5f7283e9f532e50bf99ef332292ab47328488e
+ last_write_checksum: sha1:273fb81a77168d37502aeddc84465ae4c3bdba81
+ pristine_git_object: 6dd5a8ebbb46038b72dfeaef90f693977ad898a5
src/main/java/com/gusto/embedded_api/models/components/EmployeeFederalTax.java:
id: cf84df1793e4
- last_write_checksum: sha1:8d613d0708fe7155e1b5a9b93785c22816090781
- pristine_git_object: e387d5e90fb1ef25f22f1cff2b225b88853ff3cd
+ last_write_checksum: sha1:2093f1b03f80196923c80a632853a3d35fbd3477
+ pristine_git_object: 945ab4284c62711c30f41122598528aa0aaade00
src/main/java/com/gusto/embedded_api/models/components/EmployeeFederalTaxPre2020.java:
id: 073f2c5d157b
- last_write_checksum: sha1:6ff5dbc9f9f967a3f40bdd49ceb3bb62e37b4c63
- pristine_git_object: e4670dd5f07456cfc32d452fee5d27ba8986e2d0
+ last_write_checksum: sha1:33dac74c038a1bc1bae406699978438bcbe30203
+ pristine_git_object: 75b96f63d942248314c6bcb0571dee951f28677b
src/main/java/com/gusto/embedded_api/models/components/EmployeeFederalTaxRev2020.java:
id: 3ce3be6dad98
- last_write_checksum: sha1:c8117fbff30c395e7d61e31e3506ae26a4c1be51
- pristine_git_object: a9db4027da198b3563889853db212290a2886004
+ last_write_checksum: sha1:026ccd722f6d70e23b645e5188c6d40c1287c098
+ pristine_git_object: 626a57075de0539e2d90623576fb8092fcbca505
src/main/java/com/gusto/embedded_api/models/components/EmployeeFederalTaxRev2020W4DataType.java:
id: a2ddda2b593b
last_write_checksum: sha1:56a0f52463cf048fdb279545d69d42d95c92a4b6
pristine_git_object: 3e8b0664400f4480142763a201fea1630f4c4117
+ src/main/java/com/gusto/embedded_api/models/components/EmployeeFederalTaxTypeIdResolver.java:
+ id: 26a206fc8276
+ last_write_checksum: sha1:296b155e97354712230868170659b76f95e00d8f
+ pristine_git_object: 7fd8b78153d4b39fc62d0a313a58281523c43964
src/main/java/com/gusto/embedded_api/models/components/EmployeeHomeAddress.java:
id: cd91eef2709c
last_write_checksum: sha1:3ef64c065e1575ea7a5466d7fb1fca7fcd9ff973
@@ -7159,20 +7540,24 @@ trackedFiles:
pristine_git_object: 920000129046c4b50de8927f71b95f8f185a458f
src/main/java/com/gusto/embedded_api/models/components/EmployeeOnboardingDocument.java:
id: 9983c3586f18
- last_write_checksum: sha1:2072d69882ae5174d94dda4e3541caa683ccdb3b
- pristine_git_object: c035953493237e8e104afde5289994088dc23a26
+ last_write_checksum: sha1:38ad4ef1cb78544a90373f9dad0585da021419da
+ pristine_git_object: e6f4c1614e8a325b54e826c81204d3be4661549e
src/main/java/com/gusto/embedded_api/models/components/EmployeeOnboardingDocumentsConfig.java:
id: d17baf8c4687
last_write_checksum: sha1:0c520bb05ad797b0b229da2abee07f2c662b9a76
pristine_git_object: 67f49fd22fc996c8fa59039172c1a7f03fdba1d0
+ src/main/java/com/gusto/embedded_api/models/components/EmployeeOnboardingDocumentsConfigRequest.java:
+ id: 631b984b52f6
+ last_write_checksum: sha1:f06b62dd93a99ec59a180e061b369d68882eb6c4
+ pristine_git_object: 87bb6fbe5b1589de0087db07708d169d17fd1ec9
src/main/java/com/gusto/embedded_api/models/components/EmployeeOnboardingStatus.java:
id: 12f67c1b31c7
last_write_checksum: sha1:a38920c87d21aa2b9504ebd859f6857e2da08715
pristine_git_object: e7aa89cab0f20afe3fe103e30198842c58dea484
src/main/java/com/gusto/embedded_api/models/components/EmployeeOnboardingStatus1.java:
id: 472c6f5e36a6
- last_write_checksum: sha1:7b184ea69f9ae7b41f6e4529ce2c6f0e602053dc
- pristine_git_object: 9611ef08fc447d2efbee2b074c8d3541f0b3a461
+ last_write_checksum: sha1:afe6e7c4e797c0891da4d3bf3b389bcff54033a7
+ pristine_git_object: 10cd6551dadef5d7ba4bdd172729acac839fa899
src/main/java/com/gusto/embedded_api/models/components/EmployeeOnboardingStatusOnboardingStep.java:
id: 92425ca3749b
last_write_checksum: sha1:8fca30521b3132b4c95712573f838ca0295df347
@@ -7195,16 +7580,16 @@ trackedFiles:
pristine_git_object: 84a41f2c26fbe02de4d09b63140c9f345ee71f31
src/main/java/com/gusto/embedded_api/models/components/EmployeePaymentMethod.java:
id: 018e8f5325c1
- last_write_checksum: sha1:66309a8803f583bc4ee7f38959e048667f895acf
- pristine_git_object: d86fb24a9f40ed8f53498ffbcb9d45640582ba8e
+ last_write_checksum: sha1:b9e5c9078e34d2ca5eaf89b48053bc7b59d55cd0
+ pristine_git_object: f7ed3d3641b1d806442a99996be500ace16a159b
src/main/java/com/gusto/embedded_api/models/components/EmployeePaymentMethod1.java:
id: 6647c8ca8e0c
last_write_checksum: sha1:dfa5346920e5101bb3d080fac6284b21159fb397
pristine_git_object: 1589541505fc5567edaa3422f751102fa2c23d49
src/main/java/com/gusto/embedded_api/models/components/EmployeePaymentMethodSplitBy.java:
id: 616f3d721d9e
- last_write_checksum: sha1:1059d45dc351b51a392f76ff0142fbfc2c47aa8a
- pristine_git_object: d7f9ab9e3991311f08ea62b4ea3d7a187917f8f8
+ last_write_checksum: sha1:db00c154d92def03294e3f5864d0c2efd7d26a41
+ pristine_git_object: 0a783baac8c7c5565eb0408fbf18e874e9059b43
src/main/java/com/gusto/embedded_api/models/components/EmployeePaymentMethodType.java:
id: baa3ef52ecf3
last_write_checksum: sha1:1261de86688545fc06c54409206b7dc18f6833ad
@@ -7289,6 +7674,10 @@ trackedFiles:
id: 5418c4a70f89
last_write_checksum: sha1:175cd84b16fea43e59affc105fddbd65b18b7bcc
pristine_git_object: bd8f08c159f8b3745cdbd3a7216757a761e16d52
+ src/main/java/com/gusto/embedded_api/models/components/Exclusions.java:
+ id: acdfceb03a2f
+ last_write_checksum: sha1:75008187f4c610883eb89b46a6ad246b05261744
+ pristine_git_object: 8cf2dd55b9e3f016c8e0c3bd471e26c6368e3373
src/main/java/com/gusto/embedded_api/models/components/ExperienceLevel.java:
id: adfde72e2274
last_write_checksum: sha1:e5b0caa84c8b09766a68ecacc9a0c00673c047c1
@@ -7321,10 +7710,6 @@ trackedFiles:
id: 42f8eefd266f
last_write_checksum: sha1:2018e057d9f8580956b1250a2ede8df9b84c4696
pristine_git_object: e20a0e9342307674d3a37b0a718775d3d56ab3bb
- src/main/java/com/gusto/embedded_api/models/components/FastPaymentLimitRequiredBody.java:
- id: 8b0d05ed6c81
- last_write_checksum: sha1:17ce21a5c01c7148fc23d765382a37e47c5c674c
- pristine_git_object: fca4fa4671050baa3722e607244d02d6a5d32b2f
src/main/java/com/gusto/embedded_api/models/components/FederalHolidays.java:
id: f76383f768a7
last_write_checksum: sha1:dac66e59fffbbf9e4fda834ea12a8c318540887b
@@ -7387,8 +7772,8 @@ trackedFiles:
pristine_git_object: 7c74b3f71d192b4d3dd898fa99a2d379deddc111
src/main/java/com/gusto/embedded_api/models/components/GarnishmentType.java:
id: b9485879d73f
- last_write_checksum: sha1:3870fcfcde63abb67ddc24c3632c81a54e0f9d0e
- pristine_git_object: 25799789d4595b0abaf92db4cfc7512d9e828189
+ last_write_checksum: sha1:fc17f9b5219bf97c1da61d783f664814714394e2
+ pristine_git_object: b96eee2e2cc3681e3942a2bf7ae7805bb808dc80
src/main/java/com/gusto/embedded_api/models/components/GeneralLedgerReport.java:
id: 61258f424f7e
last_write_checksum: sha1:bae205323206d6a678a3d93846a34e854a1a6cac
@@ -7479,8 +7864,8 @@ trackedFiles:
pristine_git_object: 1e099d4949b05d071881d3a93a16fb4678b2d86f
src/main/java/com/gusto/embedded_api/models/components/HomeAddress.java:
id: 6e5daf14d0ca
- last_write_checksum: sha1:445d426cfa2d34ce38c0fe346479e2d982e50bf2
- pristine_git_object: 53e3c2a08621b41a0c7b4cefb1d6f8831de1edac
+ last_write_checksum: sha1:14e3d9949a7ac8695cbaf6fe6a76eb9033f723e4
+ pristine_git_object: 55d546a4edd9c5a4b07bbfb0470e882c0690581f
src/main/java/com/gusto/embedded_api/models/components/Hourly.java:
id: 96ee54b5fb50
last_write_checksum: sha1:86a7a3f35c2e4df3dcffe17b25bdce0280722ee3
@@ -7489,38 +7874,62 @@ trackedFiles:
id: 4bbbe5a6ae18
last_write_checksum: sha1:3f86c87789f73d9976a131464af11e6ff7d50965
pristine_git_object: 8d4ca9a8ea50fed8838f0ba9da9d2ca259851d5c
+ src/main/java/com/gusto/embedded_api/models/components/HoursEarned.java:
+ id: 4528b2a072da
+ last_write_checksum: sha1:223d0067af0f7c12963e8fe033fb06a439c4e239
+ pristine_git_object: e96a1ea5c1626a5cfe1798588382eb8fa567c7ef
src/main/java/com/gusto/embedded_api/models/components/I9Authorization.java:
id: 4c07a88932fd
- last_write_checksum: sha1:35b50f14d88ad7ecc627f26ae2c209154131c05c
- pristine_git_object: b854ade1d86503865cf46db1a92356ec98a3255e
+ last_write_checksum: sha1:c9892fcd7682ebbc78fba7732cf5d6ea46ad6263
+ pristine_git_object: 7ed05249463bb6ac442c0064e7de4427d2fa0936
src/main/java/com/gusto/embedded_api/models/components/I9AuthorizationDocument.java:
id: 57ae48d8326b
- last_write_checksum: sha1:7b2750d599d66a8d77c551a34e0945cc0be35bcd
- pristine_git_object: 32199f929f24282480b611939805b7a4c56ea6c5
+ last_write_checksum: sha1:597922eebd22f80483ea82cfc9f6f1c32fea4fe4
+ pristine_git_object: 404973bfe528cf7d341a54b4dfd460042160a09c
src/main/java/com/gusto/embedded_api/models/components/I9AuthorizationDocumentOption.java:
id: 9f18da2a5c7d
last_write_checksum: sha1:11f8c9682adcaa99b9361f62fbfe4bd9a3556ca2
pristine_git_object: 55ab52f6bbfc5a7443a0be4f3f150fe13ea5b416
src/main/java/com/gusto/embedded_api/models/components/I9AuthorizationDocumentType.java:
id: 2c3eaa596bec
- last_write_checksum: sha1:329747c15d6f1c29933f96bdcc9d76e5c0b3f369
- pristine_git_object: 5031cc1208a79febf1db8ab1c246436e8ba0f9d5
+ last_write_checksum: sha1:e3f2ce447bbc8e4d279dc3ceafb3132bdbf79107
+ pristine_git_object: a718d0a284817b7e8295aeef6b2ce102c0cfd051
+ src/main/java/com/gusto/embedded_api/models/components/I9AuthorizationDocumentsRequestBody.java:
+ id: d5f6138a907a
+ last_write_checksum: sha1:24bdb195c719b914427b15a9317ec696a488818a
+ pristine_git_object: a21f1d9e578857b8305a8413e9bdd6fe56febac6
+ src/main/java/com/gusto/embedded_api/models/components/I9AuthorizationEmployerSignRequestBody.java:
+ id: 957fb78a3085
+ last_write_checksum: sha1:e08406bfc46e0e58c54af39ccb5da97eb81fa03b
+ pristine_git_object: b7b5b7e864fe3399e3d3dd80eaa372618af048ef
+ src/main/java/com/gusto/embedded_api/models/components/I9AuthorizationRequestBody.java:
+ id: 28c423433a40
+ last_write_checksum: sha1:c4124c9750ce2dbeff74bcaa10f18757323fd0e9
+ pristine_git_object: 5b98118b392e1df46bfc190e708e69b321610659
+ src/main/java/com/gusto/embedded_api/models/components/I9AuthorizationRequestBodyAuthorizationStatus.java:
+ id: aeaf6c461197
+ last_write_checksum: sha1:c5df57373227a2e21605a16648f125b24d0f9b7b
+ pristine_git_object: b3c1560ad69ab68883f5a07df104b94158965c82
+ src/main/java/com/gusto/embedded_api/models/components/I9AuthorizationRequestBodyDocumentType.java:
+ id: 9a498a6d383e
+ last_write_checksum: sha1:246251e907ce14df964a3f7afd358a78507a2302
+ pristine_git_object: e1bf43192f7b0976fd9111519e2a6e21990b8fd5
src/main/java/com/gusto/embedded_api/models/components/Id.java:
id: ef30c4832083
last_write_checksum: sha1:3ffe8b10af24536401fe5ee521a519c2b76eaec9
pristine_git_object: 58df3fab69fbaaf4441170fd0ab2c56e62f6707e
src/main/java/com/gusto/embedded_api/models/components/IdentityVerificationStatus.java:
id: 33eb4bcef0ec
- last_write_checksum: sha1:dd9b6b3c1fca0201591fde20e0d72bc0e80c80fe
- pristine_git_object: 5dbc155bb5f250f6f0b551cfb1a318706c7862a7
+ last_write_checksum: sha1:50f6c317bc708127845edd7afab19be3f41d23a3
+ pristine_git_object: 056b6d142c707af293881fdaf86485e80aa0776d
src/main/java/com/gusto/embedded_api/models/components/IndependenceDay.java:
id: f6ff72d8a561
last_write_checksum: sha1:c51c5d01d175fadca1243e080dddae02bd5dfdef
pristine_git_object: 07d6aeb7aafd8ed085e70c35e785b5352ee97405
src/main/java/com/gusto/embedded_api/models/components/Industry.java:
id: e781bf887633
- last_write_checksum: sha1:4e629ae575f292028d534ce8daa795a7c9edfcd4
- pristine_git_object: b9fe127c1bb792180866ff8e32318fd5e8e6be5c
+ last_write_checksum: sha1:47120f527ab45a67c01e807982b0331c2a7e8ee7
+ pristine_git_object: 6cfd7ca66161774829bad49dc4d33cadbabc9a53
src/main/java/com/gusto/embedded_api/models/components/InformationRequest.java:
id: 7778114c7955
last_write_checksum: sha1:dd2fea7fcf7037b8d870e2ddf8ff219d8e752157
@@ -7551,8 +7960,8 @@ trackedFiles:
pristine_git_object: f37c5ccdc4b22e06d20149399bbcdfe9c42f97f6
src/main/java/com/gusto/embedded_api/models/components/Key.java:
id: b0f9b575540d
- last_write_checksum: sha1:751af45aa618963272e8bcb8dd58d5d14b2afd57
- pristine_git_object: 2a9ca8bb3581c554dfd52b61ddaa4fab1c1c80fb
+ last_write_checksum: sha1:7d40f0ed4afe4cf38c89a8576775c1f968e68f6a
+ pristine_git_object: 89cb75a9c672ece3af3360e255a4c64b44f84b8a
src/main/java/com/gusto/embedded_api/models/components/LaborDay.java:
id: 70521207595a
last_write_checksum: sha1:00e11bff749879463a41bfa32de34f31ea7f578e
@@ -7627,16 +8036,16 @@ trackedFiles:
pristine_git_object: 3a64912555dccd561d6cbe9b829e6b875dcc5297
src/main/java/com/gusto/embedded_api/models/components/OffCycleReasonType.java:
id: 29ba87943978
- last_write_checksum: sha1:3b90fef0f498c41cad8ea092b795f59ec222800d
- pristine_git_object: dd2e456af97a6e1ce560a15129228324a5cf126d
+ last_write_checksum: sha1:31126d80a5a8a05ba04434f49c34d79389b91dfe
+ pristine_git_object: 5f84409ca601735fa1e6daf137ab5d2da0028fbb
src/main/java/com/gusto/embedded_api/models/components/OnboardingDocumentsConfig.java:
id: d8d84994c045
last_write_checksum: sha1:1c37d6df870912788093e7f6fb2186b82123c29a
pristine_git_object: cda80201051682c33c52d914935fc429b4714109
src/main/java/com/gusto/embedded_api/models/components/OnboardingStatus.java:
id: 57e5d33b50db
- last_write_checksum: sha1:0dc537c9fd00175b3b594e26173ec5e468503406
- pristine_git_object: 64c7e7d0842f470afd15c0a208e91bfff3db495d
+ last_write_checksum: sha1:0f44a8c20953125256b9118211f44947fa0f6617
+ pristine_git_object: 3b1d193185131830037a44d8aa29df049b5a55c3
src/main/java/com/gusto/embedded_api/models/components/OnboardingStep.java:
id: df41abd5bc6f
last_write_checksum: sha1:00f26b6944f8e20a5bd0712ca486877b246cbd60
@@ -7665,6 +8074,10 @@ trackedFiles:
id: cf18a3ea540d
last_write_checksum: sha1:2385e6e36d491d19cc94f2ce6a677727f5963dac
pristine_git_object: c2878747e560ab2a0759403ad510dcb218900807
+ src/main/java/com/gusto/embedded_api/models/components/PaySchedule.java:
+ id: 54b38874fbcc
+ last_write_checksum: sha1:294beee2409f7ba843eadd643fd5f9c7381d30ee
+ pristine_git_object: 5ae1b964bc002389ca2adba2a489fad4a12bfdf2
src/main/java/com/gusto/embedded_api/models/components/PayScheduleAssignment.java:
id: 06c8ac314a55
last_write_checksum: sha1:77043ab48bea196fa00dc07a231b81a7a90bc008
@@ -7675,8 +8088,8 @@ trackedFiles:
pristine_git_object: 9e3ea94077f359d7a82e49b21d03668a41b3462c
src/main/java/com/gusto/embedded_api/models/components/PayScheduleAssignmentBodyType.java:
id: e38e4a5990ba
- last_write_checksum: sha1:3d667f50bf03695fed514de206d9450b0f09fe82
- pristine_git_object: 1286dd43930acbdc3a12256e48105437b0adb256
+ last_write_checksum: sha1:b54472d5f7a5ff6129b6818617f9a662b80bb572
+ pristine_git_object: f96f521fd18393f369ed2a7e2f6fa46d3a5fdbc0
src/main/java/com/gusto/embedded_api/models/components/PayScheduleAssignmentDepartment.java:
id: 9ebeaafa20ce
last_write_checksum: sha1:9ecbd250817b59c37f581e25c0826abfe1d4a854
@@ -7699,40 +8112,64 @@ trackedFiles:
pristine_git_object: bec292bfd8cef4b428d9d330fe67119829e61644
src/main/java/com/gusto/embedded_api/models/components/PayScheduleAssignmentPreviewType.java:
id: e28c61e380c3
- last_write_checksum: sha1:3fe4247f95833d4f284eaf1dd46c01d8ef42666b
- pristine_git_object: 76b1202da720cd702cbf2e693781b419d9c4df17
+ last_write_checksum: sha1:d01820948ac41e05227a71345fce01c7badb9a37
+ pristine_git_object: e14da8201a204b1be3d3e6e8c1dcfd0c78dc8859
src/main/java/com/gusto/embedded_api/models/components/PayScheduleAssignmentTransitionPayPeriod.java:
id: d0f785e95e6f
last_write_checksum: sha1:629d7598e10b4315f53ddfe6a63d84028ed5d24a
pristine_git_object: 9f59f0c5c9d0df691dd775cdbdc60bf72a68696a
- src/main/java/com/gusto/embedded_api/models/components/PayScheduleCreateUpdate.java:
- id: f46386560ae3
- last_write_checksum: sha1:2ec1d3bfd7e4f33146239a256faa98ea208c8025
- pristine_git_object: 7fc0616a94f36d259d2f46fffdd7afbfa19339db
+ src/main/java/com/gusto/embedded_api/models/components/PayScheduleAutoPayrollEnablementBlocker.java:
+ id: eb366c65b7d1
+ last_write_checksum: sha1:187c5f100da233d577584e351e12929d85350fa8
+ pristine_git_object: 5466e58b2266036615415f06d21895a1e93ee1f3
+ src/main/java/com/gusto/embedded_api/models/components/PayScheduleAutoPayrollEnablementBlockerMetadata.java:
+ id: 9bb733f57e83
+ last_write_checksum: sha1:c792c0781653d67f6d3fd8837807e0efbc9b6031
+ pristine_git_object: 2c9a46cb665f0fb8a14f1d08d26da50b5193492e
+ src/main/java/com/gusto/embedded_api/models/components/PayScheduleCreateRequest.java:
+ id: e2a2d18a795a
+ last_write_checksum: sha1:3af5278ffcdb4f03879e603b241a0c8967869af6
+ pristine_git_object: 5413f94ffd9729ed6045d3f1bbd9f23b8a1feed2
src/main/java/com/gusto/embedded_api/models/components/PayScheduleFrequency.java:
id: 40ffe3fc3591
- last_write_checksum: sha1:6373cb96ace23eece8e8c49e42e1bb241f657271
- pristine_git_object: 7cef2140232de6d05e619ea0edaad899154b2444
+ last_write_checksum: sha1:2925b657b40be9640f3a8c6a05db467f9f4b1092
+ pristine_git_object: 9b6eff32f7a8b42c265e4d12a4637fcbba70808a
src/main/java/com/gusto/embedded_api/models/components/PayScheduleFrequencyCreateUpdate.java:
id: f1b9809334c6
- last_write_checksum: sha1:752cfcf4f7baca73b351ca0d048e70d89f77e6c0
- pristine_git_object: efabb3130d8fd7adb45c784166853ff6a8081533
- src/main/java/com/gusto/embedded_api/models/components/PayScheduleList.java:
- id: 7b0fb2fe3db3
- last_write_checksum: sha1:400d6287113211d2e1e17dfa6abd8a2488b1cc50
- pristine_git_object: 208299357d26442abb0eaf744965ef513f8fb8bb
- src/main/java/com/gusto/embedded_api/models/components/PayScheduleObject.java:
- id: 475091ab8ac9
- last_write_checksum: sha1:ffaa2f8a062d6acece75873093608d3a50145c38
- pristine_git_object: 704762d087373322b95e53c18c9b7ee5d7833e7d
+ last_write_checksum: sha1:20f27635b1f5638e53fdb9bdcc1e885fc8497a20
+ pristine_git_object: e0c42f1c421f3ff7990aafb049ef2f235a99a595
+ src/main/java/com/gusto/embedded_api/models/components/PaySchedulePreview.java:
+ id: d977c34950ac
+ last_write_checksum: sha1:24723f6263aa5e39084fdc6bee895a8857510c36
+ pristine_git_object: 2357ab697b392b263c5ca99fe674455779709920
+ src/main/java/com/gusto/embedded_api/models/components/PaySchedulePreviewPayPeriod.java:
+ id: 7bddf6ba7b8b
+ last_write_checksum: sha1:366f8f2afb33594ab214edf13778a9a3f1d3acfd
+ pristine_git_object: 454c08504dddaeeeedd21ffdac61490fde310a47
src/main/java/com/gusto/embedded_api/models/components/PayScheduleType.java:
id: 1524abeb0981
- last_write_checksum: sha1:2dee08eb4c90cbb2c437dc89ca0904dabce50229
- pristine_git_object: a6ab39378fe40eefbec03a3e65a5fbf25eaf1419
+ last_write_checksum: sha1:1ba75ba8cdc0a30d4432d18e58c1b37c3d07f3a7
+ pristine_git_object: 3b3e1b5f3aa1565358fb74bdf4fb844a550af308
+ src/main/java/com/gusto/embedded_api/models/components/PayScheduleUpdateRequest.java:
+ id: c96504e9ee9c
+ last_write_checksum: sha1:3c5a590d2a15d19a1c0ab643d8f0885ddeb1c8e1
+ pristine_git_object: aef45a2672f6f4b190aade72b2d6eac13ed4fce1
src/main/java/com/gusto/embedded_api/models/components/PaymentConfigs.java:
id: f488df794a85
- last_write_checksum: sha1:3c910ad6d6b5316342706dbe46af790a9fdc1fa0
- pristine_git_object: 28688b9b2ee1443f196582b636fc0454664d4094
+ last_write_checksum: sha1:230a6c5406a021bcb730cf60c9d1d3f5b604a57a
+ pristine_git_object: 7223b881438b815968ad1d93ff54223945a03547
+ src/main/java/com/gusto/embedded_api/models/components/PaymentConfigsUpdateRequest.java:
+ id: c726f6c3737e
+ last_write_checksum: sha1:d90bab06f6cb9809ff7063cca0d9b13c70a17a19
+ pristine_git_object: 2d5bf763d53783ea450fb3d68d74e79713db6417
+ src/main/java/com/gusto/embedded_api/models/components/PaymentConfigsUpdateRequestPaymentConfigs.java:
+ id: 5c1329d30517
+ last_write_checksum: sha1:a64783e5dc29ac4cbeb0c02f4d705abd7dc03d70
+ pristine_git_object: cc78d2f1eaba7406fce5d54dc72eef7e8880d3ae
+ src/main/java/com/gusto/embedded_api/models/components/PaymentConfigsUpdateRequestPaymentSpeed.java:
+ id: 562df7f02c0d
+ last_write_checksum: sha1:5e553ec5d3dc81bdf7b6850880f4523f426a9057
+ pristine_git_object: 2e5ec3f5724a64894b23b864f0e25cd23577fe9c
src/main/java/com/gusto/embedded_api/models/components/PaymentDirection.java:
id: f20092c37c08
last_write_checksum: sha1:06c964b050e7b78a18e4d46b5ebdd7bd4fbd2999
@@ -7753,50 +8190,70 @@ trackedFiles:
id: f0d27d8425ae
last_write_checksum: sha1:915d3af175e4905796fb2134ad0e76df5056c7bb
pristine_git_object: 7ed401de601cec91a7401130c21b019a5a744ddd
- src/main/java/com/gusto/embedded_api/models/components/PaymentSpeedParam.java:
- id: cfb5a7b5cb40
- last_write_checksum: sha1:90ba13ce1c50f139cff81c12f572e917113725f7
- pristine_git_object: a2ca6b1607d55f86a9c9b42419aeffb277b90c76
- src/main/java/com/gusto/embedded_api/models/components/PaymentSpeedRequiredBody.java:
- id: 82c2a59b54f2
- last_write_checksum: sha1:e7de387d3f69e64c5eeb454d49b12d8246cb2521
- pristine_git_object: 5b5d0ce1a8d2540fdd05efceefc52b8088d3a71e
+ src/main/java/com/gusto/embedded_api/models/components/PaymentSpeed.java:
+ id: 64df9d24fe8e
+ last_write_checksum: sha1:148d1fbef6330daf7c3a9af30fd6399fd88dedcd
+ pristine_git_object: 914de05946a18353b4c5ce0eeee6146fc38ac0b8
src/main/java/com/gusto/embedded_api/models/components/PaymentStatus.java:
id: ad0499183435
last_write_checksum: sha1:03851381004f8716230249949ee703fd7b943ca2
pristine_git_object: b8c1d48e1cea1526c57ebf06fb5ee02860e27557
src/main/java/com/gusto/embedded_api/models/components/PaymentType.java:
id: 767fa0a91169
- last_write_checksum: sha1:55cee0e74533008ea87e45325659b9b18be02472
- pristine_git_object: af47b386788e88417d209b86ce59feb8924b1a8f
+ last_write_checksum: sha1:2e08f7c5bb160a7be8248994f5a9486b6d7afe18
+ pristine_git_object: c2f236e3d8d2ea2c91c8ef2384f29500585fe66e
src/main/java/com/gusto/embedded_api/models/components/PaymentUnit.java:
id: 86e01008b080
last_write_checksum: sha1:8a573d4d7e5844a5f645f4c3669ac9dbb40ad8ad
pristine_git_object: 6baee5a44556b32150176a1f48adf725e2777c49
src/main/java/com/gusto/embedded_api/models/components/Payroll.java:
id: c3457c719c74
- last_write_checksum: sha1:568cac7b8f5d76e4bb9046c4f1b33901c3422819
- pristine_git_object: 61b412d129c3bb2bccfa80a110d2f76697771425
+ last_write_checksum: sha1:855ec5b11c8e0d665f7449d5a4b883d4bd07a2b7
+ pristine_git_object: 0291f1ec13f84e64a5f85d90bcff73ad719fdab0
src/main/java/com/gusto/embedded_api/models/components/PayrollBenefits.java:
id: 7b486950d7cb
last_write_checksum: sha1:371ad0970332e00b2b3fd645c876fab883379fd1
pristine_git_object: 9b36b6248726ceecbcc9bca51e8e45c6e37bca76
src/main/java/com/gusto/embedded_api/models/components/PayrollBlocker.java:
id: b8cf44640825
- last_write_checksum: sha1:028eee0af392b3bfe04f700ef19b39f88de8e6ad
- pristine_git_object: 45e3170ed2a94c1202308054a465afa63d8b88a9
+ last_write_checksum: sha1:cf6164505e3cc2eb7b33b1f086c019c00026187b
+ pristine_git_object: c6565d2ff6f3d44225549fb5f84f8880646f01d3
+ src/main/java/com/gusto/embedded_api/models/components/PayrollCalculateAccruingTimeOffHoursRequest.java:
+ id: 512b5af4a572
+ last_write_checksum: sha1:bf736b5a663f71d29f59ad6bd345cac1e5c287a6
+ pristine_git_object: efca42e38e219168275fac6d4fc8b03f74b55596
+ src/main/java/com/gusto/embedded_api/models/components/PayrollCalculateAccruingTimeOffHoursResponse.java:
+ id: de9ebb6163b1
+ last_write_checksum: sha1:9a18199af9958a7de46be7a9b10d040fd960b8b2
+ pristine_git_object: 6928e7cba8e1711d23f0f9ac610af9cd0040dfe3
src/main/java/com/gusto/embedded_api/models/components/PayrollCheck.java:
id: 41fd47779aba
- last_write_checksum: sha1:ec9679d51659dab544992248cd432e6e62a27c0f
- pristine_git_object: ecc892162aef438b50cc3ccfb71f485ff8ee8a2d
+ last_write_checksum: sha1:6c90d02e8b44a56be345f2847ba365f17c869c37
+ pristine_git_object: c4f72af5c5a3cddfda3b35a4b0beacb1436bcfa8
src/main/java/com/gusto/embedded_api/models/components/PayrollCompanyTaxesType.java:
id: b2e43d9a36ad
last_write_checksum: sha1:96957869483412321ea88a29076b9cb33efc94cc
pristine_git_object: 09873602d61d01713f0b63e525f4e97609b2ef39
+ src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerType.java:
+ id: cd3370333c8a
+ last_write_checksum: sha1:383fc25f8c5cc25b0fd60c7a78ee562382783d80
+ pristine_git_object: dd0e65ac1b0d46b0e6be541cd4df531879f79012
+ src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerTypeStatus.java:
+ id: 48b97dd6d9d4
+ last_write_checksum: sha1:b1987e71dc3b436f79533425e1546637a8e4fcc4
+ pristine_git_object: 78e9d4a0a2ff35fe1923175a2956bf2a1000e64a
+ src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerTypeUnblockOptions.java:
+ id: 48bba51256ae
+ last_write_checksum: sha1:7a45927ae566d6f76909abdb870b6c98355803ff
+ pristine_git_object: 1c4f074fa9c39dc2e1824c9400b2bebff0725615
+ src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerTypeUnblockOptionsTypeIdResolver.java:
+ id: 5c1a0e39515d
+ last_write_checksum: sha1:08c78e60fe26b2f864f9a143e026127936e17128
+ pristine_git_object: c8d172b91c995885a347a81d47283d02528500ca
src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfi.java:
id: f56cf5c80ea7
- last_write_checksum: sha1:61644a2132c1d00b678a428715c5c3eeb1db10e5
- pristine_git_object: 44428e796a515cd7297ddaa5c097687501b78589
+ last_write_checksum: sha1:3945a3918b823b44d5ce7ef871eedd27831a4a5d
+ pristine_git_object: 64d11c27131280e0d098617890c7cf08d1a07724
src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfiMetadata.java:
id: 101639c5c03e
last_write_checksum: sha1:28711505f16435fd97537be1d271875059a65dc1
@@ -7807,64 +8264,72 @@ trackedFiles:
pristine_git_object: adf440f92562c8fa0f6f575484b14349ae51817b
src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerUnblockOptionSubmitBankScreenshot.java:
id: c9b4f4c990e5
- last_write_checksum: sha1:77f22f01dd33a97365d7cb750bf20ff85aae646c
- pristine_git_object: 45b695fa0159f429cedd3eb6fddea1ae30b8157c
+ last_write_checksum: sha1:1542f2c242dc146ff3716c9fdcb37b12cf0c5205
+ pristine_git_object: 379c1d9b74a7a7cfd17fd68db41deeb3f0c64dea
src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerUnblockOptionSubmitBankScreenshotMetadata.java:
id: e4ef6590b96b
- last_write_checksum: sha1:01e9b1de2c664aee1a130acfbba3a5cfceaf9fb9
- pristine_git_object: 09590403fc76885bc25420a711f43e33ab0c3818
+ last_write_checksum: sha1:e18dda3f78a2d028e230defbc9b6b9805d1b1c38
+ pristine_git_object: 691fb32908f28518e3f3878479685951ab2e6b2b
src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerUnblockOptionSubmitBankScreenshotUnblockType.java:
id: 8ecdf07de52e
last_write_checksum: sha1:e0293865686806367412ac2dbd08fbcb611dbe49
pristine_git_object: 0e96a6c1afa710e020ce7eec0db2ee06a5c746c8
src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerUnblockOptionSubmitWire.java:
id: bb470fcf0750
- last_write_checksum: sha1:177af04c9c6c62ed33ec7e5fb7491afe71d990d6
- pristine_git_object: ba0202519ebb2968b133b88d86cd2fee5b4c3ad2
+ last_write_checksum: sha1:e390079578c971514cff805bfd03777bd674543c
+ pristine_git_object: aa334b7f34b8b9520a82e7bb0aea17ceacd8aee6
src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerUnblockOptionSubmitWireMetadata.java:
id: 1999c6036668
last_write_checksum: sha1:2e7b6e8c4ddafe7f96ac1801c652deb1c3b1a5d5
pristine_git_object: 6265a4c4241f7d812da847188097c0c4d54e7138
src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerUnblockOptionWaitForReverseWire.java:
id: aecbed1cf904
- last_write_checksum: sha1:465cf78d34701d586e7b1c67646e5cd7b3ae7b45
- pristine_git_object: a4cc9ca3b340aefdc911ec9fb11c2e0b221bcfdc
+ last_write_checksum: sha1:fc60e2fe0f618585c81f512bda66e00866c0dc31
+ pristine_git_object: 5a24161b3cfe4d718ddb94bcfc6ab48eaed3cee0
src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerUnblockOptionWaitForReverseWireMetadata.java:
id: 9f72f2fe5c16
- last_write_checksum: sha1:71b6ebc27ca32804d2b6b7fee33d6477a246290e
- pristine_git_object: 0a70db27683d3a35ce4cfb0c99667aca3a042c0c
+ last_write_checksum: sha1:c3afcfe9716cd2f4e3a6e0ba090346339007b9d6
+ pristine_git_object: 8c4cc79979e03c80061fcdd76a94429508d6b1c6
src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockerUnblockOptionWaitForReverseWireUnblockType.java:
id: 5177db364202
last_write_checksum: sha1:21381e8a13809e684da9d2dd6c8431f4096eedf1
pristine_git_object: c142d9c4067470de15bd9ff8e2fc7e8062772d73
- src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockersType.java:
- id: 823ab2d48f1c
- last_write_checksum: sha1:32ab7d8e3dff0ae61e50dd13024c6bf024b31330
- pristine_git_object: a459e66bac662f162c21c5cafc88e3a64039e57c
- src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockersTypeStatus.java:
- id: a7a8b32e6519
- last_write_checksum: sha1:a34508cb6777ce42c6bc138b23070e63a2cce5c8
- pristine_git_object: 3235d066de190b34cd78f259f939193c94798a68
- src/main/java/com/gusto/embedded_api/models/components/PayrollCreditBlockersTypeUnblockOptions.java:
- id: c2407925acb4
- last_write_checksum: sha1:42aba0a9e19415b70e8e096b11d1f2563e993927
- pristine_git_object: b82794af9a915251104dfa617e1b4bd2ea9d0a50
src/main/java/com/gusto/embedded_api/models/components/PayrollEmployeeCompensationsType.java:
id: eba9ef69a011
- last_write_checksum: sha1:059232deb70ad9b46e2d5d5b3b6a0c271743e866
- pristine_git_object: fe8d9738a9632eda5bffe2d0f4da4bd5d3d744a5
+ last_write_checksum: sha1:0a0620ddb27ce4b858b48c6312fd8789063e8a78
+ pristine_git_object: b47c6816b8d0a0785cdf65c7a9772aec7dbb7609
+ src/main/java/com/gusto/embedded_api/models/components/PayrollEmployeeCompensationsTypeFixedCompensations.java:
+ id: 4c947e99298f
+ last_write_checksum: sha1:faa0976c64fc1b17379f5ce5d1d130f0c1443601
+ pristine_git_object: d634354f0d30aae4c5839e82524c0c019be2f6c9
+ src/main/java/com/gusto/embedded_api/models/components/PayrollEmployeeCompensationsTypeHourlyCompensations.java:
+ id: 76edc4281c83
+ last_write_checksum: sha1:f383c321ff15dc5915b9eeca301f5844578239a9
+ pristine_git_object: 24b878e2adb74abe310cedf57ce27f23d871e3ee
src/main/java/com/gusto/embedded_api/models/components/PayrollEmployeeCompensationsTypePaidTimeOff.java:
id: fc2b471de294
- last_write_checksum: sha1:5a893a78bbb4387a529deef69e29627fa3d18739
- pristine_git_object: e1a3e5ea3de95d080b0c446ece635a939dd74e05
+ last_write_checksum: sha1:3d5efe823a6644a40953e216111cfc017a6c739e
+ pristine_git_object: 8f22d8ceb77274a8f78ad67075f6755c0f0d3a70
src/main/java/com/gusto/embedded_api/models/components/PayrollEmployeeCompensationsTypePaymentMethod.java:
id: 0fae62fb9607
last_write_checksum: sha1:7a969a7ad590897c4f991088de7853aabc1524b8
pristine_git_object: 23d418380dccff6c04f187228ae744f0ff73dbd3
+ src/main/java/com/gusto/embedded_api/models/components/PayrollEmployeeCompensationsTypeReimbursements.java:
+ id: 054fb0b450c1
+ last_write_checksum: sha1:4ce184365f0979625a79af45a7f56148e012f276
+ pristine_git_object: 5e4bd7c34e4e7f1e3ff3ca96cf161eb47226a9cd
src/main/java/com/gusto/embedded_api/models/components/PayrollFixedCompensationTypesType.java:
id: 5bace57a720a
last_write_checksum: sha1:f8ddb39dd715b5aa9f94b9a46ea263f2a8121817
pristine_git_object: 8a2919b0f4059ef8af3baec4b86896b3eb2436e0
+ src/main/java/com/gusto/embedded_api/models/components/PayrollGrossUpRequest.java:
+ id: 712f3a33483b
+ last_write_checksum: sha1:9623bca05deb25a737ac601a460490aad0d8655c
+ pristine_git_object: 2fd12dd8290c8c88a326e959088d551b1f89c3cb
+ src/main/java/com/gusto/embedded_api/models/components/PayrollGrossUpResponse.java:
+ id: 1dc73a73cde3
+ last_write_checksum: sha1:aa0721c299c6463e8e6e8eb1ad3394857eb53b1c
+ pristine_git_object: 7213e59ef3d03d33e095100bb753e121c74881b9
src/main/java/com/gusto/embedded_api/models/components/PayrollPartnerDisbursements.java:
id: 0df211b8c191
last_write_checksum: sha1:14abbc9df3c1444f2aae9bf86570b58a026b27d6
@@ -7893,14 +8358,10 @@ trackedFiles:
id: 7fc4ae546a8a
last_write_checksum: sha1:de69625abc5edd4956f24249058289b01c373fc2
pristine_git_object: 15198bb6687ebe16037b482152f0e19b1ffaa683
- src/main/java/com/gusto/embedded_api/models/components/PayrollPrepareSortBy.java:
- id: df3a0e1b870e
- last_write_checksum: sha1:f2ab3c120e5397febd3ef8815426c89c48daab3b
- pristine_git_object: bcb4cf977a293f4f8b25907dfa3675513b97fe9b
src/main/java/com/gusto/embedded_api/models/components/PayrollPrepared.java:
id: 4c67966a1163
- last_write_checksum: sha1:6fe4f72d690fe20961d110be059d6fb468ec853e
- pristine_git_object: 3cfe6631b4963271b306cf6b617fb2e80f18fe6a
+ last_write_checksum: sha1:d6f1158421621be947801fe444e58d3656b5669f
+ pristine_git_object: 95c2810586e76180c4a7c5261e151ed143dd8b4c
src/main/java/com/gusto/embedded_api/models/components/PayrollProcessingRequest.java:
id: 8679490be76b
last_write_checksum: sha1:7e464a9402fe468ed086d8a86a417df36908e585
@@ -7927,20 +8388,20 @@ trackedFiles:
pristine_git_object: 3c7f3b630011ed9e8cf887bb3f81e422ea5a74c0
src/main/java/com/gusto/embedded_api/models/components/PayrollShow.java:
id: 4adbbbc9b02d
- last_write_checksum: sha1:f990191e9894070ac0a40a5af72cabdcf80995b8
- pristine_git_object: 3f0942652c1bf773fd856a50ace813cc17ba403e
+ last_write_checksum: sha1:ab3114b57ba669666984aa1fe6e2ebab860db150
+ pristine_git_object: 60a53e9f74e11b8bfa0cb3bb32bd777adee28bea
src/main/java/com/gusto/embedded_api/models/components/PayrollShowAmountType.java:
id: 8d9a52d1f24e
- last_write_checksum: sha1:0a9add50f0b4c912b74cdc245bb579dd2711baa5
- pristine_git_object: 57b5f7a5d0327ee45dc4bef79d1e3a1717cee89c
+ last_write_checksum: sha1:44b4309bde0247691e7a20efddb3b3772e71c737
+ pristine_git_object: f8eaa959223e219c8dfc7be1a226444fca9044f7
src/main/java/com/gusto/embedded_api/models/components/PayrollShowBenefits.java:
id: 52de4b4fc366
last_write_checksum: sha1:6bdf18be7b79279c40a7d11719364cdc82447db3
pristine_git_object: 1b5ac03a012c37a94c6de725a8f4b3106f891997
src/main/java/com/gusto/embedded_api/models/components/PayrollShowDeductions.java:
id: f360d6bd81c4
- last_write_checksum: sha1:dd119c2032d25f749854fe5a2d25f68de2066e27
- pristine_git_object: 3401cf8992862e4e5fe614ec0f42d550378657cf
+ last_write_checksum: sha1:36a982d9617bb6c6d2c0498035fe48d3d6074549
+ pristine_git_object: 68b45edbc3e4e9bbd94a19b031c35c8317c759ef
src/main/java/com/gusto/embedded_api/models/components/PayrollShowFixedCompensations.java:
id: 96f24c301fc8
last_write_checksum: sha1:c88303b90acf1e6a4948bb04e4f12c4052c52da2
@@ -7951,8 +8412,8 @@ trackedFiles:
pristine_git_object: 215f5c973c9133ef7c541a7682e9fa1418d3c166
src/main/java/com/gusto/embedded_api/models/components/PayrollShowPaidTimeOff.java:
id: 555aefe4dc37
- last_write_checksum: sha1:48f5a2fd064e663799a7d3d7eb81d4d4b89f7f80
- pristine_git_object: fb5de7181bb02d3d3e7b4df1223d816ee161922a
+ last_write_checksum: sha1:e15cc575f900f193aa38571397dc5e4cd344a713
+ pristine_git_object: 5de2da7edef6016a854b69f656beeac0d07caeb2
src/main/java/com/gusto/embedded_api/models/components/PayrollShowPaymentMethod.java:
id: a0e5393d50f6
last_write_checksum: sha1:d3633da9c81570228d90ae9e226b2a22d88169d7
@@ -7965,14 +8426,18 @@ trackedFiles:
id: dda676e1d8ed
last_write_checksum: sha1:3b2aac675bafa3e637bf22b2dfaed671e639a3cb
pristine_git_object: 374c8c93b840710f9fac56286731a98ec63fd4a9
- src/main/java/com/gusto/embedded_api/models/components/PayrollSubmissionBlockersType.java:
- id: dde400c0a7c0
- last_write_checksum: sha1:f7f9c220080a966e12a1628c4aa4ed94c5ec1b32
- pristine_git_object: a7495f2e07f0190a32c74641f72eb90d7a99f967
- src/main/java/com/gusto/embedded_api/models/components/PayrollSubmissionBlockersTypeStatus.java:
- id: 7c4995cf2ba4
- last_write_checksum: sha1:595615108408ae8d8da73aeee8e14cafb203073d
- pristine_git_object: dbf772df4c15e5c77900c4a846c329cebcbcbca0
+ src/main/java/com/gusto/embedded_api/models/components/PayrollSubmissionBlockerRequestType.java:
+ id: b99eb48a78e6
+ last_write_checksum: sha1:fb682155361307465855053ceac10ac35c4150d8
+ pristine_git_object: 9ac884b4c6959bc76ed30122ba64fd1874a4ceb0
+ src/main/java/com/gusto/embedded_api/models/components/PayrollSubmissionBlockerType.java:
+ id: b94dc4132c5f
+ last_write_checksum: sha1:38258bad49dc9a3e5070489e98039d2af155cd85
+ pristine_git_object: b32012d1bba5c831af251c0c65d7f277d13620a1
+ src/main/java/com/gusto/embedded_api/models/components/PayrollSubmissionBlockerTypeStatus.java:
+ id: 1835c2d20db5
+ last_write_checksum: sha1:dbb467991dcb728e3301b04076b71caa4bcc3e32
+ pristine_git_object: 3738481808c3b50a4608c7200d836dffaf0de94c
src/main/java/com/gusto/embedded_api/models/components/PayrollTaxesType.java:
id: c03195209f03
last_write_checksum: sha1:652f254d8ba71638fe62c5811be276703cca573c
@@ -7985,6 +8450,22 @@ trackedFiles:
id: fba6e4655457
last_write_checksum: sha1:d8e1c4f7200caf22dd48b8e2962dc37dc4c3bda9
pristine_git_object: 733cb09837467e1e08b7d9612bb7d41de9f98db6
+ src/main/java/com/gusto/embedded_api/models/components/PayrollUnprocessed.java:
+ id: 388912b49c28
+ last_write_checksum: sha1:9f553829d15c997398e8751bba493552f5a2a1c1
+ pristine_git_object: 38a3a69fb87f5ccf2034a4b1c81c0d6473d1e24e
+ src/main/java/com/gusto/embedded_api/models/components/PayrollUnprocessedEmployeeCompensationsType.java:
+ id: 20c01a83cb9d
+ last_write_checksum: sha1:a5faafb3cae2460c1a02c015257c5a32aa55e586
+ pristine_git_object: c1b6880b87292d203d5c8a16727a62b0ae85b972
+ src/main/java/com/gusto/embedded_api/models/components/PayrollUnprocessedEmployeeCompensationsTypePaidTimeOff.java:
+ id: aa83f239f748
+ last_write_checksum: sha1:440fe5c5b6ad086045dfed077976e030956dbbf8
+ pristine_git_object: 642007c57f1aae617664ff26076433691e0dc302
+ src/main/java/com/gusto/embedded_api/models/components/PayrollUnprocessedEmployeeCompensationsTypePaymentMethod.java:
+ id: 24b46d678c94
+ last_write_checksum: sha1:ca899e10742d83e6a820dfaa6417f8a25e22f00d
+ pristine_git_object: 97aa7b6bae85a6a194e1e0468da6e3a7ae003055
src/main/java/com/gusto/embedded_api/models/components/PayrollUpdate.java:
id: 8acf87503910
last_write_checksum: sha1:6a0e43960d98de1e7f0e5b73231cd81b407d5627
@@ -8011,8 +8492,8 @@ trackedFiles:
pristine_git_object: 631c437f2d3cbf0171e7cad672ee090c957c578c
src/main/java/com/gusto/embedded_api/models/components/PayrollUpdatePaidTimeOff.java:
id: 3153a8a04855
- last_write_checksum: sha1:69cb8a3d8e29efdf3f5e9403287ed69e07a7eb49
- pristine_git_object: 0b3edb5276e5962957caefc37e664b1ffcdfca2b
+ last_write_checksum: sha1:0fc399622e14b6e8fa1f6d0b782620ea01941fed
+ pristine_git_object: 5af92940337e9008de4a0f8e5a22bada673a9897
src/main/java/com/gusto/embedded_api/models/components/PayrollUpdatePaymentMethod.java:
id: 15349e112f9c
last_write_checksum: sha1:5b2c9338df74942587b7166fa3ccec0e1d26a40d
@@ -8025,10 +8506,38 @@ trackedFiles:
id: "944261242561"
last_write_checksum: sha1:442a6bb165b91a953d2d242dd880575348d1b955
pristine_git_object: cb8fc63c2d774789b15d978af947ba702f06228b
+ src/main/java/com/gusto/embedded_api/models/components/PeopleBatch.java:
+ id: 54e10884afd9
+ last_write_checksum: sha1:39d813e108348393e8353624db15f6cb92328acf
+ pristine_git_object: 62ba6def1d203a4da8fac03faa8d54bf383881a7
+ src/main/java/com/gusto/embedded_api/models/components/PeopleBatchResults.java:
+ id: 7023333b1112
+ last_write_checksum: sha1:a936006f4d2e21c0ab85bbbc794166b5085b6bd5
+ pristine_git_object: 90bec4fec85e67afbdf404921f58001f77da5269
+ src/main/java/com/gusto/embedded_api/models/components/PeopleBatchResultsErrors.java:
+ id: 490617cfe546
+ last_write_checksum: sha1:7d510fe46ec071f3475400d6d30e81cea3d0ef25
+ pristine_git_object: f2b13bbf818072b8991ec8341b11951488faff05
+ src/main/java/com/gusto/embedded_api/models/components/PeopleBatchResultsResultsErrors.java:
+ id: 87f2df02d8e8
+ last_write_checksum: sha1:70a0682c2f95be8e43f4c18ee6763388f9269944
+ pristine_git_object: 156f14d7c54d23e53bfbc3f9baf4b1f536e66256
+ src/main/java/com/gusto/embedded_api/models/components/PeopleBatchResultsResultsStatus.java:
+ id: 4abe48720afa
+ last_write_checksum: sha1:a884b58624f1d55faff01e1613b111adc30e3c08
+ pristine_git_object: a0c2943a2121093a5c68a90e7c8371157a914e9b
+ src/main/java/com/gusto/embedded_api/models/components/PeopleBatchResultsStatus.java:
+ id: bc9582b7fe0e
+ last_write_checksum: sha1:d18b7d7013cc58db4c171a74d2587fd2c83b8892
+ pristine_git_object: 69126b2b3fe96693d989f8cd6909d24f8e94dc25
+ src/main/java/com/gusto/embedded_api/models/components/PeopleBatchStatus.java:
+ id: 50f4c0e0d94d
+ last_write_checksum: sha1:3a056e6cea07c2ab295ef4bbf182551749494e54
+ pristine_git_object: 60b37575c03b2e2d1f1931eb668975cd9660c717
src/main/java/com/gusto/embedded_api/models/components/PlaidStatus.java:
id: b4c197d4a9e2
- last_write_checksum: sha1:b2c713a243a5181f14884774f4b93aecedf6e716
- pristine_git_object: 7d716571061b216e8fa5cf61e99d1ed417656dd2
+ last_write_checksum: sha1:60a77f15956e408a89a2f6439de5507dc1b6392c
+ pristine_git_object: b54d6e8e0a8d17e62988ebedb8b4034c6b789bd2
src/main/java/com/gusto/embedded_api/models/components/PolicyType.java:
id: 4ea436c2ad47
last_write_checksum: sha1:90b4bffab3716189206620e632e98dfe5b2add53
@@ -8071,12 +8580,16 @@ trackedFiles:
pristine_git_object: cba888ab69ef152be3e71da03d6d841a44992623
src/main/java/com/gusto/embedded_api/models/components/RecoveryCase.java:
id: 498c762dba77
- last_write_checksum: sha1:fae4b13d00e6d8c9a27e3a90e922de41a826d7d4
- pristine_git_object: 10fddf37e0ddf9f3b38871808fd91f0df055b4e4
+ last_write_checksum: sha1:eb0167ca86ebc737ff3b0e67a95d944d741efbbd
+ pristine_git_object: 34ea782c9dbf03e8fbfd0fb2eb1ceae0c34ce46d
src/main/java/com/gusto/embedded_api/models/components/RecoveryCaseStatus.java:
id: 154e66b424f4
last_write_checksum: sha1:90bdef50ecb54f863840b8b84331da3bc52296a9
pristine_git_object: 5aa2b72da4aa6d669aac4614cd567d31d84faa2f
+ src/main/java/com/gusto/embedded_api/models/components/RecurringReimbursement.java:
+ id: 42635cc76c3a
+ last_write_checksum: sha1:0a90395a211f69bad5e6639535e3b050c6f21d89
+ pristine_git_object: 9aed60e5dfa717e47aa0dcf944238a2ac533848b
src/main/java/com/gusto/embedded_api/models/components/RefreshTokenAuthentication.java:
id: 0d35d1d1e8de
last_write_checksum: sha1:424d1472bf209916427ae56d06b1c407fb6c9c3f
@@ -8107,8 +8620,8 @@ trackedFiles:
pristine_git_object: bd7750d4ecf175aee2f86f9666acfb981b99b8c4
src/main/java/com/gusto/embedded_api/models/components/RequiredAttributes.java:
id: ea7603558c69
- last_write_checksum: sha1:ab257c88027f88d769a59db5b35b1f905499c1dd
- pristine_git_object: 3ceaaae8c4050f54ebc247cf29bda4a99e392110
+ last_write_checksum: sha1:fb38a561727add646e909d248f299876a11975cb
+ pristine_git_object: 8c888fbc35f5534cae1a198e4252982e97b93ba0
src/main/java/com/gusto/embedded_api/models/components/RequiredQuestions.java:
id: 7e7cf734bb33
last_write_checksum: sha1:dbaa8eb36152316171187c67c1b788e93e8356cc
@@ -8117,6 +8630,14 @@ trackedFiles:
id: 9ce3af2571a6
last_write_checksum: sha1:73c7924486973c763c2d4bbca405a25875b66491
pristine_git_object: a3ff719dbdf8e140a2149552bde35b002b91acfd
+ src/main/java/com/gusto/embedded_api/models/components/Resource.java:
+ id: 028b7f5722ae
+ last_write_checksum: sha1:e3559abe434dda9f8452190c110de248d6dce200
+ pristine_git_object: a2ed1a97655843f0f8243266b18cccc54f6da3d3
+ src/main/java/com/gusto/embedded_api/models/components/ResourceOwner.java:
+ id: 085b1ae7170a
+ last_write_checksum: sha1:078d7b160935a41db517b34667d7b05ca9d9cd02
+ pristine_git_object: 5f4bb5191708d311c3408ae28aea38e89f22eb22
src/main/java/com/gusto/embedded_api/models/components/ResourceType.java:
id: 77e6bcf55703
last_write_checksum: sha1:25ae91b7d90c87efc7136418c6f673be17b251a4
@@ -8127,8 +8648,16 @@ trackedFiles:
pristine_git_object: 2bebcc5045a530e95dc81b6af1386e0c3825a3e5
src/main/java/com/gusto/embedded_api/models/components/ResponseType.java:
id: a7a0deb70075
- last_write_checksum: sha1:d4efd2905df7fe0cd28e189f2abd211beda5747c
- pristine_git_object: cc23fd0ebeb6a81949f05e4294cd0cd3ef946850
+ last_write_checksum: sha1:7d19af5f401d23b4e71edb1ebb1512bf343e0f89
+ pristine_git_object: 5aa06335f986c792b4f2f4bb555206ddbf9de9ee
+ src/main/java/com/gusto/embedded_api/models/components/Results.java:
+ id: e02768787cf8
+ last_write_checksum: sha1:a22ebb04d538f9e2ef3d6886107c8d3c17fedccc
+ pristine_git_object: 2ceaac9617be57b82f8c28f97313ffa18804e3f7
+ src/main/java/com/gusto/embedded_api/models/components/Role.java:
+ id: 2a8ffb95f8ac
+ last_write_checksum: sha1:9f3ea4c7421b869942c0aebdf4a775d0b52d65ea
+ pristine_git_object: d826dbb3702c1bbcd447ebbed98a70dca9d1fb41
src/main/java/com/gusto/embedded_api/models/components/SalaryEstimate.java:
id: 539931d75821
last_write_checksum: sha1:2f7135b1d7bbf6b2c45f1d08823cd8ab9329f38c
@@ -8155,20 +8684,40 @@ trackedFiles:
pristine_git_object: d04790a75e3825b444e86f9071d6bf87d9b0348c
src/main/java/com/gusto/embedded_api/models/components/Signatory.java:
id: 9c5f62a93462
- last_write_checksum: sha1:8a74e028fb79db7422f7d21df08aab4ce208eb3d
- pristine_git_object: c02cf6bad5e6f016045fa0f5b1d2815abd40209d
- src/main/java/com/gusto/embedded_api/models/components/SortOrder.java:
- id: 291a73b7ac6c
- last_write_checksum: sha1:c3300e275955571fc51c9854e00653b178c145e5
- pristine_git_object: c4ce031ff5df36c923d4a7b93befe753d36b67b5
+ last_write_checksum: sha1:960a9e8f3a935d7dbaaaf39bdd5109b3cfe8f767
+ pristine_git_object: f2d651ff12a364cd46b8ddbef28d12acfdea8db1
+ src/main/java/com/gusto/embedded_api/models/components/SignatoryCreateRequest.java:
+ id: 2c8f50d9e756
+ last_write_checksum: sha1:c456f13d1b0c7cb65c92ae1e502bbb76080d5af0
+ pristine_git_object: 33f79e5f0ed2ef9fe50c13502f56781aa7205b29
+ src/main/java/com/gusto/embedded_api/models/components/SignatoryHomeAddress.java:
+ id: ab5d743d4718
+ last_write_checksum: sha1:a1225441c3d78e3d5b09644b23f36bdb9692309d
+ pristine_git_object: 90e12e205565d70e341c27a1df0ea33676abfc18
+ src/main/java/com/gusto/embedded_api/models/components/SignatoryInviteRequest.java:
+ id: 43b90b296a78
+ last_write_checksum: sha1:8d600374e9ad679d8a614d169336b99238f01d6e
+ pristine_git_object: 2920f71cfbd103171ee7440e2dc1d8b0431e5771
+ src/main/java/com/gusto/embedded_api/models/components/SignatoryInviteRequestHomeAddress.java:
+ id: 05ebbbff66f6
+ last_write_checksum: sha1:8ea813167faeaf821fd575400f78186f1a8001e9
+ pristine_git_object: d98d42436070dcc9d196b0029a6222121f3ef060
+ src/main/java/com/gusto/embedded_api/models/components/SignatoryUpdateRequest.java:
+ id: fcc5690e5499
+ last_write_checksum: sha1:4ec815cbcc164b626e4e19ca5d77b96213151041
+ pristine_git_object: d01e12bfa1df6d8cc42096d2ec6e27a9f2e7e7db
+ src/main/java/com/gusto/embedded_api/models/components/SignatoryUpdateRequestHomeAddress.java:
+ id: ef8ddbdb8df3
+ last_write_checksum: sha1:f4014c93b017277d76319e7de7924490b0e214d5
+ pristine_git_object: 035c0ccdd1bc92912fe63bf7b2e3fa92640b9753
src/main/java/com/gusto/embedded_api/models/components/Source.java:
id: 3f900c54e2ea
last_write_checksum: sha1:c17e1864e9bf94721b874d6255104ce86ea41911
pristine_git_object: d0f9f2d8c4ac23feba35850e615b856086a7128b
src/main/java/com/gusto/embedded_api/models/components/SplitBy.java:
id: 7b66a8708974
- last_write_checksum: sha1:491720e5abc1e6e222e2e725e1286b4a6ecf3b32
- pristine_git_object: 3f26e0145ae2d9d4fd5ab6e38e35271e87d2ad4a
+ last_write_checksum: sha1:52f517d9240bdc145bcf7e26db02e9d0bc626108
+ pristine_git_object: 6872f25daec4d4635d5424a78c42e0adb41259a4
src/main/java/com/gusto/embedded_api/models/components/Splits.java:
id: 6455cb8ec4e7
last_write_checksum: sha1:e21beb1f51f4f29fc9e76929ce08d8cb59958431
@@ -8183,16 +8732,16 @@ trackedFiles:
pristine_git_object: 68a360ee21a416211a2c158ccfbc735f78f45d2e
src/main/java/com/gusto/embedded_api/models/components/SubscriptionTypes.java:
id: a67ee4858962
- last_write_checksum: sha1:29f0db464c6946df7f142d4e04dc96cb477b95f7
- pristine_git_object: a63ff4d85a46999893a843603803443b24c41202
+ last_write_checksum: sha1:77f4741c8890434890887f216e2ccd132b3c28ed
+ pristine_git_object: 5933348a13ca4452f3f887467b9d58c138e7c408
src/main/java/com/gusto/embedded_api/models/components/SupportedBenefit.java:
id: d3ed9401093a
last_write_checksum: sha1:47883555d04ef35e7c54585230fb7d0b55433b34
pristine_git_object: 4b9f79c213a9d1965a95420e03ffa91f359c9a0c
src/main/java/com/gusto/embedded_api/models/components/TaxLiabilitiesSelections.java:
id: d739085d157a
- last_write_checksum: sha1:8e6947e2b0450a023e7757066dc806a7994f33ce
- pristine_git_object: cbe803caa0d4e104a457c40b9e743b6b308b464d
+ last_write_checksum: sha1:e5078bfdd7bb548fe26a7d03e7ddde6aabd04edc
+ pristine_git_object: ded8cc6896b62e670ba55e39c0de4560888932e9
src/main/java/com/gusto/embedded_api/models/components/TaxRefunds.java:
id: e557be588eb6
last_write_checksum: sha1:32fda9fd656a3fe0a2ed21a717838ada3fbea52b
@@ -8285,6 +8834,14 @@ trackedFiles:
id: c95f44ed06c0
last_write_checksum: sha1:c6cf10337528a23b8c6cd5017129c731a209d3a2
pristine_git_object: dc6f3fb1e9bf2c7673ca67817620bf02f82e2ce2
+ src/main/java/com/gusto/embedded_api/models/components/TokenInfo.java:
+ id: 40fe07317ea6
+ last_write_checksum: sha1:389ca816e9120f8fbc94b0f944d330340d8f2549
+ pristine_git_object: ad49670d760f150f5e96752d2aa64cd8b2df3a94
+ src/main/java/com/gusto/embedded_api/models/components/TokenInfoType.java:
+ id: d23a3458a344
+ last_write_checksum: sha1:d54817e9584196e9a8ea29760b8442a37d63b614
+ pristine_git_object: 3362e14e1df331239ab443594bbb65afb29233c0
src/main/java/com/gusto/embedded_api/models/components/Total.java:
id: 7d1591abdd5f
last_write_checksum: sha1:ce6953a199653c4549c1bc5e676f5c5b7877f693
@@ -8299,8 +8856,8 @@ trackedFiles:
pristine_git_object: e43232d9625ee5260f6b00f9df52a7d0e1d457a6
src/main/java/com/gusto/embedded_api/models/components/Type.java:
id: 2d4599e04c45
- last_write_checksum: sha1:12c9e156667b9b73e735a47237b2c8a13f33a259
- pristine_git_object: d5a1dbe030261000aaa545003ed00043f950839b
+ last_write_checksum: sha1:8c8753cfe49078a6e77074e014bf11a845162725
+ pristine_git_object: ebca79b0744bbe65275be42f66e147cc8d1a68b2
src/main/java/com/gusto/embedded_api/models/components/UnblockOptions.java:
id: 1f22ef9e44bd
last_write_checksum: sha1:231ad3c96a4a79a9f2b1284e90dcbfdb1bf51f7e
@@ -8309,10 +8866,26 @@ trackedFiles:
id: 68f461d23f63
last_write_checksum: sha1:d5063aca09ce8dcd189c459601c2b6ec44be9e06
pristine_git_object: 59ac8b30235c7ca971104861ee431d9853758869
+ src/main/java/com/gusto/embedded_api/models/components/UnknownEmployeeFederalTax.java:
+ id: 6ac40a1d2ab7
+ last_write_checksum: sha1:e70ba2b3d5dee09e09dfc17b30abd834a585bd9a
+ pristine_git_object: 630fd647d78f40f5e6efe6f7430979be3cf9608b
+ src/main/java/com/gusto/embedded_api/models/components/UnknownPayrollCreditBlockerTypeUnblockOptions.java:
+ id: fdb264ba0d6f
+ last_write_checksum: sha1:88f3db27d306c122ec5e93669b55e78c6d283dc0
+ pristine_git_object: cfb38b062ee6ce65fe58e538da9a2b27effe0b22
+ src/main/java/com/gusto/embedded_api/models/components/UnprocessedPayroll.java:
+ id: 5af5209311cf
+ last_write_checksum: sha1:4f6c8fe4eeb69ab7badb03e6de2365bab8c983d6
+ pristine_git_object: cdd1538f4ae3da57b39c40c2e0bfef46d2689dde
src/main/java/com/gusto/embedded_api/models/components/UnprocessedTerminationPayPeriod.java:
id: e29c6240e435
last_write_checksum: sha1:d878c3a4814b25d68c6721b96d1097f9a5836735
pristine_git_object: 92f3c5d64e92308fed8ba065ddaac5b0c95db140
+ src/main/java/com/gusto/embedded_api/models/components/UpcomingEmployment.java:
+ id: fe87f89e924c
+ last_write_checksum: sha1:de8e580295104c389bdacb5c98566c38ab86bb8c
+ pristine_git_object: 362698f7e9776f55aa324bdd15eb0af987665d62
src/main/java/com/gusto/embedded_api/models/components/Validation.java:
id: 866fb4d35e7b
last_write_checksum: sha1:5b911139fefbe6f90ae53728adeb5ef283eda885
@@ -8351,8 +8924,8 @@ trackedFiles:
pristine_git_object: 5ee9b7fe03885f674dd3fff7b2cd57e3d50741c4
src/main/java/com/gusto/embedded_api/models/components/WageType.java:
id: 615d3750c7ea
- last_write_checksum: sha1:a7e7047919a8f885a2d5557d34a7934b97e5af26
- pristine_git_object: e3bf0743190bf32f44377370bc08ea256cb241b7
+ last_write_checksum: sha1:8d4001c4366c2efa72d2f72702fe72e5178ae5f3
+ pristine_git_object: 70f8059e4c2bb1536adaae05e4ee58d9c2eb6741
src/main/java/com/gusto/embedded_api/models/components/WebhookSubscription.java:
id: ecd568300371
last_write_checksum: sha1:80c32b5c717a86a3cefaaef5a7408aa892cc0618
@@ -8413,22 +8986,14 @@ trackedFiles:
id: 633e33e9c899
last_write_checksum: sha1:3bbf27a6725f00321a2e513e56b66689040d93e8
pristine_git_object: 6b0fc99563a3f5789286463b5f9bfd86eb742e22
- src/main/java/com/gusto/embedded_api/models/errors/DeleteV1CompanyBenefitsCompanyBenefitIdResponseBody.java:
- id: aea26b493f49
- last_write_checksum: sha1:c0e17decdb4dc69a69ee294403397363819e00dc
- pristine_git_object: 3e27419b06f88665c71f1ff3584e3690a0322ce2
src/main/java/com/gusto/embedded_api/models/errors/Errors.java:
id: 234d3d9faf06
- last_write_checksum: sha1:776d07809536d3b0edaa40fcd95d81c955a7ab2e
- pristine_git_object: 87c6a43304e45bac0731921817477f004271a5ae
- src/main/java/com/gusto/embedded_api/models/errors/GetCompaniesCompanyUuidContractorPaymentsPreviewBase.java:
- id: 4abfee3579f6
- last_write_checksum: sha1:57ae2ecbdeaa243733bfa69531bdb99f4943f3c1
- pristine_git_object: b127834c4926df941abaafdfc1a5f7268d3abcdd
+ last_write_checksum: sha1:9e72c4f56e7748a870f4c8b2036e1ae3320ea254
+ pristine_git_object: f3210a1f0c8aa67d803dc86c7dd321577075ee4d
src/main/java/com/gusto/embedded_api/models/errors/GetCompaniesCompanyUuidContractorPaymentsPreviewErrors.java:
id: 9ef74fb2b5cb
- last_write_checksum: sha1:8f5da10b942cd74e1687c5948cfab5a28f39239e
- pristine_git_object: ff3b459da0042422dd808a266dd1f40fc893cf33
+ last_write_checksum: sha1:1ef39d87c7a4b20074966c46d5c7a1edc7fa83e4
+ pristine_git_object: 842d5cab2af0070f7c283b70e41e721f557a4c41
src/main/java/com/gusto/embedded_api/models/errors/GetCompaniesCompanyUuidContractorPaymentsPreviewResponseBody.java:
id: 643af0320dc8
last_write_checksum: sha1:fa3f623d9e5e3e4d267282b3b32b0debe79a6f57
@@ -8439,20 +9004,20 @@ trackedFiles:
pristine_git_object: c211a391820935b64061115c8ba2a68b4681076d
src/main/java/com/gusto/embedded_api/models/errors/Metadata.java:
id: 6ea111b63e71
- last_write_checksum: sha1:bb8a7218deb9aa89f98e7ada30bd567e57381099
- pristine_git_object: d09c8100f926800b37bc155cb135833d0adc0c0c
+ last_write_checksum: sha1:e169e2ff8929eb9be7497678c8bb7bc5cb4c38d4
+ pristine_git_object: b5934df6a0174e052b8a276741a10ee2308c29e2
src/main/java/com/gusto/embedded_api/models/errors/NotFoundErrorObject.java:
id: 25d507ae9e37
- last_write_checksum: sha1:97c93467173bcc30c13852c32f0952d326c6ebdf
- pristine_git_object: 813be733586e6253646f9e2972da014d134e7f09
- src/main/java/com/gusto/embedded_api/models/errors/PostV1CompaniesCompanyIdPeopleBatchesErrors.java:
- id: 8458bc37e24d
- last_write_checksum: sha1:7bf339bf31e11c7595345b4bfdb6063ce18aa139
- pristine_git_object: b5ecbe6b55545567dc51261459366ed129876377
- src/main/java/com/gusto/embedded_api/models/errors/PostV1CompaniesCompanyIdPeopleBatchesResponseBody.java:
- id: de588c60188b
- last_write_checksum: sha1:d32c05a9cf413b9997cad439310d8f28c9052c7c
- pristine_git_object: 23d3314a8c28a5f7f361f4538030f016c9879a8c
+ last_write_checksum: sha1:33db5153a95c1d5c0127f837a4b03103d4acbf52
+ pristine_git_object: 51b2f4b84d495a83d51d67e3d6df0014c6cf03d8
+ src/main/java/com/gusto/embedded_api/models/errors/PeopleBatchConflictError.java:
+ id: 584b11b5eede
+ last_write_checksum: sha1:78bb26dbc90ad401eb64fa13ed076c69ea026a2d
+ pristine_git_object: 0380545c183be3a9e6c1c30dbe87827513f3a5f4
+ src/main/java/com/gusto/embedded_api/models/errors/PeopleBatchConflictErrorErrors.java:
+ id: 5e8571e1c2ae
+ last_write_checksum: sha1:0f3f289b589a7dfa9872e6b133fe0b5ff242b386
+ pristine_git_object: 3ad8367a761011e55b54b3348e322e0f162a4876
src/main/java/com/gusto/embedded_api/models/errors/UnprocessableEntityErrorObject.java:
id: 479ccb65047f
last_write_checksum: sha1:7fb28fbc52b25d02c6bb36a0b08d14d81a9cefb1
@@ -8463,12 +9028,12 @@ trackedFiles:
pristine_git_object: 923cfd2e97d75a6ca6a210666975ae90f5f9cce8
? src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1CompaniesCompanyIdBankAccountsBankAccountIdRequestBuilder.java
: id: 1ec693bd6b86
- last_write_checksum: sha1:13eb0163143bd090eec74bb3dc3cf2c70536c6bd
- pristine_git_object: 88d6c5a134dac40817b2b63438023789e08dfd9b
+ last_write_checksum: sha1:a9779cd10ac099f079c04ff1e405aeafe8a18970
+ pristine_git_object: 8a5547f4ed966795b2c4bd7c4434278a7512fa3e
? src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1CompaniesCompanyIdContractorPaymentContractorPaymentRequestBuilder.java
: id: c168e8250bd3
- last_write_checksum: sha1:ede49ef572ff721e9f1edff1fc49d0d8e075cfd0
- pristine_git_object: 90c58c2b6a079319d2588960e195942a743af825
+ last_write_checksum: sha1:48a46fe63cedc03b8ae29ee7086d1913a2f63480
+ pristine_git_object: dad19404e97a8da4e751f0dcfdbe2260a5bf8117
? src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1CompaniesCompanyIdEarningTypesEarningTypeUuidRequestBuilder.java
: id: d3a6007fe553
last_write_checksum: sha1:39f84ebbe85f151b4c53739dab765d5bb9520bcb
@@ -8479,28 +9044,28 @@ trackedFiles:
pristine_git_object: e9b6a016b84fd4619249606f216a00f1f797debb
src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1CompaniesCompanyUuidHolidayPayPolicyRequestBuilder.java:
id: 72d06d1a0dea
- last_write_checksum: sha1:62d9c30f6f0113081b9c9d4f09ac59e4ceec2f1e
- pristine_git_object: 051b8a7673a7d046d5eb60154c7ddf442958fc94
+ last_write_checksum: sha1:2e88f6f74c97f1fe6e35a978b9e00022e9c2f787
+ pristine_git_object: a7392252f8f63583b25c68d3bcc5bddd5889f663
? src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1CompaniesCompanyUuidSignatoriesSignatoryUuidRequestBuilder.java
: id: be63fed4add8
- last_write_checksum: sha1:8aceba439e522f97cd6690083885c3c58e17f578
- pristine_git_object: b8c069c1b713d32ed87fd7de1e1c71f77511518c
+ last_write_checksum: sha1:5b33f5382a24f471f3ec6001d78e0c4264b7790c
+ pristine_git_object: 1fd41340c5093deacaff2160d2bd76ce33efcffd
src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1CompanyBenefitsCompanyBenefitIdRequestBuilder.java:
id: 01d6a2c7b6ab
last_write_checksum: sha1:c5d10c702d86f5f821961ef0c0a5cb3b9199325a
pristine_git_object: 538c8669a02c60a6f3219c6e8c6a0ba3993b06e1
src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1CompensationsCompensationIdRequestBuilder.java:
id: 948e71753bda
- last_write_checksum: sha1:1ed6e732387ddaf01ade7a90b8a547d1cac1addc
- pristine_git_object: eeb43da5d42b1b0eab880b794c3e9c5e852b8876
+ last_write_checksum: sha1:bb74ec06cb67294cd262ec05fbce5519af503577
+ pristine_git_object: f679e6912a9c65741bbd4df027a50ad0e0f6caa7
? src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1ContractorPaymentGroupsContractorPaymentGroupIdRequestBuilder.java
: id: aae48f68eba1
last_write_checksum: sha1:386cb5f087da817b447e6584e8da8b57bb050617
pristine_git_object: 61038fe8ac0215b949e7950349e35010fcb4451e
src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1ContractorsContractorUuidRequestBuilder.java:
id: ed323c3643c7
- last_write_checksum: sha1:88cf507cadc95d112a0ee8e2a2cde4a55915029d
- pristine_git_object: f1f2872b55243c52f9812881fd25bfd7bf4b9c99
+ last_write_checksum: sha1:b5454d1495c4a10186c14844263f19a879512892
+ pristine_git_object: 614377ba35c2d8889da968ca36513ded22315be6
src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1EmployeeBenefitsEmployeeBenefitIdRequestBuilder.java:
id: 872ddcf1944a
last_write_checksum: sha1:6b8e043f091a3c5b3c3f9ff2ad8418b31a5d9789
@@ -8515,8 +9080,8 @@ trackedFiles:
pristine_git_object: 9ea8d6c81d6a3f404882fc8c616472e324a1f9dc
? src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1EmployeesEmployeeIdI9AuthorizationDocumentsDocumentIdRequestBuilder.java
: id: 987edc251f30
- last_write_checksum: sha1:f69603f5cd3c1b51c0a124f6920b4e97bc8e8d9d
- pristine_git_object: 3f00491fc8ac6b6b4fa6daf7d0ee82d8feece9bd
+ last_write_checksum: sha1:5cea3e7921fd3cfb8831420e73669bab20442d9f
+ pristine_git_object: ae184e572975b3d930d499381f55a3637b8d1205
src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1EmployeesEmployeeIdRehireRequestBuilder.java:
id: 8d020041b133
last_write_checksum: sha1:acede82abfff1d24d4587cb8f330b1ac7352f2be
@@ -8539,8 +9104,8 @@ trackedFiles:
pristine_git_object: fc29467e5bb7b090161d8664b5d801d39686fbe7
src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1RecurringReimbursementsRequestBuilder.java:
id: b40c7856d13a
- last_write_checksum: sha1:f48f02b7fea3ff9957f377438d8ce699120164b2
- pristine_git_object: f4a2ccf0bb696d90b74079af5aea7ac2ee7018b8
+ last_write_checksum: sha1:734f0c149e6a0306a0792f7b11a9a94644bd0237
+ pristine_git_object: 4a730d19a09f73c20802f04ae347cb5811e6be58
src/main/java/com/gusto/embedded_api/models/operations//async/DeleteV1WebhookSubscriptionUuidRequestBuilder.java:
id: ebd9a84ec80b
last_write_checksum: sha1:42e39ee4945a69bfc64993bf5c078c0736d13f2a
@@ -8647,16 +9212,16 @@ trackedFiles:
pristine_git_object: 76e79e8cadf7aeae06e664b7c7b42dbb0908811e
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyIdBankAccountsRequestBuilder.java:
id: 35b3007360e0
- last_write_checksum: sha1:4d03759b2fef728612ad773771d814700adbfa38
- pristine_git_object: d232d0dfdfa8d55ddccc8b456f223725b1c6e935
+ last_write_checksum: sha1:cebdad370422522764b6044c54de83287b2c048e
+ pristine_git_object: 0f4ff80e9d426cb39a44023ed34efcdae03773a3
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyIdCompanyBenefitsRequestBuilder.java:
id: ada071dd6add
last_write_checksum: sha1:59ab522fb763a720257ee7886117f560d8440291
pristine_git_object: c19c99f7f888577a6878a5f572f10a5a13b2e4ed
? src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyIdContractorPaymentContractorPaymentRequestBuilder.java
: id: 4247511d6b36
- last_write_checksum: sha1:9e7c595392f53b7b43a7781d17f54143fdbc215f
- pristine_git_object: 7b3dc46200498a5d5f38a8905db7d2524fedca5e
+ last_write_checksum: sha1:93632b08fd532f5455df3e6a358770859ddfae65
+ pristine_git_object: 5e795db4ae96da3ba6ceecb0f86575af3fa126c0
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyIdContractorPaymentGroupsRequestBuilder.java:
id: 26b6026e1809
last_write_checksum: sha1:903db4f16fc8e476daab7624bda89e13889ebf13
@@ -8691,8 +9256,8 @@ trackedFiles:
pristine_git_object: 4e1c2235e895c023283f4146044dba17c249ee74
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyIdLocationsRequestBuilder.java:
id: 84163334bf29
- last_write_checksum: sha1:efcb92aaf243b75e62b6a0d589c4e977a7e02551
- pristine_git_object: 2fa50eafcc70f9e643582242ba3f938e9331dc15
+ last_write_checksum: sha1:c194ba6b1ec0778aacc6fda55d9c6aab9fc69a92
+ pristine_git_object: 0bb77da22b9aa0567e028a27343d724a3180e56b
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyIdPayPeriodsRequestBuilder.java:
id: fdd9d3d49905
last_write_checksum: sha1:a73b4db710e35d5350c69bc784cb3d7824321458
@@ -8703,16 +9268,16 @@ trackedFiles:
pristine_git_object: f28fa37c007aaf20f026c0828635be25fae15f2c
? src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyIdPaySchedulesPayScheduleIdRequestBuilder.java
: id: f58057997eb5
- last_write_checksum: sha1:3ce21ba788e0cae5100747d4165d084d718db25c
- pristine_git_object: 8fd059f639ab39dd12a469f928c539a40006c794
+ last_write_checksum: sha1:3f7a3717855a6c9340f8997cf22a74e98a5ae229
+ pristine_git_object: 2eade85c186d61d5a7713ba799e453d71eea9749
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyIdPaySchedulesPreviewRequestBuilder.java:
id: ede8256ff1b7
last_write_checksum: sha1:bb4c10509cb0bce80fbf421f9480d9d124d3f240
pristine_git_object: 898fbfe1535836fb9e0b230b5ba47a2fb33a2d95
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyIdPaySchedulesRequestBuilder.java:
id: 9031567c2201
- last_write_checksum: sha1:4d863eeebd49bdb6c2d162fa5e929eeff34eb802
- pristine_git_object: 48981ae8d70bd0e6f7935f674d39735660ac55e8
+ last_write_checksum: sha1:1893f5990269d958945f429149c4761f5381e31f
+ pristine_git_object: a9ac477a2f4426b09c654341c20a632574c94b4d
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyIdPayrollReversalsRequestBuilder.java:
id: 52af3cc9e272
last_write_checksum: sha1:a434e3aed33a73afa728d60ed1664ffca14958bc
@@ -8739,12 +9304,12 @@ trackedFiles:
pristine_git_object: 5958a7e43a01f3bfa0f2df5066c7c6c5dca4432d
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyUuidHolidayPayPolicyRequestBuilder.java:
id: 2f7f7c8b1aab
- last_write_checksum: sha1:bc7b9f8512e8a53a5feec0c59ce8310a1e5ddd8d
- pristine_git_object: 9b48d60fcfe453220872b6a7cfbef8d56f1a74be
+ last_write_checksum: sha1:4b82b23b97e8b8a6afb87676ff06480e58630eaa
+ pristine_git_object: 20ed951978123e927e1b86f27d75990ca8eca54c
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyUuidSignatoriesRequestBuilder.java:
id: f999523dd1bd
- last_write_checksum: sha1:3dfe5f3020346f0978afa50fb816856094ec8844
- pristine_git_object: 38f2d3adc083637befed1d242feaaaf2d6c24ed1
+ last_write_checksum: sha1:cdd019c25819201bebdc454582ab531597e65b02
+ pristine_git_object: 65b72810470c97ab9577ded433fef145ee57e932
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyUuidTaxRequirementsRequestBuilder.java:
id: 90e20b78adb6
last_write_checksum: sha1:95f0d873b89653bf8ef0d698cb7557207333fec3
@@ -8755,16 +9320,16 @@ trackedFiles:
pristine_git_object: e3bb935f035a806b87143680e11861f1d3e7c006
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesCompanyUuidTimeOffPoliciesRequestBuilder.java:
id: 0cef52de9780
- last_write_checksum: sha1:81497316d2c5f232f5d09534c87204c0307bcb6e
- pristine_git_object: cc5ce439019930d8f59219581bbe603f2bb8aca4
+ last_write_checksum: sha1:5a74e66bc44b02cbcd3ae5d8ff594f14b1f61b80
+ pristine_git_object: 39c729d4d72455456102ae5919d3967dc3f8c7c6
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesPayrollBlockersCompanyUuidRequestBuilder.java:
id: 1483c3ce9eae
- last_write_checksum: sha1:feb2f2b35bd0539ed229d5fac50cd4f3d6d3f386
- pristine_git_object: cc40da5e152434e2fddfe9748c4a9d57a8df247a
+ last_write_checksum: sha1:f57160e3607fb871c2204b2e149d9f9c649f3845
+ pristine_git_object: b8909d676d48c2cb318d90f2a50e198a796280ce
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompaniesRequestBuilder.java:
id: 3cbbd76d6e2b
- last_write_checksum: sha1:84d3d265ca37fd5a16fe3c4d4a98ce7f3c48da00
- pristine_git_object: 37b93c6f30e5407888434707cd2c3b9032df4a21
+ last_write_checksum: sha1:de3272b25ddaf81c9c037eba95e200fce1d8584c
+ pristine_git_object: 5004937ddd839f6d6403e1f57c1a3c91c33eefab
? src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsRequestBuilder.java
: id: 5bf4621fd535
last_write_checksum: sha1:0933a2e6817a6d69cfeb4dbcbea660471d2ad8c4
@@ -8783,8 +9348,8 @@ trackedFiles:
pristine_git_object: a058b509af24458f347dd0be2f78ad5cc9daec91
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompanyFinishOnboardingRequestBuilder.java:
id: 13b130524ff2
- last_write_checksum: sha1:3fb345a4f36ddcd95e4ded73774fb961ecb617e7
- pristine_git_object: 74d8f93313aaeec73487a7c360419fb1d8d25c31
+ last_write_checksum: sha1:501786705969411c5bae8bbd48ea742ca8ba99ea
+ pristine_git_object: 936771fa9b9c8c1ac53c58b7e7ef09263284c674
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompanyFormPdfRequestBuilder.java:
id: e5339111763d
last_write_checksum: sha1:1bdce40d155b05462556d3c2bf4be60a2fd57a06
@@ -8795,24 +9360,24 @@ trackedFiles:
pristine_git_object: 9ff9d6f2f6c48ae6bad799534298f9a6e19c241c
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompanyFormsRequestBuilder.java:
id: 5460cbea6d2e
- last_write_checksum: sha1:aea9815d5234d8fe557c984887df0d4e5cfba565
- pristine_git_object: 4c60a93d47e169fdcb3fb75f64db78d7f05bd227
+ last_write_checksum: sha1:d724eef7b5ef2335613eb9b2ffc5f0f80cd8f877
+ pristine_git_object: 4306f01c36b3894330dac48f9e6c1a48fd154012
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompanyIndustryRequestBuilder.java:
id: f45dff8d7b39
- last_write_checksum: sha1:4c213616839442a7285538dba8d5ad97971b7ed7
- pristine_git_object: 2ec79bd8d13d544b7ea36ca404c6dda51b8c9698
+ last_write_checksum: sha1:107b7b6237ef35710ca9b01396bb7c90e9354b21
+ pristine_git_object: 4acab3128486eb2cc39e05786ee9f4675b37f225
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompanyOnboardingStatusRequestBuilder.java:
id: 54190ab4fbb5
- last_write_checksum: sha1:c078daed158eb2021e26bbaf140c2c16a8327d42
- pristine_git_object: 2647d8228633af0012bc10ece6a4c8f438cd521c
+ last_write_checksum: sha1:c78278e2115ec9b4c1477e1fb11183e25291d7f9
+ pristine_git_object: 715af1db097b1654053ba7b08bb345218cc019e0
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompanyPaymentConfigsRequestBuilder.java:
id: 725119b5f1f1
- last_write_checksum: sha1:6765309f65d1dac97d54e96dbce0e7674f3f8dc3
- pristine_git_object: 7ffdd4b2e1863f3263e2e4fed4676128503cc5df
+ last_write_checksum: sha1:b0f4fa99469e9e65642fe1630e68282de9eae3f0
+ pristine_git_object: 54bc5c0bdce4b63ed0ed460b57b60e7b8373833b
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1CompensationsCompensationIdRequestBuilder.java:
id: a68374378d76
- last_write_checksum: sha1:895ca639771d51c7af53099197ea056abab64bda
- pristine_git_object: adee3b5d4b198d4602bf921d2ed48226d206d3e4
+ last_write_checksum: sha1:9644d6af0db62fc6dc1eca65694c4832308e084d
+ pristine_git_object: d6ca58e2d071b80e7064ab7c0c3c32e9d8a0eb9e
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1ContractorDocumentPdfRequestBuilder.java:
id: bc013e736cf2
last_write_checksum: sha1:9b04443402ea3cdfb2641b57b1ba1a545a969111
@@ -8871,8 +9436,8 @@ trackedFiles:
pristine_git_object: 9c6b4cce13189711b5a8cf64f1032421f003949c
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1ContractorsContractorUuidRequestBuilder.java:
id: 02e52b3db080
- last_write_checksum: sha1:49baeca40a83e126c009d7dfa66375050a2fb755
- pristine_git_object: fd49fea995127e45b08497e1d7f9ee93ab5366f2
+ last_write_checksum: sha1:5b84c0c7b3e58ceef9bf6ad4a0c384dfba64a5d7
+ pristine_git_object: 3e5cfa78e0d1f06df55a08c7df196d4e137fc259
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeeBenefitsEmployeeBenefitIdRequestBuilder.java:
id: cbb4dae5fb1f
last_write_checksum: sha1:c43246b79372fd3a0f07357da4900d60d7818d06
@@ -8907,8 +9472,8 @@ trackedFiles:
pristine_git_object: a8e91673861705ace34e33b7c587d1d99d4ff176
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeesEmployeeIdFederalTaxesRequestBuilder.java:
id: e95c6d7aed95
- last_write_checksum: sha1:b73d3dc27ec62ff01342c39678d21c8a2e9bd161
- pristine_git_object: fdbcac0ae03894f6daf8a89bb083796c70fd71c9
+ last_write_checksum: sha1:b679c7c55c25b509e6cc527fdb88195c681a2fbd
+ pristine_git_object: d7b90b29301141dfe74325df356996bf22cb05a3
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeesEmployeeIdGarnishmentsRequestBuilder.java:
id: 25fe19ac582f
last_write_checksum: sha1:52f1907d85d7192322ec165ab5ab4e08ad69b039
@@ -8919,16 +9484,16 @@ trackedFiles:
pristine_git_object: a66d92f4541e584ad6e33798d0307d860e5a6a5f
? src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeesEmployeeIdI9AuthorizationDocumentOptionsRequestBuilder.java
: id: c77095249b80
- last_write_checksum: sha1:70ca83b3057b63e8fcc32c6e666166ab1e521730
- pristine_git_object: 66c30a7327a955e5b941b4f095708826611293c1
+ last_write_checksum: sha1:6e1315c8af5d269caffe50dd6b065c14d758de0c
+ pristine_git_object: 44d33740c6ddced276f665926e067180cadabe11
? src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeesEmployeeIdI9AuthorizationDocumentsRequestBuilder.java
: id: dc62a2b34212
- last_write_checksum: sha1:dc032a19e9a658864ff529cc90e3e9416f9c2dfa
- pristine_git_object: b1de571f311ce6f364decd0ad96ea1bc3e7c91d9
+ last_write_checksum: sha1:15f1f9f1dfa4a1bdca0f49edcb19b32d7ada6274
+ pristine_git_object: ab9d852bf0d8b90122ce0ba4b00c46ea612a1ee1
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeesEmployeeIdI9AuthorizationRequestBuilder.java:
id: 2c63768cd376
- last_write_checksum: sha1:9de46b48e0ff9ccdd73d1b2f11c6a22c5003f9c1
- pristine_git_object: 24dff2f95fbfff5cf965e8ebac5a9dc651b3a73e
+ last_write_checksum: sha1:46554ac7af3caf271ee0213f742a9af05d4b9003
+ pristine_git_object: 6f5ec299fc4051daa4302c7720cc0681ba1fa7fb
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeesEmployeeIdJobsRequestBuilder.java:
id: 654cea72e1d5
last_write_checksum: sha1:7ba1f058d63c411b9f1a5c545832dcd377e61ad2
@@ -8939,12 +9504,12 @@ trackedFiles:
pristine_git_object: 0dcfb5e6e4068a4b9ffff6ff8673ad8d5ae4698c
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeesEmployeeIdPaymentMethodRequestBuilder.java:
id: bc78da4a16af
- last_write_checksum: sha1:c6508247014d2e6ed054c036f1ce6d86fb6ebced
- pristine_git_object: 2c2b371eb1eed10dd214e36a2e1ea2de40d6d19b
+ last_write_checksum: sha1:8ade21dee4fcea009083948636f3310c382af1c5
+ pristine_git_object: b4702b443832788c0adf9437ca556828a4141cf9
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeesEmployeeIdRecurringReimbursementsRequestBuilder.java:
id: 2d8c6fddfcbc
- last_write_checksum: sha1:490fa16fc51533b3eac6b60c83e0f7a54921a60f
- pristine_git_object: 0da7e600b0c33209186732de4d1401b07b525b0a
+ last_write_checksum: sha1:760d9d2ca64bd4cc00f5552fba795fb327f30df1
+ pristine_git_object: bebc392c93de1c8e62cc9769b42fb0a7b8254d09
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeesEmployeeIdRehireRequestBuilder.java:
id: 5a7cd3f712d4
last_write_checksum: sha1:bb36446db8b987a734dee00489082bc0e16cc53e
@@ -8967,12 +9532,12 @@ trackedFiles:
pristine_git_object: 55ea69d021a2c7bfc4677d1300db5516c20c8abc
? src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearRequestBuilder.java
: id: 4118465bad26
- last_write_checksum: sha1:3c50b260dd6bce544c18309e70aa7d7897857270
- pristine_git_object: 9fe9cc2dcb3ede60fa4b5d2106b947bd95efa83b
+ last_write_checksum: sha1:89679a388d01e388ea978e3f7cf0d1c59a2d854f
+ pristine_git_object: e9dff2e9a496192fb2aa293b5f04800145c4c591
? src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesRequestBuilder.java
: id: 32b21a35fafb
- last_write_checksum: sha1:b0d4c05488e0d6f0324dc56fb1995371bc948a58
- pristine_git_object: 3febc4398343d5bed936ef4e0b5f787176713489
+ last_write_checksum: sha1:efacdbe23d4e523d10b857414aee754a68134a1d
+ pristine_git_object: bc248ad5e93de49b0e9ce4730cb11412a4a7cb5e
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1EmployeesRequestBuilder.java:
id: d1bb9266a202
last_write_checksum: sha1:dff482f07c390da720f1770e86b3592b0caa16be
@@ -9011,12 +9576,16 @@ trackedFiles:
pristine_git_object: 5c894e5d247c77f9a3f1a659f813760722d53e12
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1LocationsLocationIdRequestBuilder.java:
id: a3a8b7c017a0
- last_write_checksum: sha1:e6dc5ead243b4f0e857ae4047d221ec40cd1a4b3
- pristine_git_object: a6b5901202b27aa426946b66051dab30a0c21b2b
+ last_write_checksum: sha1:38fcc106b331d1055b695ef4ea295c2fc3578315
+ pristine_git_object: 2f5a908b682754e93afc7b3c36c982fb2896b4a6
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1LocationsLocationUuidMinimumWagesRequestBuilder.java:
id: 2c385f828bea
last_write_checksum: sha1:1eff359e791cb4175ebe0b28d8bfe00b2cdbbd7e
pristine_git_object: e9f9aedc0a5bb136e52a8e1a421442e06de00275
+ ? src/main/java/com/gusto/embedded_api/models/operations//async/GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessRequestBuilder.java
+ : id: d7b48a441795
+ last_write_checksum: sha1:0c8b417e08fa8e733315dc6e82c9fb0eb123208f
+ pristine_git_object: af807ad22805ee67b93e7f755a24c4cf958a0bdc
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1PaymentReceiptsPayrollsPayrollUuidRequestBuilder.java:
id: 13cea91ed47b
last_write_checksum: sha1:fe3a7a0aa7a675497910a3b8c6cffbd1b3ccd40b
@@ -9027,32 +9596,32 @@ trackedFiles:
pristine_git_object: 9fbec4546d4c75498ff299c8e18be6ab8bae53e5
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1PeopleBatchesPeopleBatchUuidRequestBuilder.java:
id: 1e0e14f969ab
- last_write_checksum: sha1:d760d3480f71d28aeeb2355fb79e43f2e59cd2a5
- pristine_git_object: 084718f39dea0c70893ce2429c28d6d240cf120f
+ last_write_checksum: sha1:70b27cdce2afc25c919a38cff1026b7b0a4d8f82
+ pristine_git_object: 76cb1b6a92d6cc8e437f3f2b068e352b0d6c7c98
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1RecurringReimbursementsRequestBuilder.java:
id: f269e5b2ea47
- last_write_checksum: sha1:bb3ec07b0d7372228c28d1834e3da7477da1bfa2
- pristine_git_object: 7e8705497dbfc08eae784ed0f6955fb622aa634f
+ last_write_checksum: sha1:c8cbc58c3fdefac35cffbf591cf14247a8536c38
+ pristine_git_object: aafd6aa912341217d89439afdbf3ffd7d8bb0910
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1SalaryEstimatesIdRequestBuilder.java:
id: a37f0b9032df
- last_write_checksum: sha1:41e34046a5dce1550d6cd88f6477ed59ff514bca
- pristine_git_object: 2681b6907e044a3463fe48fbab18f097fc6f48fc
+ last_write_checksum: sha1:685ec567618d6c3e0760de5fb51faca0386982b7
+ pristine_git_object: ec1c918256494bef13965380ddcc289d5b980fee
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1SalaryEstimatesOccupationsRequestBuilder.java:
id: a8c588c25b91
- last_write_checksum: sha1:831f9ed88b012f93ea09fbc85ded104719540737
- pristine_git_object: 90b226f511a55bbb579ff5b5a5619e8ce0917e28
+ last_write_checksum: sha1:21a19b7a49ba4d870cc30c103534f2fd27724d69
+ pristine_git_object: 5320d981957b90daf258bb2e89b4f5eb7715731d
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1TaxLiabilitiesRequestBuilder.java:
id: 7e9f3bd4ca8f
last_write_checksum: sha1:ecff05d3b32e294d91b44f462ae04e9b5ce57a4e
pristine_git_object: 976fc8dcebbdafb9025f1e425fc669f55fb61fbd
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1TimeOffPoliciesTimeOffPolicyUuidRequestBuilder.java:
id: 5ced0485b437
- last_write_checksum: sha1:26893298de1c991ff101d6894b748f097b8c9331
- pristine_git_object: e94b62a8321feefb1bb861324cc6a2531cfef2bb
+ last_write_checksum: sha1:a4ac555de204c9da2fc866d948f6a049ab59efcc
+ pristine_git_object: 6ad3f238922b918eb943c33a577702764d767899
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1TokenInfoRequestBuilder.java:
id: 8470fa7f8355
- last_write_checksum: sha1:81eda82a542cabb9457b9fdb29b90c0cdaeafe78
- pristine_git_object: f0e7ccbf30e11b369290cbf5659893e3c4b2579a
+ last_write_checksum: sha1:dc46f19936199e27989bf41c1a91250c9f24e5a2
+ pristine_git_object: 4ce7210acbfde928202107d34aa2d2595c888c0c
src/main/java/com/gusto/embedded_api/models/operations//async/GetV1WebhookSubscriptionUuidRequestBuilder.java:
id: 449c5a571091
last_write_checksum: sha1:27feac2f12ad48c9bdcefefbe88ee3155b4a6f88
@@ -9083,8 +9652,8 @@ trackedFiles:
pristine_git_object: 67e4961338170f64d14a565b95980370c1946263
src/main/java/com/gusto/embedded_api/models/operations//async/OauthAccessTokenRequestBuilder.java:
id: 1f4658b049e7
- last_write_checksum: sha1:04105cf2f62dd8172510b86e0f5cd9107523e2d1
- pristine_git_object: dd3de7e918ada6f6395771191371713775b606bc
+ last_write_checksum: sha1:ef1bcb24159f29debaf8779ada0e20ea3d202d37
+ pristine_git_object: 38e5dcb99b660636c855b16666ffc51b38975b68
? src/main/java/com/gusto/embedded_api/models/operations//async/PatchV1CompaniesCompanyIdPayrollsIdPartnerDisbursementsRequestBuilder.java
: id: 14ede85e6c81
last_write_checksum: sha1:fab5497c341e0dc581d08c11a988fb210734e686
@@ -9095,8 +9664,8 @@ trackedFiles:
pristine_git_object: 2bad060fbc005fadae9673a4f8ed04a423bb0ea2
? src/main/java/com/gusto/embedded_api/models/operations//async/PatchV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearRequestBuilder.java
: id: 6b0bfe65d3bc
- last_write_checksum: sha1:576f4e747f39814cdc404706e4a49e1dbf307b4f
- pristine_git_object: 90e35830becffd4d28013684c7315c176caa5e06
+ last_write_checksum: sha1:615a17c1ab391c00c24ea659764d2c9b867e5ddc
+ pristine_git_object: bc4c08ef5cb291d14932caca4330e1f6325f4531
src/main/java/com/gusto/embedded_api/models/operations//async/PostCompaniesCompanyUuidReportsRequestBuilder.java:
id: 13850122bee6
last_write_checksum: sha1:f0619584062bb6683ba46ccc5fca24b5f9f0068d
@@ -9121,6 +9690,10 @@ trackedFiles:
: id: 7de18748362c
last_write_checksum: sha1:f02b903de7f2d55402146fd4e313a924ecf29076
pristine_git_object: f9a239681e2f1f8bc53eed0d5de62bfe7d49a70c
+ src/main/java/com/gusto/embedded_api/models/operations//async/PostPayrollsGrossUpPayrollUuidRequestBuilder.java:
+ id: c98602673f8e
+ last_write_checksum: sha1:2f094619cc78e84b134d6854ab843b1ee8e50bbb
+ pristine_git_object: 58a02d7ff456202ab12578926e4c4ae8673fd4f4
src/main/java/com/gusto/embedded_api/models/operations//async/PostPayrollsPayrollUuidReportsGeneralLedgerRequestBuilder.java:
id: aa4793171ada
last_write_checksum: sha1:acf3a2f092391d3a11003ab7449d550db1b28e68
@@ -9135,8 +9708,8 @@ trackedFiles:
pristine_git_object: c76aeeb61c7ab2516e462e0f180a7142ea49a70a
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyIdBankAccountsRequestBuilder.java:
id: 22d9aa85a5bf
- last_write_checksum: sha1:b77b9078ab0bcca5acce76419a5e74f3ea962209
- pristine_git_object: cb789039f38d37321b34767bcf1e77758b84ba2f
+ last_write_checksum: sha1:44cf660d196f8478d8fe00c5a55bf2a7e957c983
+ pristine_git_object: 167642eb01ae35ee910ca7328f06691ed730c733
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyIdCompanyBenefitsRequestBuilder.java:
id: 96c2012c544c
last_write_checksum: sha1:dc2f7ba035cc624ebcf0617cd64690d7eb1336fa
@@ -9151,16 +9724,16 @@ trackedFiles:
pristine_git_object: 51d66fe2bab7a8fd6119d0ac91331bfc52662d93
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyIdContractorPaymentsRequestBuilder.java:
id: 27673f624254
- last_write_checksum: sha1:495c9dbdfbf786ca0529c543169df014914ce59a
- pristine_git_object: 2849c46d0fd8869e0e565834b32e5550b3a5784f
+ last_write_checksum: sha1:97ee132d0ec7e8257896f00dac719de85b7e09d7
+ pristine_git_object: 049f7a4c076afea8e599f6194b2917524cc66a3e
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyIdEarningTypesRequestBuilder.java:
id: 76da5dc7e850
last_write_checksum: sha1:13416c6d83839a39a9f22415d73f21c09c13ae73
pristine_git_object: dcbdd2b1ccbe63597cea791d9b3454250f5bacd6
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyIdLocationsRequestBuilder.java:
id: 844a54f116fc
- last_write_checksum: sha1:4d0b2b27aeef5bb86bcfc06a4434ed88ac71362b
- pristine_git_object: a0bb002ae8a6e09fde20f413eae2f5ba93db9dc3
+ last_write_checksum: sha1:9b4ff55d2fdfd4db2b0cec508d4e6311163a52d9
+ pristine_git_object: 75ce89b85c83e3e3e5c8a2fede3beda494d3fb45
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyIdPaySchedulesAssignRequestBuilder.java:
id: eece6ce7d227
last_write_checksum: sha1:ea81e77717253b47d84beb5f0e7a0d04bcc7da8f
@@ -9171,48 +9744,48 @@ trackedFiles:
pristine_git_object: 40eea29fa6ef89233b7f1e36f86b745f3409b6eb
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyIdPaySchedulesRequestBuilder.java:
id: 50f18e5e16d6
- last_write_checksum: sha1:6390eaad314f1ff1de4ea21f1dc9fbc91155e051
- pristine_git_object: 4fd7bf390ad387b10b08e0f7a65a6b8c8c8b1e1f
+ last_write_checksum: sha1:4c087fe04d50f59625e925ca998c5ba4c45650e9
+ pristine_git_object: f8776c0605784dd5cca7f0982a939b5ed0974230
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyIdPayrollsRequestBuilder.java:
id: 7fd5a5d96259
last_write_checksum: sha1:7efa51e1b6bf51436eb22e6c6c42571829a70a1b
pristine_git_object: 3a82506024ca037196f900691bb2c1210caa41d6
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyIdPeopleBatchesRequestBuilder.java:
id: a20cf60116e9
- last_write_checksum: sha1:a709baabc5ae7aa975d8503b1b21b1251caa7f1f
- pristine_git_object: 9778a7a222d62b9af9d316c7064a61f4499ca941
+ last_write_checksum: sha1:17fdc9149da82037aef6f6d0c6e92e9b6aeee47a
+ pristine_git_object: 89086288748e42ddddc35f20fc741f7eb2e7136c
? src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyIdReportsEmployeesAnnualFicaWageRequestBuilder.java
: id: 3312cd529ac9
- last_write_checksum: sha1:3f79e05692280da05256a6af39dba82e3d20fc25
- pristine_git_object: 1e702f0b814c569156a713f3b7380cf7d630e39a
+ last_write_checksum: sha1:d7bb7f710ac3d44b212085bad3f0432ffb66d9c6
+ pristine_git_object: fa19e63008d46eafdf8172a9c8c35be5495193d7
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyUuidContractorsRequestBuilder.java:
id: 4d16f1e7874b
- last_write_checksum: sha1:b84aa7275a2f487f04dee95f3f28496252780c68
- pristine_git_object: 9446531f91342682174037ffbc70b3ec09783afd
+ last_write_checksum: sha1:40433916ab995c0708ddad2bfb27376703b3c21a
+ pristine_git_object: f131688fae806d376ec2fe8728ee5911b4b19dfc
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyUuidHolidayPayPolicyRequestBuilder.java:
id: 69f92d39b8b9
- last_write_checksum: sha1:2fabd074d1ddb22dc2311095324dfc8eef33ae49
- pristine_git_object: 5e6444441501b4a04bf77063dbea41ac300fa33c
+ last_write_checksum: sha1:5d2abdac18db3e392b99d8ea47a1174e38e9e551
+ pristine_git_object: 375a988ce36da9e636c8557983782c2cc80d46cb
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyUuidSignatoriesInviteRequestBuilder.java:
id: 51ce7bc1f6e5
- last_write_checksum: sha1:b04a2e75989421b214a7783af44da9143ebee44b
- pristine_git_object: 0c86a418e00b697bd8a95e85d9cb1f48ed034af1
+ last_write_checksum: sha1:6c23d19de260cdeadcaa105a8538fee7c32d7ae5
+ pristine_git_object: 272a5323dbf0ef59a26dc0d3e8ff74636a3ffce5
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompaniesCompanyUuidTimeOffPoliciesRequestBuilder.java:
id: 7546f49afed2
- last_write_checksum: sha1:cc87a3c2fa90ed0f0307ca51db9902cf4d6b6644
- pristine_git_object: 941e578f3b98484cf1a2dc908f701fe083821617
+ last_write_checksum: sha1:f5056c241351c5926bcf65c7318463d2cf6e4982
+ pristine_git_object: 01a7e98efb4d746a28ae2a7f035ae6aa56dd23f0
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompanyFlowsRequestBuilder.java:
id: 2d1f25c133f7
- last_write_checksum: sha1:7c0266469c1df638f153af7d237c13dda35c971b
- pristine_git_object: 1217c3616228260063e9b59101c40c7f1eb9db36
+ last_write_checksum: sha1:41d3041bdabad45fbdce9f2806c99528a5af0527
+ pristine_git_object: df5d40bed4a78ecbd71e4a5dd0e49d6b2027dc38
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompanySignatoriesRequestBuilder.java:
id: 8e69ab51bac5
- last_write_checksum: sha1:ec085d95d2f85c9db8d95feae60aa16e31972918
- pristine_git_object: d301073afb5ce004e100cb647837679b94baab83
+ last_write_checksum: sha1:77cef8fa3de173bae6721c8a2b14dc5a07749e1e
+ pristine_git_object: 14aeae353b6d29c2f8f12a77ecba6fa4f955fce9
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1CompensationsCompensationIdRequestBuilder.java:
id: 69d02d0238b9
- last_write_checksum: sha1:eab838fced944e6d456b5ebd21eb7e9757c22798
- pristine_git_object: ec568d42e9856a4728da9fe2bdb4bb93d6761cb5
+ last_write_checksum: sha1:05c761b698294859bae1b1f4c192fcb9d846f965
+ pristine_git_object: 6927e8fab85e1d5f27cbdc75754daeafbdbf8916
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1ContractorsContractorUuidBankAccountsRequestBuilder.java:
id: d2cd99436fd8
last_write_checksum: sha1:614ce0839e39404801265b547916d7da89847472
@@ -9235,16 +9808,16 @@ trackedFiles:
pristine_git_object: 4d0d48a3daa13a28cf55f9dff8d8fa7df9ffea17
? src/main/java/com/gusto/embedded_api/models/operations//async/PostV1EmployeesEmployeeIdRecurringReimbursementsRequestBuilder.java
: id: ea4affcc77f2
- last_write_checksum: sha1:b66e783a2632c42aba09fbcf009ae6d312c39981
- pristine_git_object: 88520dc2ba4372a9145cf04783b24c48a4c30ee9
+ last_write_checksum: sha1:817618ac65d70283fcbaf2747464e3d0e14cbafd
+ pristine_git_object: 77a22bc9ba402dc40b3cbd8c885ea03e017bfa50
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1EmployeesEmployeeIdRehireRequestBuilder.java:
id: 1a19b0a22153
last_write_checksum: sha1:91a360838361219989b6d9be4119f87561488021
pristine_git_object: 779db3ad318217492c52ac509b96a8a4499cca8b
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1EmployeesEmployeeIdSalaryEstimatesRequestBuilder.java:
id: fd8fcb23e371
- last_write_checksum: sha1:cf274c077204b1ec82b8f4d08239b61a2a9b42d1
- pristine_git_object: 51e226246b77fbc0d67a97c7e14334e62ef88966
+ last_write_checksum: sha1:bb120a7a43bd7b07a894981ea76e9a7b2b9b9964
+ pristine_git_object: d47b0330546f245838f1cdc1a984fbf50d8f6db9
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1EmployeesEmployeeIdTerminationsRequestBuilder.java:
id: a12991e50a2d
last_write_checksum: sha1:dd82cbf210c106dc5d1843225411f2992503b1c6
@@ -9255,8 +9828,8 @@ trackedFiles:
pristine_git_object: ca0be70e7512248b2d138ad2c90e8b890e80a724
? src/main/java/com/gusto/embedded_api/models/operations//async/PostV1EmployeesEmployeeUuidSection603HighEarnerStatusesRequestBuilder.java
: id: 6bc33337dedd
- last_write_checksum: sha1:7449f1b2f6c409b0f94d4e246495a86eb740eadf
- pristine_git_object: e238d7f8701398783849cc95c18fc653d7d7f005
+ last_write_checksum: sha1:c1267930c99f4349b93a26b48567bfc142b5595d
+ pristine_git_object: a5d797ad5131f89aa9896a7e2e380183478b4312
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1EmployeesRequestBuilder.java:
id: b73264bd1d48
last_write_checksum: sha1:a6d3bfb0cb3d00b37db6048776cc414df7fa4b14
@@ -9279,8 +9852,8 @@ trackedFiles:
pristine_git_object: b45a85f3d766c6cd1aa15fcdef250f00319ae6f0
? src/main/java/com/gusto/embedded_api/models/operations//async/PostV1PayrollsPayrollIdCalculateAccruingTimeOffHoursRequestBuilder.java
: id: 03b878678b8d
- last_write_checksum: sha1:698bdddbcf29e82bf893a45f13dc0674a4d51f80
- pristine_git_object: 40ff02223bd0eb460b4f14ce9fe692940ffb6958
+ last_write_checksum: sha1:d7dd4effd1bc90caefab3c21ffb40336e9ae938b
+ pristine_git_object: ddc270605365dda5e0c852c0a00429dfe6314093
? src/main/java/com/gusto/embedded_api/models/operations//async/PostV1PayrollsPayrollUuidGeneratedDocumentsPrintablePayrollChecksRequestBuilder.java
: id: 5ef1b05ca612
last_write_checksum: sha1:28f591cdcfdaac2fd46ac11aa19c816eae0a3548
@@ -9291,8 +9864,8 @@ trackedFiles:
pristine_git_object: 35d550c5dc1358db23c469e2d9a8f57143ef6562
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1SalaryEstimatesUuidAcceptRequestBuilder.java:
id: 1a93d19e2ff9
- last_write_checksum: sha1:bda183e1572340b7f22a8d5422579339b2a53319
- pristine_git_object: 4e8965a0a2b044872e53cfe31acaa59fcad06a9a
+ last_write_checksum: sha1:98899685c95a73a44065f9c45ef0cd3120a09946
+ pristine_git_object: 73dc9b7802241a485d924b82c0eb632c0f2fdd1d
src/main/java/com/gusto/embedded_api/models/operations//async/PostV1SandboxGenerate1099RequestBuilder.java:
id: 34e125c34a7c
last_write_checksum: sha1:f6af94e32a0c93963d8bad1d90dc4d7d24452f53
@@ -9311,8 +9884,8 @@ trackedFiles:
pristine_git_object: c35bd95fb0e8fcfc64f99c2ee9571913a57803ee
? src/main/java/com/gusto/embedded_api/models/operations//async/PutApiV1CompaniesCompanyIdPayrollsPayrollIdCancelRequestBuilder.java
: id: 2dd041d1f077
- last_write_checksum: sha1:0c396b6dbafe76df302d9cec6f825feab380b8ac
- pristine_git_object: 62179e75ffbdb4dd8c567935470789b5bd6b41e1
+ last_write_checksum: sha1:510c0b34c8268bbea04fe0f7121cded74c93b3fc
+ pristine_git_object: b2582a285a7513b3570adaf7cfc9d4a6d8f1a31e
src/main/java/com/gusto/embedded_api/models/operations//async/PutDepartmentsRequestBuilder.java:
id: 7131b9be0e74
last_write_checksum: sha1:f0bd70fec613ee00543387c2d6413a94e0779ef2
@@ -9323,8 +9896,8 @@ trackedFiles:
pristine_git_object: e7c87ca6fafe4d7fe1575d7201654c1d65a3ce2a
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesCompanyIdBankAccountsVerifyRequestBuilder.java:
id: 24e48d6dbf8b
- last_write_checksum: sha1:1b185129d457c5d69019089fb9857eea4dc29051
- pristine_git_object: 47739d47e6dbfe13d6c4597a73c5930c1b88fba2
+ last_write_checksum: sha1:610e6be2f2ffd32e979d429edf80f433f65e3161
+ pristine_git_object: 54c08fc15ed2451c86ab93e5c860ba3244687e33
? src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesCompanyIdEarningTypesEarningTypeUuidRequestBuilder.java
: id: 2f8f64bf3fa5
last_write_checksum: sha1:02bf07e5f329013608477d9702797cbe4be52e3a
@@ -9335,40 +9908,48 @@ trackedFiles:
pristine_git_object: c0af3834959471294cbafb898527428b7c88db3c
? src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdRequestBuilder.java
: id: f47a91e9debe
- last_write_checksum: sha1:071a7633b424984ebe2822a930b12b4bf9d6839c
- pristine_git_object: 907a10178e0ed7e7cc5e913ba5638b372387141e
+ last_write_checksum: sha1:a17135841e448b3799dfc696107affc303331c34
+ pristine_git_object: 0e7f52ae01b00b725e6be9a0f632b314306609d1
+ ? src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesCompanyIdPayrollsPayrollIdCalculateRequestBuilder.java
+ : id: 103ff5ec4fa0
+ last_write_checksum: sha1:beaf5f2d14ee7955fb557fd71b9f586fd2308da1
+ pristine_git_object: 4b76811d2157113afb2cbf886ab0b8a1b81bbaf6
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBuilder.java:
id: 94a754301591
last_write_checksum: sha1:3dfc364c3763d6e2692023a3763085aebd60291a
pristine_git_object: 5dc03d728f435b91a833f8cc28ed0503e0eef37b
+ src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesCompanyIdPayrollsPayrollIdSubmitRequestBuilder.java:
+ id: 83b7ab7df47f
+ last_write_checksum: sha1:e7727a7deb30e78b0f0ad90e8b3e88c09e43d821
+ pristine_git_object: 03259b3cce84c5f32eec66dbeb9a7fe69816de3a
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesCompanyIdPayrollsRequestBuilder.java:
id: 418aebce10e9
last_write_checksum: sha1:6179796b80e4ad399cf326e907bfcd87d7cb1d04
pristine_git_object: 56c6609b9f722a4d287cd322b7ea2ebd9c5855bd
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesCompanyUuidHolidayPayPolicyAddRequestBuilder.java:
id: 6fac8a5dde9e
- last_write_checksum: sha1:97ccbaa36d0f70c74e45dc9b6ae8fc05ee96feb2
- pristine_git_object: a06dd4c5c1e03971a6aa421ca8da8b844c281832
+ last_write_checksum: sha1:35bb1b9120ae20c5bfa29e9763e1c09cd8fdef7a
+ pristine_git_object: 292d2028dbdd957fcfd83a599955f3359e30ac4e
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesCompanyUuidHolidayPayPolicyRemoveRequestBuilder.java:
id: efb49bf2e378
- last_write_checksum: sha1:c4b6aca52490e926a2874e465f19c605a8c9808a
- pristine_git_object: b78d0c10908f7ed409da521323ae3ce5a7eae7a1
+ last_write_checksum: sha1:bef64982fd39830c46b87a8f8209e060cf35156f
+ pristine_git_object: 82286187b62d190718e9d171c2f9a98c7f911ed0
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesCompanyUuidHolidayPayPolicyRequestBuilder.java:
id: eded6fc4af2d
- last_write_checksum: sha1:358312449059c3ee14a7dc0d099ab539909728a4
- pristine_git_object: 8788e0dcc1b567689f01c886f6d6067e320bc512
+ last_write_checksum: sha1:fe3a5569951344fec0b5b846f254afbb46ec00f7
+ pristine_git_object: 541c4bcfb58d8d1184364270ddd624e44e6d9f3b
? src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidRequestBuilder.java
: id: acd7fa458499
- last_write_checksum: sha1:327f2b65a57bd456e79f60bc9dbd41aa044b74e1
- pristine_git_object: 618ecfd9d57982a0b88508e28070fae0aecdf5e8
+ last_write_checksum: sha1:85681449df9ac9c94d40b356b6252b2e6affee94
+ pristine_git_object: 922e2739911387890a45f5b33c57f3a0239caefc
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesCompanyUuidTaxRequirementsStateRequestBuilder.java:
id: 09797393e9fe
last_write_checksum: sha1:3d7e32e0bf55dc6a127f5abd48f42a373228bb9d
pristine_git_object: 20cebc2f3733503f27839037b839e61c923a1531
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompaniesRequestBuilder.java:
id: 66e901fdaff2
- last_write_checksum: sha1:4a5e5a441d6a1e6294ed08f2cbe6431b9f4f2788
- pristine_git_object: d0753839fb1641499a3bb6282b2d7996742864c8
+ last_write_checksum: sha1:afa9ea04ddeef30b16c3a34a4cb8b8d00ba5b095
+ pristine_git_object: b0cae2b5fbb650c3d64e6a2198969f5f5ac6f9a4
? src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompanyBenefitsCompanyBenefitIdContributionExclusionsRequestBuilder.java
: id: 459d32c75ea8
last_write_checksum: sha1:f31055c4bd5ea205003b1fa6e636c3fce46219e1
@@ -9387,16 +9968,16 @@ trackedFiles:
pristine_git_object: 3dffd38cf1f41f794a4a145046625fabae8d4282
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompanyIndustryRequestBuilder.java:
id: 99116db0b312
- last_write_checksum: sha1:bbf6e570d200da940e86757fdf13b739c2bb9467
- pristine_git_object: a212bd93be7d55cba8ba15a565039d62dc29a8e3
+ last_write_checksum: sha1:b152bd0a660d81383c01573a4ffcee10d40dfaeb
+ pristine_git_object: cc65eda8b71fe9d7c513c440c1650637a4794bfa
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompanyPaymentConfigsRequestBuilder.java:
id: 1c0f13bc0244
- last_write_checksum: sha1:5252f967dc269b744475a4543847ed57c7539dff
- pristine_git_object: ccff73dad781b1117655116b8e28d920d0aa8234
+ last_write_checksum: sha1:8c85262366d8bfb710e97d44ce787cf1382b509d
+ pristine_git_object: d8829a935b40a19b85bf27d56bf3c31bd3307cca
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1CompensationsCompensationIdRequestBuilder.java:
id: 291eb747d8c8
- last_write_checksum: sha1:9df6711f0230141c18f93f199463de598d68210f
- pristine_git_object: d7bd8082ac141be1c7e6b3de12cd4645cbeb6d42
+ last_write_checksum: sha1:c517900236ddc1f1ab01a5c96212b42ba63d7ccd
+ pristine_git_object: b61d7529063a44a83be8a367bc42ecdb068fad2c
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1ContractorDocumentSignRequestBuilder.java:
id: cb0fb67b52ab
last_write_checksum: sha1:c516fc868577e652db1ae306b913f496e3477c34
@@ -9419,8 +10000,8 @@ trackedFiles:
pristine_git_object: 1f5e457b1f1d64bd27c76f422487fe898bf44e34
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1ContractorsContractorUuidRequestBuilder.java:
id: b8953e9d8af2
- last_write_checksum: sha1:700410586ce6c2cc93cb8b99ea75f43892b75839
- pristine_git_object: 389f37a56f5c035ba83ba263bf2d25829b3be2ec
+ last_write_checksum: sha1:6742726166989cbd1001d983387b57fdbd33e4b4
+ pristine_git_object: 3f78b99f22e83e562be1f5f1566e44bd98add3f4
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1EmployeeBenefitsEmployeeBenefitIdRequestBuilder.java:
id: 9831ff1ea289
last_write_checksum: sha1:e16ca7f30ce60523914615b254633708bb12d990
@@ -9435,32 +10016,32 @@ trackedFiles:
pristine_git_object: 5e44022cc050251f38f628a7772d0b74b42ee678
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1EmployeesEmployeeIdFederalTaxesRequestBuilder.java:
id: 9ad83eaf6bac
- last_write_checksum: sha1:09ff04830b045d9f84ee2fa6f7017cdbd3af4184
- pristine_git_object: 069b5f0b0d88cc9373e74328114f005ffa3d7ccd
+ last_write_checksum: sha1:6afff73bd1b7b46b55a5a420fb152dba72b4cd8b
+ pristine_git_object: 24ce6814c52ee8ee2e96f9e453c3680b5ae6bc3f
? src/main/java/com/gusto/embedded_api/models/operations//async/PutV1EmployeesEmployeeIdI9AuthorizationDocumentsRequestBuilder.java
: id: 1c2c283257a0
- last_write_checksum: sha1:2da4c5c568db1180c03924e5da4f2d55db3fd4fc
- pristine_git_object: e1532e2ffece1a4ba731e4618aa3be5c846dc427
+ last_write_checksum: sha1:df9bc5c0ad4c0d2048a9701f50564a0333af277f
+ pristine_git_object: 7eff697972f8bcc65e6c5322d40645518fd5d534
? src/main/java/com/gusto/embedded_api/models/operations//async/PutV1EmployeesEmployeeIdI9AuthorizationEmployerSignRequestBuilder.java
: id: 714c13dcb372
- last_write_checksum: sha1:43df10f0c42a1ee291e9cb087bb817640d8b0bfb
- pristine_git_object: bd6ea8fcc3b63d3746393091472dba88e2c37a56
+ last_write_checksum: sha1:28161b56d1557de009cd3469544294c7ac21477a
+ pristine_git_object: 1a00dd7c9aef0ff7aa6b13c56bd591b3a20dd3b1
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1EmployeesEmployeeIdI9AuthorizationRequestBuilder.java:
id: 4311e73a1b6a
- last_write_checksum: sha1:d7f554185a08c73432ed22db7429e10b5beccd6d
- pristine_git_object: 0afd5f4a3b431dbf15bb50675f01556a3443a698
+ last_write_checksum: sha1:b956d96ce27d18b7310c8e45b86d84c297f9c0ef
+ pristine_git_object: 37bb33035bd8475436c2b03387b197f760840179
? src/main/java/com/gusto/embedded_api/models/operations//async/PutV1EmployeesEmployeeIdOnboardingDocumentsConfigRequestBuilder.java
: id: cccdb74182ab
- last_write_checksum: sha1:1b56ad8dd873ede1df8e52c8b142229ac068b89c
- pristine_git_object: 022ddcab13566cc293ecdffbdf4f0fd9416a3825
+ last_write_checksum: sha1:b026e000c67b3f38fc421b0d85e4584e4d6eae4c
+ pristine_git_object: 69990278b7fffc41cf9687d5a64aa2fab4a99dbb
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1EmployeesEmployeeIdOnboardingStatusRequestBuilder.java:
id: 338307365fc6
last_write_checksum: sha1:fa20ba893f135f7a90f75cc5b905f82c8e0b4fcd
pristine_git_object: 52a23a39acb4fcc56143eb968ef95c94b1a19b12
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1EmployeesEmployeeIdPaymentMethodRequestBuilder.java:
id: adc859c1f4a3
- last_write_checksum: sha1:4bd2fbae403fb5238e3a490151f024cd20aebe73
- pristine_git_object: a5e3ccaf9974873c208c204218e935cefdc7d6dd
+ last_write_checksum: sha1:5da4397267c65686a205e066c6ce448110d4b370
+ pristine_git_object: 8005b14c401563a84c75d9eef064211ee42b2664
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1EmployeesEmployeeIdRehireRequestBuilder.java:
id: bb23a5a3df48
last_write_checksum: sha1:8e2010439529a19f4bc64fa2343a6640f0c523f0
@@ -9497,18 +10078,14 @@ trackedFiles:
id: c7ff984e20eb
last_write_checksum: sha1:36ceb1e342bd1ac4df9b6daf3c11fd4e4a380b05
pristine_git_object: 70579325cc474ca2836471e1cdbf4933e41784b5
- src/main/java/com/gusto/embedded_api/models/operations//async/PutV1PartnerManagedCompaniesCompanyUuidMigrateRequestBuilder.java:
- id: bd8d6e59d7f6
- last_write_checksum: sha1:dda3f00213e775c26811ccd1aa35a62bde17db04
- pristine_git_object: 2a0a468f2d7178a6b9b1c36fb3359c458ad98c67
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1RecurringReimbursementsRequestBuilder.java:
id: 8961e96bd55a
- last_write_checksum: sha1:72a9e20e1b68bf68f89b40fef0bfb6180e4d5edd
- pristine_git_object: 871ad5cce2325d605b010c5736512f0c2d8a83de
+ last_write_checksum: sha1:235f580b08fff16b664e17b4189741d90a2253e8
+ pristine_git_object: ef0b972294f25669a7fda7d74b09c0da1e6591c8
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1SalaryEstimatesIdRequestBuilder.java:
id: 1ea885457c0f
- last_write_checksum: sha1:d40e2293581308141de12fc6cad0c87e61122803
- pristine_git_object: e71c5e263a8744948ba20fd966de55f4ff8e604d
+ last_write_checksum: sha1:ea998c0015ddd3692378718b2119b41c01d1bff6
+ pristine_git_object: f9d1b018de5f5be16941e1523a05efe4901dd745
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1TaxLiabilitiesFinishRequestBuilder.java:
id: ee54bafa5eea
last_write_checksum: sha1:3d412a0b9c93cb8a8eec411768aefb77801bc4ad
@@ -9523,24 +10100,24 @@ trackedFiles:
pristine_git_object: 02a21b8aba11debb4463ad324c3fa64627cad19d
? src/main/java/com/gusto/embedded_api/models/operations//async/PutV1TimeOffPoliciesTimeOffPolicyUuidAddEmployeesRequestBuilder.java
: id: 5a91bcc18a84
- last_write_checksum: sha1:75300838562ff0c7464a0ccb81e8110784b47730
- pristine_git_object: 436a0945322152e01e58a077624cfbc8b68dbe50
+ last_write_checksum: sha1:5c6de19d843797c01573a17eea59863169ad76e2
+ pristine_git_object: 7745b8481e7ec8161092bd8316b0a30cb83640fc
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1TimeOffPoliciesTimeOffPolicyUuidBalanceRequestBuilder.java:
id: 5104e7f3b15f
- last_write_checksum: sha1:198895cb8d3aaceeb8493e1a1d99343fe1e00486
- pristine_git_object: b3153adb606b1856f94ae4a2d513020cf811fbb2
+ last_write_checksum: sha1:8ad86b808a668bd111c2e2d63496fa76a785a6a0
+ pristine_git_object: 4e4905520a5a62ffe66a678126c68d4042f18025
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1TimeOffPoliciesTimeOffPolicyUuidDeactivateRequestBuilder.java:
id: 538599166ea9
- last_write_checksum: sha1:08fd979f5c942726a8c9b5d7767945cc75bb98d8
- pristine_git_object: f19b36b70f784d39b0d524a0ccba76d082484e30
+ last_write_checksum: sha1:0d99c82686d0a5510a30c5e032834b290d4379d2
+ pristine_git_object: 75409b59b90b989d1cf03a4801a29a2fb9c58e25
? src/main/java/com/gusto/embedded_api/models/operations//async/PutV1TimeOffPoliciesTimeOffPolicyUuidRemoveEmployeesRequestBuilder.java
: id: 0c810d1d2991
- last_write_checksum: sha1:8e17f7d7add6b0b726ea016ab862516018bcf72c
- pristine_git_object: d3c9fd2ee598501b88005766c15ed2b40edde81f
+ last_write_checksum: sha1:2fc9e4d28998653341eb20f562ad8524b4c6dc9c
+ pristine_git_object: 5ec303bb937f4c5371733b6080b628e5f5fddaf4
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1TimeOffPoliciesTimeOffPolicyUuidRequestBuilder.java:
id: 4db5054827b0
- last_write_checksum: sha1:afd570a277b7838d2971ef32af91000c9ebff27e
- pristine_git_object: 5d746cfb9928f779b0d1aad63588e0ca21cf0d2d
+ last_write_checksum: sha1:e07cee8b19fae0ce38d5a0ef12f5b75a81e16614
+ pristine_git_object: 9613275a76a010a94869e728354c575018148bf4
src/main/java/com/gusto/embedded_api/models/operations//async/PutV1VerifyWebhookSubscriptionUuidRequestBuilder.java:
id: 3dafc84abec9
last_write_checksum: sha1:c72b63b95f97bc0c49116736f2babd8ea8ef2994
@@ -9577,18 +10154,14 @@ trackedFiles:
id: a7e62b41b54c
last_write_checksum: sha1:c1bf9dbc316129f358a1bec4f6af49fb55402dd7
pristine_git_object: 23e02776a9da00bec30a7ff0698a7922c4ad122c
- src/main/java/com/gusto/embedded_api/models/operations/AuthorizationStatus.java:
- id: 68fec70fffe9
- last_write_checksum: sha1:e421029daf98981909208147d68ef4e7845430b6
- pristine_git_object: ff52c9f6d3900bbbc48ab9caba1ecb32fb0facc3
src/main/java/com/gusto/embedded_api/models/operations/BankAccounts.java:
id: 829dbefb7143
last_write_checksum: sha1:41ad09cf364ccf034db518383f814019527e28a8
pristine_git_object: f2d46aebb75e76c5e1edbdea584b3c35bf0ae6a0
src/main/java/com/gusto/embedded_api/models/operations/Batch.java:
id: e4149401c2f0
- last_write_checksum: sha1:f939abb085bd46bb7ace3febafb720d3e9fdcc65
- pristine_git_object: 76986dc69a3b4c5713ea30b3c720e0169f123ee5
+ last_write_checksum: sha1:89a2ff66d840cad007b83c123d2a4194e2491d66
+ pristine_git_object: ea4cec9c513bb1bb7242cf23b4751735a818d54d
src/main/java/com/gusto/embedded_api/models/operations/BatchAction.java:
id: 4702cc4e20de
last_write_checksum: sha1:1bf1256ff0509c03b28bdc0ea7ef6acaae81ed41
@@ -9623,12 +10196,12 @@ trackedFiles:
pristine_git_object: 4c5b0f8cafe2bba5d3167ffda57554c31e9087d3
src/main/java/com/gusto/embedded_api/models/operations/Compensation.java:
id: a97e31f8912a
- last_write_checksum: sha1:61a1249b92c2fb938217cbc5d33d58f271b26750
- pristine_git_object: 4fccf7593fe9892aa92f51b5770576b65a91921d
+ last_write_checksum: sha1:10ef761c3f895d4b76089b0b2e28cbee0909718b
+ pristine_git_object: 3e14a4f89bb0d5b2c9ea6d50fff4bef374678da4
src/main/java/com/gusto/embedded_api/models/operations/ContractorPayments.java:
id: 90ff4dee1570
- last_write_checksum: sha1:aeaf11ed14ed0a7aaafc5005abcf941f3114f872
- pristine_git_object: e8b7945f0003c6ca9f0e8a94f613b5e8880546b9
+ last_write_checksum: sha1:9d62a11e667c36ca9522e9fa7815e876b748d7a4
+ pristine_git_object: daad3e16d104f13f6a9dfa73272f65b426e0991e
src/main/java/com/gusto/embedded_api/models/operations/Contractors.java:
id: bec9f65a3802
last_write_checksum: sha1:7ac150a322f853cb9bd5c2b6b1bee13214691630
@@ -9663,24 +10236,28 @@ trackedFiles:
pristine_git_object: 3653c7a8bfed23a66b2259754eeb9423e0a82dac
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyIdBankAccountsBankAccountIdRequest.java:
id: e91492261719
- last_write_checksum: sha1:569cc5d82410fcf97830ebab743a60770640a0cb
- pristine_git_object: dd0d17b95d3ad09259a7bf271fd08f9703d2a5d5
+ last_write_checksum: sha1:fa68f83910d63111857abdd9e1b59120d961483f
+ pristine_git_object: 2f4b085e6e1cd3b17b60dc5f368547b179743ac3
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyIdBankAccountsBankAccountIdRequestBuilder.java:
id: 04979bbc08a0
- last_write_checksum: sha1:8446ad3d81c478125573a669396ad82acbd8ae88
- pristine_git_object: 6f06bc30ede990e718b592bc1a4f2e4e926e0503
+ last_write_checksum: sha1:dec12047a2e538579785c7f2f7db7fec6d7c2c06
+ pristine_git_object: 793a485e11807a04dfdc9cda983aa22847e24466
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyIdBankAccountsBankAccountIdResponse.java:
id: 8c63365b594f
last_write_checksum: sha1:25fc4ecc1d9037a16a1876350914fe8921284101
pristine_git_object: 64a1a92661c806e3159d60b98d32b9834a7523c6
+ ? src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyIdContractorPaymentContractorPaymentHeaderXGustoAPIVersion.java
+ : id: 257a296fadb9
+ last_write_checksum: sha1:0bbab355de2a28ec22a9c4160ab89dad0c3f5581
+ pristine_git_object: be477b342f31524b3354ea4d9c25bf744146a0ed
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyIdContractorPaymentContractorPaymentRequest.java:
id: 542eb2a6b535
- last_write_checksum: sha1:9ca0d8929c13ffd12531b1fd4f89c01d07fa18ae
- pristine_git_object: bff8fbfa822a48c5df46aeb43e0e59d57909ef67
+ last_write_checksum: sha1:a5fb67d6dca78eb68b3c87aea1815f58926cf773
+ pristine_git_object: 4931fd2d1ccbcc21a86a5f02798cbd73d019bef3
? src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyIdContractorPaymentContractorPaymentRequestBuilder.java
: id: 4a641dbd727f
- last_write_checksum: sha1:c84feb0d1216fc1d6f20c103bf98fe2debb9e4f8
- pristine_git_object: 4793da5a1949857fac0e19c9530af7330206f88e
+ last_write_checksum: sha1:c540bff71b70cdd206997183a15315e2841dde6f
+ pristine_git_object: 205b004be555fc4cb3d9e48b67d98353bd7a0a08
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyIdContractorPaymentContractorPaymentResponse.java:
id: 757008ee5891
last_write_checksum: sha1:08f6c1932aa8eb8ca978ba514bc344aaa6373d63
@@ -9715,28 +10292,32 @@ trackedFiles:
pristine_git_object: a50bc8c438972bbbdf946e57ea52169c624f49d8
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyUuidHolidayPayPolicyHeaderXGustoAPIVersion.java:
id: ca1d904fd97d
- last_write_checksum: sha1:29c8a2d3c128ff234befac5a41b2b8ec1ec0a0fd
- pristine_git_object: 0e08a7a19658feaed54cb42a384d6538695cc940
+ last_write_checksum: sha1:e559cf156ce771be51500b456e8dd48382f7db2a
+ pristine_git_object: 7e1d700fa6734e32b0adf68538d84dd6013508c2
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyUuidHolidayPayPolicyRequest.java:
id: 6f7bfde4a218
- last_write_checksum: sha1:211ea144ce02443e477ea7f08654cc17c88cb012
- pristine_git_object: 94fb46dff904b40b2d31a002f35535301072ec87
+ last_write_checksum: sha1:eb3e4ecad2c4580f760e5d61a5496290afb1506e
+ pristine_git_object: eb9c00b4eb3adc3342d8934b6575554c7e25f96d
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyUuidHolidayPayPolicyRequestBuilder.java:
id: 6ccd70bc63e5
- last_write_checksum: sha1:824c75e69e53462ab3e9f58b372cf0ef9a2b77e4
- pristine_git_object: 16a5880102710a308e278a544c562818249fc3c0
+ last_write_checksum: sha1:ba5a09f7a834d87e3e025aa9c855cb2eb30b1353
+ pristine_git_object: 890ebe996d632c1b5aec53ace564e6b3c8a68d93
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyUuidHolidayPayPolicyResponse.java:
id: c7d383dc7515
last_write_checksum: sha1:4aca2c05700b87f20113e8807d409e2244544074
pristine_git_object: 7d6c2be14ae2217951ecb3fc41f76739a0849281
+ ? src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyUuidSignatoriesSignatoryUuidHeaderXGustoAPIVersion.java
+ : id: ecc8463e8e73
+ last_write_checksum: sha1:1f1eb34c9a8a6310fbbcd6c644fa4b54b9f9214a
+ pristine_git_object: f00604131148aef5383db70b186416bb166d5810
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyUuidSignatoriesSignatoryUuidRequest.java:
id: b30a0db78527
- last_write_checksum: sha1:d77ba1a0bb7f3ddfc457433a015296d754a3d78c
- pristine_git_object: 7553a191cce6e236406a1f91e9da4d35156d07d0
+ last_write_checksum: sha1:d60c81a70cab9cf0fc8b2e57ab6fe702169c93ea
+ pristine_git_object: bec877d9758bf52b1565de9cf756205a80c4b968
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyUuidSignatoriesSignatoryUuidRequestBuilder.java:
id: 4e2cf7404cfd
- last_write_checksum: sha1:fae80eced6bbab4ec40a6137bf9d41635965e674
- pristine_git_object: cbc7119d0bcf5a91c9789ce3161f606cdc653c79
+ last_write_checksum: sha1:7ca5ed4ee6b405f8fceed0fd2329efd430bd08e0
+ pristine_git_object: 7fc3930f49e075ee6679e438ac60865bb800ac2e
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompaniesCompanyUuidSignatoriesSignatoryUuidResponse.java:
id: ecdf5289a1a0
last_write_checksum: sha1:f7f6e8d600163c77a405565ad3a3206d23ad246a
@@ -9753,14 +10334,18 @@ trackedFiles:
id: 0b6b66c71130
last_write_checksum: sha1:a928a438dabac7c10e9a3e1a69cd9618d614ce3d
pristine_git_object: 4a98c83223c57778918d050b9ed10d4066a9ef58
+ src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompensationsCompensationIdHeaderXGustoAPIVersion.java:
+ id: 25f5d3191bd8
+ last_write_checksum: sha1:d5fa84169e8c9537f217ce61b86b485218c1e3ff
+ pristine_git_object: 5dda3a44de6d4a855a41ccf8273c71357e7b7fa3
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompensationsCompensationIdRequest.java:
id: b62179d0a219
- last_write_checksum: sha1:0abafff68300dbc11b4a165f69f7904031bb012a
- pristine_git_object: adf1c0502141347b3b38638896eeb01fcca743dd
+ last_write_checksum: sha1:b2d3d50dcd5e2d78cf9d020e2f70e64700d14702
+ pristine_git_object: 9e5457fea2d5917d5272d6719ddf73f1f0d587e0
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompensationsCompensationIdRequestBuilder.java:
id: 6caf5cc83c5d
- last_write_checksum: sha1:cd541e32c8b7fac4503bed002aa644dcc0d16354
- pristine_git_object: f0514e3d54079e9dc66a31533b1290eaeca8c30d
+ last_write_checksum: sha1:be4180308e32753e6afe04f361f5cae7195fb9c4
+ pristine_git_object: de9853f2ac204ed13e397125ac3e84582946364c
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1CompensationsCompensationIdResponse.java:
id: 864d54169f90
last_write_checksum: sha1:3d3909b1a9cab0e6f3802e7a282f2a6e403d9317
@@ -9781,14 +10366,18 @@ trackedFiles:
id: a96ae19da974
last_write_checksum: sha1:69ca46ee4c5055e20e3f9179fb02fc8dfbc684d7
pristine_git_object: d075dcb471348bc6f6b1845902ff2ee132be72a2
+ src/main/java/com/gusto/embedded_api/models/operations/DeleteV1ContractorsContractorUuidHeaderXGustoAPIVersion.java:
+ id: 7e9c00654467
+ last_write_checksum: sha1:e1116dc121587e49dd26626ffb7985588aa82a7a
+ pristine_git_object: 6f3139fc182e125cd3d46480696d277c8c90f1ff
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1ContractorsContractorUuidRequest.java:
id: bc3e033e7157
- last_write_checksum: sha1:979cd5cfaec8fba50ba1aa396ce52e4aa5ffb1bd
- pristine_git_object: 5c6cfdb719976bf50223dcb245a110643d7f2ec1
+ last_write_checksum: sha1:ceb11038694146fae6d780b859b1aacbbe22abd0
+ pristine_git_object: 8e8024b87121dc301efd8ad7552b2052265ac9db
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1ContractorsContractorUuidRequestBuilder.java:
id: 43013c9c6045
- last_write_checksum: sha1:0441ae005c3efccb93b62cc408ccc30f5a686a88
- pristine_git_object: 6589b11d1f6a053cf354f5ed80b5d1845f211ab0
+ last_write_checksum: sha1:53cad022eb1941a329b9300d37f0eb779303df3c
+ pristine_git_object: bf2b327c45c90ed5361cd3389b4e7f60538e8536
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1ContractorsContractorUuidResponse.java:
id: 6311822fd015
last_write_checksum: sha1:e23cae5dcf521d3e7a1eea6050963f9129747668
@@ -9833,14 +10422,18 @@ trackedFiles:
id: cc29dfd89dd4
last_write_checksum: sha1:356343d51c171a4a9529f4c000ae691bf0c00371
pristine_git_object: 42de8dd80e6a2113c9be23cebef6c57833835914
+ ? src/main/java/com/gusto/embedded_api/models/operations/DeleteV1EmployeesEmployeeIdI9AuthorizationDocumentsDocumentIdHeaderXGustoAPIVersion.java
+ : id: 6a36d1614f64
+ last_write_checksum: sha1:98d4ec7d40e6f0a31b83626ead6372e887884dc2
+ pristine_git_object: 01d1cba7f3674ecad8c687a94ddab384a7d23c86
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1EmployeesEmployeeIdI9AuthorizationDocumentsDocumentIdRequest.java:
id: 6a564dacdede
- last_write_checksum: sha1:5ec4712495b200571eaf998f3b49d27be9ca3515
- pristine_git_object: d28e3adfae616505cd35e3a9604b2ab08f4123f0
+ last_write_checksum: sha1:fbf513c6df38b1628dda7884d935fe34f792970a
+ pristine_git_object: da326ce926e180230d53e60dc995cfc4674f80f8
? src/main/java/com/gusto/embedded_api/models/operations/DeleteV1EmployeesEmployeeIdI9AuthorizationDocumentsDocumentIdRequestBuilder.java
: id: 54b1e773bc48
- last_write_checksum: sha1:2d8e2bcb8aa6a82218c8549ff84787064770298b
- pristine_git_object: 60f846365b768f86b371dd316f381617bf56153c
+ last_write_checksum: sha1:ac3752e14f18521e6a90ad12e8475ac2e8b1e38f
+ pristine_git_object: 7a1bbb0fde8fdf245d0aea1638a1776f928fce11
? src/main/java/com/gusto/embedded_api/models/operations/DeleteV1EmployeesEmployeeIdI9AuthorizationDocumentsDocumentIdResponse.java
: id: a2cd41f95891
last_write_checksum: sha1:d66ed594ff16f9238a65fd3a7bcecf61bf7a85ce
@@ -9911,16 +10504,16 @@ trackedFiles:
pristine_git_object: 4cb978eb1ec4877c95a5cbb35b1264b442c89929
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1RecurringReimbursementsHeaderXGustoAPIVersion.java:
id: f603ca8b66ab
- last_write_checksum: sha1:dbd338d65cf36dac9160aff9a097f89b860b3492
- pristine_git_object: 7a14b3b17f6226d4c93a74f801424356e3f61ce9
+ last_write_checksum: sha1:c5debe0df5e41cfb036dbbb09bd42b105395649f
+ pristine_git_object: 760a83765444464f6af1b56b6c2b937a3dfb9653
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1RecurringReimbursementsRequest.java:
id: b6918005777d
- last_write_checksum: sha1:7683cc6dbda5cfdb4173f5a9d90892156e0524dd
- pristine_git_object: 49bf2b38fdb4de66976d95150193c74623f2935c
+ last_write_checksum: sha1:14e1db1dde12cf546a982867d6310876b0a0fc20
+ pristine_git_object: 09440bacb460275d2cf12b9c2760fe48a050e8ac
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1RecurringReimbursementsRequestBuilder.java:
id: 679c9284236d
- last_write_checksum: sha1:a1a7933cb2762a151d46ed2267543563feed8007
- pristine_git_object: 068d957e6189f7965e86901bfc39f9bbd18072e1
+ last_write_checksum: sha1:a7947c13b648645284ea80a96ff600cf05d60659
+ pristine_git_object: 36f4df62b3dd7c5541c6bf668903f9a56b8319c6
src/main/java/com/gusto/embedded_api/models/operations/DeleteV1RecurringReimbursementsResponse.java:
id: b786c65784fe
last_write_checksum: sha1:d2d264f22ccdfb2c6502cfd3f940aaee0090d075
@@ -9969,14 +10562,6 @@ trackedFiles:
id: c4d2446fdc1f
last_write_checksum: sha1:14b7331ff22ce83af8308ccc78a1018383e99fed
pristine_git_object: 4efb0b6c55f551af633b182c00b1c78010ca1853
- src/main/java/com/gusto/embedded_api/models/operations/DocumentType.java:
- id: ab210364829b
- last_write_checksum: sha1:c40ed13ddc24357312da3b7cd70b0f1398d6ba1d
- pristine_git_object: 75e95e30f18ada094f4c2854d82a49072bea2c37
- src/main/java/com/gusto/embedded_api/models/operations/Documents.java:
- id: 7f8ef595ba83
- last_write_checksum: sha1:90a3634284909cd0285f5c708e1a4dc2486ae4cf
- pristine_git_object: 0ffb219b17e8c74d66a12bd1388f01abd963d7f0
src/main/java/com/gusto/embedded_api/models/operations/EarningType.java:
id: 2615947da87f
last_write_checksum: sha1:8bf270516e1fa62b553bcc6a6daf206809283c85
@@ -10003,16 +10588,12 @@ trackedFiles:
pristine_git_object: ce9b04cf66dc20f6905e9c13687b6139d8346494
src/main/java/com/gusto/embedded_api/models/operations/EntityType.java:
id: 392f01a2e357
- last_write_checksum: sha1:16a36071c7217e7b7fa8b63783c4d213a242b3c8
- pristine_git_object: 6426443b153c60f60bb44e74a4584cefd428a1ae
+ last_write_checksum: sha1:cee01ed1e0925fa8948ec5604144ff3239e46d4d
+ pristine_git_object: f36fc9987b0a6bf2000ff6e16cb81e9e60703905
src/main/java/com/gusto/embedded_api/models/operations/Errors.java:
id: 1755b59056ab
- last_write_checksum: sha1:b8641cf7ac62937076d5a53f648f69b5e1b30b9d
- pristine_git_object: c2d91bfcf12bfaf119fd0374965fe9265d2e6fb5
- src/main/java/com/gusto/embedded_api/models/operations/Exclusions.java:
- id: a7510c07e075
- last_write_checksum: sha1:b224c7403516b7cd7d27fd684d649a13d9f9f670
- pristine_git_object: 7f0829323bf640181a788afc7ce109d881c82a75
+ last_write_checksum: sha1:be869126f02f916041bebffec2ba3d6b349de437
+ pristine_git_object: 9c61d7c95c00028ac72802f78077352eb265e5a3
src/main/java/com/gusto/embedded_api/models/operations/ExperienceLevel.java:
id: 624d9bfb4c60
last_write_checksum: sha1:ef419d948f6c9611636a585f544310582be98f3a
@@ -10037,14 +10618,18 @@ trackedFiles:
id: 1f87c0614753
last_write_checksum: sha1:372de1343888cd74d4be41f30af794f982cebc97
pristine_git_object: 998c479a8d32d11055bd982f59dccef19ae08178
+ src/main/java/com/gusto/embedded_api/models/operations/FilingStatus.java:
+ id: 8c34a7fdbe07
+ last_write_checksum: sha1:286cd98c0856b9922fa13e46417f9494293173d0
+ pristine_git_object: 03408801ba69547fde91af785feee2a9db70c88b
src/main/java/com/gusto/embedded_api/models/operations/FlsaStatus.java:
id: 4c3c79e88a4f
last_write_checksum: sha1:085d9c8150b5aedaa5d68e00466848c5d9447aea
pristine_git_object: 61c4a388879e239c67f633ea5e635248ec579665
src/main/java/com/gusto/embedded_api/models/operations/Frequency.java:
id: 5aaba13f60e9
- last_write_checksum: sha1:fd70501726cd55d45c7c3c9dd6fbe372c5e25ab5
- pristine_git_object: 3696ef790fe6c92acbbf29512e542edc7ce475f4
+ last_write_checksum: sha1:b2fccd3b1968caf137b299a3809846b55dc89833
+ pristine_git_object: 9b1f70895671ef321de527b0ccd08ad93e640303
src/main/java/com/gusto/embedded_api/models/operations/GarnishmentType.java:
id: 9e3cb6da4bfd
last_write_checksum: sha1:f8a150602753d6e304d483114418d0d528c34fba
@@ -10193,18 +10778,22 @@ trackedFiles:
id: adad750ac1bc
last_write_checksum: sha1:38ab94fe43d1745fc44ec0ea1aa0d650f073e2c6
pristine_git_object: 58077bf24c7bc6d125bc62f1364dc049cafd89fd
+ src/main/java/com/gusto/embedded_api/models/operations/GetEventsHeaderXGustoAPIVersion.java:
+ id: d299145fed3b
+ last_write_checksum: sha1:02c60fc87a25dbdc22f9f110a8c53067e09a0408
+ pristine_git_object: c369cb1f35cfac09d0e62c08fc0702ac63f8a687
src/main/java/com/gusto/embedded_api/models/operations/GetEventsRequest.java:
id: fa8fee744dd9
- last_write_checksum: sha1:ebb83ea6cfb8d60097d9605038974948cf8ae201
- pristine_git_object: f89ea37f48dec8181cb8685dc4159ffe3b52a783
+ last_write_checksum: sha1:a04571cccb44a3fbbb47c8ce509705a599adec11
+ pristine_git_object: 31f7695fba0e449cf95a9b8b8675f9f3535bba6e
src/main/java/com/gusto/embedded_api/models/operations/GetEventsRequestBuilder.java:
id: 6a79fe3f7087
last_write_checksum: sha1:1300f4e9f4687acaeef957af0b480e48beb20959
pristine_git_object: 9a37145e1ccd5e7e09f68879c4888beb987ae115
src/main/java/com/gusto/embedded_api/models/operations/GetEventsResponse.java:
id: 29d5bcf3f506
- last_write_checksum: sha1:91ba1742a4631e812a9286935fff51cdf2fc9a1f
- pristine_git_object: b3e0845a95ed38f7f4b8e0b2753754818e607d70
+ last_write_checksum: sha1:41737c0bd6309313f03222ee97a5da3a196e4cb2
+ pristine_git_object: 7c380244419d1d395efcba891a7ff73e657091d1
src/main/java/com/gusto/embedded_api/models/operations/GetEventsSecurity.java:
id: 6bceb5caa9e3
last_write_checksum: sha1:3b9adc08065dc4972d8b87c8ba82e1265fd091da
@@ -10379,12 +10968,12 @@ trackedFiles:
pristine_git_object: 748e01f47063a322268c097caec23fd103d6fa48
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdBankAccountsRequest.java:
id: 4f5e4e5f95c8
- last_write_checksum: sha1:c3ea9d75fcac6ece2a2315af89cdcac10bd86e18
- pristine_git_object: 1662f4d5af7b603b43ebd7d8246542f42e1b4a12
+ last_write_checksum: sha1:265cebb1450eaaa5f33232d4716ddfc1e57c738e
+ pristine_git_object: 1551011ba9e885edf23a1184333e1dd4cc870bb8
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdBankAccountsRequestBuilder.java:
id: 542fa2ccc942
- last_write_checksum: sha1:4c8064d3edde8da244d85e645f9edadb18aa5ad9
- pristine_git_object: 1f304ae402db7c126dda20629e2eec4660cd59ba
+ last_write_checksum: sha1:3066095a351c75ce90e7edb058c20ca114d80920
+ pristine_git_object: d10d167357ab4336edc027e096e37bdb3ba7dc93
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdBankAccountsResponse.java:
id: 6d44a0bb4a1c
last_write_checksum: sha1:2bcfda913181f01821c3bb1f0269f7145b6daa5c
@@ -10401,18 +10990,22 @@ trackedFiles:
id: 66b8059da9a2
last_write_checksum: sha1:60aaafe0c8594c27d97b19a131629ecdea0ea568
pristine_git_object: c1c7c2282ee3cd4aec418164b9578b8b018a2a19
+ ? src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdContractorPaymentContractorPaymentHeaderXGustoAPIVersion.java
+ : id: 1a4803eac354
+ last_write_checksum: sha1:eb83fecf8af6927ede4f9651c1dd9f15fcd0d3f0
+ pristine_git_object: 55d7a5906ee6db19fd7b0c0d44fecb97f685faf1
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdContractorPaymentContractorPaymentRequest.java:
id: c8b4333f58b3
- last_write_checksum: sha1:75ba291b7db91fde109a7881f29dbed8beacfb59
- pristine_git_object: d091640fddfff172edf5f4d2e0a9fef04424000e
+ last_write_checksum: sha1:c984d22bdc0096b0f5e65e5cb669b6fb695a9c08
+ pristine_git_object: fb04d6289acfdb05ad60509537db600097e6e40e
? src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdContractorPaymentContractorPaymentRequestBuilder.java
: id: fdab8d6c26b9
- last_write_checksum: sha1:3efd695f2c9909069169b6fa3e0ba55ead7e8ebf
- pristine_git_object: e72491c1a2dd924b0e4a0521145e5fd63c1e64e3
+ last_write_checksum: sha1:a11bf0410132fc090def498c3ba703abbe0824fa
+ pristine_git_object: ef96d37cc553b1d9a5586f91f3691d0f65a529e1
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdContractorPaymentContractorPaymentResponse.java:
id: c711cb52672d
- last_write_checksum: sha1:f1e8b7a61b9430e1963487cc1121671dcfa1e2dc
- pristine_git_object: 32f4af70566e07550dff5f66e5a4339997189521
+ last_write_checksum: sha1:46d40a9a7d18f0fa22db153c9ecf76171bd0ffeb
+ pristine_git_object: 89928c9b0b8797963b8aca389dfa07ad27888a73
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdContractorPaymentGroupsHeaderXGustoAPIVersion.java:
id: 7015f08790db
last_write_checksum: sha1:458cc60049a57ecccee8d857bcd07f216ae908d1
@@ -10429,10 +11022,14 @@ trackedFiles:
id: b567f667f074
last_write_checksum: sha1:4fa9787da8d18fe02356fc6220a2b45dd131a5d8
pristine_git_object: 614d52b4db0cccde6491680aae0966395c0699d9
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdContractorPaymentsHeaderXGustoAPIVersion.java:
+ id: d5f0f6c3df23
+ last_write_checksum: sha1:719ba4a0f764474a48ee5682caac4c513868c6b5
+ pristine_git_object: d715f9b41017c6c0391d34d02e3373cc04036ca3
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdContractorPaymentsRequest.java:
id: 05854ab64930
- last_write_checksum: sha1:6415b014f2eea4fa7e495f2cbe6951ccd15226ed
- pristine_git_object: 849a5e33cd46dd99f561849a077a9f21432c0aaa
+ last_write_checksum: sha1:3d89661c21e403b14868651beff60c983d119fd0
+ pristine_git_object: efab440ace82723c2a196e261252e4166f002e2e
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdContractorPaymentsRequestBuilder.java:
id: 46857bcb6fb9
last_write_checksum: sha1:7cb8b2f0b4a4ef9bc5f2ca84b148803ffc41c356
@@ -10525,30 +11122,38 @@ trackedFiles:
id: a80b355a286c
last_write_checksum: sha1:1b05d7e23ef0d42da88028e8c576835ee72368c5
pristine_git_object: 7bb5d451b52483fa62b8cee31d9494f392326455
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdLocationsHeaderXGustoAPIVersion.java:
+ id: a50b39331f93
+ last_write_checksum: sha1:ed344a158b62b59ecbec4194606d7ae293543111
+ pristine_git_object: 84575683e2127d3404dec9e2c930f90a77e49044
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdLocationsRequest.java:
id: 8fd7b872839d
- last_write_checksum: sha1:25c9de162cd52db48964df334ad8b47d155e549f
- pristine_git_object: cf102e1ed88075b8e4267663e5b6615d7ae6e079
+ last_write_checksum: sha1:0ece9994080b1ce604ba4039caf802bc6170ffbc
+ pristine_git_object: ae7ed0f8cb1eff62bf2965e02bb25d2d739d4bd8
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdLocationsRequestBuilder.java:
id: b91190de7fb6
- last_write_checksum: sha1:71072f41058f67ad0a8308f6c654918479e09fde
- pristine_git_object: 4bdda527d3b3fc868cf15775069707ec0d71289a
+ last_write_checksum: sha1:767cc44e366b1375f6ffcb7dc7c6bd531f1fd17f
+ pristine_git_object: 00d264ab8feaef5610cec35f6c501578b5089c7b
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdLocationsResponse.java:
id: 06ef9d11b626
- last_write_checksum: sha1:08b472bc691b119503f7029917e77959e8c3c3c6
- pristine_git_object: e57ee6415a902d904112d5f83fee03725151dfd8
+ last_write_checksum: sha1:54afc46a8446d4becc46d3489b0afad4dee9e46f
+ pristine_git_object: 87a5483dd897ba729cebe1df268e520a955c7b5d
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPayPeriodsHeaderXGustoAPIVersion.java:
+ id: e4dcb247fc9f
+ last_write_checksum: sha1:98d7f1b115c426482b77b4e04ceea67260193e71
+ pristine_git_object: 25046544bf7993ed3665a34a4107bcfe698949f3
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPayPeriodsRequest.java:
id: 50b27f759cf5
- last_write_checksum: sha1:642f217c83392f129bacaba184b7e54185a54d00
- pristine_git_object: 5ccb2e7f6c14d316c005034d9dfda650073f2374
+ last_write_checksum: sha1:a85d6477559fffc128cb71d55b0ac7cdae885af2
+ pristine_git_object: 1dc46f745cfceb0f2c8c37bd0f9ce28a748b2b40
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPayPeriodsRequestBuilder.java:
id: 444b1fb2d7f5
last_write_checksum: sha1:505663727d3b5a5ab2c6d44f03b007cee3e1108e
pristine_git_object: 72b0fb2163d789dfed128ecc36f4fba41e0bce59
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPayPeriodsResponse.java:
id: 4a35095de587
- last_write_checksum: sha1:8bfe4385f51259e81ad58a5021cba17018c58967
- pristine_git_object: 67cc6b7aa733a1551e5974dbe8ae776f35dc075d
+ last_write_checksum: sha1:d77fbc6d880bdaca00f836b63edb587856402872
+ pristine_git_object: 05b6e7568e71e3f0e37428840495587fa612b9a5
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesAssignmentsRequest.java:
id: 397318a0902c
last_write_checksum: sha1:d07e70538ef71615bc191b2005d21f06d3054e11
@@ -10561,46 +11166,54 @@ trackedFiles:
id: f496ebe26524
last_write_checksum: sha1:485fc958eb217949eb0876a6f925526c2a40bfd6
pristine_git_object: be5b61ec2fedefbc32d88005a6b2aa8483534c85
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesHeaderXGustoAPIVersion.java:
+ id: fd81e8937453
+ last_write_checksum: sha1:9ca384032956b5653f1ad36ec3d62d24dc54c084
+ pristine_git_object: 927df1aecc1740b2506e8b46f33a8a2f09b06884
+ ? src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesPayScheduleIdHeaderXGustoAPIVersion.java
+ : id: 19b2eeb3e5c8
+ last_write_checksum: sha1:96e76b73f7a3509cf341f0b1c65772c6c96ab33a
+ pristine_git_object: fa3eb5b89da5e63842ac063295edc1d9a85e3516
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesPayScheduleIdRequest.java:
id: 6ec6747c4846
- last_write_checksum: sha1:1fb1ca96099d11b2a8a545fea3b5396e11e4b5cb
- pristine_git_object: 4c8937f4181e735b986e0b348cf37643905355a9
+ last_write_checksum: sha1:6fb92ef20889a2c027f730e017e2a95cba8975bf
+ pristine_git_object: 05eb721b606f6d5d7eac4ae5a99933c86d170f88
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesPayScheduleIdRequestBuilder.java:
id: 024ee078c1ff
- last_write_checksum: sha1:ca43b4f6937447c8f4615993d8cfa48eb3fb3225
- pristine_git_object: 8f2ab43f5f41a44a9365575ee1452bee9b9aa2f9
+ last_write_checksum: sha1:41ef8f85ef8c6dd68072002cfa31521a3457a5d6
+ pristine_git_object: f8ee44512888bd29d08544c946f461ccc9bc7e62
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesPayScheduleIdResponse.java:
id: 04d187ecab45
- last_write_checksum: sha1:3d32c1ebfc59e58b9fc5b73f8c09da894d99b96c
- pristine_git_object: af351bc893e62260446c3ce075c97afecb0ed65b
+ last_write_checksum: sha1:cb24fb4d69950b2ae4fea897a5ac3018ee3f1359
+ pristine_git_object: ba3c45bb11da6573b1338d449fda4a8215ad026f
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesPreviewHeaderXGustoAPIVersion.java:
+ id: 150ddfcdcaa1
+ last_write_checksum: sha1:b3a3f7c93a008c46a4127edb5d444f50fb6a1cca
+ pristine_git_object: 8e74f223fa7d0c050774f455014f533056bae098
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesPreviewRequest.java:
id: abcd13b01e0d
- last_write_checksum: sha1:f9a98b5be64698c5798adfcd3e45c624190147d1
- pristine_git_object: fe0455265b2fff3d9e72c9c25db9fbf77c65c9a2
+ last_write_checksum: sha1:e8341e9f2766306e9d9fb412c224667975d1e02e
+ pristine_git_object: 106758343904c8acd949d786ca7072d0a4ade517
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesPreviewRequestBuilder.java:
id: a608e1f44d5a
last_write_checksum: sha1:4e1139f6c2bf8eb6a11248db07320d0ed1430b10
pristine_git_object: c721b5dd892aedf21d1fc7294c1aff7ac185d1e4
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesPreviewResponse.java:
id: b8dbc7804800
- last_write_checksum: sha1:fc4fae8819ba010f89e3a7bfd86ad1cbe8b49de3
- pristine_git_object: 7b88173c9f293d219b25eabe12b1174cd3c09254
- src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesPreviewResponseBody.java:
- id: bc44f73e69ee
- last_write_checksum: sha1:c61eb7e7b19551d0c031823642863dd56c12345c
- pristine_git_object: 939b816fcfded1e1a8dbf7e58670845bad3c79c5
+ last_write_checksum: sha1:780bd185799ccb12cb3661b2e3a4f8fa5a3c6494
+ pristine_git_object: b2176dcb8d8d5c947cbcf03f613ae9c84048a22e
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesRequest.java:
id: 6f3625ab411c
- last_write_checksum: sha1:62c78da92d5adc494a1bcd5dba5597931bdc2536
- pristine_git_object: d562941fd4903af2dc057ffec507dfe5e0bf2215
+ last_write_checksum: sha1:5ec22a152fdf01576edd363072071ba7870ab8c0
+ pristine_git_object: 03b50de1d44d0406416c64ca6a009afd2257b1ef
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesRequestBuilder.java:
id: b7595322eccc
- last_write_checksum: sha1:04a7ea5ae9b85bd7d21da8f970013b5fc62e2237
- pristine_git_object: 009421c53657e8cc2e13c903897eeec21fa4fc7c
+ last_write_checksum: sha1:40a8d331cf6b4f3f435171397d3baccc844e986e
+ pristine_git_object: 280002eec3ff1105502956fd6757538f8ae9ce4b
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPaySchedulesResponse.java:
id: e62b3c28e691
- last_write_checksum: sha1:d963ef9fb0fe603d089737a1c47036ec7e869783
- pristine_git_object: cd844ff8d304d65c37161346180c58b91711f350
+ last_write_checksum: sha1:98b254e5313154b3786d5d01da8707fdb570c9a3
+ pristine_git_object: 182de01f5dae4983ea8154ffed0c00979c155b5f
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPayrollReversalsRequest.java:
id: 0155ccc410b3
last_write_checksum: sha1:5ac12c442242e515bbf7d1986c9aeb3603b91555
@@ -10659,16 +11272,16 @@ trackedFiles:
pristine_git_object: 5b5b1d9ec31669899e60fe90957af37d5e9744d4
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPayrollsRequest.java:
id: c6d3e166263c
- last_write_checksum: sha1:e7ed463d1245260199d4499145a10c469a849147
- pristine_git_object: d5fcb086d19d5d505d38a26d1764dcb616f52efc
+ last_write_checksum: sha1:1bf3b354e9a49a2713b1a59d05b63f1d34a7a0ae
+ pristine_git_object: 6ab6ddbe02c504c9ebbe497ea6b0509c66b0757b
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPayrollsRequestBuilder.java:
id: f7a93c34f5f1
last_write_checksum: sha1:bb64ef70c7bbec772049742104074cdeb04768e7
pristine_git_object: 8d1aec26c3313ccc3eb4e323282c9dafe1a342a7
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdPayrollsResponse.java:
id: aad01fbdb123
- last_write_checksum: sha1:278538d341c3467ee6ae05f062a3513ab8248ea0
- pristine_git_object: 9e1eb6770faf38b08ea45d7e8e2a9a04199c25c2
+ last_write_checksum: sha1:53054cea383e1d4cf9b49f2e3e694d600daa25b0
+ pristine_git_object: 823101c9cc8af27d7ef4eb817bb5b8647982ce8c
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyIdUnprocessedTerminationPayPeriodsRequest.java:
id: 7e722ff27ed0
last_write_checksum: sha1:301b3727fa4769b65be0a820990f61afb791a38e
@@ -10681,46 +11294,54 @@ trackedFiles:
id: 5fd1bc699230
last_write_checksum: sha1:17d15ffde24b77458d67812c428fc214a1c9e6f4
pristine_git_object: ac58ba9aec692237dfe8e7849a73d32dc663b81e
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidContractorsHeaderXGustoAPIVersion.java:
+ id: 4c77390ca9be
+ last_write_checksum: sha1:03780997ed3161328edeedad0cc91a62cef0d780
+ pristine_git_object: c0a4e750f24b36fbf3e93636566e369b35bed89d
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidContractorsRequest.java:
id: 0f8e215940e2
- last_write_checksum: sha1:b0f6d7b0e0888acc350d0525ea7c6624e40d2fb0
- pristine_git_object: 6f36af90a6e720e3af7dc62de3c8b0be35ce757e
+ last_write_checksum: sha1:6bda54fbbcced34e9157928a4450fb1206e494e4
+ pristine_git_object: 41b1466cf059f2914b3d58a71702fbcfad285a99
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidContractorsRequestBuilder.java:
id: 9f3c52bfa973
last_write_checksum: sha1:e077490a96afdae5b2b7deea4f665d7b9fe34d6a
pristine_git_object: cf8c9b1d09d646b7f8f989f3f1313472d8f083b3
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidContractorsResponse.java:
id: e7d5379c487f
- last_write_checksum: sha1:6c4c487493cb340dbc005d5e8379447e78d17ba3
- pristine_git_object: 8c163a5553a1420e4aa27182d01ca228ee196d17
+ last_write_checksum: sha1:21278408c39afe488cb5bb8c0d85b44825b5e069
+ pristine_git_object: 8f6c0c55b7dc618db84e1172ece9e723df1a00ae
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidHolidayPayPolicyHeaderXGustoAPIVersion.java:
id: fe6834774de3
- last_write_checksum: sha1:dc728c5733394d30be3962be97542eca600d0d15
- pristine_git_object: d332664f9c1e9168a49f2e5e0ab097c26818fe6f
+ last_write_checksum: sha1:8dbd6fd13a05e869b73b0f06fcafaedac95eb405
+ pristine_git_object: 7998b0f2ca5cf5616ca43ca4a63e7865bc335d64
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidHolidayPayPolicyRequest.java:
id: 6775d8f18096
- last_write_checksum: sha1:bab68acd7413446c7d224e163651f43252e0ea01
- pristine_git_object: 277d7bc0f83422ac36a2d9ca20dabb87d11adc1c
+ last_write_checksum: sha1:3a5e77be8af49a5a1c0608c4c6bbd3f4d6a79f05
+ pristine_git_object: e38809eb507f24072734596f684f0fc00f935b52
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidHolidayPayPolicyRequestBuilder.java:
id: 1342ee068012
- last_write_checksum: sha1:ac2be228531d264a0b66a97bb2c0c0116e7f312f
- pristine_git_object: 3170bc213f1fdfef35f3ff207b33fc0cd12c092e
+ last_write_checksum: sha1:a74dc911d2af543ccd45cc951a023b2ec12ac018
+ pristine_git_object: 8f3cb531524294e3ec023924244337ba8510352d
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidHolidayPayPolicyResponse.java:
id: 32a17c1d945c
last_write_checksum: sha1:aa1fe11bb9c3561d05b1a7fc234bf32656ae5be4
pristine_git_object: 79c4bd1ccbe941025ea9538dd18f708f1f14ff36
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidSignatoriesHeaderXGustoAPIVersion.java:
+ id: 381f704e7aeb
+ last_write_checksum: sha1:5f9edb6d5acea5d1faa0600df4980efa1eab72b8
+ pristine_git_object: 66f2e296632dead2ea7778dfd6f1cacf0fe272ef
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidSignatoriesRequest.java:
id: a4c5f9606999
- last_write_checksum: sha1:97384c6122c0fe76abadaf23e25edba875a2d933
- pristine_git_object: b69c1b286cc434446b4095389ec4e6be6162a858
+ last_write_checksum: sha1:4debeff1f0aabaf7ade7086d46f94da162f4d2db
+ pristine_git_object: 8525f28749dc1cf89a397007626b8459195143b2
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidSignatoriesRequestBuilder.java:
id: 36232d3c941e
- last_write_checksum: sha1:ea2a2970f9a47170680099a2a7731d3bedd44ad5
- pristine_git_object: 314589ce85459e978f180f2abcb2a17c274f5e63
+ last_write_checksum: sha1:38cc36df2336f97392cf6b5391c7667068508d47
+ pristine_git_object: 467d48778959603b9ae289346ccdd8fb9a8e1090
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidSignatoriesResponse.java:
id: b2a78487f89d
- last_write_checksum: sha1:fc265841a365860f6d7e7a52a8386cd0ef4f0559
- pristine_git_object: f53bdfffe4a48d62dabfe9398f98f9c2494af0ba
+ last_write_checksum: sha1:1958d2895d510cf544f3ea5ff4479aa7d7ee696e
+ pristine_git_object: 08b577137791c063bc2f51fb081da3d2af45191f
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidTaxRequirementsRequest.java:
id: 23fe42032b91
last_write_checksum: sha1:f9aa5637d36dc8e1aac87c266ec45f7ee6cfe78c
@@ -10747,44 +11368,52 @@ trackedFiles:
pristine_git_object: abdb4920a741280058a589138e9e3ce8a5dcd027
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidTimeOffPoliciesHeaderXGustoAPIVersion.java:
id: ca096dec5576
- last_write_checksum: sha1:8345a38bf17f9ef252a03dfa9f0e3d34b9b0f1e2
- pristine_git_object: c00d853bf39b238d1eea3f2d9b41e746e8512df6
+ last_write_checksum: sha1:f500a784186ba49a1aed23dfd8c68df568bbd7e9
+ pristine_git_object: c1ad0c12f4645a757b781a4e42db738f26d16ca6
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidTimeOffPoliciesRequest.java:
id: 69bad4968737
- last_write_checksum: sha1:dacc08e0fdfb5b50133966b8311c840a7089fbb7
- pristine_git_object: fc7c6751977c62be995cb3b3535783d0fc3e6def
+ last_write_checksum: sha1:c912c11b9072becf9f64804782d4af363e313bf9
+ pristine_git_object: 4c3b5d7eba58fac8738e7c4c5451d6f7c175956d
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidTimeOffPoliciesRequestBuilder.java:
id: 9837546a5843
- last_write_checksum: sha1:04a38177bce524f09c8886f9d5cc4fce8069c86a
- pristine_git_object: 4f86d659d62df2c78fa8866747512da640ba5019
+ last_write_checksum: sha1:cf2a4c2581bcc0f3e8ab5b6583f1fc4cf07cde31
+ pristine_git_object: 6d98c79dc96a2a37e4f27c471621c85bd6e7bd7d
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesCompanyUuidTimeOffPoliciesResponse.java:
id: fec2a48e65f6
last_write_checksum: sha1:f0d13b13ad9acc679e461d6c8086adab6fcdce1d
pristine_git_object: e5eb4d880369f9a995e2fdbbf2af38e55c680f9b
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesHeaderXGustoAPIVersion.java:
+ id: 6eb9de77a78a
+ last_write_checksum: sha1:fc4cd0d4b88bc60295086878b91177c1f45a17d4
+ pristine_git_object: 31a2b0871a4c424682f9953dc9f74067a4370a9e
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesPayrollBlockersCompanyUuidHeaderXGustoAPIVersion.java:
+ id: 34aacb737fdc
+ last_write_checksum: sha1:3946767210c52d6a2cec6ee0a26ec845f2e65898
+ pristine_git_object: ff58169ec1798147fa51a87d2a4308220e6e307f
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesPayrollBlockersCompanyUuidRequest.java:
id: 8ea6d894f1c7
- last_write_checksum: sha1:5c250abaf01a4b1bfd4b0b2e65d590e50929cf5b
- pristine_git_object: 99bbde35113f344a994857dec6be9a0187565786
+ last_write_checksum: sha1:382ca7a1a237d8298b9d7f9090e488c69a29f74c
+ pristine_git_object: 52f6cb5737d32cd1b0a5887305318ef0b419d43c
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesPayrollBlockersCompanyUuidRequestBuilder.java:
id: 973edccc0587
- last_write_checksum: sha1:1a572e15c3a6fee710994dcfb3975c7433050e21
- pristine_git_object: c277b89b126dcf986d00d91640a9b02590549c82
+ last_write_checksum: sha1:fb6409c3b999ad658a9ddb34648202b5769be496
+ pristine_git_object: 307eb82de1c05fe6d1481c51b25e4a36e59a3b9f
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesPayrollBlockersCompanyUuidResponse.java:
id: 69d3383edfa7
- last_write_checksum: sha1:04b3e2cf5cc9b8fc7f894d07d817c7f5a1dddf99
- pristine_git_object: a8288f8b44b16bb5b420f3142a84224a357955fb
+ last_write_checksum: sha1:eacb7662f4630bf4da0fae88a467ea8afd8221dc
+ pristine_git_object: bb3a8598b30be8a36dc6c5904298da09e2fe0612
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesRequest.java:
id: bcc8d0c3de4e
- last_write_checksum: sha1:70a6ab6b21f7534b6624546ab40194813716f6df
- pristine_git_object: edcd545d66ff878abc44714d54eafd41652c0a41
+ last_write_checksum: sha1:e8be9a9b5a981f944c118efc994baf24c9f375d2
+ pristine_git_object: 0d404e63fc8b5335a301327223f6a67d142dfe1e
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesRequestBuilder.java:
id: 377ffb36ee64
- last_write_checksum: sha1:3ba8c1d303b2ce8fe582e2eb8a79e48b937595f7
- pristine_git_object: f9680ff249de7a4f3c63fba9711e7e6b11b1d527
+ last_write_checksum: sha1:71ce9d11173dad0c5cfa0ede760fab9ffbb3e696
+ pristine_git_object: 39ade571de3ccb3e52fab5513317fedc6a61537a
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompaniesResponse.java:
id: 985ec066a3fd
- last_write_checksum: sha1:8da57318f094cacdb5bc8a864ea7d46af4be85e2
- pristine_git_object: 9a591a1028e1ba205b6e70e62190cb5a94486eb8
+ last_write_checksum: sha1:17533aa1faa0c0c0535f4a4aad6be160a8b5d902
+ pristine_git_object: 0d342ea011145b5284934b62692b24bda8f42156
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsRequest.java:
id: 46276368d82e
last_write_checksum: sha1:1ccc3f5959212a068682f8455a250da7f34d964f
@@ -10841,18 +11470,22 @@ trackedFiles:
id: 433d9a37071c
last_write_checksum: sha1:cdfc220f203313eaf4e750f65f37b6766913f6a8
pristine_git_object: 3982c017a271ceb68ddcc1d406eb016c6e552ec6
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyFinishOnboardingHeaderXGustoAPIVersion.java:
+ id: 6c7b92ec91e2
+ last_write_checksum: sha1:adad5069ff3b2384e701ff3c624e4a4cffe29b8a
+ pristine_git_object: dd6df96eb1ad3f58f3578186286c4e3d50ca7003
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyFinishOnboardingRequest.java:
id: d08b685baf51
- last_write_checksum: sha1:1993345b31486d01f8bf1863f69af86e6915bbe3
- pristine_git_object: 809fc7a773016856c95479c2cbf93c638363e70d
+ last_write_checksum: sha1:2a6d3f791e1d17695041fc6ec1285d33c2e225e7
+ pristine_git_object: a1dd3af3a1140c143be3e7a9112c0b6516468dc0
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyFinishOnboardingRequestBuilder.java:
id: 1c20caca2380
- last_write_checksum: sha1:0acceb24d242af2eae7018e3bb4fb2f0ee3fcac7
- pristine_git_object: 4524b454bbf32458719093ffc50f256b3eaa1220
+ last_write_checksum: sha1:6ab29e685e120e28475290ea034a41f3a35ad9e0
+ pristine_git_object: 16c9582f7f43fbd0569caf130ab8db890caf7985
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyFinishOnboardingResponse.java:
id: 3d11409972ef
- last_write_checksum: sha1:2c3821fd1a910969d5d32df12feab5792550aacd
- pristine_git_object: 89d57e06dc8b7ebc248bd1ba8cb5a1af07743d88
+ last_write_checksum: sha1:37a4e710c8e9a67a0d58a7f78460107a028463d1
+ pristine_git_object: 6130fbf20de4bf28832a0ecf5bb5ba13072c6a82
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyFormPdfRequest.java:
id: da94a626e92d
last_write_checksum: sha1:f41617799246ffb395fdd87e8c8508c9d6495b5d
@@ -10879,64 +11512,80 @@ trackedFiles:
pristine_git_object: b62bfdb196f50d797c08a162985c5ee01dd81f02
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyFormsRequest.java:
id: c076dacbd3b0
- last_write_checksum: sha1:f6ab108cf5d4b7a38373bc78e2ac53068a97b5eb
- pristine_git_object: 4c540ecba340c134e06226502f5c3da524789a88
+ last_write_checksum: sha1:4654b59370d10d96e5c2c4aae53258cc17aa0b2e
+ pristine_git_object: a1802614d868e472177fa589751b728f96a37125
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyFormsRequestBuilder.java:
id: 458d9c89bfbe
- last_write_checksum: sha1:ba5c64bdde820a1f70a3515b4af3dae026c95af0
- pristine_git_object: 3c22b99b3030c1cceab396b7ad1e81b3c61f0e37
+ last_write_checksum: sha1:874bae8b174d5b70dbdd316dc9557e6bb4a372a3
+ pristine_git_object: fb1d06dccbcdad366120dab2a030d5565fe61afe
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyFormsResponse.java:
id: f385d834d2ce
last_write_checksum: sha1:01abffe385a27df3e2cd7b2e39b97cd18b4eb903
pristine_git_object: 4d450093dac996bcbd6712362fe360a1607fd6f8
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyIndustryHeaderXGustoAPIVersion.java:
+ id: 6354a5dba837
+ last_write_checksum: sha1:e7111ec73a2ed0f2a9cafa504e0e4759258af2f6
+ pristine_git_object: f9a159a7caa69ddcaf22952406d813a52e372459
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyIndustryRequest.java:
id: 8d0b41a6ebdc
- last_write_checksum: sha1:35204dcba7a5990534ae3ce6d054a15bfb2502ca
- pristine_git_object: 2efade77184127761a55cbd2c620e2fac42b1104
+ last_write_checksum: sha1:66cfd987a2bcb9eccc14dff32006c1dd1388535a
+ pristine_git_object: 0ec154711d0c4ae7f80cdabb9c04c75cf2f73db0
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyIndustryRequestBuilder.java:
id: 9348736ca584
- last_write_checksum: sha1:5bbe17c2bcda990cfa66c8b036070d3e69f40c0e
- pristine_git_object: 56403ca65dce804b2449a076e9e1760e8424f42c
+ last_write_checksum: sha1:62ec92054218ecce900ed5133c8c3d07f3b8d03b
+ pristine_git_object: d0d0a26d6af8aed47fcd7423e98b768741840862
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyIndustryResponse.java:
id: 625ca5188031
- last_write_checksum: sha1:20c2ece264fe46a9077f12d417c3e8ba075b60a9
- pristine_git_object: ccd207474dba7c6c09dec837bce2da1d63322932
+ last_write_checksum: sha1:9cf0b3a962832888a1138445c95c3f39f6925217
+ pristine_git_object: d492fba7b94667d4b79b5bf58e4ac6e1250c5265
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyOnboardingStatusHeaderXGustoAPIVersion.java:
+ id: 6ddd75bc8925
+ last_write_checksum: sha1:99f433b855cb0ffd27bd74881954e7ac2bab68be
+ pristine_git_object: e51ef3513cc1f2649d17defc5d814c937239e173
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyOnboardingStatusRequest.java:
id: 2eed87bd4bc2
- last_write_checksum: sha1:8aaa9dfebd885cb6cc2a475900c215e98ce92eba
- pristine_git_object: bd7eebb1b9f82740cda24481dbddc8674ef05a1a
+ last_write_checksum: sha1:5f13d8e66b5a7702bd66e5512fa16f8b17974b38
+ pristine_git_object: 0b32b66847ed6f17cc49f91db49e87e7dd959f93
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyOnboardingStatusRequestBuilder.java:
id: ea49633520b6
- last_write_checksum: sha1:6d12f43dd577607d7cc9d09bbfdfffdd6e16af0b
- pristine_git_object: e99a1065df5b5f67be910fdd8b599a1c63dbbe7d
+ last_write_checksum: sha1:b81916db096027fc7ddbedfee6ecde8630b64b49
+ pristine_git_object: e9839f8771b684a4596c3026b764436c3d98174b
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyOnboardingStatusResponse.java:
id: d68a0967d748
- last_write_checksum: sha1:93dea544df8bfcf975dc3bf057441adbaa4258c6
- pristine_git_object: 2d1e3a73704145cfac74774dd4c8cb70bba24f0f
+ last_write_checksum: sha1:12fc53c1aad801377866e813c7e5a2167748dc4c
+ pristine_git_object: 010a0c7618f0519c46e4db9d13dac9200555153d
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyPaymentConfigsHeaderXGustoAPIVersion.java:
+ id: 40555f1f8494
+ last_write_checksum: sha1:31912bd9b53f77891eeebbe6c95ced9def71c568
+ pristine_git_object: 587ad407a38e2ac223c52ec9da2f98e99761a087
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyPaymentConfigsRequest.java:
id: 83ee4951f743
- last_write_checksum: sha1:29d531333f3b5afa6da6cf075aea16780301b9bf
- pristine_git_object: 5fd9d41fef17946c5851613696da3d57476616b6
+ last_write_checksum: sha1:cfc6725b9d7089ea7dbe814c50ec4f937db15b3a
+ pristine_git_object: ccb2befff1c5ea537f2cd35e3d5e26baee193c2a
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyPaymentConfigsRequestBuilder.java:
id: 30ed7da79274
- last_write_checksum: sha1:880bba607de6a3be42d25f81165958c4cc02f3c3
- pristine_git_object: 72c4f6828ee2eb68d60b0cf00534ed1328067a87
+ last_write_checksum: sha1:b703ed22d8660f89ef6607dbb0102f82721e548d
+ pristine_git_object: 6ea3cf00bd16d10b53329586f9359b6ec0a1ee2f
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompanyPaymentConfigsResponse.java:
id: 8f999bc343d3
- last_write_checksum: sha1:37b7be9c12b30641154468e4dd72081abefe0ad6
- pristine_git_object: ae1640dbe289e7329ed46ae6dc072314196a14b3
+ last_write_checksum: sha1:5d4e7f50583a09255106b106926aac04d1fa7c44
+ pristine_git_object: 6a14d814a4e238d980d6956dc88143e53367a9d5
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1CompensationsCompensationIdHeaderXGustoAPIVersion.java:
+ id: 69e9d394c7d7
+ last_write_checksum: sha1:cc750db45e049a22a73dec7fff05e24f535b5955
+ pristine_git_object: e6b52b094488a9679e44bfa303067080b002a1e8
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompensationsCompensationIdRequest.java:
id: 737cd5222e38
- last_write_checksum: sha1:bc57c165a61bc5452098de07154fd5f019d485fa
- pristine_git_object: c489991754ec6273ea23877ef10580f55e6538bf
+ last_write_checksum: sha1:0847d2921c623840259811681544b4b6bd2be4b3
+ pristine_git_object: 4cf4067ee98c32879215546930f96df214215c06
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompensationsCompensationIdRequestBuilder.java:
id: 25fbd2e95475
- last_write_checksum: sha1:906ff253db08201ca2429132dbc4176f5f2cea9e
- pristine_git_object: a05f4ca01bec83f2c58a7660ea22a8b3c582386b
+ last_write_checksum: sha1:2f1399e282e4dc0212a6b66afb027b7e2f4e1e25
+ pristine_git_object: 5b4af6903805caa469556d0ca3bfb7b9d3f7c1e8
src/main/java/com/gusto/embedded_api/models/operations/GetV1CompensationsCompensationIdResponse.java:
id: c1b68927ed59
- last_write_checksum: sha1:30b405b3514d2df1009541054f4d467f91032287
- pristine_git_object: ab2cb41549c5c1f6a08cec97a8b8f52a89528f35
+ last_write_checksum: sha1:2e0387bc582d074f81cee35f458de5fadf0de1d4
+ pristine_git_object: 3854955847bc8bbb897cf71c01ad2c728745849e
src/main/java/com/gusto/embedded_api/models/operations/GetV1ContractorDocumentPdfRequest.java:
id: 42c8efab625f
last_write_checksum: sha1:a95c44e8f373bda42c7b138635082105fe114eff
@@ -11089,6 +11738,10 @@ trackedFiles:
id: d4ce4e0c48b1
last_write_checksum: sha1:93777efac6586a19dc0d2f02a4545099bce964d6
pristine_git_object: 248788edb43ea0d3a9197ca5d2fc13241db03a5c
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1ContractorsContractorUuidHeaderXGustoAPIVersion.java:
+ id: 32eca9236ef9
+ last_write_checksum: sha1:fd3a32dc8df6e1d699318e2fb153ad9b1b73e565
+ pristine_git_object: 86bfe412cb5cdf08da2bd56483fca5cb683043cc
src/main/java/com/gusto/embedded_api/models/operations/GetV1ContractorsContractorUuidOnboardingStatusRequest.java:
id: addee1255ee5
last_write_checksum: sha1:8f4079def7e4702d8f2e75d89f200a56de71be0d
@@ -11115,16 +11768,16 @@ trackedFiles:
pristine_git_object: 9342d8fbe3a110850f388ed302c0fab1231ba2ec
src/main/java/com/gusto/embedded_api/models/operations/GetV1ContractorsContractorUuidRequest.java:
id: 8e0de08d3eda
- last_write_checksum: sha1:04668e92efb9f973572a4d465a96529be2068add
- pristine_git_object: 9e89ecacf68f2bf4e9f58a787d21f0d6c61a293c
+ last_write_checksum: sha1:e5f287c8e4d8b1cefb97f76c78ca4bbac09ed760
+ pristine_git_object: cbd31fec324d243ae72f3434cc9af697de261ae8
src/main/java/com/gusto/embedded_api/models/operations/GetV1ContractorsContractorUuidRequestBuilder.java:
id: cba76e7b2688
- last_write_checksum: sha1:867a51dcb8f6bb0cedd3b9f7bfc33656e437f1f5
- pristine_git_object: 78aa2a70cda5d5d3ce7569f001ac53a22bbd5052
+ last_write_checksum: sha1:0651f1a3d1610bb30025c5b05e5b6dee3f2a2119
+ pristine_git_object: 27053f7a07cd4b3a040f0de1fe6c2e572c68cf3f
src/main/java/com/gusto/embedded_api/models/operations/GetV1ContractorsContractorUuidResponse.java:
id: c4eb42f574bd
- last_write_checksum: sha1:d8b99a0f6e5e362d1aa7fc20ede0493fa273d1b1
- pristine_git_object: ab544268a364ec94d06996d0e4328506198d643d
+ last_write_checksum: sha1:f0501826abb710432aa790f35d878073c14b0d88
+ pristine_git_object: a4c06453815051a8b1f0b35b728833b81b889e55
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeeBenefitsEmployeeBenefitIdRequest.java:
id: 959bc094bf36
last_write_checksum: sha1:c5f866d1f6f051c080a7ab0e05482c9863a790a3
@@ -11233,18 +11886,22 @@ trackedFiles:
id: 914e1acb7665
last_write_checksum: sha1:96ff0c554bcbb764773417b5ff8e7ed84d3308f2
pristine_git_object: d7db461acc8693ff22f76ef48870434b46faeafc
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdFederalTaxesHeaderXGustoAPIVersion.java:
+ id: 4926ca59a856
+ last_write_checksum: sha1:d818f6098cf94468725e5c75cd786bc7676c670d
+ pristine_git_object: 1ef2563b11007cde75b2b324a85165505cb76575
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdFederalTaxesRequest.java:
id: d0ca5416bfc9
- last_write_checksum: sha1:95b4a2fc8926387d7de5eecc4c982b075e465854
- pristine_git_object: 10969563688107bc44668642fba8fdf46bf421e4
+ last_write_checksum: sha1:ab0f359b57f53dff28353817b18b60d9fd17678e
+ pristine_git_object: 59b65e8b275dd63d58b265f2ae1dde2f2d5ff4f3
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdFederalTaxesRequestBuilder.java:
id: c0cf91f048e6
- last_write_checksum: sha1:d6198a86c7d829a9be5b1cc9cd613da1c0a87a76
- pristine_git_object: fd75f931a7b2817813bce95ca1f7f4f870668462
+ last_write_checksum: sha1:00bb2a6b481baab2abd825e0e426b2079690184e
+ pristine_git_object: 9a329a8ea4b25316a873c1e9cbf1666237e620cc
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdFederalTaxesResponse.java:
id: ff2da09629f6
- last_write_checksum: sha1:830de89a46172504d02fadcc2fcf49edd3bb21ce
- pristine_git_object: ea775ef8d59cbc4eb3050ac3263aa2c0a802c6cb
+ last_write_checksum: sha1:e67e806bf9f877303c2f24b7dea347b3b06174f5
+ pristine_git_object: b9e594b33adf401c5fc22074dcb916bb1f66846c
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdGarnishmentsRequest.java:
id: f8c2ef318bad
last_write_checksum: sha1:43a9568084ad3400122d77e28d96bdb0f3d3b964
@@ -11273,42 +11930,54 @@ trackedFiles:
id: 939c0dcff053
last_write_checksum: sha1:ebebd4cc25b307dde7b8bd7c4f5f60570f4465a2
pristine_git_object: 37248b0f1dc6e93b0f982ff7b0848af7524cb7e6
+ ? src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentOptionsHeaderXGustoAPIVersion.java
+ : id: 787aaf95d129
+ last_write_checksum: sha1:c84f9eb78fb6364927b1e5d7ad1df2db2e427b0f
+ pristine_git_object: 7b8ea395548e31628f0837cb964e7d4fa112a7d1
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentOptionsRequest.java:
id: 47c6337b69f6
- last_write_checksum: sha1:40d17db75104e36c4e62759e19fb89d5c3b92d40
- pristine_git_object: 3dabe5fab489513c7fd053124113c60251fab656
+ last_write_checksum: sha1:ccbde132f5d0731e9493bb7b39b66c92fa6c012b
+ pristine_git_object: 56e55fb72b6ba5084c56f0827e1781f27e0a90dc
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentOptionsRequestBuilder.java:
id: 9794c09bbd68
- last_write_checksum: sha1:752f2c46b531a32993d16845ff53f08eb85b1c92
- pristine_git_object: 15e2746f0f94a9bdb3a29c11b2dbc18a6cdabc9e
+ last_write_checksum: sha1:fcf631726010e8269a9b02d2bb2248b9012f8fad
+ pristine_git_object: 0d115c20c56347edc9e91f060bd0c7f6b5b6fc70
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentOptionsResponse.java:
id: 3ee980f9f0e1
- last_write_checksum: sha1:083d5c283215a942ea3618ebf3d7cac048aa10c7
- pristine_git_object: 26144d52ddcc83c6711e0947108858381ca86702
+ last_write_checksum: sha1:2b059cd1fb58a29ae5920dab3d00b66d89485939
+ pristine_git_object: 7b52ccf31287a8ed07052720233acb740d21b6b0
+ ? src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentsHeaderXGustoAPIVersion.java
+ : id: 5109fa474e18
+ last_write_checksum: sha1:815787fa86a1815769f7576e2f3917f87d24ae0d
+ pristine_git_object: c5b04cdbb3cdd63c5e04ea45c2c37f6603f2f024
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentsRequest.java:
id: 2e6e9554515f
- last_write_checksum: sha1:27ef3a0bbe8790755b8538a78dafa5a7949418bd
- pristine_git_object: d26d4d1a8631c5e4fcb4c46908f7fac0f1191fbe
+ last_write_checksum: sha1:2a440955fb3852ee5b7ad2296a43627048f08557
+ pristine_git_object: b52266d8122abdb0cd71112649996b05e98425d8
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentsRequestBuilder.java:
id: abcd1f87ecc8
- last_write_checksum: sha1:17491b5a5c586a5726cfa8c10a3f8f37c48dc6fc
- pristine_git_object: c77408541dc11003eb3bd7fcf303a1d011502ef4
+ last_write_checksum: sha1:61a91c6fbb2159a08b6910861d24d03b08bf86c0
+ pristine_git_object: 88a5a6fcdfe53d511866254e6c7681fc8f982262
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentsResponse.java:
id: 8ee87772649b
- last_write_checksum: sha1:9e4f2270dfa344204c7cac963565fc8ea76ecfeb
- pristine_git_object: c24f01c6880c22cbd0f99d69ce07460ab814c826
+ last_write_checksum: sha1:0c96ece8fd06e87845c8f06276b2a746704ca439
+ pristine_git_object: 30244bf33cc136ed2126bfece539d8cb29a039ec
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationHeaderXGustoAPIVersion.java:
+ id: 3dfde1dc6933
+ last_write_checksum: sha1:6c7dc5298af47b4ef0526680d2378a86608fb877
+ pristine_git_object: 606763183e1331be7b6f2b839dbc13126f0f2942
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationRequest.java:
id: de872337ab17
- last_write_checksum: sha1:602cc302ccf2cad1a1fe9b8319f85c42a9a4f24e
- pristine_git_object: 72238122f427180ca695f6cfe9f0c7c2f8886ad9
+ last_write_checksum: sha1:f5995af72eca4e6e5fa92d97106fb731092c575e
+ pristine_git_object: 3c60e8c074f2d60e9bafa6aef4df03fc5743a14a
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationRequestBuilder.java:
id: 3c97149d4b42
- last_write_checksum: sha1:66ad705a922d672c4c4afa832f435d9a5259362c
- pristine_git_object: babf28b8b96d4343d99784c8506ec247ed74b996
+ last_write_checksum: sha1:9a624084fabc9c87c61e172fc0b29ef9323d926b
+ pristine_git_object: 61b6653357e3cd7c3ba5de608c1fee20ac3e6268
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdI9AuthorizationResponse.java:
id: 817e8e243b36
- last_write_checksum: sha1:fc11fdba6f5dad81e109f2f59a32f812f955af12
- pristine_git_object: 76a630dd9e71779d210a8d4dabcfbb2bec74948e
+ last_write_checksum: sha1:7f50c17f5be4f02cfa8254fac759305339ea3ccd
+ pristine_git_object: c4ae9ba7a8e2f4e165e3eff73874edf5cb3c9877
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdJobsQueryParamInclude.java:
id: 502d1f6d9b96
last_write_checksum: sha1:9a11879ffdd5fad9ba4a35a7eceb30d5eacdcbf4
@@ -11341,38 +12010,38 @@ trackedFiles:
id: e19c261b3f36
last_write_checksum: sha1:d76c2b36ef619b3f9433a419260e2f737a07ae63
pristine_git_object: 2009523d6880d2f464b8b9fefeead66e7500205c
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdPaymentMethodHeaderXGustoAPIVersion.java:
+ id: a3f0501f3108
+ last_write_checksum: sha1:6e0a674a8b5d8542d0f53922492f9a2dac1929aa
+ pristine_git_object: 22bb4d14900548eab4d539ab8101ad632a124041
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdPaymentMethodRequest.java:
id: 63500dc77039
- last_write_checksum: sha1:65b2868bdf6e371aaa774cbc5f9ebef338d4e0dc
- pristine_git_object: 5edebc78c12045bd8a766681400c3219d42d7f48
+ last_write_checksum: sha1:6a13b9c85008d1694b486007260982a48c067d68
+ pristine_git_object: c07e21b55a939fb02fc4d9c58c419fe0f805b216
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdPaymentMethodRequestBuilder.java:
id: 883fd55feab3
- last_write_checksum: sha1:3c12c1158c65954116d7e7554d05c7244a4a3c2e
- pristine_git_object: 818a0d8cddb3883fc8ecaab552328837df451666
+ last_write_checksum: sha1:5878c18ef1c83b5902c6e7e403fcd2b8f7dbe474
+ pristine_git_object: f91da1da2dc1aac2147fa14137b2e817cf2bbfb3
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdPaymentMethodResponse.java:
id: 6db12f89c7cd
- last_write_checksum: sha1:515eb0211841c0c88c7f5729d0403a371bef907c
- pristine_git_object: 2a8d93832867331a5c8c7f55b2778335fa27bc93
+ last_write_checksum: sha1:1f4c35e23ca9644a4f54fee238e697d7945c934e
+ pristine_git_object: 1d9aa3c934a678fe54fc350f5523cdd3f2cc7e21
? src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdRecurringReimbursementsHeaderXGustoAPIVersion.java
: id: 59bce74e34c3
- last_write_checksum: sha1:d92a2ffdb988e05aa32af1f949d429cd37558f5e
- pristine_git_object: 23f0479984f8a1998872aa3844e6fdf8f44b8e41
+ last_write_checksum: sha1:83c24913ed396be457f9f790249551f06637fd85
+ pristine_git_object: a84df4a7ee867512e4f591e6fc05ffc8ab31745b
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdRecurringReimbursementsRequest.java:
id: a8e75feba038
- last_write_checksum: sha1:9d0a7bf7c837d116f21fde451ef8652c84357666
- pristine_git_object: b62b7712a20209ab076b1e2b6ce269a34715ef09
+ last_write_checksum: sha1:f5259019af1821983f774edd7aa1975ea38e6a19
+ pristine_git_object: fc53e1ed4caf0ec6f6e71caffa3f6fe72d098b83
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdRecurringReimbursementsRequestBuilder.java:
id: 78fd45bc0467
- last_write_checksum: sha1:54cd386695add27a3386e65c7ab19e41d184d07e
- pristine_git_object: 3de1624d9c0e84e0287ba963faba7bc32707967a
+ last_write_checksum: sha1:86e8767d3939fd1f24a2472fd1321c9c5682e74c
+ pristine_git_object: 92071f07cd41d18425a73a9f39be4aa0b2f94145
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdRecurringReimbursementsResponse.java:
id: f3432b364b00
- last_write_checksum: sha1:5b4657ccf1a54e988c356586a5e363b02f475259
- pristine_git_object: 12100257a38f692906a383a5781794e0f6e0f298
- src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdRecurringReimbursementsResponseBody.java:
- id: ea6b4a3c4d3a
- last_write_checksum: sha1:fc9f7a29bbf22eccc1618e9496613bdaff0d64a0
- pristine_git_object: 7b2908a9758fe9ffdd312ce16e8faad2f94fe8a7
+ last_write_checksum: sha1:56233071b4efe6da1790d58dd62929c5283565e2
+ pristine_git_object: 8cabfecb5ea8c8c4bcec220589f175b32788c7ee
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeIdRehireRequest.java:
id: 74ba6b810d10
last_write_checksum: sha1:8aed4ff3290242f171661f7db82183c95464f1a7
@@ -11447,32 +12116,32 @@ trackedFiles:
pristine_git_object: 871b16a06d503144c07cbfbe9c226a6188c33ddd
? src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearHeaderXGustoAPIVersion.java
: id: c6bcf64d9e38
- last_write_checksum: sha1:8fa3f78d7fce66303fa8b99d0eac948c06218e62
- pristine_git_object: 6739eb9a08baa3c0d04466d2538d99fbb2d2b209
+ last_write_checksum: sha1:963257757b64c0c0e2a594f3293bb25f26d6f0b4
+ pristine_git_object: 9779bbd7c60bcbd7e0d1cca01b102f971c4db995
? src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearRequest.java
: id: fc87c2eac2da
- last_write_checksum: sha1:59164dc93f2bad5383d3254901d5be4a914c4dae
- pristine_git_object: fabb4c323cd5342e0aaa309d6580e2f99c8b45bb
+ last_write_checksum: sha1:25804ee17f41dbc88d28462f6cbf40987ab6f637
+ pristine_git_object: 4e9a78b2db73efe0704a396221024ec0a4e9e372
? src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearRequestBuilder.java
: id: eaafe99ec23b
- last_write_checksum: sha1:e8d976799ad1292b99bc3040ef322234d98bd297
- pristine_git_object: 1be7c07cdc2c13f9e056644f6afce49fec71d8f2
+ last_write_checksum: sha1:bb4952e0a71e07664f47f5668e50f28c6808232f
+ pristine_git_object: 0edc70bbf8c216326f90da0da18d018dd5ff85d0
? src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearResponse.java
: id: f8e5cfb4c7af
last_write_checksum: sha1:ba83616e9e5e83eb8f7a913bcada1cb8a231d8a2
pristine_git_object: efa15b14448fbc93bade9a5e597c6681a079ffd3
? src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesHeaderXGustoAPIVersion.java
: id: 8254051d9633
- last_write_checksum: sha1:90f4b76ece25675ea075f604bfc185270c591798
- pristine_git_object: 68f52c9b9e4bdf15d288f202e58ae13c7eaf6a0d
+ last_write_checksum: sha1:c799fac764eb861a84fc40c88c589410523361b9
+ pristine_git_object: 8ddc02d62d92cc30853a69c352a69b633ac8aa18
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesRequest.java:
id: de27ba0f7a8e
- last_write_checksum: sha1:90b2d213218a480e8c94c093e408cb5a6de302ea
- pristine_git_object: 0f2414ab4d3dcbc56062cd45f82833458e9f2161
+ last_write_checksum: sha1:2a58a5e5767e01b6226dd20a80a452b4e42e4343
+ pristine_git_object: 1426c7d22cdaea7d56332b83cefd3edcf5153f9a
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesRequestBuilder.java:
id: 8465cf37453d
- last_write_checksum: sha1:50c88a330f419dc215dc5111bc75998bfaf31bd8
- pristine_git_object: 02252fab0a708ed6e07ee4829e43345d87790ef4
+ last_write_checksum: sha1:2a03272376feaf74479bb79192ecd1b3cfa6f326
+ pristine_git_object: 8c1e2200184b56cdc7f15a4743513ebdf9bda6b6
src/main/java/com/gusto/embedded_api/models/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesResponse.java:
id: 8c05067d00a0
last_write_checksum: sha1:c3de2ca08fd8ddc1fb289d0a55293f18ffab8069
@@ -11569,22 +12238,26 @@ trackedFiles:
id: 1addac9d6ebf
last_write_checksum: sha1:be854e60cf4ab700d4436c5e12884cf053981264
pristine_git_object: 636bb05d52adc571bed4b515c26963a6c2e1e8f4
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1JobsJobIdCompensationsHeaderXGustoAPIVersion.java:
+ id: 1f83b58076d1
+ last_write_checksum: sha1:dd1139815941d02fd07567c67196c35e03fdf33b
+ pristine_git_object: 89941b9ddcaca53f02c08af21e63aa3403b8c42a
src/main/java/com/gusto/embedded_api/models/operations/GetV1JobsJobIdCompensationsQueryParamInclude.java:
id: cc860752b199
last_write_checksum: sha1:f10ce4b98b1e6e854d85ef8d9cc47ff8bba0dbb1
pristine_git_object: c53c8df2ee8a48af25f9e3b8c4ddab5a8c94b4ae
src/main/java/com/gusto/embedded_api/models/operations/GetV1JobsJobIdCompensationsRequest.java:
id: 72406f810f34
- last_write_checksum: sha1:61c62bff1ed56fb8556cf38c4f47665ebbbc50c8
- pristine_git_object: 75c33d3397fc541c87547bc25dee02cb26a42ad8
+ last_write_checksum: sha1:99342deed892454e8dda432cc19e5896b30976cc
+ pristine_git_object: f1d0b9b68393f284b512abff9c724028c4caa341
src/main/java/com/gusto/embedded_api/models/operations/GetV1JobsJobIdCompensationsRequestBuilder.java:
id: 3ec261400c9d
last_write_checksum: sha1:82d5414042893b15fa95c16d3f6d466f9beafdfb
pristine_git_object: 856bb7a646cbeb371a90be44d66b4834402f0867
src/main/java/com/gusto/embedded_api/models/operations/GetV1JobsJobIdCompensationsResponse.java:
id: 07752fe55864
- last_write_checksum: sha1:d00b5bfb350fbb37473c2287c1e87ea695cbce08
- pristine_git_object: 60a47fe6bea31f9ce12d83aad0264370ddea3e40
+ last_write_checksum: sha1:03a4a8a6cbdf6fe0d71c62e5444fc0f388ac6393
+ pristine_git_object: 4341c3f0c13faeb61608692369fec00fe2dd53a8
src/main/java/com/gusto/embedded_api/models/operations/GetV1JobsJobIdQueryParamInclude.java:
id: 41d806291557
last_write_checksum: sha1:4d84f3478eeb83d7a84d12a0bf090b161918166e
@@ -11601,14 +12274,18 @@ trackedFiles:
id: 9758bf3f8fdf
last_write_checksum: sha1:6019659fda0288661ba49c1ea7da322fc75e55b9
pristine_git_object: 6b453fca262ee542f349dab766c0b5b32710c1ca
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1LocationsLocationIdHeaderXGustoAPIVersion.java:
+ id: b005be863dc3
+ last_write_checksum: sha1:d448769cdbf0a505511a50e3188fecc7c6243511
+ pristine_git_object: 67df9a48dde87a6c2856981232bea45dbdb9c194
src/main/java/com/gusto/embedded_api/models/operations/GetV1LocationsLocationIdRequest.java:
id: 6080eca7723a
- last_write_checksum: sha1:2e753f79b0e2c97f7cfbd40279194064eaaf8348
- pristine_git_object: 6dd0ab1406b334c6f27aa889793161156ffa1ce2
+ last_write_checksum: sha1:9d69d22545025d7edd20bfc132719f10f704997b
+ pristine_git_object: fd993d4fec8a98f4949a246a806fb9ab5214900b
src/main/java/com/gusto/embedded_api/models/operations/GetV1LocationsLocationIdRequestBuilder.java:
id: 591093046f01
- last_write_checksum: sha1:e30e892a864fd71895e98da15bdcf2e30b420eea
- pristine_git_object: 42763bad72a8f2552b39d19609d0d388b21cd421
+ last_write_checksum: sha1:73e819fc29852bf8218ef711b3183c7033e11ac3
+ pristine_git_object: 18e014c4edcbac00b4f343174b4e681ec8839564
src/main/java/com/gusto/embedded_api/models/operations/GetV1LocationsLocationIdResponse.java:
id: 528bdc0450d8
last_write_checksum: sha1:d49b1301ee5eda3f86beafaa5844e24623933308
@@ -11629,6 +12306,26 @@ trackedFiles:
id: 45fc0518b98c
last_write_checksum: sha1:3fe56578f0ff8cac1955d0f73647aad5a0c67570
pristine_git_object: 1918014d7bcd7f6ebf78aa2cacbd3906e2a6479d
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessMetadata.java:
+ id: 5f2cdce1ebac
+ last_write_checksum: sha1:22f6c713b711aaed327d553545126dc71197a632
+ pristine_git_object: ea715a626ef5d09848f084bcc08dc5b11938499d
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessRequest.java:
+ id: 69c230c0a2af
+ last_write_checksum: sha1:c4a4d857a4991b2b6325f64f1d6986ca3143ad7c
+ pristine_git_object: 239e57150b2054f9df573e2a2569f2f150b6e0bb
+ ? src/main/java/com/gusto/embedded_api/models/operations/GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessRequestBuilder.java
+ : id: 99acd3474d5c
+ last_write_checksum: sha1:a02dfca306809ecb8b66e45d6b1f6f9d4a26bda4
+ pristine_git_object: e2e890a9728bcbab029b1459378c8f7d159be3bc
+ src/main/java/com/gusto/embedded_api/models/operations/GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessResponse.java:
+ id: 3cb5066211e7
+ last_write_checksum: sha1:04b966dee9730da8da034541f375e03516edfabd
+ pristine_git_object: 006ee864bb652a396db2cbd7fa7fe1d8e88a26a0
+ ? src/main/java/com/gusto/embedded_api/models/operations/GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessResponseBody.java
+ : id: e599689ae0ee
+ last_write_checksum: sha1:242633762c56465133f8b0ffb66b565545a2d977
+ pristine_git_object: e93172dbfa4222092360cbf49031f75b34e80ce2
src/main/java/com/gusto/embedded_api/models/operations/GetV1PaymentReceiptsPayrollsPayrollUuidHeaderXGustoAPIVersion.java:
id: 323fea92ac81
last_write_checksum: sha1:5d0add7a4d3b4caad4a54f6e4eae9a0c0f59bb47
@@ -11643,8 +12340,8 @@ trackedFiles:
pristine_git_object: f2c489dff0826eba06f033d352103a1c32549ef6
src/main/java/com/gusto/embedded_api/models/operations/GetV1PaymentReceiptsPayrollsPayrollUuidResponse.java:
id: f5270556c1fa
- last_write_checksum: sha1:f60aee5a3f9a59aae7cdb1ed9a4cb7b0e7248407
- pristine_git_object: c861c5406111461ce1f11760c8b9fa93acbbc88d
+ last_write_checksum: sha1:e966c9704dc63bd331808a1ead7bb7dba93071a0
+ pristine_git_object: 8911d29f0a5703e023575ddfb887ceb93ba0fd16
? src/main/java/com/gusto/embedded_api/models/operations/GetV1PayrollsPayrollUuidEmployeesEmployeeUuidPayStubHeaderXGustoAPIVersion.java
: id: 112c566cb901
last_write_checksum: sha1:00f9b6ea76407ec11576e26eb479e4b369ab92b6
@@ -11661,86 +12358,66 @@ trackedFiles:
id: 56555a801b28
last_write_checksum: sha1:825df3d89ea2448ae9d4bfaa0c8c1fab16fbc282
pristine_git_object: eabea49a7499c01d5845cd1e9a3eaacee9cd9e13
- src/main/java/com/gusto/embedded_api/models/operations/GetV1PeopleBatchesPeopleBatchUuidErrors.java:
- id: ed4e01a83a10
- last_write_checksum: sha1:93659b419ad2da116ace21569dacb86b07ebf706
- pristine_git_object: 331f280a43548a2e7d09f1f55fb00f568d4e214f
src/main/java/com/gusto/embedded_api/models/operations/GetV1PeopleBatchesPeopleBatchUuidHeaderXGustoAPIVersion.java:
id: 8f5c78bf06c0
- last_write_checksum: sha1:fc5a64ab15c2d66efbe638e08c1d9000aae9ab83
- pristine_git_object: 98077c7abad6e2e4c5a507250943864cd564a304
- src/main/java/com/gusto/embedded_api/models/operations/GetV1PeopleBatchesPeopleBatchUuidPeopleBatchesStatus.java:
- id: e173a5a8916a
- last_write_checksum: sha1:71e96bd9b53c98578cf10a9dedc6f027f73e95e2
- pristine_git_object: 63b059a676bd0e4d73e4ec7b48ac42b66f0eeb9e
+ last_write_checksum: sha1:b1cfd0e07ccb59b0416839c4ea983b69cd61c502
+ pristine_git_object: 60cd2ef90ddbd6bb6d49bda507c258cbad23c773
src/main/java/com/gusto/embedded_api/models/operations/GetV1PeopleBatchesPeopleBatchUuidRequest.java:
id: b167633201cf
- last_write_checksum: sha1:7540c04397ac9ae636b240d479bfd102b14e7f92
- pristine_git_object: d6296d015010b4aa3562ecaccafc9508674c8baf
+ last_write_checksum: sha1:ff9643d8c5c14000d32eef4c684415ee6291f807
+ pristine_git_object: 5c7dfe959bb0cb7d05d7ad81d050f59b3517d4c5
src/main/java/com/gusto/embedded_api/models/operations/GetV1PeopleBatchesPeopleBatchUuidRequestBuilder.java:
id: 43d1f9569c82
- last_write_checksum: sha1:c773fd5f183568003333a9ae9d70606a3685600e
- pristine_git_object: 53a05bb6e8f097080dc0b70aa57532db1548b002
+ last_write_checksum: sha1:5a70986c2d17070daba782cef18fef1cc2f72d85
+ pristine_git_object: 612d166ae66d2a02dc5fb3e3d5048b0a37d74b7a
src/main/java/com/gusto/embedded_api/models/operations/GetV1PeopleBatchesPeopleBatchUuidResponse.java:
id: 96e6f19f9125
- last_write_checksum: sha1:8fdbbfcdcffca62baf0afbd159ee018c50a77624
- pristine_git_object: 8a7a69aba55ffabf028d003fdaa5b59f67980f2d
- src/main/java/com/gusto/embedded_api/models/operations/GetV1PeopleBatchesPeopleBatchUuidResponseBody.java:
- id: fcc151e05db2
- last_write_checksum: sha1:558a88506d9a272ff2fa8fd41df70011c21d6260
- pristine_git_object: d6ac94a15098de8fe1b9cdb600a2ca2e03054355
- src/main/java/com/gusto/embedded_api/models/operations/GetV1PeopleBatchesPeopleBatchUuidStatus.java:
- id: fee0065a2dc4
- last_write_checksum: sha1:3f5eb4d6aa0e82ac7c02d6e0d09a195dadbacd8d
- pristine_git_object: ecd18365abf7d2861a78c52743698f6a6f4f372a
+ last_write_checksum: sha1:68e4fd7be7ed0a5f2859b10d79f9dd9ec11326d4
+ pristine_git_object: 4b1c51a75ae5f1d09d2c178069566167aaf3bb1f
src/main/java/com/gusto/embedded_api/models/operations/GetV1RecurringReimbursementsHeaderXGustoAPIVersion.java:
id: 9311ba8d65ed
- last_write_checksum: sha1:fb652fa647872a492b3b982c9801483d9fd52cc4
- pristine_git_object: 4e677edf5b3c3acad07d302006b61b151c97d469
+ last_write_checksum: sha1:c00d8638ded4e9b6de25394b0d70a89307abf84a
+ pristine_git_object: bab69b817657bedb217c291b9ecf2833d57c987d
src/main/java/com/gusto/embedded_api/models/operations/GetV1RecurringReimbursementsRequest.java:
id: e9b50a40c9f5
- last_write_checksum: sha1:4596e7ccd04c4ec609b6049dbd6baae6fe661f83
- pristine_git_object: 882159895d375f8d014f38b8cfa5162568e5e0bb
+ last_write_checksum: sha1:5f2466351423a89405f9990a56ee692f70c0ea68
+ pristine_git_object: aff6bbd793fd3e7cde23d7cf3a2fe6eb03bb375e
src/main/java/com/gusto/embedded_api/models/operations/GetV1RecurringReimbursementsRequestBuilder.java:
id: bfbac738101d
- last_write_checksum: sha1:d9de72b60aad91f0c7c1723fdb4d49e667391910
- pristine_git_object: 76dc82788f2e7023957da51dc3c6c608a2076979
+ last_write_checksum: sha1:8bb41c6012018c6def5c4d330f543e99447e9515
+ pristine_git_object: a8f6235cb1571a5c1551dc8760bb1029d781b90c
src/main/java/com/gusto/embedded_api/models/operations/GetV1RecurringReimbursementsResponse.java:
id: 3f37023c24be
- last_write_checksum: sha1:ce98cc16ce8adac28f6a08c38f0c5d2816aecc3c
- pristine_git_object: 8677414b2a3774eb9cc52c82c06c851c1a52446f
- src/main/java/com/gusto/embedded_api/models/operations/GetV1RecurringReimbursementsResponseBody.java:
- id: 1610c73b21b5
- last_write_checksum: sha1:05808fa614a97480859f5fde1033eaf97268cff1
- pristine_git_object: 4c1e90a6adf330e695b93cf21423619482aa8e7a
+ last_write_checksum: sha1:bd3e369c301da20d43233b9bb919efa67a47bbe2
+ pristine_git_object: 21f715fcb33301e507b42eecbc39395e256bab5e
src/main/java/com/gusto/embedded_api/models/operations/GetV1SalaryEstimatesIdHeaderXGustoAPIVersion.java:
id: 1474ae40bae3
- last_write_checksum: sha1:4da184a725eb74cd70c0f30cc86d3349350e6925
- pristine_git_object: 6728d7d5ba7f67eace2cb2ec137238eaa0586f0c
+ last_write_checksum: sha1:24b2d28c33f4b74faca5b9b11cc330ded05ffd09
+ pristine_git_object: ba3b7180882be9209e595ea0932d24487cbfdc0a
src/main/java/com/gusto/embedded_api/models/operations/GetV1SalaryEstimatesIdRequest.java:
id: 9dc42984f8fa
- last_write_checksum: sha1:b79ac5071fb0cc13d8a3b00075d8fb42abe12e85
- pristine_git_object: 99f8377ce1bb1f1331af3dfc1de9962f74027339
+ last_write_checksum: sha1:aeb049a65673bf5353a51153ed16b25f69e1f0ae
+ pristine_git_object: f425a313b6fc415f2655b6cbbf4f79940fff8c00
src/main/java/com/gusto/embedded_api/models/operations/GetV1SalaryEstimatesIdRequestBuilder.java:
id: 6d852f5006be
- last_write_checksum: sha1:ea019fbab49999457ccc6d35d2d92ad7b2797b97
- pristine_git_object: 076ec586bc6e4c2a71772d819b67195852d9f686
+ last_write_checksum: sha1:bc134e52667b1d419ae2810296642ee86608fe03
+ pristine_git_object: b64e5d8a96b484f1c30cecb430ab092dbe6df51a
src/main/java/com/gusto/embedded_api/models/operations/GetV1SalaryEstimatesIdResponse.java:
id: 11fb0e8d6cc9
last_write_checksum: sha1:5fe7b68662cb12354ebb4bfef818bb05426cd284
pristine_git_object: 53b20e4b7ed87d138ca4b782177bff9e4cce7948
src/main/java/com/gusto/embedded_api/models/operations/GetV1SalaryEstimatesOccupationsHeaderXGustoAPIVersion.java:
id: ae3a3d1bde67
- last_write_checksum: sha1:a0255e5e5cdf721b7c2d2a48a7d50d0afedaa40f
- pristine_git_object: 8040fda32acc0db6539c39c9dd43151a572e3bc4
+ last_write_checksum: sha1:0bf45e935f18f69eeecb330517d446eb87dec518
+ pristine_git_object: d74f3fc6a44f12c8dd1fdb24c0692f0f9c589933
src/main/java/com/gusto/embedded_api/models/operations/GetV1SalaryEstimatesOccupationsRequest.java:
id: 547d6ede685a
- last_write_checksum: sha1:89d73e3d42ee0f3f470b68b05d259afa1832d394
- pristine_git_object: fe47d2bd6e8031ce9e458d3c2fe89a67bd2c28a9
+ last_write_checksum: sha1:b3ff2e6e77b4b4dd5151c2f9463e05fbbab37bd0
+ pristine_git_object: 3ad064f698ddedd06121dae548a9390c016100f9
src/main/java/com/gusto/embedded_api/models/operations/GetV1SalaryEstimatesOccupationsRequestBuilder.java:
id: 089e14c14217
- last_write_checksum: sha1:25e61db273e0e4aa790198cd37686fecc0194bb0
- pristine_git_object: e32b3f4c7ed188a6c888e84f532dbf9ce85312b2
+ last_write_checksum: sha1:046dedb69f720cd9f018fdd4089c3c4242798393
+ pristine_git_object: 71dec463922336ef94122198f7211cc288a9a405
src/main/java/com/gusto/embedded_api/models/operations/GetV1SalaryEstimatesOccupationsResponse.java:
id: 1098a88d99f2
last_write_checksum: sha1:98934e334321778c6dadc8d27314cadc23cc8705
@@ -11759,44 +12436,36 @@ trackedFiles:
pristine_git_object: 4078c0a81a55497e5fe5e604329ed2451eff1861
src/main/java/com/gusto/embedded_api/models/operations/GetV1TaxLiabilitiesResponse.java:
id: 54582b095263
- last_write_checksum: sha1:8669d2aaa6c2b83f7b9eaf4beb92849095aef944
- pristine_git_object: 372298d6325153b1a7e33e4c2d19111e3eb0a4ba
+ last_write_checksum: sha1:ee64c4d3911087e85d9877df379647a65cbaf1bf
+ pristine_git_object: 4ac203f0cb1a16620393696f3a4807435da4ebe1
src/main/java/com/gusto/embedded_api/models/operations/GetV1TimeOffPoliciesTimeOffPolicyUuidHeaderXGustoAPIVersion.java:
id: 30268be50ec4
- last_write_checksum: sha1:f1dc8e09a3d60b50a3c761984773003eb1f1d589
- pristine_git_object: 87558d0b79979c5cabfc7f6f87ac64993eb36b70
+ last_write_checksum: sha1:37dccb69b7901c874664f682f317a6cf92a90b38
+ pristine_git_object: e2994cb52099c89b17c1b15fa8124a04155d722e
src/main/java/com/gusto/embedded_api/models/operations/GetV1TimeOffPoliciesTimeOffPolicyUuidRequest.java:
id: 273b895465e7
- last_write_checksum: sha1:999edec478921d6a0eadff4a56346aea130c4eb8
- pristine_git_object: f55333df7c3b68fb51b66bb5cb1aede0e3dd408f
+ last_write_checksum: sha1:3e8f042b8c6bff642d9b07f6fc4a4a32879888b7
+ pristine_git_object: a0a943dd72b3565e0580be2b3a7ffe2148102dce
src/main/java/com/gusto/embedded_api/models/operations/GetV1TimeOffPoliciesTimeOffPolicyUuidRequestBuilder.java:
id: 537e0f2dd67e
- last_write_checksum: sha1:766b323f3f67ce84ba5b2a1e65980a48898bb14e
- pristine_git_object: c841224be71696d30329c12f539a3401d1022120
+ last_write_checksum: sha1:0c8ce5a41c392151f26b3710209701b3323bbf94
+ pristine_git_object: 368439b588977f432013ab112bb90bfd6152428b
src/main/java/com/gusto/embedded_api/models/operations/GetV1TimeOffPoliciesTimeOffPolicyUuidResponse.java:
id: fcec8d7d4ef9
last_write_checksum: sha1:d441da993eb2ca8c2c341366991010d544fc0495
pristine_git_object: 73c7e533aa9607e4db70aea8ae78118fa6b583a4
src/main/java/com/gusto/embedded_api/models/operations/GetV1TokenInfoRequest.java:
id: 112eb6fd0497
- last_write_checksum: sha1:63501aa89e2d348b43fc332b1f5ec7ec42ed1395
- pristine_git_object: 7a902ccea2d0fa64d9c5ebe707701c69834760fa
+ last_write_checksum: sha1:5f20527aba9c0ad633e44d8aa1e228ae05a612f8
+ pristine_git_object: 70a8ca091528679ce93cb93be80cd4560c21422b
src/main/java/com/gusto/embedded_api/models/operations/GetV1TokenInfoRequestBuilder.java:
id: 6e6f43493cb7
- last_write_checksum: sha1:9f1f32fb0a53b5ea6c27857aefdb1ea270502130
- pristine_git_object: f6c624e7b5df8cd3aac0cc523670f3501bc0b900
+ last_write_checksum: sha1:570daad3a8575320d70de12e05449a33cdbfbb64
+ pristine_git_object: a4fc4c1684e402bdb415ac6afe74b97b176bf19c
src/main/java/com/gusto/embedded_api/models/operations/GetV1TokenInfoResponse.java:
id: de87de4675d8
- last_write_checksum: sha1:4e899e29ffc172e5678c994f26c4dc1bea653909
- pristine_git_object: f208bb4ae2ee9c2538b074044bf7710ab1c7a85e
- src/main/java/com/gusto/embedded_api/models/operations/GetV1TokenInfoResponseBody.java:
- id: d9b5a3e867f3
- last_write_checksum: sha1:72edbcdf0f94d9f3551d7cf7e8d71fce90abbae5
- pristine_git_object: f941a240944d2c58cdae3f5a5260ed53848c0a48
- src/main/java/com/gusto/embedded_api/models/operations/GetV1TokenInfoType.java:
- id: 4e281adf4de3
- last_write_checksum: sha1:9e2f69f56d7f7cf445adf32eb783487c3b5e20e2
- pristine_git_object: ccd85b5d18108d9ca0d406c26c285b782462d63a
+ last_write_checksum: sha1:61844eb729f042d5cbced4e5ac179810d30c3f9a
+ pristine_git_object: 0d8a7458e71b06daf72763af0ca1e4c8791e8d2d
src/main/java/com/gusto/embedded_api/models/operations/GetV1WebhookSubscriptionUuidRequest.java:
id: b6d05f49ffc2
last_write_checksum: sha1:f5f153bc420b006b247987a66fe98792a03de0f9
@@ -11919,8 +12588,8 @@ trackedFiles:
pristine_git_object: 87024e0e23bd52b271144df97277fce147dcdf25
src/main/java/com/gusto/embedded_api/models/operations/HomeAddress.java:
id: 593ff06db970
- last_write_checksum: sha1:e279e7cbcf8e31a72fbaa488f3e58ac63bdd5d2f
- pristine_git_object: 470619414148603894e0d24b581800f01fda9459
+ last_write_checksum: sha1:a56551d5e6a8c1bde42a830c95a0234a1997be2e
+ pristine_git_object: f7e833093ac0e9349c5f7c65129af292c5b4f987
src/main/java/com/gusto/embedded_api/models/operations/Include.java:
id: ce77dc64b506
last_write_checksum: sha1:cccd30f6e1cac2c9d8fcc76c5feb1b444b5529af
@@ -11961,14 +12630,10 @@ trackedFiles:
id: 9a0bec42d0d4
last_write_checksum: sha1:199352489eb8e55b141502ab023b62ae00032338
pristine_git_object: c40a77fadd34158c03d88eb7e6fa364e77e4e19c
- src/main/java/com/gusto/embedded_api/models/operations/MigrationStatus.java:
- id: 7410060312ba
- last_write_checksum: sha1:b55e19037d16db4342d24308d75ebaaf9671f371
- pristine_git_object: 6681b02f036ff7471d9a355d03dab836dc8c61c9
- src/main/java/com/gusto/embedded_api/models/operations/MinimumWages.java:
- id: 6072d3190a04
- last_write_checksum: sha1:60bb7344f97359d14c52d1e4b72088dd36872c96
- pristine_git_object: 1865401f3f828ddd700c114a343723e7a90426f6
+ src/main/java/com/gusto/embedded_api/models/operations/Metadata.java:
+ id: 0132f0e977a2
+ last_write_checksum: sha1:d9f89e4e0d099396efb45a0d271ff1ea4a2dc8c5
+ pristine_git_object: 9c80428df9020c8de94598d4bf0a32c2b771f001
src/main/java/com/gusto/embedded_api/models/operations/MlkDay.java:
id: c7ba5a902fd7
last_write_checksum: sha1:3a5919db4c1471b579853f6fda2ac90ffeb3194b
@@ -11979,20 +12644,20 @@ trackedFiles:
pristine_git_object: b2c7cbc5bdc890425e4ee38fa4531c16c0d9b6a5
src/main/java/com/gusto/embedded_api/models/operations/OauthAccessTokenRequest.java:
id: 53cfd68060b7
- last_write_checksum: sha1:7a096d7d6a22b2fe64ad41ef72c674600d8f0434
- pristine_git_object: 75ab1b1c2f9f0eeac7eeab318af5cb181f36a532
+ last_write_checksum: sha1:835e994c1ff5fa5c1f5141d1efbc6e1cf88db4f2
+ pristine_git_object: edb6fdcb3eee49e510ccf2a2a380ada488e9bd22
src/main/java/com/gusto/embedded_api/models/operations/OauthAccessTokenRequestBody.java:
id: 62769ca5477e
- last_write_checksum: sha1:20aa2e23a2eab8084f131970a38c63a03757b50f
- pristine_git_object: c99c00e1650632692a55ed31d6565e4141583388
+ last_write_checksum: sha1:7adc3c675ea09da63cf2c57036f42f9788efdd28
+ pristine_git_object: 9dc39f6b92d4b1f8966da60bdfad33f39d471b52
src/main/java/com/gusto/embedded_api/models/operations/OauthAccessTokenRequestBuilder.java:
id: b88130428e77
- last_write_checksum: sha1:faff41eb49d7988e54203e2aa16aed74740d2b1d
- pristine_git_object: 5eb57b03c1017b7551cfe470f70c2deb3496dff4
+ last_write_checksum: sha1:70b1b88ecf1160cb2ae027bdd8adecc9358ddccd
+ pristine_git_object: 72b017c406596082016c3a8b83381ce61239f44a
src/main/java/com/gusto/embedded_api/models/operations/OauthAccessTokenResponse.java:
id: e50d74d04d66
- last_write_checksum: sha1:82fb4f2642c89073ce90937c5662d8ea41760af4
- pristine_git_object: 3f6e63d2c2985e596905d57412abaa1722b678ef
+ last_write_checksum: sha1:49001e43d1faee228b124c8fbc36d29221c517e7
+ pristine_git_object: b69ddb4bc3b96d35cbcc9e28abb7378a2ed028d8
src/main/java/com/gusto/embedded_api/models/operations/Occupations.java:
id: cf16f32e4b34
last_write_checksum: sha1:50eda35fb5c7e4690e2bd1dfbb782683c25aeada
@@ -12005,10 +12670,10 @@ trackedFiles:
id: 949cdad156b9
last_write_checksum: sha1:26487131cb24c4f62c57bc71537cfe7fce50e5f4
pristine_git_object: a62149cb1a08e81c6a0bc727ced77350d8841d67
- src/main/java/com/gusto/embedded_api/models/operations/One.java:
- id: 7abae91edd1b
- last_write_checksum: sha1:12b5d5e5368de2c5affdf4eeac9b0eaf707ad2d1
- pristine_git_object: 2c19dfebc424b0c514fb82fc51d6bd6aa0e2edae
+ src/main/java/com/gusto/embedded_api/models/operations/Options.java:
+ id: a2b8e36efee3
+ last_write_checksum: sha1:df06bdcfea9ab3d8e9e07a6849c029862c9c335a
+ pristine_git_object: cd405b7a5de3fa52d5580bf05dc9941bb213465f
src/main/java/com/gusto/embedded_api/models/operations/OwnerType.java:
id: b5047cb1a44b
last_write_checksum: sha1:b9a406d6c4ea50dd8a2832b69b85041f72340762
@@ -12071,24 +12736,20 @@ trackedFiles:
pristine_git_object: a2726dc770aea5d93c29fa52438d19b9e0f2681e
? src/main/java/com/gusto/embedded_api/models/operations/PatchV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearHeaderXGustoAPIVersion.java
: id: 0fa4353195c6
- last_write_checksum: sha1:ae10877cecada2f8bc82da004ee91a0cc9e65aa3
- pristine_git_object: b0b46e635a00dcdaa1458952ed634ecce5f86f20
+ last_write_checksum: sha1:62fa97f632d416008a976b1f733e442471570289
+ pristine_git_object: b8af3751a6e49cdf5a865e33c6f8c63345e30160
? src/main/java/com/gusto/embedded_api/models/operations/PatchV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearRequest.java
: id: 661fde144233
- last_write_checksum: sha1:39cc1266641d46258ec78ec488a8e1376f0763fc
- pristine_git_object: f8ba0f798d3424d85c19de77f49b35f6e5ac651b
+ last_write_checksum: sha1:a04f5012ed8ee7ef12936ec3f3cffcf363dfd020
+ pristine_git_object: f6968a35a8ecea29a1c75755fb6dad9eb2b24bd0
? src/main/java/com/gusto/embedded_api/models/operations/PatchV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearRequestBuilder.java
: id: 5c5cc873e86b
- last_write_checksum: sha1:e700360fa5c46e0d5a2fb4d46ca3138e4921cd0e
- pristine_git_object: 35fd7162a4ccaeedc580645c6e8f7c5dcf9be739
+ last_write_checksum: sha1:a9ca1f60075130b1ac0221591444a47fe0472960
+ pristine_git_object: b07f2c9f5d8594fb4f4b81ac130e0fbe3ace0845
? src/main/java/com/gusto/embedded_api/models/operations/PatchV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYearResponse.java
: id: 8128ed58f15c
last_write_checksum: sha1:8952f363dae9315a112b01162da87c69266fdabe
pristine_git_object: 01c0908f91fb8d62a7cbb9df12f27e141eb67a78
- src/main/java/com/gusto/embedded_api/models/operations/PayPeriods.java:
- id: 904d383721d9
- last_write_checksum: sha1:e68c456d7301a6610736818d87767b710ca12b37
- pristine_git_object: 374fa7b0a2508fc7ee52bacc10f3ab68eb5f90c4
src/main/java/com/gusto/embedded_api/models/operations/PaymentMethod.java:
id: 30b5bd50c5fb
last_write_checksum: sha1:2fe4fb950f8d84eb11263b3279a8f84b6fa88e5c
@@ -12099,12 +12760,12 @@ trackedFiles:
pristine_git_object: f373c936ed8eb1d8a77f08251354d6d25ac00ae3
src/main/java/com/gusto/embedded_api/models/operations/PaymentUnit.java:
id: 3884d244319b
- last_write_checksum: sha1:253bddf9d2bb7f5a4a75f58eb2a4398c704ce64b
- pristine_git_object: 563c348d68f6dd5085f6b2376dc0f6fb345cd64a
+ last_write_checksum: sha1:901f5c60f228688c7c319287122ee2ff6eee4c1f
+ pristine_git_object: 3c4cf1983d7d505832364e6d9e65545d1d3fbb44
src/main/java/com/gusto/embedded_api/models/operations/PayrollTypes.java:
id: 2bd9280b451e
- last_write_checksum: sha1:a26090229835a8972a5016df41fb354baff8c160
- pristine_git_object: 1f9a008118e6cc2c69bc8326517857181025f95e
+ last_write_checksum: sha1:a906d59e468c2c95e3d1dcb44c362b2ce492a13a
+ pristine_git_object: 9376c891c888cf552bbc6f2b8c0d54946c212a36
src/main/java/com/gusto/embedded_api/models/operations/Person.java:
id: 15f4ace345d6
last_write_checksum: sha1:2bb709fea4e93a1dd1a9a4dcd4a6b8e826de7286
@@ -12127,8 +12788,8 @@ trackedFiles:
pristine_git_object: 721951012d190a4dfb83de1706822dfc696e7d89
src/main/java/com/gusto/embedded_api/models/operations/PostCompaniesCompanyUuidReportsRequestBody.java:
id: c4e9a83c2f78
- last_write_checksum: sha1:e41adcece5f8492cfd149f47decca6815026102f
- pristine_git_object: 8fb8182a47b9781add7d86339b16ecb218f65e5f
+ last_write_checksum: sha1:d15ffb3bde0a21999577de62bf1c541723432879
+ pristine_git_object: abc4442d31cde280667f46d6013335f9232b29a5
src/main/java/com/gusto/embedded_api/models/operations/PostCompaniesCompanyUuidReportsRequestBuilder.java:
id: 66ef5502924d
last_write_checksum: sha1:041ee4b7e0cfd427f6a49e71fa70da469519c766
@@ -12225,6 +12886,22 @@ trackedFiles:
: id: 1b55113095ab
last_write_checksum: sha1:665262f3aea8736be6e0fe7ab554fd11da5f4b94
pristine_git_object: ab437964a632a956922e6436507ddc5584173c78
+ src/main/java/com/gusto/embedded_api/models/operations/PostPayrollsGrossUpPayrollUuidHeaderXGustoAPIVersion.java:
+ id: de93123cc27a
+ last_write_checksum: sha1:7a120c9d3f6a2002a3e3deaff59161d7992499f3
+ pristine_git_object: b7c640fc8c6e7f4ec651c00a9f16ec50a6623c5d
+ src/main/java/com/gusto/embedded_api/models/operations/PostPayrollsGrossUpPayrollUuidRequest.java:
+ id: 2c269954d9d7
+ last_write_checksum: sha1:8650c9458a3179af48620b0e812469557c53ee15
+ pristine_git_object: ffc940632896060d106ecb747f499382370c7ebc
+ src/main/java/com/gusto/embedded_api/models/operations/PostPayrollsGrossUpPayrollUuidRequestBuilder.java:
+ id: 03bb1c25bc66
+ last_write_checksum: sha1:9464285dc73796604565e52e43b0cf6937b1833a
+ pristine_git_object: 7c4ed2522db491ee8d6e5090bf44e81b12869825
+ src/main/java/com/gusto/embedded_api/models/operations/PostPayrollsGrossUpPayrollUuidResponse.java:
+ id: e17722f96847
+ last_write_checksum: sha1:0fbe9c926f27ae318065c2bcdf4b892cf508d8e7
+ pristine_git_object: 77d013b9684513d10c0269a900a457c2a788d318
src/main/java/com/gusto/embedded_api/models/operations/PostPayrollsPayrollUuidReportsGeneralLedgerRequest.java:
id: c8d949ee4fc7
last_write_checksum: sha1:8f372775a74fa173393bc6c0e5f00a0daab72e73
@@ -12279,16 +12956,16 @@ trackedFiles:
pristine_git_object: e5289737eaabcdd97ce1e583157b224c1ebead95
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdBankAccountsRequest.java:
id: 21e833a8484c
- last_write_checksum: sha1:cb2482f011fa69cb909ec393853a8a6909feeb93
- pristine_git_object: 83441a36e780f33550780b7029981c45737f2820
+ last_write_checksum: sha1:db344e60d7576e306e8e799f56f229700b001de4
+ pristine_git_object: 2ff78eea65212818f07b51998480e35dceab7145
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdBankAccountsRequestBuilder.java:
id: cacdaf226cb6
- last_write_checksum: sha1:2acddcf420fbf2efd38fe032dd8375d366165905
- pristine_git_object: 442de18882a3e831990165d63a3c858b904604b8
+ last_write_checksum: sha1:d809239252c8bfcba0d91e60937c5bff227623e2
+ pristine_git_object: 0a281357e7c20759f69235bb5a6637976f14e218
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdBankAccountsResponse.java:
id: a9b4e5be8010
- last_write_checksum: sha1:7a81a39782ad60eb5221035ebf45a6aba3ecc6c4
- pristine_git_object: 2cbb2628b71f54e4643c33d0f07f9b554c71cb85
+ last_write_checksum: sha1:cdd3f3901a699b66c5a598adf5c4ccc753b1fdce
+ pristine_git_object: 4a9a29eade5bbefea47c7f5956326d968ff525fd
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdCompanyBenefitsRequest.java:
id: cc94a63d0e39
last_write_checksum: sha1:c380396ba27d16884bebf25102d0cd2da3efed8a
@@ -12309,14 +12986,10 @@ trackedFiles:
: id: 8898c81b8e44
last_write_checksum: sha1:1e32c24894dc42c3c3720b09ee87cf20941f5b0a
pristine_git_object: e9b5249c2aec080d782951ac3fd57f87d8f57b6f
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsPaymentMethod.java:
- id: 47dd198b7344
- last_write_checksum: sha1:e530ca6476243e3166d937f457b00286dcbadc35
- pristine_git_object: f51ae2090cd09992a89c8b0a72055501396405d6
? src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsPreviewContractorPayments.java
: id: b457fe0adbb9
- last_write_checksum: sha1:37095abfdcd07a2c1ec78b89eaa7fd83a73a93fd
- pristine_git_object: eec2393d65581c88945857a0e9fb2313247f2c36
+ last_write_checksum: sha1:6fed5dd1817106294921b2963816238882d0ab07
+ pristine_git_object: 019f573edce8184305a270b974f28c7e64f0bf92
? src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsPreviewHeaderXGustoAPIVersion.java
: id: 4ecadc212132
last_write_checksum: sha1:aecb6a0610fa045dca2f7e196a1d69c2f044ab69
@@ -12347,8 +13020,8 @@ trackedFiles:
pristine_git_object: a9b2aa9f94193119099cf5e0c188b56059c68cba
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsRequestBody.java:
id: 2aa540df1886
- last_write_checksum: sha1:e99046893aa8d7bfec462f9adcbe0fe8f195720d
- pristine_git_object: 56bfe09207936fc9e20987bf137fd4102862f329
+ last_write_checksum: sha1:77cff235d27e1f740d75604ee0958f6dd9df2ae0
+ pristine_git_object: 09198cf7e76b95b74c53535c717d984133dbf63a
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsRequestBuilder.java:
id: 600a7b186775
last_write_checksum: sha1:0b04621655e6546f7bf2e235800abccf0fc76697
@@ -12357,22 +13030,22 @@ trackedFiles:
id: f8c68a175e36
last_write_checksum: sha1:3c9f87f5e22cce00ef824bf92b198f4c6e27bc15
pristine_git_object: 8972bd40e21f52325a393b7b4f78db9d5582ad78
+ src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdContractorPaymentsHeaderXGustoAPIVersion.java:
+ id: 1b4a8a3d675d
+ last_write_checksum: sha1:48b946e32252a36edbd79e5f49cb1085f082db37
+ pristine_git_object: 7851c37eeb932710a51d683485fadf846691bf55
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdContractorPaymentsRequest.java:
id: 3359a18437e3
- last_write_checksum: sha1:312c3f31264cf62035ac03e92d69a049ec4dbfc7
- pristine_git_object: 319112ecc0c906d84ed3942c77862e81bf44b72a
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdContractorPaymentsRequestBody.java:
- id: ac49e70f4335
- last_write_checksum: sha1:b69d35384d8562079f0e00f487af2b34ef39473d
- pristine_git_object: 9805133ce78252870550153cdbe2d24534ea6cc3
+ last_write_checksum: sha1:cf5f7f398d9e6e4c815c721f24158881c33cec3a
+ pristine_git_object: 1d2dc58b61f4d9caae5a3fb92b64bb58dd15f9d9
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdContractorPaymentsRequestBuilder.java:
id: 9b63c809b322
- last_write_checksum: sha1:90bac8179de4c99e9c14fdb7067cc73a83ddfc2f
- pristine_git_object: c773e511e25c812c78cb4db99d21baace5347dd6
+ last_write_checksum: sha1:d518a2dfbdb167fe99f8c8023a05b33aba7f82b6
+ pristine_git_object: b105fc8eacebc5d76deae7c19b2aaf765865458c
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdContractorPaymentsResponse.java:
id: 18f89c6307f0
- last_write_checksum: sha1:d87ae16cbc51362121f2747c377f2d1c8144f9c1
- pristine_git_object: 3bbdafcf9bc245a8089ae64ee34e43bc9fdaa99a
+ last_write_checksum: sha1:d5da76693873fc4863885a72a6f0d8ecda5b675c
+ pristine_git_object: 48ed9f7509bbb719dd9d4c0ddcf753909914aabf
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdEarningTypesRequest.java:
id: d89b75bfdba1
last_write_checksum: sha1:b14bc70db962c7265b205baacb4c9fc37ecd9250
@@ -12389,22 +13062,22 @@ trackedFiles:
id: 06c3056eb3be
last_write_checksum: sha1:423d0031f53e7e0e05dae89ca3b26112f187dfa2
pristine_git_object: 819b2cfcfa41335cc6d1ee38dfdeee30093a8aac
+ src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdLocationsHeaderXGustoAPIVersion.java:
+ id: 4033ebf45b27
+ last_write_checksum: sha1:060ed55abd54bfd5dae97b303f5d8986031c0b7b
+ pristine_git_object: eba83c0039fb31f739bb41da8b1bcfd792638bc0
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdLocationsRequest.java:
id: fe79270b3e6e
- last_write_checksum: sha1:32d2b3c3f539b4e5255350af24baa1985de57605
- pristine_git_object: 2ceb5a4e348238dd3a8eb000c3b61ce343181b90
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdLocationsRequestBody.java:
- id: 6a1e4d3a9e9e
- last_write_checksum: sha1:2b24691c3dde728a3f72ee3dc9c10755e1349672
- pristine_git_object: 82ddc7181d05f46a5e507401fad26ff257b94aba
+ last_write_checksum: sha1:5ed49c5ee9306f5f961d02b799a4c3a21443231f
+ pristine_git_object: 3485e4eb34c73dfd5a0606274a76c5620f8278b3
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdLocationsRequestBuilder.java:
id: 6d2bf69b69ee
- last_write_checksum: sha1:bba3aed46d3bcb61d61768d9bb6bd8c7bc2c4362
- pristine_git_object: 6fc1dd7b6bbfb95f7b2f780c283d9222239c1274
+ last_write_checksum: sha1:46d8e4b9227ff525f4b3cfa6df61250a0c3400f1
+ pristine_git_object: e1122d0222b0eb84973c187543b7f7c19d59f82c
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdLocationsResponse.java:
id: a437d4ce7bca
- last_write_checksum: sha1:c336de1486e431b485803c7c10ef33866170a7ee
- pristine_git_object: d7830f330f9764ba0103c0935458231b2f4643d3
+ last_write_checksum: sha1:64f3ad06f08e41ac3df145396843f8f489720cdf
+ pristine_git_object: 4031b732ae5762972c65ae79574568ede9432b77
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPaySchedulesAssignRequest.java:
id: 63e38815cbd4
last_write_checksum: sha1:bef90547068f122cdebe673a1ebd4fd77260d324
@@ -12429,22 +13102,22 @@ trackedFiles:
id: 1f12888e28a1
last_write_checksum: sha1:d0e63613a7ca1b0b58d6254943aeff21202f0a1d
pristine_git_object: 30e5901fdd53ab3c45fef7cb695ad65d022a11c4
+ src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPaySchedulesHeaderXGustoAPIVersion.java:
+ id: d2b574711167
+ last_write_checksum: sha1:98fc48415c699147037480bab996d23d0a2e33b4
+ pristine_git_object: c1b47f8e438af2e2bb8b1903403a4b38defb887f
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPaySchedulesRequest.java:
id: 0879056dad75
- last_write_checksum: sha1:95fe56f4940a170939cf9a58f52b1399c2412121
- pristine_git_object: 6cdb1a8e7defbb03949fd8120604fdcf74324236
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPaySchedulesRequestBody.java:
- id: 6e876e5cb46d
- last_write_checksum: sha1:24f27dae51566f895c48addf0ac78e8808f0164b
- pristine_git_object: 7f7fe860f89d334e2b48cf9b14894249013eaf7f
+ last_write_checksum: sha1:e8b3742b20f973e675001b5f356f29ff67e7767b
+ pristine_git_object: fa06e3da4d2bb71337bd38e6b1ef0e0fd6e65bc6
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPaySchedulesRequestBuilder.java:
id: 0fa900e117b7
- last_write_checksum: sha1:8171e2d7f3da3c97430555062d0aff9539e25a7e
- pristine_git_object: 566bf304340fb997d2ed4f901a8a40a5e589e582
+ last_write_checksum: sha1:68b162e1c6c64e8b5578348458667d817d061199
+ pristine_git_object: df38c76005cb6feae6d205061166d0a72c472cbd
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPaySchedulesResponse.java:
id: d6cf4edf9024
- last_write_checksum: sha1:c5f8ada548645399bd0df2aa363d63237ce7acb5
- pristine_git_object: c5fc5662a0a574685b0e1856f026824a217ad18e
+ last_write_checksum: sha1:493d9276923048d2f22cd22af130be84c3be5f71
+ pristine_git_object: 21094dc1ba6a4dac30ccb3194b4d1c17375e8df1
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPayrollsHeaderXGustoAPIVersion.java:
id: c62f371d365c
last_write_checksum: sha1:1319d5f380974f8a810bcc24cbf9513a227017b5
@@ -12455,28 +13128,24 @@ trackedFiles:
pristine_git_object: dcebf31324f2d684e076f220f13d2ef4e2482955
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPayrollsRequestBody.java:
id: 55c2ea7321de
- last_write_checksum: sha1:0e0ddb6a4598efc2e950eead2036f5638ee08381
- pristine_git_object: c3c1a606252d6d60e727c95f947be4ed0a3da3dc
+ last_write_checksum: sha1:155068d69b281ec0a9c00fd8a6b1470081a39abf
+ pristine_git_object: d223fcde78fd4b93896b6a8d2c1dffb3e7121344
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPayrollsRequestBuilder.java:
id: 110a9147669e
last_write_checksum: sha1:7926094fba43c9de0f7f7b85f04f4340af0a82ef
pristine_git_object: 34311f2c7cfb4eb97904d089896ce5aa70788054
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPayrollsResponse.java:
id: 3c24cf855192
- last_write_checksum: sha1:458ffa7642b7c1a474af7623d849127767d4223c
- pristine_git_object: fd75f26a0c7769a711bf7d3b7672dd1aeeec4ac5
+ last_write_checksum: sha1:0dcc82778576e76d5389ca3ce50e31187ae59de4
+ pristine_git_object: 8b23e4283d7f9909f8b19afd82d40a512b0e293b
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesAccountType.java:
id: 51ae83bbf11a
last_write_checksum: sha1:97ff45b8f3619839fd293d9e4f4d90694fafb8ca
pristine_git_object: 3dd4d680855d506e80e2198838ac33a9a319f748
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesEntityType.java:
- id: 5d10fcfd5312
- last_write_checksum: sha1:af7c1560c637a6f35a4c81bd6272894dbcfca550
- pristine_git_object: e22023a3c44e6b5cee5142175f468357c5eb73cc
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesHeaderXGustoAPIVersion.java:
id: 12764b51bf1a
- last_write_checksum: sha1:5ca0b8e42e6a4cddf02a2974b6e6c76601d7f03f
- pristine_git_object: 774bdd0c39063973b597fd750d210228b0c660a5
+ last_write_checksum: sha1:287f00d4ef502f49913b61a4709f46dd5060d627
+ pristine_git_object: 1b435b88a212e04bf25b17b1f838323d907caef2
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesHomeAddress.java:
id: f8bd32cf477a
last_write_checksum: sha1:da5dca646542542efc611720427055e7da2c5c5b
@@ -12485,38 +13154,26 @@ trackedFiles:
id: 45b575c1f0bf
last_write_checksum: sha1:c435453a90e414bb750a0dde585323bae4e8b65a
pristine_git_object: 7d0f150930ff825a336bfd33fa9c76db22e360f6
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesPaymentUnit.java:
- id: "257774818679"
- last_write_checksum: sha1:0d809d15d355df8df7dd4fe5ced5465d628c30e3
- pristine_git_object: b747584a1df0623fa0b6f5ea1698a8b85ba512c2
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesRequest.java:
id: 9297310feefe
- last_write_checksum: sha1:f53e699a2de956188e41f7a4846e152c025977f2
- pristine_git_object: 8521412953147d934836ee62dab3097f780409a7
+ last_write_checksum: sha1:11df21f42bc677cf1eb6b349705a5ef1f9a7bd74
+ pristine_git_object: 36b0bdd75a789335bc8cd4b0142cd06226fe9030
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesRequestBody.java:
id: 8e3c07997f89
last_write_checksum: sha1:61118439b03224057e86869a996567696e84bd31
pristine_git_object: 7fc0adb984908e790f5b82b2d2b604a9f8cfdba5
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesRequestBuilder.java:
id: 7cf4524d2104
- last_write_checksum: sha1:bc30c4dc639d415d44c974ead02012fc2b94b221
- pristine_git_object: 542290391d2450e934de7e0b1a687b13e9064932
+ last_write_checksum: sha1:1bf0970acf6be124a357fda17bffd6d71e400f7c
+ pristine_git_object: 88cb5ba3eee0e1467377f308e7f0cc89b0f7d8f7
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesResponse.java:
id: c941abbfcb08
- last_write_checksum: sha1:800e283dbf0e97f6cd0e76722a60d21221c90bab
- pristine_git_object: 8770b64315cd1f5d5a5f37ba14bf147c224452ea
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesResponseBody.java:
- id: 8d15f8a47743
- last_write_checksum: sha1:188b0a8fa720b44554380ea177b54a51dcc8f56f
- pristine_git_object: 2805bef1c3f6a40d35f9fe7db943af222cf0eaa2
+ last_write_checksum: sha1:c7f0209512228149aa943f201ae22c2608744070
+ pristine_git_object: 295465e9c687b1638925b2b72332f535b549818d
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesSplitBy.java:
id: dbba803636be
last_write_checksum: sha1:836d2d23301d832f46df32e69792354025440984
pristine_git_object: 0d9ad54dea3afe78a3f06a7522e9f7f74d66e455
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesStatus.java:
- id: e68fca3ef677
- last_write_checksum: sha1:f784a045f2b1c7d9cb541211ec34a5d722dd477e
- pristine_git_object: f20e328b2e41df85aab66fff9a03df52cce9deb2
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdPeopleBatchesType.java:
id: 8cb99e3a22ce
last_write_checksum: sha1:dda79158c89706ac315b3d6919a44849bb13df0c
@@ -12527,20 +13184,20 @@ trackedFiles:
pristine_git_object: 5151d0ebb630d47a0d34f1534b346a2ee0e26d99
? src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdReportsEmployeesAnnualFicaWageHeaderXGustoAPIVersion.java
: id: c1608647dd66
- last_write_checksum: sha1:909ee89663f28efc8baad0e4fdeb5fe1ebae9d2f
- pristine_git_object: fd6e99233dd3bf1a96ddea79d9991dc634a45559
+ last_write_checksum: sha1:a8f2d675577f62827a128c6588cdd29885a5062f
+ pristine_git_object: 406fd5ebb4b3b5d17265ce55b65e0a13dc63eed4
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdReportsEmployeesAnnualFicaWageRequest.java:
id: 1e17e2217788
- last_write_checksum: sha1:a19dea71e3adc9e4a4cb678ed509981cadae4088
- pristine_git_object: e9252f81f0b223a432ad4e2761d1b868025a1018
+ last_write_checksum: sha1:25874bf0ae7dda35a7bd236d697ab18816975873
+ pristine_git_object: 44a5cca2888264ff6b29f8053d15c1140dbb2e1f
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdReportsEmployeesAnnualFicaWageRequestBody.java:
id: 8138b8c4aec3
last_write_checksum: sha1:eb3a58476c3b5e7b6515d3b11d829cb7ef41ef6b
pristine_git_object: cb8517f49d26ab4b41b713a95e82d7322fffe17d
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdReportsEmployeesAnnualFicaWageRequestBuilder.java:
id: 8515a06a111a
- last_write_checksum: sha1:9f33e17aa872b7f7f6c559d37250034a547b5bdf
- pristine_git_object: 4905b363f1fbb342d2ce416c0b62ec6ea78dcf11
+ last_write_checksum: sha1:4c7ba757ea5a437d20ef4c0348505c8d363c96fd
+ pristine_git_object: d29a43223cd03b39cd087bc0643f1c8d1927d989
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyIdReportsEmployeesAnnualFicaWageResponse.java:
id: 806f6f89a30b
last_write_checksum: sha1:a43a98ca4d80b9527f64f897a8c32cfefb7f961e
@@ -12549,122 +13206,118 @@ trackedFiles:
id: 9d5ac7f55980
last_write_checksum: sha1:0c92931b6442376da78ea72f535303b7ccf90311
pristine_git_object: 7239bb30959162c3c05985a0a08c024745ebd554
+ src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidContractorsHeaderXGustoAPIVersion.java:
+ id: beb0fe9a7a16
+ last_write_checksum: sha1:fc6ff8f782631e647f6e29e702705a236f64ca0d
+ pristine_git_object: 078ed5f2a4e1f1f7353fe0f9d180d6ee230058d5
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidContractorsRequest.java:
id: 277eecbc4982
- last_write_checksum: sha1:8425df20dc7f8b4484ec10f06f3e35783bca8c44
- pristine_git_object: c76e7ac81a1531b7b7c4e95dbfcdf8546453438e
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidContractorsRequestBody.java:
- id: c9975acef765
- last_write_checksum: sha1:eeb0028c2f6fc900e5796aa82914f960b87061f9
- pristine_git_object: 3919b31d89b74e8b61f04c2010476509200e2584
+ last_write_checksum: sha1:c9a746153f422989e20daaa24a8cfb01839e83e7
+ pristine_git_object: 67d2edb8dd9d4eb85f6d41bff09267475fe46556
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidContractorsRequestBuilder.java:
id: 5baa8cd4aa8f
- last_write_checksum: sha1:bc028d8b8522855349cd7be2adf71750ad1e348b
- pristine_git_object: 0b778da76053ea97a7f4521acd16f9810bafa548
+ last_write_checksum: sha1:3eee75376c29eff8b4a3914c61fac9b230880098
+ pristine_git_object: 4e8fc1b7388dfcefd015047756dd858ac77c873c
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidContractorsResponse.java:
id: 19c1010d12ae
- last_write_checksum: sha1:5e63c6dff44b78c6a79ab425b18343a21d360bb0
- pristine_git_object: 8828906a3a4049975fc136404cfff9f5ad2940cc
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidContractorsType.java:
- id: 7843592ecf3c
- last_write_checksum: sha1:84b1c6bccb34ea80ce4d6e2ebfe9251059a6fba3
- pristine_git_object: b2c796874b576349f9d5f1d1176946664880f6ad
+ last_write_checksum: sha1:0b8507b3647929a1e5bac25f45a79181e5e03b87
+ pristine_git_object: 4e5571d25c552e1ef53ca779467b20e00c8eb887
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidHolidayPayPolicyHeaderXGustoAPIVersion.java:
id: c438728f92e6
- last_write_checksum: sha1:56cc5b546daf4fbcc17c55c3ea9ec76352828faa
- pristine_git_object: d6bbf99763e95edbf47b565392f17aad6a88af3b
+ last_write_checksum: sha1:62e88957a06b488452dbeb0aa656eadb740852cb
+ pristine_git_object: c3d563c49c83e145143c9bba3dc71a20f6df6db5
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidHolidayPayPolicyRequest.java:
id: 5e180e8264c3
- last_write_checksum: sha1:d4f55a98640690ee90617311fa89d8c46b59c1df
- pristine_git_object: e69359d38c4cabbe622d89934be928d85d2115fe
+ last_write_checksum: sha1:e236742ed1ee2e1743dd63a3bcec7547634277b2
+ pristine_git_object: 201122f282399b88c9d568157f880a0d3da49a19
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidHolidayPayPolicyRequestBuilder.java:
id: 06581a18aa6d
- last_write_checksum: sha1:d578f591046b831026e331df3c2a36638fef0a34
- pristine_git_object: 0ea1b9ad3881775194cd36bcf3017d61d14b1c23
+ last_write_checksum: sha1:89d11a3326bdb54dfa414e103a187fda81f13569
+ pristine_git_object: 1f85f8b9ce5415cca389e1ed49dbf46b5a915453
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidHolidayPayPolicyResponse.java:
id: 2d73e41bad32
last_write_checksum: sha1:e59804f47ab3a99737f73a0ba39b7ab4c78de3e9
pristine_git_object: c6b1d88b7a2f52b4d2087519e8d55f5a2774bfd7
+ src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidSignatoriesInviteHeaderXGustoAPIVersion.java:
+ id: f090d883a458
+ last_write_checksum: sha1:34e32f98e8c95f397e45a9ed1226d925853047cc
+ pristine_git_object: 4121a19a793a0603e4742735fa028bbf5cefda30
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidSignatoriesInviteRequest.java:
id: d731f0206378
- last_write_checksum: sha1:7ede5ab41e8711ecaa1c75981f8d971b1de433a7
- pristine_git_object: 5738c8e9f2fcdef0f59d9fb41a3f134a44ad4e82
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidSignatoriesInviteRequestBody.java:
- id: 6a17b08094da
- last_write_checksum: sha1:f8f26b4b6ff5fdd12ede9ae5b663769dc813ec76
- pristine_git_object: 9263bceb131cba8d57fc15ddc0ceefcd8638f165
+ last_write_checksum: sha1:804063aba5582279c0b4a87c490f9e52fe2509f2
+ pristine_git_object: b2d634d0113ab2bad935f6d50d159e4230736be6
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidSignatoriesInviteRequestBuilder.java:
id: a46c87f2c6e6
- last_write_checksum: sha1:825391d3f0fb8a3bcef2ddb947ea1502db540e77
- pristine_git_object: e610e541f98f3eeba8676de0787cf516ca10e775
+ last_write_checksum: sha1:a7916b948004aca1155f910d715f34db16ae7500
+ pristine_git_object: 18eab821b668301e1936fd48d5df77af9e8b8bf5
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidSignatoriesInviteResponse.java:
id: 53e0660c2b01
- last_write_checksum: sha1:46a1874318d2bddbe853b7967a5ec49a62812299
- pristine_git_object: ae9390083e057669b417900317b9ca35467935c6
+ last_write_checksum: sha1:977dfe2e42fc5b3ba9c189154980ae705b6d338f
+ pristine_git_object: 3da4a653d62c4e6505c545e284cff9cf9333f46a
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidTimeOffPoliciesHeaderXGustoAPIVersion.java:
id: 0c35a854dcd6
- last_write_checksum: sha1:b359c8a3c4a6ac368ef162f55320ca97fc9b19e6
- pristine_git_object: 10ea127f3fa0b78edce31170802121048e816109
+ last_write_checksum: sha1:1fa6e8d32f30e3208cab83cda806b6e21608d679
+ pristine_git_object: fb41a20f74a19f94077a585d50acf7cb3f49c3cb
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidTimeOffPoliciesRequest.java:
id: eaf090209c02
- last_write_checksum: sha1:bf4322eecbca4542748941000b658c63ab20114a
- pristine_git_object: 571641dbe8fe48b56b2229b4efb61714e6bb2145
+ last_write_checksum: sha1:4f7c8fe4ce9f4302c7f454f21cee8336676d3d1d
+ pristine_git_object: 1d92f122317a9c469a577abcd320152b7f1030c8
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidTimeOffPoliciesRequestBuilder.java:
id: 24de68258208
- last_write_checksum: sha1:c66c1d4d413bfc3c9f9d5581a65f883e6e481221
- pristine_git_object: 3a01212f2202accef2ef2dbd270cc9e72683fd62
+ last_write_checksum: sha1:4031555b480b0ef9d77b89287d146a6fda35fdd3
+ pristine_git_object: db2ddced590330f5b6626e56e7e6b3cf80b36264
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompaniesCompanyUuidTimeOffPoliciesResponse.java:
id: 5b401f73ee83
last_write_checksum: sha1:d49f462c1ae9801f6f2a898e4f2a028e16315bfc
pristine_git_object: 154cd4e9acbd41c7f571eec711736e79f170ad9d
+ src/main/java/com/gusto/embedded_api/models/operations/PostV1CompanyFlowsHeaderXGustoAPIVersion.java:
+ id: 1a5ceb3a5a69
+ last_write_checksum: sha1:426ce8153692321c3b8b1660100586cd721fccc9
+ pristine_git_object: a90ab6bd477c306384d79e3e336271aa8c8340c7
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompanyFlowsRequest.java:
id: 2f47fbebe48b
- last_write_checksum: sha1:ff88cd49785bc33d2a94cef7157d3982d172da01
- pristine_git_object: a4a85e37395ee35335451e37d63fa242e103d00d
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompanyFlowsRequestBody.java:
- id: 71ced4efa2a2
- last_write_checksum: sha1:f7aacafc57210a325f356de32a5db628de3c4fca
- pristine_git_object: 34f708e138cb19acc3c95fbb8c6a72948d682b0a
+ last_write_checksum: sha1:40d9820fa297225938c17b20eebb3c87f57d0f45
+ pristine_git_object: 2aa4473b6012e0412a93530d0e58a84435340b27
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompanyFlowsRequestBuilder.java:
id: fb550f5e5d5f
- last_write_checksum: sha1:f5ac35c614bf6ec51cea23e526d8f4893eab04f4
- pristine_git_object: 1a74103d9854276eb9fa4ce2304f101c6601bb7b
+ last_write_checksum: sha1:169e8d560adf7789397e38907582e13a8614e3ad
+ pristine_git_object: 36615d05cf052c1d44f388041611b8bdd26abd8e
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompanyFlowsResponse.java:
id: 18bcad161530
- last_write_checksum: sha1:c7c195abe119bf098a225e11030dcf0aa21103bc
- pristine_git_object: c1828fd804c48f4cd837e3f23f643421039e24e3
+ last_write_checksum: sha1:c4a60a225f879ee5fdc015ce4468db809eed530f
+ pristine_git_object: 404c59f7cef62bc955ce96477a1e8cd195c7eff9
+ src/main/java/com/gusto/embedded_api/models/operations/PostV1CompanySignatoriesHeaderXGustoAPIVersion.java:
+ id: 4f8badcfdf1b
+ last_write_checksum: sha1:4ea1850f94a98f4de3dbc6fe9f370a7dc4e52ab9
+ pristine_git_object: be1530f69599b200352e87f89b271a6fe89b7f7c
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompanySignatoriesRequest.java:
id: 4d8f801e31fe
- last_write_checksum: sha1:bd98ad6fe7c821471c73ec62c12225a65eb0874f
- pristine_git_object: fbf318faa05bd6d177278d15deda301a3a25ee94
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompanySignatoriesRequestBody.java:
- id: 1531a231658c
- last_write_checksum: sha1:ad2e70b2dd9d7ddfe6b8c8c59adf7bf7f45c7c93
- pristine_git_object: 7ade79081c7a37477c1e796f0202e6818851a861
+ last_write_checksum: sha1:f246f3f8db96a80248916d6202e6a6cb7fdd02af
+ pristine_git_object: 2270cdcdd7bdee18e6b224bfed10df0c1214bfdd
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompanySignatoriesRequestBuilder.java:
id: bafd14df761e
- last_write_checksum: sha1:aa92be8b380b82808220cb3eea6b35036d513a06
- pristine_git_object: 2b139790cb8609a9e662d1703510e27147d389d2
+ last_write_checksum: sha1:64a5b3f654d63c62f642e9c0fa224e7e54b62d5b
+ pristine_git_object: c2963c9a2e3140657e53635ab471f394019250ff
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompanySignatoriesResponse.java:
id: 6429f1bb1adf
- last_write_checksum: sha1:e54be75cc1d6cc2fd55f621ad170c2a40db02cdb
- pristine_git_object: 83e59739a7a3406c2b759b76c2432b2fe336c81c
+ last_write_checksum: sha1:939880e440f127d632852388a0dffb083fa1db3d
+ pristine_git_object: 253e8a8ec71c90ca74f7185927bacb4662d6fe2a
+ src/main/java/com/gusto/embedded_api/models/operations/PostV1CompensationsCompensationIdHeaderXGustoAPIVersion.java:
+ id: 9a0943919995
+ last_write_checksum: sha1:81353299d995507697b1d2bd2fc7b4c7aba56ea7
+ pristine_git_object: 697f1d790b3ea4ea12600fa22c9bfeacaae7e81c
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompensationsCompensationIdRequest.java:
id: 119e0e88087e
- last_write_checksum: sha1:1ac9c3db66f8445d6ca8b19910dd71990e860b9c
- pristine_git_object: 70c5666e4110a077fec3ab7f883a532687186de0
- src/main/java/com/gusto/embedded_api/models/operations/PostV1CompensationsCompensationIdRequestBody.java:
- id: 2c54e72b8212
- last_write_checksum: sha1:34e51b104558f275b49be8b01d4404fc748adc14
- pristine_git_object: 35e5df83d8b8ed4ef856a73adf73c89cef85a21e
+ last_write_checksum: sha1:92759c938ea2edf9b1572ed22bd4319c8ad8d7a4
+ pristine_git_object: 2d6aa32aa1235c95a75324b0bfde37e231890919
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompensationsCompensationIdRequestBuilder.java:
id: db5c1b02c149
- last_write_checksum: sha1:e3c75da1492b0d7888d51369706cc625e032fe36
- pristine_git_object: 6a14d17d5134850c74d32e08385af092a1fa1bae
+ last_write_checksum: sha1:ecd739c21a3c4ee7cd3a8e0fc6900890f31fc6fe
+ pristine_git_object: 4dffaa1f3bee9739c5981a83755233e1b3fab979
src/main/java/com/gusto/embedded_api/models/operations/PostV1CompensationsCompensationIdResponse.java:
id: d7b2f1664cf7
- last_write_checksum: sha1:6e461f650b24a6ed88aee04174c212941a574c20
- pristine_git_object: a549bd592e28492a76eb14cf2735878d27059d68
+ last_write_checksum: sha1:34187f9becf34388572530e6619164add61a2d45
+ pristine_git_object: 2a550f92d0b1109a0f2919fe000dbb63860632d4
src/main/java/com/gusto/embedded_api/models/operations/PostV1ContractorsContractorUuidBankAccountsAccountType.java:
id: 1d414a104c63
last_write_checksum: sha1:fe01deac8db34ecaefb220055e353ccd25b12699
@@ -12759,28 +13412,24 @@ trackedFiles:
pristine_git_object: f421301107be0864962250b4b6c462e181837de3
? src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeIdRecurringReimbursementsHeaderXGustoAPIVersion.java
: id: 2331fa8d20be
- last_write_checksum: sha1:367f26d33256c8ae57560449f68d54b2ed81bbf6
- pristine_git_object: 262891208ba582cb24d0e5a2e1e025a5cabf16c4
+ last_write_checksum: sha1:54dd30aeeac34efde2997323bf723824f7a6724d
+ pristine_git_object: 183ea1865708c246f0762a5b306d2491b7c6a6f8
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeIdRecurringReimbursementsRequest.java:
id: aabaf1c03485
- last_write_checksum: sha1:63d09af2fde67e9fbd351b64e23724cc48a78b14
- pristine_git_object: 9299fa201507baaa46f766e70ec52d946da0b9c9
+ last_write_checksum: sha1:a57466a823a98ab26ab92afbf9872db7222c61f4
+ pristine_git_object: b72ce7279858f8b9f4d2e2516b6c1e121fa389dd
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeIdRecurringReimbursementsRequestBody.java:
id: 24901e8ce2c2
last_write_checksum: sha1:426252fefdac3890e7984e94211a25b239a01831
pristine_git_object: 0110648f6a663938d006eac156ed830541f400ce
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeIdRecurringReimbursementsRequestBuilder.java:
id: 8d4acf2c148b
- last_write_checksum: sha1:9c275a6c30d465b8140b044cd64eeca6deb6d2ed
- pristine_git_object: 47d0edec612f58e6370e185d2b7cda1daaebbba6
+ last_write_checksum: sha1:a8e33c88fa1ba6ce780dca9f433c130dbdc89d28
+ pristine_git_object: bc51f04f6aa59a7cb668333ccfc6cd6a683fa629
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeIdRecurringReimbursementsResponse.java:
id: cc88505e573a
- last_write_checksum: sha1:b4d4881efda634892dcb341a031084aae1199e9f
- pristine_git_object: 562aa79e0ec5daaa816509a0b7e49346b8503b90
- src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeIdRecurringReimbursementsResponseBody.java:
- id: ca06f2bdd796
- last_write_checksum: sha1:c9ed7d7f6cb602892cfc927626903a766ceb6d5a
- pristine_git_object: ce48a2dfada999e53ffebbff33e3c23144c57eef
+ last_write_checksum: sha1:b981df7992a6d892ac44440c06714e77161d5055
+ pristine_git_object: 351f43235fa38c87a24ac110eeb985f1878c0393
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeIdRehireRequest.java:
id: c896b855164b
last_write_checksum: sha1:16b34ca7377569e789332921649e0b667b6650ec
@@ -12795,20 +13444,20 @@ trackedFiles:
pristine_git_object: f22bf2c8fff87de88e1735693104bd749c23af3b
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeIdSalaryEstimatesHeaderXGustoAPIVersion.java:
id: a252550bd660
- last_write_checksum: sha1:e30d8230c0fd2192c5aedf8fbf58ea5fc655d2a0
- pristine_git_object: ff2eb278f6fba2fce3415abdf6a5f7509912310d
+ last_write_checksum: sha1:8ebe6f9809f135598e573008c371408f73df475a
+ pristine_git_object: 3714af9b73c4938f764c8521642316b726f730a3
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeIdSalaryEstimatesRequest.java:
id: b6d669035afc
- last_write_checksum: sha1:2605ca6bb9244f5b9cf8a39cf34ae1077b15f3d1
- pristine_git_object: 25d15de4476ab9b3b3d36eff801767665b51c80e
+ last_write_checksum: sha1:2f86611bab6a1b4ac7ba163f254c7318aff5de43
+ pristine_git_object: 65c0acae0be0a854ea2a6cc38361b4331ab1e58e
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeIdSalaryEstimatesRequestBody.java:
id: 2d9a824e1f28
last_write_checksum: sha1:c2b5f9340c5bfcbdaaa85ec017d700d3b29c1537
pristine_git_object: ed96592dbcb3f86bdbb655a766a41b9e7e392c81
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeIdSalaryEstimatesRequestBuilder.java:
id: 68a18006fda3
- last_write_checksum: sha1:6d288dc503477f43407eee3b47ac01a259cb89b4
- pristine_git_object: 512c8d26da3d90c039be83148a22f6b5e8bcb6c1
+ last_write_checksum: sha1:fea3fb7560efe32aad2bfb73f07a727609231d8f
+ pristine_git_object: 268a0601ad67249a98153d4fa96a06ebf8d74b66
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeIdSalaryEstimatesResponse.java:
id: 49a7f67ea5a6
last_write_checksum: sha1:fb5325a6842429830d4652dee947b52b5b654885
@@ -12851,16 +13500,16 @@ trackedFiles:
pristine_git_object: b5d3cdf4791ed5d20ac19f205ab67efa8a13e565
? src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeUuidSection603HighEarnerStatusesHeaderXGustoAPIVersion.java
: id: fd5dea880499
- last_write_checksum: sha1:1ffd4b74d6d4569852b3b7f320195deeebc119d8
- pristine_git_object: 4bac27c6ee70d6b46df015b7b08c7eea5caf5325
+ last_write_checksum: sha1:3990ead2f4a31157127d7bf8a3fbac7f124bb4a7
+ pristine_git_object: 2147de2cd3784b7d85d7c1d308e11037a355c8ad
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeUuidSection603HighEarnerStatusesRequest.java:
id: d2f8123824d9
- last_write_checksum: sha1:44ac594a08de4f2a5ecbf83978599e9ab340ea61
- pristine_git_object: 40175e12a5ce9817d627a0d9481a09d2f0018ee4
+ last_write_checksum: sha1:e05570257a258d1cb7d92dafefe5d96ea52317a3
+ pristine_git_object: ae0a26ccd125f5fca141fabdfa9f20d319d7cdb1
? src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeUuidSection603HighEarnerStatusesRequestBuilder.java
: id: 3d9e4e134fe1
- last_write_checksum: sha1:cc64b607f80cc2b5cdf6f31f3adcaaa6c463ff95
- pristine_git_object: 58ba09dac52943e2909d45217550a91d096b326f
+ last_write_checksum: sha1:47766a22e41aea6d410b3d54f13a18935e15d5fb
+ pristine_git_object: c2fa4d2a6413ddb6d6f00ee5e6d4ec5690dbf3ca
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesEmployeeUuidSection603HighEarnerStatusesResponse.java:
id: 972e6d2e0bf7
last_write_checksum: sha1:a484a27f38104bea6eee6d9f1b1615bafd36a944
@@ -12875,8 +13524,8 @@ trackedFiles:
pristine_git_object: ef971e5b7f5d7e83beb931a247bf5245f904c4a7
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesRequestBody.java:
id: a5ba1de4a87e
- last_write_checksum: sha1:ce210039739689a518c78c2d0f5ce3f14622ef98
- pristine_git_object: d72d4bd3ada6d566699a7bab2e6fbeb1f241a982
+ last_write_checksum: sha1:696552aeab80b6c6e651c25c6cb27d37f282a743
+ pristine_git_object: 8714241a9c99dc3b2f9215dff62ccd219a9a9d29
src/main/java/com/gusto/embedded_api/models/operations/PostV1EmployeesRequestBuilder.java:
id: 571717d482f1
last_write_checksum: sha1:d96ab854e36e91be70d5c105e5b2ba53e4a336a6
@@ -12953,22 +13602,22 @@ trackedFiles:
id: 8d7a4355acf1
last_write_checksum: sha1:4d3e72d3a7f245363d33dd743762b653113210cd
pristine_git_object: 58b8da58fdf592942fb62338c7fb2a21936c141f
+ ? src/main/java/com/gusto/embedded_api/models/operations/PostV1PayrollsPayrollIdCalculateAccruingTimeOffHoursHeaderXGustoAPIVersion.java
+ : id: 9400ff455733
+ last_write_checksum: sha1:d43384bbcd5d4757f86de227501e4293f2bf104e
+ pristine_git_object: 36b6560e6564d148c27e59d1ca9c209568b230ee
src/main/java/com/gusto/embedded_api/models/operations/PostV1PayrollsPayrollIdCalculateAccruingTimeOffHoursRequest.java:
id: 00ce7d8cdaff
- last_write_checksum: sha1:3feda406eac3047c98b2ca22cc7e396abc688fa4
- pristine_git_object: 902f4e8e33769c1f0a736e5c44d4ffc392132798
- src/main/java/com/gusto/embedded_api/models/operations/PostV1PayrollsPayrollIdCalculateAccruingTimeOffHoursRequestBody.java:
- id: 423122ef2c4e
- last_write_checksum: sha1:608ba759953b55f5014e9d354e3e32622c671a68
- pristine_git_object: 2c05c190cdd5a7f9b28d657665791f4a4979fbbd
+ last_write_checksum: sha1:23c061cbf6cc5014a912fd645ed439aeb3c3c7f7
+ pristine_git_object: 87bb64c97f1039b42acdc621747373622079ba90
src/main/java/com/gusto/embedded_api/models/operations/PostV1PayrollsPayrollIdCalculateAccruingTimeOffHoursRequestBuilder.java:
id: 403194fe35e0
- last_write_checksum: sha1:6eae65fcac320ffe37d29f0a05b1519b51bded93
- pristine_git_object: de7d20f9c5df6b58d02c1d321a7cca896f81dacb
+ last_write_checksum: sha1:b69ba9d1a9c6ca2878b903e42b5214204327033c
+ pristine_git_object: 690d5a475c678ba0bca2a41bfc5871a97c298568
src/main/java/com/gusto/embedded_api/models/operations/PostV1PayrollsPayrollIdCalculateAccruingTimeOffHoursResponse.java:
id: 4f2bd43ad8dc
- last_write_checksum: sha1:120117019cd076100c8a4e2455d3cdfd1e5e3f31
- pristine_git_object: 32409b4a49f6c87ca81a9b1bca5580a6ff6bfa06
+ last_write_checksum: sha1:496bbb5dda7468724fec5a2ec0e8be36d51319b1
+ pristine_git_object: 8e65ddebc5edabeb217b63097cc54026cfc3a0c7
? src/main/java/com/gusto/embedded_api/models/operations/PostV1PayrollsPayrollUuidGeneratedDocumentsPrintablePayrollChecksRequest.java
: id: 9157617869c4
last_write_checksum: sha1:f7ec9cb4becf00553908a486b9712b1805119240
@@ -13007,20 +13656,20 @@ trackedFiles:
pristine_git_object: 33cea7c3449aee747163a6f4683f787b19f36fa0
src/main/java/com/gusto/embedded_api/models/operations/PostV1SalaryEstimatesUuidAcceptHeaderXGustoAPIVersion.java:
id: 36e5da842999
- last_write_checksum: sha1:b08c2231e6163f301d78bfd92e2c62a0b7d2d934
- pristine_git_object: 2ab753b2e9d5aebbf155855ad91da7dbdf36220e
+ last_write_checksum: sha1:571257e3e6b1889143ba77e1a8abb25717e0cbbd
+ pristine_git_object: 4caaaf1e7ff640b9113891ac4aed812a24559edb
src/main/java/com/gusto/embedded_api/models/operations/PostV1SalaryEstimatesUuidAcceptRequest.java:
id: 47ddc44a0349
- last_write_checksum: sha1:b5fae00c2c8f40073f218f1e91d61883725754b9
- pristine_git_object: ea84039b8466cb9d335c46e70f4a6563b215e6e5
+ last_write_checksum: sha1:4d0ea476b596f07532dce0bfe4c9a40feb89442a
+ pristine_git_object: 5ef8384755bf59889df1eacef92a06ad57835c9c
src/main/java/com/gusto/embedded_api/models/operations/PostV1SalaryEstimatesUuidAcceptRequestBody.java:
id: 3252bf0b44ac
last_write_checksum: sha1:5cd2e180fa53a99a700c3b28aa7511e4e770da74
pristine_git_object: 0e268b968bbe0bc058820897010c991ea4c79cb6
src/main/java/com/gusto/embedded_api/models/operations/PostV1SalaryEstimatesUuidAcceptRequestBuilder.java:
id: 056fae052ec9
- last_write_checksum: sha1:fd78af291124c09a45f02b4fbed95eca9b646d23
- pristine_git_object: 189d4aaa63ed61a0614e579601360aabd6c82575
+ last_write_checksum: sha1:e59d37f9401c5c0bd278ae25c1acd505ebf0ef17
+ pristine_git_object: e7dde34de8d1873c399a689de2ba9f67517f2d0f
src/main/java/com/gusto/embedded_api/models/operations/PostV1SalaryEstimatesUuidAcceptResponse.java:
id: 33779350e9a1
last_write_checksum: sha1:c47d63360882d7d7284ae909f2aeae5a30d2cef0
@@ -13093,6 +13742,10 @@ trackedFiles:
id: 1c0111ba5b8d
last_write_checksum: sha1:0053d505fb1e224a92f03830542015c56036aa21
pristine_git_object: 5b046641f842783e926b590ebaca0177064874b4
+ ? src/main/java/com/gusto/embedded_api/models/operations/PutAPIV1CompaniesCompanyIdPayrollsPayrollIdCancelHeaderXGustoAPIVersion.java
+ : id: a7e8a3481f03
+ last_write_checksum: sha1:e1d475034843476d3bdae130b6ceffa71147f046
+ pristine_git_object: fcc165d5c7beedcec1c2e26ce4d644acec37ec08
src/main/java/com/gusto/embedded_api/models/operations/PutAddPeopleToDepartmentRequest.java:
id: 08b397915bcb
last_write_checksum: sha1:0178076fc79d3212bcb070b4b6c29dce882b5e5e
@@ -13111,16 +13764,16 @@ trackedFiles:
pristine_git_object: fe7bcb8dce57b3ea004a08d459e1b8ad952ab862
src/main/java/com/gusto/embedded_api/models/operations/PutApiV1CompaniesCompanyIdPayrollsPayrollIdCancelRequest.java:
id: 55c4c28697e6
- last_write_checksum: sha1:79f80e468ab7237edd7b615537b42ef0bf4f2a31
- pristine_git_object: 6355d3a88c11ae0fff00c1840e403264b814d72c
+ last_write_checksum: sha1:fd3fed82c3ff3045c6d0f3276dfe0dad69b7e684
+ pristine_git_object: 3162452e47c6d968fd3d501fb317fec0b3111115
src/main/java/com/gusto/embedded_api/models/operations/PutApiV1CompaniesCompanyIdPayrollsPayrollIdCancelRequestBuilder.java:
id: d92735f64ac5
- last_write_checksum: sha1:8406c5bc1bd62cbac22eba920f69f1a81d8a0135
- pristine_git_object: 3cb469c17206c0fe7793cd6b5df35143b28dc442
+ last_write_checksum: sha1:f6e37742151aa3f8299f2a6e298d2fd0eb1438df
+ pristine_git_object: 6945a0c1a8899f9409a2deb1cd3e089bd880528a
src/main/java/com/gusto/embedded_api/models/operations/PutApiV1CompaniesCompanyIdPayrollsPayrollIdCancelResponse.java:
id: 6649e608f3c0
- last_write_checksum: sha1:caaada6a54ea81b3069d0669624ccfda4b35d0cc
- pristine_git_object: ccbe1f137dd79b5a6a26328d4a39636c717025ae
+ last_write_checksum: sha1:92fc44e4a30b2be28bfc284282efaa7a5a4e9161
+ pristine_git_object: b324ada40a005820b36205f107ffa8214a38fe6f
src/main/java/com/gusto/embedded_api/models/operations/PutDepartmentsRequest.java:
id: 769f0aaa9380
last_write_checksum: sha1:fc6bd5eeaa5246c743d17759f2c0fb1785745a95
@@ -13161,22 +13814,22 @@ trackedFiles:
id: 7c0081754285
last_write_checksum: sha1:7e3d7c85152e05ba46b7189b733a69b547c58635
pristine_git_object: 3918ead9983684d41605e216d3558a832cca2544
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdBankAccountsVerifyHeaderXGustoAPIVersion.java:
+ id: a8e98aadc1b2
+ last_write_checksum: sha1:ad15ca38b5b4b47cbf90f556e370d7426392087b
+ pristine_git_object: 5c15f052d69b6185ee6ec3e06731de6215c6bce6
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdBankAccountsVerifyRequest.java:
id: 96f3d2c4686f
- last_write_checksum: sha1:c2a5661f3511fdcf82318d6bb8efe08a98f8067c
- pristine_git_object: 0f778ce55bdf5844ab05496e2400f918965e8c71
- src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdBankAccountsVerifyRequestBody.java:
- id: ab1bc4753c91
- last_write_checksum: sha1:4479d4f11092b3d4e9f636eeb5a77082510f87ea
- pristine_git_object: a4ed84343f154faa152f23fd2867105ae2c357b1
+ last_write_checksum: sha1:c05603c85ed780029497261dc0f178114350e712
+ pristine_git_object: 0dadd6ad2db573fb6fa6067138e948c27758ab40
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdBankAccountsVerifyRequestBuilder.java:
id: d05d872a11bb
- last_write_checksum: sha1:522e2a5ee096756b7fecc52e9e2918045ec9cd2b
- pristine_git_object: c51bf2c15b448cc3f059ff764375466c467c9983
+ last_write_checksum: sha1:7fbe9c5bdbac83b0f015377154dabdfbb74d36b9
+ pristine_git_object: 8525b504f2db483fa3436ff3980e379f50b38d95
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdBankAccountsVerifyResponse.java:
id: b1a075b68531
- last_write_checksum: sha1:2dccf857cde9a34051686fb9b2c54d286678353e
- pristine_git_object: f3caa7e8d05f35cd9aee8aa5c1d950072612d099
+ last_write_checksum: sha1:c0f36b5d760ff5b26fa90d7479ba60cd7288d4be
+ pristine_git_object: d1d130cdb8d642adfde487b095248450f07be0e0
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdEarningTypesEarningTypeUuidRequest.java:
id: a8772d61a520
last_write_checksum: sha1:9532603d364449b088156b6a333c516e8abd3d60
@@ -13209,46 +13862,82 @@ trackedFiles:
id: b7c5876247f1
last_write_checksum: sha1:6f6a5fc690b25e4204b2f0ce4d265c4d2db1d850
pristine_git_object: 2ad4c4c32548b2f4c9e81efbcfc9759015f7eef9
- src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdFrequency.java:
- id: 1aaa08347ea6
- last_write_checksum: sha1:e3df8044dac2c132b8474cbef3b9a5434822b4b5
- pristine_git_object: 732c60879f63d00fd3fa467f1ebd7a577bbb7544
+ ? src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdHeaderXGustoAPIVersion.java
+ : id: f70d7a889da8
+ last_write_checksum: sha1:d25f33423b7850cf65436124af20e939c16fa996
+ pristine_git_object: d005f753aafbcf59740d4ad4a394f21b7812ed4a
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdRequest.java:
id: c8a6997a63fe
- last_write_checksum: sha1:0fe3929ff4f9740bb5f7ac96ff99e5037a852b47
- pristine_git_object: 795a98b6d897746f668db3ad037cce349f5c2e16
- src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdRequestBody.java:
- id: 9f2f1acdb67b
- last_write_checksum: sha1:6d667b43776e00160e88f7baa329f9385cf0bc58
- pristine_git_object: 15595666fc67b0a3a4b36b129d61cb11d5b89b95
+ last_write_checksum: sha1:835cbf39eafe0bbbae773326386e9f7659291221
+ pristine_git_object: 4297407a36713d98d67ff8a399e997c3f3bd1765
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdRequestBuilder.java:
id: e057c4199775
- last_write_checksum: sha1:e80ba00dee65bde4e4ba25aab948527ee6020932
- pristine_git_object: 489bf03edb2e3f0992fd395762748645eba85ff6
+ last_write_checksum: sha1:83a631b399fd4888abf131bf45b9552bf1f104b9
+ pristine_git_object: 4a693acd0e98f7bd7071d25d2d58ee0273578275
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdResponse.java:
id: e77c204e8937
- last_write_checksum: sha1:b881d1d00a93053b78caaf7182b519b8792f67a0
- pristine_git_object: 9d4e1e2eb0d1ad0966dae8c6cf326ba8ddea1983
+ last_write_checksum: sha1:f027da4efe56dc195ffe95b0818ae0efcaef383c
+ pristine_git_object: 8d9d99195908c2e54571ffda0b473b95b3a1600a
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsHeaderXGustoAPIVersion.java:
id: "919809778e50"
last_write_checksum: sha1:c925286f94c4e016e4b5c2e0fe762fd0179e33fc
pristine_git_object: 17b7976d408cb41015e58075c71c3312470de69b
+ ? src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdCalculateHeaderXGustoAPIVersion.java
+ : id: 3d175cdcbfda
+ last_write_checksum: sha1:48390766e6684ff1baef837796fac96e8a40ec48
+ pristine_git_object: 8ec6b4113cddeba3b14d8ced8b715f9f928f346c
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdCalculateRequest.java:
+ id: aa4954e506e8
+ last_write_checksum: sha1:2b9e68ed78ec428905b9b949cc6fa5707870305e
+ pristine_git_object: 3893042d85eafb06ae0a72d4969a22b3f51556aa
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdCalculateRequestBuilder.java:
+ id: d22da15d54d8
+ last_write_checksum: sha1:841053b0876b8c3b43cdaf8b9daf043ef93dc256
+ pristine_git_object: 292c6fabb0b66ac06440f391b0b1b9aa889e40a2
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdCalculateResponse.java:
+ id: e980d2963c05
+ last_write_checksum: sha1:8c3d70a69ed64af9cf5e39d2d4b720987149adb9
+ pristine_git_object: 13e3548ff13d6bac1b3117dd9549f28e50c8da95
+ ? src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareHeaderXGustoAPIVersion.java
+ : id: 9eb992b701d4
+ last_write_checksum: sha1:954db3d8f783ba47a846cffdf3edc1cb5a473922
+ pristine_git_object: 967607705d191f4734b9ff8362686f87ce1928e5
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest.java:
id: 38978c91cb8e
- last_write_checksum: sha1:2b0a91e2dfa60ed2adea0cf42a07c19c44c1bdf2
- pristine_git_object: 79d945158dd912dd313845ee5ce42c30daad6817
+ last_write_checksum: sha1:3bd53b1db0b53c51f7f293aedaea5c5335a6670f
+ pristine_git_object: bb93be30c9782eaedca63331c5744209e79dc67b
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBody.java:
id: ca0a7d0ade88
- last_write_checksum: sha1:804679f4b9906fd9849dd1d0ef635f6bf0f2f777
- pristine_git_object: 51f61e878cab27547271dfd1f3c35ac3cb85e8ce
+ last_write_checksum: sha1:8ae3d4ec7a11a85764713dd5995dd77b19371851
+ pristine_git_object: a70a6817a6f8532e71e15f2d11cc27de6bcc1b8b
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBuilder.java:
id: 5f511889fedd
last_write_checksum: sha1:4550ace22faa5d6e3edf8e6ae3d5b8d873f72052
pristine_git_object: fd562541ab268eee029ebad7c92f28dd7eefed78
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareResponse.java:
id: 38403b41fc3c
- last_write_checksum: sha1:42d3a5f5289164fdcfe72669bb643600a7ad6d60
- pristine_git_object: 44e7b56d7de73ae68b814b2c2eb21728662724d9
+ last_write_checksum: sha1:7019b25d853c3a28775fceca73f4637300c57331
+ pristine_git_object: 56cdf8f36d2800eb7fb7dc9f9dc782355eb434b3
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdSubmitHeaderXGustoAPIVersion.java:
+ id: d713e84290be
+ last_write_checksum: sha1:fbba774f651d06dbf7ee7fa7e71f01ebc69991ec
+ pristine_git_object: 6951c19d16b7d11fcb642d8a835233d36fd516ad
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdSubmitRequest.java:
+ id: a2fca952140c
+ last_write_checksum: sha1:891b1e2555e2944c2b45f114a6afad093769f860
+ pristine_git_object: 3efc240b45cc8150699e9dbb1bc321e7320aa8a4
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdSubmitRequestBody.java:
+ id: 2ca7d6f472e5
+ last_write_checksum: sha1:b5cc57105ae6a4005e9eafe05af7e8b94e64e4d6
+ pristine_git_object: b6a0d23e08d9183c803211071cec6550edfe198e
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdSubmitRequestBuilder.java:
+ id: fb46f5f8d2ce
+ last_write_checksum: sha1:5ed8cb154d5b3648151e8c16e8ba43fa3306755d
+ pristine_git_object: e748bb9eb0ef4deaa922c722f42d20612875421a
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdSubmitResponse.java:
+ id: 4432cca18d24
+ last_write_checksum: sha1:a48d24a5dd7f11e181a631d52cdc6fb87acc9fe6
+ pristine_git_object: feadfd774212aa9371def86f7fd05dfba2f628e4
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsRequest.java:
id: 483edda0c6ca
last_write_checksum: sha1:8e71605ae422eb414df8fc948cc3a7d75e0a9488
@@ -13259,96 +13948,92 @@ trackedFiles:
pristine_git_object: 2cf4731664a458ed6c592c4cc8ef8881f37c3453
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyIdPayrollsResponse.java:
id: 426a193179ec
- last_write_checksum: sha1:823486df3687b9791865bb5be14776c9621b5fd7
- pristine_git_object: 3ef8790b0dd0abfdae85077e506d2f7819384c3f
+ last_write_checksum: sha1:ed7234b57722dc761c6ccaf9b8a8d72993dc2a94
+ pristine_git_object: 8478a05d6f6f586ae01ebce5eecef727d67d5cd7
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyAddEmployees.java:
id: 1a40387fc03d
last_write_checksum: sha1:a1c2b8f225089f1f9bb5bcb9e2a5a162418f29f6
pristine_git_object: d50eae90e74dabe83f735fe113392b5640ee2b1c
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyAddHeaderXGustoAPIVersion.java:
id: d89a7007801e
- last_write_checksum: sha1:fe547f909afa5559eccf1b671928eb6a7e13502f
- pristine_git_object: b39ebe98d24cc328aed4cbdfd62035e6432c236e
+ last_write_checksum: sha1:7e46e1161d2d010d5094f524d6ac8880d344db39
+ pristine_git_object: 9dbc7803ea49a8e1a9b3d22cc08f7a8d781d26aa
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyAddRequest.java:
id: 4c8f6e9a1b09
- last_write_checksum: sha1:12aba67fc2da1e36fd8775a837554be95174ae53
- pristine_git_object: dcb4678030f0697b65226b551ea126304fea9945
+ last_write_checksum: sha1:df804b15b4af468c0840bb07eb74ad5d2630a7bb
+ pristine_git_object: 7bb5cf1cead8c0fdf64a91bbb698507eeed08ff5
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyAddRequestBody.java:
id: e3b30fd05385
last_write_checksum: sha1:8014ce00ddb48409e2700faabd891bd9e30b078d
pristine_git_object: fa68ce89d914031095ac2f5810c08d6b655ce527
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyAddRequestBuilder.java:
id: f9e346e6eb19
- last_write_checksum: sha1:a0517c0d5e32afaeb2b27cf8d16e288c3a4b446c
- pristine_git_object: 67bc254958898c9522d7d5cc9ee23e9fff27c993
+ last_write_checksum: sha1:f984359f791a45f4395edc1e4c0a0b0eed9d270c
+ pristine_git_object: 8ee4f4405c58ce1ceb1a21d82ff8aadf7ba3fcf0
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyAddResponse.java:
id: 13dc783fcb3d
last_write_checksum: sha1:72590d3a85527c3452f3e7549de532a477aaa6b9
pristine_git_object: e89588f7b2af41ec646755418518a23936be6e63
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyHeaderXGustoAPIVersion.java:
id: ba3459dd098f
- last_write_checksum: sha1:eb077b76bc51240b62248261d8446484e34ffa0f
- pristine_git_object: 8191ac01eabd542f1b6b59a4ddb11d4fe9c6607a
+ last_write_checksum: sha1:8f3a5accf4b11deac7196e2cda531b5dd9f512d0
+ pristine_git_object: 4e5b800ae7064bc8151fee1e11ed5ae3f88a9a0c
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRemoveEmployees.java:
id: 747bb7c32def
last_write_checksum: sha1:f228084529a1b99654b25428066e34880e273db3
pristine_git_object: 26159318812dc76a91f7ceca6c1d7c7da3b6b139
? src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRemoveHeaderXGustoAPIVersion.java
: id: 1627586d2673
- last_write_checksum: sha1:77e8f2c90153af23325e88c44b30b21947f81d21
- pristine_git_object: 64161b1c873be947723eb06daf4cf3a89221d675
+ last_write_checksum: sha1:614ae7aa51defdd15408d6da85d4874929832d97
+ pristine_git_object: 66313c206c08ac92c0ffac189ef423b09a7b3c73
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRemoveRequest.java:
id: 7533d03c1da8
- last_write_checksum: sha1:9f61f28d2e08a23d7b599f00f60d5ab41c5c94b1
- pristine_git_object: 8916132d6d132b1d4a3e32993c87e59f5d656ca4
+ last_write_checksum: sha1:3845a87fd75bb887a2e4339f2344a9cf0d7d9dfe
+ pristine_git_object: 66f42efa1408c41d4f8af18bf88299aef5da2724
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRemoveRequestBody.java:
id: 633eb8a8bec4
last_write_checksum: sha1:f280a1dbdba1d6ab8069da002001dbd353196420
pristine_git_object: b275bd01e3a0c0e7965a13eae570ceb40cc053c9
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRemoveRequestBuilder.java:
id: 0046253a6bd8
- last_write_checksum: sha1:4eac1e7b99d845d5d4282fdfd253dc42001bbba7
- pristine_git_object: ddb4c9ef619e59e9000bcdb0a9f937f43044e3cc
+ last_write_checksum: sha1:4daee8fbe68db7864191ca4761ad3dd640779f1b
+ pristine_git_object: f70e2ba99610712f259384ec7e4f48c53c4f5d8e
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRemoveResponse.java:
id: b24409965073
last_write_checksum: sha1:f278819afac49eb93feec1d9a04e2a8e2393034d
pristine_git_object: bd470ef96959761f2d217ff50851a8d104b7bbd2
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRequest.java:
id: 17dfb0c6e6c6
- last_write_checksum: sha1:d3743d7de55429b6bdf541f8f6539a7c0453de17
- pristine_git_object: cbcbd9bd66f30e9f27d230f90e112046a0ef5b38
+ last_write_checksum: sha1:0bd6ff3f300a3842d8e303a5b9c755d34443cb63
+ pristine_git_object: 2fd54616ae0a6528b1444582fd75a32efd98b3b8
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRequestBody.java:
id: 7d5449282f5c
last_write_checksum: sha1:da36426eaf36d067a41f0001f10ae65566e44e0d
pristine_git_object: 46e2d7c0013332efa799cb52e3b97484c734bcc3
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRequestBuilder.java:
id: 01b55a7d4a25
- last_write_checksum: sha1:6d2bcc4662cc421b8c9818db47a01ee545ed61a2
- pristine_git_object: 20522d6c768d0623e6f9c6bd6ff2ab0b69869066
+ last_write_checksum: sha1:13fab1288c42f1a1ab5f54150ac005939ecefcef
+ pristine_git_object: 00a84001f710fb81c1aa1d9bd553d2014b66910a
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyResponse.java:
id: a1dce69cd0a0
last_write_checksum: sha1:9cbf95cfb9a9777cc52d98777f6eae4fcb48fbf6
pristine_git_object: 1857fe0d341ee2b588e25ec626aa30beeaf8de45
- src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidHomeAddress.java:
- id: 1eeb606c3bc9
- last_write_checksum: sha1:465085af6d9f6d6c7a1f0eeef1507e3ad98d4e7c
- pristine_git_object: 4e07bb6e5088147d3a2015894e092ec8b935a241
+ ? src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidHeaderXGustoAPIVersion.java
+ : id: d4cdaf4e6aea
+ last_write_checksum: sha1:204ff360574fbcb51e291c4e878a41cae8767bdc
+ pristine_git_object: b5b8da129c8fa28db3e95c5d4bde8f52e2f2dce9
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidRequest.java:
id: 25e6733869a2
- last_write_checksum: sha1:54967af21c1ce574a91206aae447f114e4ec30cd
- pristine_git_object: b14f6dae635571f19c5730cff09a46424c0df470
- src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidRequestBody.java:
- id: d2fdfa327df5
- last_write_checksum: sha1:a86f137d54945e2ca6bb94bab0a18e64c00b869b
- pristine_git_object: b721df4af70894c95777cd0cc033e8968e8f8667
+ last_write_checksum: sha1:a9dfa8141ee169a485d732c475d6740fe2dd5d44
+ pristine_git_object: 9d8a55ed4da7535c12fd7ac0ae020d2d1d1f674f
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidRequestBuilder.java:
id: 6d1f2a24884d
- last_write_checksum: sha1:5558135cc3b05c81f05d57ff6c2b87204a359ee8
- pristine_git_object: f870d9f9ac58685b9658a6612c26ddf655b92ff5
+ last_write_checksum: sha1:fed1279c4d3b3ac990763c708b23badc3309627d
+ pristine_git_object: 8b20f042a14fbf777801ff7f76b8984a17e7439f
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidResponse.java:
id: c60a0ffcd589
- last_write_checksum: sha1:c1a3c4eee56cde21ae34a410359c1e7115762469
- pristine_git_object: 701023caa6cf37a4f4093a5855f6d77535926aff
+ last_write_checksum: sha1:84bb1a6a832aa15a74bdefbdc65e0e624449c9dc
+ pristine_git_object: 4ed3dcf583aa893d4349c3066f9088859dbeeb98
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesCompanyUuidTaxRequirementsStateRequest.java:
id: 068816b064ae
last_write_checksum: sha1:24e5c935d56ae1489a3f816e27394661cf2cde21
@@ -13365,22 +14050,26 @@ trackedFiles:
id: aa02bf30a05b
last_write_checksum: sha1:3c4502558d1653c217881fac04ce8c282a4061d5
pristine_git_object: 80de6b76c9569aa163600a2a7a81e3877e8e6b48
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesHeaderXGustoAPIVersion.java:
+ id: eea27e56bb90
+ last_write_checksum: sha1:a8a1a281ea9926dc4dfd5938bc07012d6006366e
+ pristine_git_object: f239712ffb81f3fd2f7997b7427c71677c17aef5
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesRequest.java:
id: 741f9a7b8ecb
- last_write_checksum: sha1:226da8a1f8e7535efc850fc183709912aac7d0c1
- pristine_git_object: 8777d5fe814fcf96d0642d58c4af8cadeec4b864
+ last_write_checksum: sha1:682b1316dd11aed69c4ceb25145e342104d222be
+ pristine_git_object: 90bb281c2a7373bc40374480ee49c0df4df7c0e5
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesRequestBody.java:
id: 1051d131fd4d
last_write_checksum: sha1:2cf72816147f898e78ea021c8e9e0c9612d860c1
pristine_git_object: 090cc2cbc0b127bc3a08d26d458cd7ad036f74d2
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesRequestBuilder.java:
id: af989c44e98e
- last_write_checksum: sha1:51f5712895a7785e339946b8b9a3c5954981c56f
- pristine_git_object: 916cc79f1bf300b7ab07c9b595ed9c4b5ea1c558
+ last_write_checksum: sha1:8ea5f57382287f67411ac823625faca5eb5ab1d4
+ pristine_git_object: 0f4b5ba3509cd93541be6840b43fd683e38183f3
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompaniesResponse.java:
id: ca1dda3749f7
- last_write_checksum: sha1:d83eebcc054e2dc8f6411eb7b606091e21d1afa2
- pristine_git_object: 4e6ab44fc52ec4b93835fef65ee53de7352a99d0
+ last_write_checksum: sha1:b9ce3347588cdca5c82da597b0b492773ee0417c
+ pristine_git_object: d15e99fea38f5c75781a098764b2dab05532c759
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyBenefitsCompanyBenefitIdCatchUpType.java:
id: 64eb877b9faf
last_write_checksum: sha1:d845c938bcd266a74b6962b808aefb995354b564
@@ -13423,8 +14112,8 @@ trackedFiles:
pristine_git_object: ee4ef4d67914f9145a32e5f887b47239f1267ed6
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyBenefitsCompanyBenefitIdRequestBody.java:
id: e3ce4c527002
- last_write_checksum: sha1:89216e1ac84ea66d9b7a8557d15296ee3a61174b
- pristine_git_object: c617b013c99f43641ff0a84ff215cee882ace3f1
+ last_write_checksum: sha1:b9961c87f94a84afe74eef82510bf8eddf5fabcd
+ pristine_git_object: de89b4825f2e101f0790dc018d55d55c1f61dd55
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyBenefitsCompanyBenefitIdRequestBuilder.java:
id: 8158c19fe37c
last_write_checksum: sha1:5d25de55d40925352870814b8fe654cc8c930003
@@ -13449,62 +14138,54 @@ trackedFiles:
id: e01fbf1c21de
last_write_checksum: sha1:d0ede0bce75c6b3c33a5fdb49b2bf879ee79b3db
pristine_git_object: 8432f01cd409988f2e94ab862008e3edf96d8af1
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyIndustryHeaderXGustoAPIVersion.java:
+ id: 5a33de17d5f8
+ last_write_checksum: sha1:10093cec0cb5376d55ffb582446387c820aa8b58
+ pristine_git_object: b34e3221c3bcf606265a6edd93cd0ad90ab6613c
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyIndustryRequest.java:
id: 4d5082949f68
- last_write_checksum: sha1:66e343042f3fb5049807792c4efd3d4c5e9ddef4
- pristine_git_object: 950fb2c03e080afe1e44f6416d9ac7a6451ddc0e
- src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyIndustryRequestBody.java:
- id: 7db79d94bebf
- last_write_checksum: sha1:bca65545e2870c30dda73dea563562d16b7191ed
- pristine_git_object: 59f14caf4b78ea2143cd13d6207251102f8d3eb9
+ last_write_checksum: sha1:6dc825adf91e40acecb60f382b25a21f0eca8f6c
+ pristine_git_object: d35c0caac5197122e7d150aff61f321d2afbf4a7
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyIndustryRequestBuilder.java:
id: 01b75314a693
- last_write_checksum: sha1:e7420d52c730cf93a38d997f7cb66afa32026a33
- pristine_git_object: 90cbb4e6e024a2b2249a60ee5af9d7b85a897330
+ last_write_checksum: sha1:b893e247795936cf09de453582caf934b1ecc6d5
+ pristine_git_object: e7a4ec2110592c17c15bec76e136978ea387ef60
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyIndustryResponse.java:
id: 594579b1a028
- last_write_checksum: sha1:466e8019e54514450ddaaaf99a998fda745a77c7
- pristine_git_object: 2c95576c20bfa4bbbe448c8b33e3261fa2f5abe5
+ last_write_checksum: sha1:702c6941945d9733c244f034ffede7dc35838467
+ pristine_git_object: 3f9aff2720c40c141714ba8cb777d63f484ac524
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyPaymentConfigsHeaderXGustoAPIVersion.java:
+ id: d4150fc9c4d8
+ last_write_checksum: sha1:7d31fb5ebdbe2140c14a22ad42a5f6ec8c6c837b
+ pristine_git_object: 78a621457245aa26ab7ba6288551079dfb18b1f2
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyPaymentConfigsRequest.java:
id: f9572e25c63d
- last_write_checksum: sha1:5513b033f86f8cfba442a97e85097122c4ae2fd8
- pristine_git_object: a664cf6cfad4d2be4d4f2cd0998bc82fe1b8f516
- src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyPaymentConfigsRequestBody.java:
- id: c1984e5d9209
- last_write_checksum: sha1:c5138124a856a292893c8aa29de851c4e93328ed
- pristine_git_object: 652e6b77ecc9a9de124e17e10e5c33b10140b57d
+ last_write_checksum: sha1:81baa59e600acd3ef9562c25df0ba231b3307f3a
+ pristine_git_object: 9d302e2fe787e828b5a88f60f472bae96b46b69d
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyPaymentConfigsRequestBuilder.java:
id: 07a21bd8e78e
- last_write_checksum: sha1:5b205a295dbb77eda03d3a0c8d293adfd4d2c45d
- pristine_git_object: 9708234492e5479e0cbf3d2e36b49418a671381b
+ last_write_checksum: sha1:60aa2a4824907b3c098d29200f69d75f11f7a062
+ pristine_git_object: 576267330e1212798415b4ccbcce6968d2cac655
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompanyPaymentConfigsResponse.java:
id: d9b4a35d5263
- last_write_checksum: sha1:74185b828bc1c1ba754a2b1046f60629f0059056
- pristine_git_object: 953221986b6e6cc74cadd2f52e408dd2b29b9116
- src/main/java/com/gusto/embedded_api/models/operations/PutV1CompensationsCompensationIdMinimumWages.java:
- id: 96b692bc24a9
- last_write_checksum: sha1:d7d667ef3289b0ee77ff11b87d6d7532c34ed418
- pristine_git_object: 7ee6614d8033a6bc04d73353f34d6373ce1478ee
- src/main/java/com/gusto/embedded_api/models/operations/PutV1CompensationsCompensationIdPaymentUnit.java:
- id: 4c3aa7ee2992
- last_write_checksum: sha1:8670652973e35a7cf5817fc9a4a3c5846b8fd51a
- pristine_git_object: 5e2b9d6beb49bfe61fc8deb67a8a09b1f2eec62e
+ last_write_checksum: sha1:08138130e7031047ca89f08d975c786404da0e21
+ pristine_git_object: 827ed9de1dc6c8772d7754c0053dbae86aead940
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1CompensationsCompensationIdHeaderXGustoAPIVersion.java:
+ id: af752d512110
+ last_write_checksum: sha1:fb7d25d08f7659ed7346bf5ce206f799911b1b87
+ pristine_git_object: bf184b8b0e6ae0a682b0e28314ba40548361d750
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompensationsCompensationIdRequest.java:
id: 8ae6485fb6d9
- last_write_checksum: sha1:94dc3ec5412cfb9319f587aa74b97919ce823768
- pristine_git_object: cda90a19761000ae7477c9df44cbf248d762590c
- src/main/java/com/gusto/embedded_api/models/operations/PutV1CompensationsCompensationIdRequestBody.java:
- id: 699faaf1a45c
- last_write_checksum: sha1:aa59dac6996125bd7b83c9d2b94514f7bd53d861
- pristine_git_object: 09f72dd2c1238d946892c50808750e55fe27cf8c
+ last_write_checksum: sha1:a03cabd502b8ed217473af768752f11fe0cc1b47
+ pristine_git_object: 2619dd1cc2f7a000a07383ee9fcdc4c3d32c50fe
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompensationsCompensationIdRequestBuilder.java:
id: 38136057320c
- last_write_checksum: sha1:8747e7193791c5b88e384b75ce53fdc5b70e70f5
- pristine_git_object: ff6fdf129e2f8efcd7746050eca3f06a4f0b68d0
+ last_write_checksum: sha1:bf51455192c932c0eb3fc29f326e9c5b6397e355
+ pristine_git_object: ba31ab9f2a6f7bc5fdfd32b5035488df53897335
src/main/java/com/gusto/embedded_api/models/operations/PutV1CompensationsCompensationIdResponse.java:
id: c152ccaace8d
- last_write_checksum: sha1:af51ee14f4637e99ecbf39f75ceb7e826d1941af
- pristine_git_object: dd3ef081fdd831b996108aa4b733f6eb3770d1e8
+ last_write_checksum: sha1:98e647fc0e7a159a715eff9c7918ad71940399b2
+ pristine_git_object: cbdcf4bba5b8d51f2fe6c9c4d3b31b78069f27a3
src/main/java/com/gusto/embedded_api/models/operations/PutV1ContractorDocumentSignRequest.java:
id: 837059c7ff64
last_write_checksum: sha1:b50bbb3661d59fd6a1cb3d46153ea0e50748ed90
@@ -13573,10 +14254,14 @@ trackedFiles:
id: b0bccd6f420c
last_write_checksum: sha1:c22c9367337fe8143a8baebc4b4855ef14f3232e
pristine_git_object: c14452ecc01879cdf1c79835d15cef37a4a44a92
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1ContractorsContractorUuidHeaderXGustoAPIVersion.java:
+ id: 0c9103ab31e3
+ last_write_checksum: sha1:d8f017c855f5573a8fb2cef67cc1e8110c7b46cf
+ pristine_git_object: 6d4652c698ee0afedb80ee43299e731fee4d68df
src/main/java/com/gusto/embedded_api/models/operations/PutV1ContractorsContractorUuidOnboardingStatusOnboardingStatus.java:
id: 6fffbff1211d
- last_write_checksum: sha1:bb8d642330c45b853c248ef3fb1813f24a8df175
- pristine_git_object: 95e7f07ac4172e3c20998e981b700c34eef77090
+ last_write_checksum: sha1:213f94607bfae2698b3f40f78689a51d884c4b0f
+ pristine_git_object: 3fcee390d21c19a6500f393eea433f8d9c5ff1e2
src/main/java/com/gusto/embedded_api/models/operations/PutV1ContractorsContractorUuidOnboardingStatusRequest.java:
id: 2a3dfc831d67
last_write_checksum: sha1:28222e5c96eba95033d80fc63a4487bbd07545cf
@@ -13595,28 +14280,16 @@ trackedFiles:
pristine_git_object: c6ed4641575d566cb1a0d2f4b288f48b9cc827dc
src/main/java/com/gusto/embedded_api/models/operations/PutV1ContractorsContractorUuidRequest.java:
id: de68e0db1ab9
- last_write_checksum: sha1:1588ec357bdb52ed9766a2ea9b002d5e3a7123ed
- pristine_git_object: 8f9f1c1d3c7aedb3655f0e896279e254d0de8567
- src/main/java/com/gusto/embedded_api/models/operations/PutV1ContractorsContractorUuidRequestBody.java:
- id: 8541d1b50a80
- last_write_checksum: sha1:f5b6fbbe0d7056a9a0c6443871c380c059fdac0c
- pristine_git_object: df0c34e571af5cd2d5553cb0452c417f405739cd
+ last_write_checksum: sha1:ced7f3df31a9b19798007fda053720895c833d3c
+ pristine_git_object: 5a01659105196ef0c6a9654758ad0d120832e952
src/main/java/com/gusto/embedded_api/models/operations/PutV1ContractorsContractorUuidRequestBuilder.java:
id: c1da0e74ef86
- last_write_checksum: sha1:768dbb8d4f40a6077908259ed39448ad89567d9a
- pristine_git_object: c9e5d094988cfd10659c48bb2d15c9ab1d92d2ba
+ last_write_checksum: sha1:7da2fb1d9142fabec6dd7f51f3b2d23cfb327a71
+ pristine_git_object: 5ee57ab7976de5cedb1cc5ef595d0568e1673ea0
src/main/java/com/gusto/embedded_api/models/operations/PutV1ContractorsContractorUuidResponse.java:
id: 2eae52e6934c
- last_write_checksum: sha1:13228153ce521ae9b76ff5a90a115356ff22a7ff
- pristine_git_object: 1e763552b0b464e58b0df04cbd91aace7f36d8d9
- src/main/java/com/gusto/embedded_api/models/operations/PutV1ContractorsContractorUuidType.java:
- id: d7f961de9ad4
- last_write_checksum: sha1:69d324fa6d9574df103c3baa4a873be884dff303
- pristine_git_object: 2347008bc44dd73becfe931ed9cf371977b64a91
- src/main/java/com/gusto/embedded_api/models/operations/PutV1ContractorsContractorUuidWageType.java:
- id: 8dd51f8c1fba
- last_write_checksum: sha1:f883535d269a68b886bd14a54cfb934d753518db
- pristine_git_object: f10e29f51a7845d38f47b39b458a8bba59b42534
+ last_write_checksum: sha1:92e96f387f57876d80e72991e365a77eefa3d7b0
+ pristine_git_object: f381b570d7d35a063a75004b3a3dbc9f16762ab0
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeeBenefitsEmployeeBenefitIdContribution.java:
id: b9f8c45f6b5b
last_write_checksum: sha1:f2a5f424cdc5adeb6b26e25285f06aee76e00610
@@ -13689,86 +14362,90 @@ trackedFiles:
id: 579a86d38da5
last_write_checksum: sha1:051d8df4581398cba694a3a0f6dad5c58f784adc
pristine_git_object: ecbba66723dc74dcd5c239fb1a04c0fb490b2899
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdFederalTaxesHeaderXGustoAPIVersion.java:
+ id: 6e802a19f381
+ last_write_checksum: sha1:bf119eb5bf409603a7a1cb9b628913967e49d936
+ pristine_git_object: e3305618658a56f918668165278e5de4af26f5cf
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdFederalTaxesRequest.java:
id: f0c548a07137
- last_write_checksum: sha1:210bb695e0f8f0656b277574e5e27e38e7f65046
- pristine_git_object: d78d4530a01c4095ca0c1b9d17a2e14fc3c50b29
+ last_write_checksum: sha1:450b89c5f3391c203a624051c4191917839bd026
+ pristine_git_object: cba438158ea7c97aebc52ef83be568f713177044
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdFederalTaxesRequestBody.java:
id: 26fec0f0665f
- last_write_checksum: sha1:15809ecc5bc553cf9996cce1c0a520e708103a3c
- pristine_git_object: 659ab422d065b482ae58ea779e5a426594d44095
+ last_write_checksum: sha1:fe5c4d3109d421fba0360fdbfd6c42a2c1ac1d77
+ pristine_git_object: 17da6a7a74d252283fbe6450feb54a0618a87c3f
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdFederalTaxesRequestBuilder.java:
id: 64af7a5684b8
- last_write_checksum: sha1:d55b4109bf2339a7343de4f0283da7e95ebce1b0
- pristine_git_object: bca6523af48139a5e101aeca0ada2637aeb1e1d4
+ last_write_checksum: sha1:8b06905d65b3f4a66e8a269b80f19c71cf4d6fd1
+ pristine_git_object: 4184df893cb711ea75638abfa29e0eafd6213a46
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdFederalTaxesResponse.java:
id: effba7b33555
- last_write_checksum: sha1:32a28274f87ef2d10e02d14b4c5553adad175b05
- pristine_git_object: f10b5def8ef5e242f413666d41709f7782e811aa
+ last_write_checksum: sha1:c1ed231b80d03927847950b776b63d5dc9741e58
+ pristine_git_object: 2f9beb8e8e966788d677a16f81c719ddce0175ba
+ ? src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationDocumentsHeaderXGustoAPIVersion.java
+ : id: 4983180d0bc0
+ last_write_checksum: sha1:92d71245a1d2619b92b6c47e288039ee3be0dd17
+ pristine_git_object: add107386e35551281379a5e4d28b7601086f82d
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationDocumentsRequest.java:
id: 39f511536f3a
- last_write_checksum: sha1:07012fc618a7346c4c511206c2175d3b1bf094f5
- pristine_git_object: 80b5dfd7cc96d531693b56484053c4e62124fb38
- src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationDocumentsRequestBody.java:
- id: 95b3ac64388e
- last_write_checksum: sha1:56156a20a03259adda9c9cad8efd5cb6a9d37668
- pristine_git_object: 52106631d510fed54aaa63f16f288ff44e4337a4
+ last_write_checksum: sha1:30e7e7772b13fffd353aa905b85514a7c65f1e4a
+ pristine_git_object: f25c383e4109b67b511b42c42c30ecdd57d13ddd
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationDocumentsRequestBuilder.java:
id: c719020e20a4
- last_write_checksum: sha1:8e0c002db3bc1a0cccae9829e634e05aa882d76c
- pristine_git_object: c1a2b6f4848229b971e6d08210b36f3dbf861cb8
+ last_write_checksum: sha1:7ca12f0ba24a21ec8f1e86f2afabad4442b37a2a
+ pristine_git_object: 443da4effaf0d52d53764e278fe1d9fc9bcbd93c
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationDocumentsResponse.java:
id: 19f5346f0f81
- last_write_checksum: sha1:1df072198fe4ed79655bb57333b3f5496b28d6c5
- pristine_git_object: 20f6015e9a7540075e54e9f8f373098838800e27
+ last_write_checksum: sha1:06ea2024659a1243ffbf13f13d9cb24381eee6ce
+ pristine_git_object: c0786190d96057029be856f56b2cd47ef6cc13e9
+ ? src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationEmployerSignHeaderXGustoAPIVersion.java
+ : id: 3c50c3000c68
+ last_write_checksum: sha1:5f7fd8e60831eddb1c6480aaaaf61ee525a06732
+ pristine_git_object: 41eb601f859e7908b9b2ccb1d2b51f2ba21e09a7
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationEmployerSignRequest.java:
id: 28a77631ecef
- last_write_checksum: sha1:538263f40169e66fa7d7122ad029fbfa7384e611
- pristine_git_object: 35ca6efc1e2ace96216b7faeabb9cc2f51a94835
- src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationEmployerSignRequestBody.java:
- id: 2c7c0d74f11b
- last_write_checksum: sha1:cf5c4609d4a9f52da1af42585d947a811c8cfbce
- pristine_git_object: d86672d11337aa3129577a71ca84c1ce1653f873
+ last_write_checksum: sha1:b45ff03361badd28be2c4524cbaec93924dc0f72
+ pristine_git_object: a99f0acf616c84e3614c19cb117220b411c9bd37
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationEmployerSignRequestBuilder.java:
id: a366cc044a30
- last_write_checksum: sha1:2c3d82c29ec3ccebb886f732dc7f52394d867cc9
- pristine_git_object: d5064c867efe2a3be3338f51eeee86ffbdadcaa4
+ last_write_checksum: sha1:93f02a9db3da40bce0c1d568c911bb2e6f3eff20
+ pristine_git_object: 8216316d80846069415a2ea0890c1295a5415142
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationEmployerSignResponse.java:
id: 94cb4cbcb811
- last_write_checksum: sha1:35bf220a388882b9c1b69fb5eb5b12aa2d872440
- pristine_git_object: cf373284343d3a6023ab17abb7f5a74a66ac1567
+ last_write_checksum: sha1:e8d8ee533384128b8742c6942238cea05175b7d6
+ pristine_git_object: c94022ef25632285d53cbff1bd2bf3205434dfda
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationHeaderXGustoAPIVersion.java:
+ id: 67fcb8f26473
+ last_write_checksum: sha1:82d5e1da0ce61bd8b407e7bf55333590aad5f0f2
+ pristine_git_object: 301beb6a4590e59e17b2add567563521cba52281
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationRequest.java:
id: c77023249cb8
- last_write_checksum: sha1:c99c1035e80ec606141eb79b330c64bfdce0f7bd
- pristine_git_object: 54d377123cbe56c30480bd9a203a3ab9357003e1
- src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationRequestBody.java:
- id: 9c2cb2007660
- last_write_checksum: sha1:b329144a39e7580f8b26549264dbd73c238b5890
- pristine_git_object: 05aa1cb5bb9fa39a80051e1202d99e35235c7b41
+ last_write_checksum: sha1:5c44ec26817d7fd11e91bdec5576d676c361a7f8
+ pristine_git_object: 0be472dfe7940d3082b24cd4840db347953c6a65
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationRequestBuilder.java:
id: 58829a649667
- last_write_checksum: sha1:6018e12bb320dbefe7952c2e00ee8edf4848637c
- pristine_git_object: 6fc808edf6efc0a0021800b7c41ac59302b7d39d
+ last_write_checksum: sha1:bd799cf5a5466049ffd48c48a209856682907a19
+ pristine_git_object: cc061ae275165f426c8d9daa8a9ad49503661164
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdI9AuthorizationResponse.java:
id: 2ba8e9d033dc
- last_write_checksum: sha1:b8b2c50f15fa69e469b951ac9bf13b1cd1d72d1c
- pristine_git_object: 12ffbfe33170221454f7004faaa7443437e8f456
+ last_write_checksum: sha1:81637370c0723835b2a89cdffccb11e3cef928e7
+ pristine_git_object: 50a3482b478f644ccd89f0442b7e1a1be69180d6
+ ? src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdOnboardingDocumentsConfigHeaderXGustoAPIVersion.java
+ : id: 4caa41cee8b3
+ last_write_checksum: sha1:f069479ea34676e052bbdaec176c829cadd7194e
+ pristine_git_object: 45e5e70792ce472efeb85ad6037e44d2eaa13d4e
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdOnboardingDocumentsConfigRequest.java:
id: d286482c655a
- last_write_checksum: sha1:13cfd503ac6d3a305477cd9c3823f76c093fcfd3
- pristine_git_object: c219254ff7db56917e812f725eadbff053610b16
- src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdOnboardingDocumentsConfigRequestBody.java:
- id: 8929ed7aa8c3
- last_write_checksum: sha1:b0981c7853ab53498b5edb9f8921ef4af9dfe35e
- pristine_git_object: 1819f0676a985686b5b4b2423733185646e027dc
+ last_write_checksum: sha1:5052c1efd59b64ad0c37a7bb36d2af646cf3dfa3
+ pristine_git_object: 95b0f9405693f917683449160f01f74022b2c4d9
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdOnboardingDocumentsConfigRequestBuilder.java:
id: b8b5bc35026c
- last_write_checksum: sha1:9b48c79d0c122ae61802154c1f947c7f60934cd5
- pristine_git_object: a2aa29f30a7d511639454a1f7f80dddcf6b4812d
+ last_write_checksum: sha1:3dc50e7f51c92fe2a8c7537dffcbcf1462940e54
+ pristine_git_object: 23c89220911beb1d730a838d0b50c597c1cd6bb4
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdOnboardingDocumentsConfigResponse.java:
id: 762dfd43c8fc
- last_write_checksum: sha1:91535de08222d15c8bde66c28108f7e337aca29e
- pristine_git_object: 1050689cdeeea26e6c87fc6dc2096899b3c40c2c
+ last_write_checksum: sha1:bdbe169788511ac009074ff680c459ca9b14fbe2
+ pristine_git_object: ec6ab1a9b3fda5b5079212109ca83f2a2ea9e8a0
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdOnboardingStatusHeaderXGustoAPIVersion.java:
id: b56bf6834286
last_write_checksum: sha1:8d840313d4e7f1f99042c29eb32de150014f1881
@@ -13789,22 +14466,26 @@ trackedFiles:
id: 3488b08aa9d7
last_write_checksum: sha1:a44300864cb1c6b6f2251d4359c6d56c4eb2a6d3
pristine_git_object: 06d496324bccc7522e9efee13b3d9c7ae4a28310
+ src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdPaymentMethodHeaderXGustoAPIVersion.java:
+ id: a53e2d0cb232
+ last_write_checksum: sha1:7d0c08797edd5daab9c06fc1e58506261d40badc
+ pristine_git_object: f192abfdcedf2c0e470f74dcb6d17df2a60ecdaf
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdPaymentMethodRequest.java:
id: d12343c1f827
- last_write_checksum: sha1:18f7a2d8c8d2b8800dea096d43f17d7bd1334ee1
- pristine_git_object: 0eb599bbeb86c58cc87fc73b6d3aa7253616bd13
+ last_write_checksum: sha1:9a1ea317ff7dae30b02cd3d1c3d11f44ad8b3e36
+ pristine_git_object: 5466595483647cb96060ccc71aede8e508f2f5c6
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdPaymentMethodRequestBody.java:
id: 32125b1ea2c9
- last_write_checksum: sha1:96d456126d17de5ec1cb04b6bcbbabda8288f411
- pristine_git_object: 8e7f64a431d3d06fe67bd0c4d5d72cd0ebf28d75
+ last_write_checksum: sha1:89d64627cdd46233b7dadb70799fdbd57d138b24
+ pristine_git_object: a00df76c01c5f059844f60afcde547ecb372b76e
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdPaymentMethodRequestBuilder.java:
id: 3fc8ddfca292
- last_write_checksum: sha1:799aa5189e5f3cc0835fe93496f1d42d01e86d30
- pristine_git_object: ce1e231b1f18b2cf53fd625eafa108f99b1bf385
+ last_write_checksum: sha1:05f9201b39976f230dd6876950aca3c829f44043
+ pristine_git_object: f57875b73eb76ab19a0a1c2a5c149789628bb84e
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdPaymentMethodResponse.java:
id: cfc5ca2a5227
- last_write_checksum: sha1:2b98712a313e653a25d77c2f9529baaaaf56ef5b
- pristine_git_object: 76c5fea8d377d8ff4d59dd11c3f78a0c9ed8faef
+ last_write_checksum: sha1:f10da1cf0ccc512941d069cd2d40c125b026c61d
+ pristine_git_object: cc8031b194d34fe485a7b036d6aa40dcf8f80675
src/main/java/com/gusto/embedded_api/models/operations/PutV1EmployeesEmployeeIdRehireRequest.java:
id: 0a10f1b3197f
last_write_checksum: sha1:5fef8c6e87b39669d8064b9346e68a3f7f45bf9b
@@ -13889,18 +14570,14 @@ trackedFiles:
id: ae3ad9e4b342
last_write_checksum: sha1:573639f3e3c6e41393b417f04c5c0cf9b39c3dc6
pristine_git_object: 29c2004bb4cfc1738cd8aa79b6230e45ca53a2b8
- src/main/java/com/gusto/embedded_api/models/operations/PutV1HistoricalEmployeesHomeAddress.java:
- id: fd5cbb925382
- last_write_checksum: sha1:d5a3b04e343601db6a32e1516619136f7808b755
- pristine_git_object: bc5e6c9cea6117cb466e9eac758d935d8445ef55
src/main/java/com/gusto/embedded_api/models/operations/PutV1HistoricalEmployeesRequest.java:
id: 95f1a471c039
last_write_checksum: sha1:853cae6cfd218fb7077d80567f02bb9189ce0fcf
pristine_git_object: 0cc75d899e5b72236084e0d53ca2d23968128cea
src/main/java/com/gusto/embedded_api/models/operations/PutV1HistoricalEmployeesRequestBody.java:
id: 4fc4b2edf1cc
- last_write_checksum: sha1:5eacdad2202df7f01f68c42b083ea37c48d3291f
- pristine_git_object: 4f168a81b0d926746d86d214a713083f685a2d0b
+ last_write_checksum: sha1:cf498f1b441b6dcd908262085136f64818216265
+ pristine_git_object: 165f524054b5b92c1e44eda982655d5ca64ac0a7
src/main/java/com/gusto/embedded_api/models/operations/PutV1HistoricalEmployeesRequestBuilder.java:
id: fdd3ba29eefc
last_write_checksum: sha1:0ae6cb6e8d65ae653cf432b145bddf503a9669bc
@@ -13965,74 +14642,50 @@ trackedFiles:
id: 63ee1722ba5b
last_write_checksum: sha1:81785b0319ccf6aa6fcc8050a89c07764af76479
pristine_git_object: cde9e37ddb9e04ccd73ce68c02d34085ec83353d
- src/main/java/com/gusto/embedded_api/models/operations/PutV1PartnerManagedCompaniesCompanyUuidMigrateRequest.java:
- id: 4cdb42f66094
- last_write_checksum: sha1:c7f2017660471b001df04baa7745915162ddaa58
- pristine_git_object: cb01158c879a2411c786cece74efe36f6881cd9b
- src/main/java/com/gusto/embedded_api/models/operations/PutV1PartnerManagedCompaniesCompanyUuidMigrateRequestBody.java:
- id: 902788cca237
- last_write_checksum: sha1:a8814b47304cbf8b96f8e33ce59b963741bf62cb
- pristine_git_object: 86d4c6824818d3de86416de0c59935afabd5f41b
- src/main/java/com/gusto/embedded_api/models/operations/PutV1PartnerManagedCompaniesCompanyUuidMigrateRequestBuilder.java:
- id: 9ada3776153d
- last_write_checksum: sha1:a423439f36220ce8ddd7624533606a1c60c5d6a2
- pristine_git_object: c9854455b33022faeed64bf36e022fdd49ecd231
- src/main/java/com/gusto/embedded_api/models/operations/PutV1PartnerManagedCompaniesCompanyUuidMigrateResponse.java:
- id: 87c9ee7ca765
- last_write_checksum: sha1:8d5fcd8623e0551d386c8937cc4d778b1cdd3bad
- pristine_git_object: 8411471fe784e8994af182093e947b809b45bc69
- src/main/java/com/gusto/embedded_api/models/operations/PutV1PartnerManagedCompaniesCompanyUuidMigrateResponseBody.java:
- id: 708f9f56ee5d
- last_write_checksum: sha1:08675486962c3e1a77de53fda71f017b344dd17e
- pristine_git_object: 4ac786764813e3323ad0ed5ed24fe6e4db2471dd
src/main/java/com/gusto/embedded_api/models/operations/PutV1RecurringReimbursementsHeaderXGustoAPIVersion.java:
id: 2d2ff0964660
- last_write_checksum: sha1:4f473f856f1339cde4957e3b95bb2d76b3f53005
- pristine_git_object: 97c969a6b9b49aa4e0360a9a73c06fd77915bcd5
+ last_write_checksum: sha1:f823e4d0cc647b475ed8edee4ef921e62a2ac399
+ pristine_git_object: 7ca39acfe2a274971121d5ff375f1447bf569d75
src/main/java/com/gusto/embedded_api/models/operations/PutV1RecurringReimbursementsRequest.java:
id: 8d3c719f8182
- last_write_checksum: sha1:ab4c84c94226dc34af25ea9dab389e6e206be019
- pristine_git_object: 585b1fc27204c19351f685890a62b5da61b5dae2
+ last_write_checksum: sha1:d6701bd3bdcb7e81f865ec5a7f95247b2f70740b
+ pristine_git_object: 6120af51f729471c73e915c6ecf620d484b3e930
src/main/java/com/gusto/embedded_api/models/operations/PutV1RecurringReimbursementsRequestBody.java:
id: 413d84799a51
last_write_checksum: sha1:81dc786d821f361bcd6a3f160abb9d14af1fe44f
pristine_git_object: b668e4db1066d3e2328fdc664c3c30ae29e8f9dd
src/main/java/com/gusto/embedded_api/models/operations/PutV1RecurringReimbursementsRequestBuilder.java:
id: 2bf5b8cc68b9
- last_write_checksum: sha1:565040e0ddf36fb0266bb2d3215df38d24c14564
- pristine_git_object: 53b740f3c882bd83e704d06e10a6e44f6b0fa0f3
+ last_write_checksum: sha1:c2a79a4631969725d3193bbf3d21252c033e635a
+ pristine_git_object: e08e0daacef4ee9e1abbd91fd01c26650e0f70a3
src/main/java/com/gusto/embedded_api/models/operations/PutV1RecurringReimbursementsResponse.java:
id: c4c469895f75
- last_write_checksum: sha1:5419774a816358182559577ec64eac967fc67440
- pristine_git_object: c1315da04423fc242126d62edfc7466540537645
- src/main/java/com/gusto/embedded_api/models/operations/PutV1RecurringReimbursementsResponseBody.java:
- id: 36e24092e5da
- last_write_checksum: sha1:2e17c3db7fba997adb59d80620bf2193b1357e7d
- pristine_git_object: 8dd770665a2356de10c322dd1bc3a85cc7e8d570
+ last_write_checksum: sha1:91cc941f6a4ddbf00037c4e9d6313e508d977fb1
+ pristine_git_object: 4da0e36de347fe687ca24bcdc0fc32f68c95392e
src/main/java/com/gusto/embedded_api/models/operations/PutV1SalaryEstimatesIdExperienceLevel.java:
id: 46ece5c65c5d
last_write_checksum: sha1:0aa4ec7399121b96e0f749c9706272967a373aca
pristine_git_object: c0689f9402e50ce311c0c40ee9626b8a9a62e130
src/main/java/com/gusto/embedded_api/models/operations/PutV1SalaryEstimatesIdHeaderXGustoAPIVersion.java:
id: a5d4e643691e
- last_write_checksum: sha1:7e4da692275c0dec0065bfcb62a798a8227fa53e
- pristine_git_object: 9da3bdf1e38e8ad79471e7d069a8c762358cc771
+ last_write_checksum: sha1:0d4b3c6f089a086630f8ef90ec5445390ce17d64
+ pristine_git_object: 8ab061c3457cba0e33a481245c59428c1c604d21
src/main/java/com/gusto/embedded_api/models/operations/PutV1SalaryEstimatesIdOccupations.java:
id: 79cd7a6f17f0
last_write_checksum: sha1:46b7f399de3fdd7f9b2913e155724c99b5536452
pristine_git_object: 9fbaaf94166c32c8e8f3d65e0affa649d08ca029
src/main/java/com/gusto/embedded_api/models/operations/PutV1SalaryEstimatesIdRequest.java:
id: a0fd47a99061
- last_write_checksum: sha1:286d5ada5923a5ed0606ce118b0d252174eef188
- pristine_git_object: 591f23b39ce7456f708b238599b6e19ea70e9565
+ last_write_checksum: sha1:ab19a4666078932c71eaf28e7e3bd2f0a1deebf9
+ pristine_git_object: 76c600b27c69ececfaada9e95d024286e9052a8d
src/main/java/com/gusto/embedded_api/models/operations/PutV1SalaryEstimatesIdRequestBody.java:
id: 0f96424e935b
last_write_checksum: sha1:688ddcc6c9ee4936a30c0d92d72acd47f8f8ddb7
pristine_git_object: 84b19201dca44f4b5c2b0f40d98cc16631847093
src/main/java/com/gusto/embedded_api/models/operations/PutV1SalaryEstimatesIdRequestBuilder.java:
id: 7201e9644b28
- last_write_checksum: sha1:e973470130ebafad4657a1e99102fe303ba0a69e
- pristine_git_object: 77032f4ad3d13447ffda1b887400c62d2fabe795
+ last_write_checksum: sha1:e9c988c32f8e95c47a3ef0e67718ac995b32a65e
+ pristine_git_object: b0124e23d46d8e367a83bdb218dcf4746b200d3f
src/main/java/com/gusto/embedded_api/models/operations/PutV1SalaryEstimatesIdResponse.java:
id: 2703d0ac3a93
last_write_checksum: sha1:ec7ed7ed98bbebde8a278396facf771df305a70c
@@ -14063,8 +14716,8 @@ trackedFiles:
pristine_git_object: 5c9c102d0d5f146a9e53852e3d2481dc917f89b5
src/main/java/com/gusto/embedded_api/models/operations/PutV1TaxLiabilitiesResponse.java:
id: 4b85fbcf3d78
- last_write_checksum: sha1:ff34deb8e45d4c3a65bc3a3460cd35be1b392001
- pristine_git_object: f3a2cd4ef6147e61d08e734a69883503cc358f70
+ last_write_checksum: sha1:30023d8ca55e66af81a7b53cf7fe90d47f96a8d9
+ pristine_git_object: 24f3d95f3b9f4cf72b8c66fe254dcfe99606f342
src/main/java/com/gusto/embedded_api/models/operations/PutV1TerminationsEmployeeIdRequest.java:
id: 7f9461172dbf
last_write_checksum: sha1:72ac71b8c377a9eaac77abdfda38d296e1847600
@@ -14087,20 +14740,20 @@ trackedFiles:
pristine_git_object: 8658440c9298488143e1b49843712f713091bbdd
? src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidAddEmployeesHeaderXGustoAPIVersion.java
: id: 1e655b2453d4
- last_write_checksum: sha1:e1f307169cd305f12bb259997c94dd2232f202f1
- pristine_git_object: 48b8a247d33a8d69f010ab8721eb294722a12dba
+ last_write_checksum: sha1:c86121289a6b73ee15f94d4e055198fe2324ed9c
+ pristine_git_object: 109386c698cb51c4263bfefa87cb99e61a341ad7
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidAddEmployeesRequest.java:
id: 30949d20b9a7
- last_write_checksum: sha1:a3e4868b13ba1bb5878f08d4222de8f0a9aa6d90
- pristine_git_object: 98ee35bc951efb58da60637e220e5513bf8a5eeb
+ last_write_checksum: sha1:182a1708104f40e9e2c64cbddeea2e161d71fb21
+ pristine_git_object: c85744730f3f94662c019818fc9efadb805027d4
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidAddEmployeesRequestBody.java:
id: aa73f2b3475a
last_write_checksum: sha1:82a0df6843ee8f495f418df37d1c7695d70c81cb
pristine_git_object: e66899b4f5557ec5a03696d471b73570f3b7fcf4
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidAddEmployeesRequestBuilder.java:
id: 6f4b6d6baa49
- last_write_checksum: sha1:7713c58afc71939c9295ae5b294485490d47ad99
- pristine_git_object: eea4c8b8a890156f521b7ef9132a3dd10de577e2
+ last_write_checksum: sha1:4920db5aac2fe445bd6cdb385c65f5ea7b6d9dd2
+ pristine_git_object: 9268dcd50a90e4e92ead69149f88afec9fba2354
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidAddEmployeesResponse.java:
id: 315909fe4f07
last_write_checksum: sha1:e822edd4374deefda891bc92a058d0a74dbabb53
@@ -14111,80 +14764,80 @@ trackedFiles:
pristine_git_object: 764a6267d637dc8073910dc13d6ec78021b24246
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidBalanceHeaderXGustoAPIVersion.java:
id: dce20741e9ea
- last_write_checksum: sha1:11ff6060ce12dc9efee14b02aa5b3bac9a118133
- pristine_git_object: 51c2411cfa1e6f18e2cdb1752cc1bd2cdcfb1586
+ last_write_checksum: sha1:87195d9adf2990abcebc8e77c864b810d142196a
+ pristine_git_object: af4ab6cbebd756ef708d1e5dfb145d01f39cbc27
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidBalanceRequest.java:
id: 68d3279ade44
- last_write_checksum: sha1:cd8bf645b8d2a90778411ad0e5512a0714cd97d9
- pristine_git_object: 4edf84aee5575e0452850618f5f84220f732f5cf
+ last_write_checksum: sha1:2ea50b121df8de713872d30ce11547f6b9f2e924
+ pristine_git_object: bc6138b07fbf979e664b3aa43b61ad82327c36da
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidBalanceRequestBody.java:
id: 61d7803d5b54
last_write_checksum: sha1:b12a6ed64a2cba86b0ad213e2490233ec587694d
pristine_git_object: e6844a39019b3a44b9f389d0a58cf22c5fdc5bc3
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidBalanceRequestBuilder.java:
id: e9878bc6fefa
- last_write_checksum: sha1:f9ca90061d998b1813695ad9e92ae742517a9ab6
- pristine_git_object: f1ff88de9d6dbf596a64cc5d0b5b520cafd8f310
+ last_write_checksum: sha1:c346ba45a08fda2a0500a070ab1719307c1a38cb
+ pristine_git_object: 34bd813c19b34aab6f7be13db211f2f4fa7daea1
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidBalanceResponse.java:
id: 87e384866aef
last_write_checksum: sha1:54a9e10f9e6dbae706cafc8f50c11122e4ff68ac
pristine_git_object: 04f4c0a31a63d4273a2d713e0f0575fd4011a182
? src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidDeactivateHeaderXGustoAPIVersion.java
: id: e9f65cd87db9
- last_write_checksum: sha1:b14f4650562a0b1e9feb6a384ce325de1a84ba91
- pristine_git_object: 047eb71987580b370ac938aac680e035d307bee8
+ last_write_checksum: sha1:5d31a14694b3d91c98243268226e134be2fa1957
+ pristine_git_object: 3ff44b13b2aff59e68d460259d4c732b5f07af2d
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidDeactivateRequest.java:
id: 824def04c27e
- last_write_checksum: sha1:20bec838b902a87c368010c8b8c6b3dad77cdc1b
- pristine_git_object: 4022122195bb33bf6688976fe56a30ae193078aa
+ last_write_checksum: sha1:ae98583aea8335c9d09fb723bbb94c01c55683a1
+ pristine_git_object: 5a219962117b6b229f34af461367b2623f12f425
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidDeactivateRequestBuilder.java:
id: 03a7c11cbf69
- last_write_checksum: sha1:9a9887209086eab3bc84d29893c299a78b193c2d
- pristine_git_object: 6a901a98b4e6a87727b298ad7305ea02f793a27a
+ last_write_checksum: sha1:cd76ec82be6a4226b70b3372e872f3f4d039f45d
+ pristine_git_object: 8ca61e2152f5d4674db893c9ecd1297985c84e8d
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidDeactivateResponse.java:
id: bc882f447c1f
last_write_checksum: sha1:d549cf03b74b700a6a1ac61b40af338724d00f32
pristine_git_object: 9aadb9c7ad852278365ce9485fb1c6f9df1f869c
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidHeaderXGustoAPIVersion.java:
id: 085f736dd561
- last_write_checksum: sha1:0ec9a82d721657c1cf19df6bff9342088f9385f5
- pristine_git_object: 85edf510752ac1ae55b2b140e0794a1a072634cc
+ last_write_checksum: sha1:60be26d5913d814f14aebae2c84d2559d5e6a03e
+ pristine_git_object: 8ed73ce028053f5d8c4a74c5a5f7b54f4dfad161
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRemoveEmployeesEmployees.java:
id: c525fb851aff
last_write_checksum: sha1:7948434149f857a0be9a1e970680a979a18d070f
pristine_git_object: 5bb3e62870cef86c473ad8e1e8b1d92e5311da92
? src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRemoveEmployeesHeaderXGustoAPIVersion.java
: id: 7c0841041da0
- last_write_checksum: sha1:c14ae61df889395f53b1762cf6b472822de7822b
- pristine_git_object: 9619e07f4933a7f81f830e6cc806e7d4dbc1d10a
+ last_write_checksum: sha1:1452c20a0793c92b4f96779279ec6e0316254dcf
+ pristine_git_object: 35a6fd673d6fe6adb3f41df54c0d608f858cb0d5
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRemoveEmployeesRequest.java:
id: 276fcdadb1b8
- last_write_checksum: sha1:b1b0048376b4d5c625edba3666e4c075221e4ba0
- pristine_git_object: 1733675fec7c1827f7c2333f9630af602d9a15c1
+ last_write_checksum: sha1:c08891f2d71848f8fa33a87ad092381ec423f207
+ pristine_git_object: 8d16392dcb5516e341debb6a8c35fd46c7e06c0d
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRemoveEmployeesRequestBody.java:
id: 9e0ae3ff3f24
last_write_checksum: sha1:10149f933f9f96950ca250a44cc777a35c6b0771
pristine_git_object: 92fb40f423445f7bd8ef0756f37f1ba012a4abe3
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRemoveEmployeesRequestBuilder.java:
id: b1a9eac89d39
- last_write_checksum: sha1:e4de6d62aa5252b8fb5ed85b01f8d177c931499d
- pristine_git_object: f5284d20bb7e9d60b5027231989b461ce74eab01
+ last_write_checksum: sha1:d3cec895320605efadb4d7efe069e8bb78790111
+ pristine_git_object: 4574dbede0981d799ea82e55d0b7509f2e02c4cf
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRemoveEmployeesResponse.java:
id: a23e67918bf3
last_write_checksum: sha1:8a46a3dc5ed5c470aedcf5e5b960cebf8dad6a4b
pristine_git_object: f8ea993204984e7c2a84c943b5c24b5af75280e7
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRequest.java:
id: 4b236daab254
- last_write_checksum: sha1:21fd27ff5f53799f62cea7311038a5215d877ad5
- pristine_git_object: e4657663542a5bb03f519d4e130bf5b2efd58c8e
+ last_write_checksum: sha1:91ef206c37503c6589d0f8a6fa1d56ba1c1f52b7
+ pristine_git_object: b9f5df8fc71d050a59f5c3d6c904993abf7014ec
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRequestBody.java:
id: 55ffd3316fb7
last_write_checksum: sha1:e271c8a48e55fde91ec429993f3a340fd4216c1e
pristine_git_object: 5021624f0aeebdc012cd6c650a7f96d2dec55d78
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRequestBuilder.java:
id: 55e0e46d0378
- last_write_checksum: sha1:20fba720dc06db1438182036f3e94068ce3cd4cc
- pristine_git_object: c693f171ab024272194fff834cd5d67b709804bb
+ last_write_checksum: sha1:d54beddd7d65f5fcc5132322a8b79b5f8c66c6c5
+ pristine_git_object: 0e51902312ddc89a89adaa08c9c0ecdcb57c6b80
src/main/java/com/gusto/embedded_api/models/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidResponse.java:
id: 296c694eae60
last_write_checksum: sha1:500ed4b10a1f9a484e2d510991bfea335d68a180
@@ -14269,14 +14922,22 @@ trackedFiles:
id: 0a17907f8711
last_write_checksum: sha1:bc2179ee6d19f527e6f355a6bd93428cf9d10053
pristine_git_object: 1c7cc231aa4cb35b51a375a24a73c6782753e1b0
- src/main/java/com/gusto/embedded_api/models/operations/QueryParamFrequency.java:
- id: d858e6115909
- last_write_checksum: sha1:a0aae748f25fc751e0fb5b175aeb3b1628aea655
- pristine_git_object: a7b9849e19e9889dd43a1df75d7b8d91a0f90998
src/main/java/com/gusto/embedded_api/models/operations/QueryParamInclude.java:
id: b70d1a3f87d3
last_write_checksum: sha1:5909320ed8de8afc650e622c355d74bac5cd81a7
pristine_git_object: f8408cec4f854346dac0abf48d55110e84827ffb
+ src/main/java/com/gusto/embedded_api/models/operations/QueryParamPayrollTypes.java:
+ id: bce16c55b2eb
+ last_write_checksum: sha1:da926edd8867197bf13eddcba30869a2b1704bb7
+ pristine_git_object: bf22d132d688005f7f35ce0c46288ec3f188ef10
+ src/main/java/com/gusto/embedded_api/models/operations/QueryParamSortBy.java:
+ id: 4789a61bdf6d
+ last_write_checksum: sha1:b86435af48826a6cf3826046e7ea4dd0f2051938
+ pristine_git_object: b35bd7dc157a7e3da083b06f83c255380003d4db
+ src/main/java/com/gusto/embedded_api/models/operations/QueryParamSortOrder.java:
+ id: 2a819f66914c
+ last_write_checksum: sha1:8e3de4b0d0e891c05a0a476d69cca13a1efe74b9
+ pristine_git_object: 3b12c26468f47f863973761057cd37810812f024
src/main/java/com/gusto/embedded_api/models/operations/Reason.java:
id: e27c11f6be4c
last_write_checksum: sha1:3826695e9651816cd22c27807faee6936aec4c30
@@ -14297,10 +14958,10 @@ trackedFiles:
id: 4b87be9bdbde
last_write_checksum: sha1:d366228c28ddbcc2daef86307acf3a34d1e1591a
pristine_git_object: e4dd4d6538d7fdea48c57ca0d3f3ef8092958722
- src/main/java/com/gusto/embedded_api/models/operations/RequestBody2.java:
- id: c04cd5380aa6
- last_write_checksum: sha1:e361b385a83741674feff9ec1f5b5a7da95c0f7a
- pristine_git_object: 112180355c3c38e5ae06d9dfa8c5bd0398644277
+ src/main/java/com/gusto/embedded_api/models/operations/RefreshTokenRequest.java:
+ id: 01947c071e32
+ last_write_checksum: sha1:fdc75aadf948ffcf4bc293ceeafb9b8a2ab0d668
+ pristine_git_object: 1e4aac927de5671a97991e1e8ae5b1f2e55bb66f
src/main/java/com/gusto/embedded_api/models/operations/RequestBodyGrantType.java:
id: 5332d9e6aefe
last_write_checksum: sha1:efe769e729c7eccd971be3741881853e87ee2aeb
@@ -14317,14 +14978,6 @@ trackedFiles:
id: 4ed99bfba69a
last_write_checksum: sha1:6ec8ba7b4eac947fccc7ebbcba276a22250b5556
pristine_git_object: f2b94750793f5a2652794bf5fe839589626be568
- src/main/java/com/gusto/embedded_api/models/operations/Resource.java:
- id: 7dbc95153f1a
- last_write_checksum: sha1:2864ff0a9484f6b86d9a6bcacfd61b93826610c3
- pristine_git_object: 8bfce8f4a3ada86c8229ae4c2350c5163ce5eadd
- src/main/java/com/gusto/embedded_api/models/operations/ResourceOwner.java:
- id: 5a76aa6e790a
- last_write_checksum: sha1:eebc57c739a0745e409927c5cd82a2f7d3a9ef87
- pristine_git_object: 74feeb760cebbfd27e8231276180b57802fca433
src/main/java/com/gusto/embedded_api/models/operations/ResponseBody.java:
id: 1a7e8dba1483
last_write_checksum: sha1:e3ecd7f980bb3796bcbd30f3bd5a8616423bd6a7
@@ -14333,14 +14986,6 @@ trackedFiles:
id: de00817a7b56
last_write_checksum: sha1:dc1b3a324e78083a7ab1bb47f602a47a2770b3f9
pristine_git_object: 3c176f81eb3f525d8eac1820b4e1047db6f14489
- src/main/java/com/gusto/embedded_api/models/operations/Results.java:
- id: 62f351227f95
- last_write_checksum: sha1:84f8ce47acfb1cbb9a8d4fdb584dde3cb8c7f913
- pristine_git_object: 59137ab1aa516ab2018d721daac8117c17331edf
- src/main/java/com/gusto/embedded_api/models/operations/Role.java:
- id: f111bb682426
- last_write_checksum: sha1:d8a2e0c7806695ee07cf3fef10cae027c059fc45
- pristine_git_object: 38f27fab8835858d8cf66f19c491f15eca12123e
src/main/java/com/gusto/embedded_api/models/operations/SortBy.java:
id: b2c131dc9cde
last_write_checksum: sha1:925ff7a84a3f5e2d16c333db2834f06efdab9eb2
@@ -14351,16 +14996,20 @@ trackedFiles:
pristine_git_object: 0e0b00ba28f82f6614998a7fdd8c359ca9af9004
src/main/java/com/gusto/embedded_api/models/operations/SplitBy.java:
id: 8272ae994300
- last_write_checksum: sha1:25820e4637aa16fbd4f281a2a4110dedee48f8fc
- pristine_git_object: 349d3fe6b63fb0d1f13b910f82146ee2312cf4c8
+ last_write_checksum: sha1:cd1ab99860b548afdb8a5b1674730d0de97ee98f
+ pristine_git_object: f216cebccd1caf2962bb40a35373fe2b66d843e0
src/main/java/com/gusto/embedded_api/models/operations/Splits.java:
id: 461d74187378
- last_write_checksum: sha1:a3332a1b40fa572f0547e30bb6d06960eb3620a3
- pristine_git_object: 4ed8afae52f8243829c374dc3e53dc2b1521da26
+ last_write_checksum: sha1:83ee743802fe9f9101b72ff7a5527a23253817f0
+ pristine_git_object: 0e577f486f2a6b83017e66aaeab19e4646bd74bb
src/main/java/com/gusto/embedded_api/models/operations/Status.java:
id: f53b91ae36b0
last_write_checksum: sha1:161357eaabc302216b852349057db644de65fbf0
pristine_git_object: c6b3cff96f27f67223b2ad2ab74c52582439eec0
+ src/main/java/com/gusto/embedded_api/models/operations/SubmissionBlockers.java:
+ id: 615c8072bf64
+ last_write_checksum: sha1:ced1c36fc83a0efa9397b644419ec490adf21220
+ pristine_git_object: 0ff167081231f08bd26e7f3ae693c40c5dd9c954
src/main/java/com/gusto/embedded_api/models/operations/SubmitInformationRequestRequest.java:
id: 90d515969f66
last_write_checksum: sha1:a73bccf9f9fb48a4409ac7222b60d8deb81b3343
@@ -14381,6 +15030,10 @@ trackedFiles:
id: b52a19241cf3
last_write_checksum: sha1:23e52b0f1bc153326e92e08b63a175a862c2e6a3
pristine_git_object: 4ba2ee641e4dcf66f3db7e6017ba6acfbf8e2980
+ src/main/java/com/gusto/embedded_api/models/operations/SystemAccessTokenRequest.java:
+ id: ad1c3b2ec635
+ last_write_checksum: sha1:7402d96840c256ff2fd3cd18e1febd33cded1147
+ pristine_git_object: a840ccdd32b03151db47c466eca7672278660a4c
src/main/java/com/gusto/embedded_api/models/operations/TaxPayerType.java:
id: 04fe05fca7b1
last_write_checksum: sha1:a606381301bd838d2d323659d4706965ac02adbe
@@ -14403,8 +15056,8 @@ trackedFiles:
pristine_git_object: 92ee8e5281bbfebb504c25dc5870a17b4a7ab045
src/main/java/com/gusto/embedded_api/models/operations/Type.java:
id: 126437c03e1e
- last_write_checksum: sha1:14567fde3f9937900d6d94fedab94a492c7fb1a1
- pristine_git_object: e9fd586ab0f64322c20b6996701c44e022daf160
+ last_write_checksum: sha1:afa982d3ca80a7f88bd6e5688988fcd79a235460
+ pristine_git_object: fd43cfb69237f294d33dacf9c21349ae7e4e4f24
src/main/java/com/gusto/embedded_api/models/operations/User.java:
id: "256303976534"
last_write_checksum: sha1:18169b136b9e09c1dbc3263ef3ce17a90f0578ac
@@ -14421,10 +15074,14 @@ trackedFiles:
id: 3409c87a67f1
last_write_checksum: sha1:850eefd436514c4538f4496dd1e9f1ade4adefa6
pristine_git_object: 10ed6711db4d062d621df2ed2fa39d1e23982232
- src/main/java/com/gusto/embedded_api/models/operations/WageType.java:
- id: 94d95c24ca4c
- last_write_checksum: sha1:fc35365595568be85634a66badc8d95fa7bbaaf5
- pristine_git_object: 0ec944cdb2f14af3b5bf42f85c8ddc834ac50f34
+ src/main/java/com/gusto/embedded_api/models/operations/W4DataType.java:
+ id: 20fc5207a1b8
+ last_write_checksum: sha1:18d2dc42a9fdf7b0743886a7a0f9a7cf7dc53551
+ pristine_git_object: b14d7e5142a57418268e63118126af45b1d7281b
+ src/main/java/com/gusto/embedded_api/models/operations/Warnings.java:
+ id: d72897030a95
+ last_write_checksum: sha1:5cb900ecd8fff35212e409eeb091c5d72e85df01
+ pristine_git_object: 1afd5f55c11b2bc3adc54d0cb0fe13da4fc763c6
src/main/java/com/gusto/embedded_api/models/operations/WithholdingPayPeriod.java:
id: e50645455956
last_write_checksum: sha1:0a814c9b01cf444f8f4c4da23f595b21c832451d
@@ -14435,8 +15092,8 @@ trackedFiles:
pristine_git_object: bba72a8e08930b1994b50b3ca85a22e1fd7a9c1f
src/main/java/com/gusto/embedded_api/models/operations/XGustoAPIVersion.java:
id: 3adde9c196e0
- last_write_checksum: sha1:031b24727016659a5bd7df923c1428c93d103a75
- pristine_git_object: 4daebb59a2884fd8d7bf27ddf608673ef4a655be
+ last_write_checksum: sha1:1a14cb5147b6eddce78bab3ddd88642b9dfdc063
+ pristine_git_object: 33d18295669c5e2686c84fc2cbe16cbf0563f575
src/main/java/com/gusto/embedded_api/models/operations/async/DeleteDepartmentResponse.java:
id: 415b037701bf
last_write_checksum: sha1:df26a60fb03defc05b5b4767969a8b6cfa820650
@@ -14571,8 +15228,8 @@ trackedFiles:
pristine_git_object: f100f3ab6429f0ca3f35af3435ca30fe5536e0f6
src/main/java/com/gusto/embedded_api/models/operations/async/GetEventsResponse.java:
id: 35bf5b5365c2
- last_write_checksum: sha1:3a0e599a22652451eaf32a33bf6b464bcbab450b
- pristine_git_object: 9f9bb39a40bc180bfa95f11afd9d68057d4c2316
+ last_write_checksum: sha1:66c0556bcebc7ea35ba32ebd0ca57c93769611bd
+ pristine_git_object: f26abd28544251f3e88962900b1f6f9ab2e69cf9
src/main/java/com/gusto/embedded_api/models/operations/async/GetInformationRequestsResponse.java:
id: 36e7d266a8e9
last_write_checksum: sha1:8614ed239f45adc8f8e723e6c83a8df4ef3d065e
@@ -14635,8 +15292,8 @@ trackedFiles:
pristine_git_object: b55b5a33ee050b3db960069c9277fb179ec8d2d0
? src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyIdContractorPaymentContractorPaymentResponse.java
: id: f07a8a17a88a
- last_write_checksum: sha1:f8ee811746584fe053e1d18197212c02843a96d9
- pristine_git_object: a2d043e9ae872e8ec5e62162c0526c2a4afa2642
+ last_write_checksum: sha1:0f4780c15270d0f940a815877cb78e82b30c5918
+ pristine_git_object: ced2909e8377b17c95d40de62f5aed404d1b4c42
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyIdContractorPaymentGroupsResponse.java:
id: fbb4aa409ce8
last_write_checksum: sha1:ee3fdd9558b3db0b1f098f4382f4ce0d0f1b771f
@@ -14671,28 +15328,28 @@ trackedFiles:
pristine_git_object: c7cdd27bd3969690a2d0a3857d8f55e366742028
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyIdLocationsResponse.java:
id: 10222088d3c4
- last_write_checksum: sha1:5ba2c8215f352b3e1cc5937b29fff3759a63c96a
- pristine_git_object: 6864b63fa3e169cfe9739315f988189d26f19df4
+ last_write_checksum: sha1:b9e7260df64cfe0f5b226c1c6490836f63bfee7e
+ pristine_git_object: c7cb63c29686537b9672a775b4579a0afa540cbd
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyIdPayPeriodsResponse.java:
id: a6066e126d4e
- last_write_checksum: sha1:a90e22e690e16ad4e51d9019911f8319fe73280a
- pristine_git_object: 6241b4f5bd0d1f21f5415b8ba4fe7e48f3b5e6fe
+ last_write_checksum: sha1:5eb27533a20a239816c95a00edde61522bea67f2
+ pristine_git_object: 840f084f96f4250b2d37ff1b539e30a818b57a2c
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyIdPaySchedulesAssignmentsResponse.java:
id: f29c2d748487
last_write_checksum: sha1:508f2c257e9290c064918714582c9c99656e5d42
pristine_git_object: 703f2b6a876eca8a889522b0a61306f8e668f0b7
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyIdPaySchedulesPayScheduleIdResponse.java:
id: 545add89a45a
- last_write_checksum: sha1:4a026496258d4f728185c3def67377928f5bfc35
- pristine_git_object: 32d8925c5235e460ca523f5ee79c411a82841215
+ last_write_checksum: sha1:a638c29729e06f05ffb32af4c9917eb21037ab2a
+ pristine_git_object: b3af0768ef8043d3a9effa555698e373281bc3f9
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyIdPaySchedulesPreviewResponse.java:
id: 27c6086af890
- last_write_checksum: sha1:d8489215248708475f67a91a14ac83e60da55087
- pristine_git_object: eb7c849550e527adcebddbbb19c9903093d51f76
+ last_write_checksum: sha1:6f8dceeff3d06ebfd7f7815c19a152d0a6f67dae
+ pristine_git_object: 04f11c2e3e3b9052d1edebb957b50a0d79b4c24e
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyIdPaySchedulesResponse.java:
id: 1b6a58d58ca0
- last_write_checksum: sha1:1b94be07a38b1cefe491f57e3f9851de51e6ec90
- pristine_git_object: c076eb00fc1174b685d445d41299e6905d23ccfa
+ last_write_checksum: sha1:93fcbf5154aa82d352bd74553a9c0ce1bbe824af
+ pristine_git_object: 3c2bb0d7d645e7da4d200be72a7e3b3f08a6e3cd
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyIdPayrollReversalsResponse.java:
id: 5e76ee3165e1
last_write_checksum: sha1:c7b0d24b422390e23566dd62a55220eaad99bae0
@@ -14707,24 +15364,24 @@ trackedFiles:
pristine_git_object: c8b69ef6f5536059eaa273bb12fa96a41a16c04a
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyIdPayrollsResponse.java:
id: 3f839c5039a3
- last_write_checksum: sha1:1294929c7da0ba8af35e00dd3c094bc36f71b577
- pristine_git_object: bab5f993ed6c457a2bdafa490d25e534b44a95be
+ last_write_checksum: sha1:e81f7194d6a47557a1dd0d37e562393b77d0acfc
+ pristine_git_object: 5accca7f8bba9fc6c9762020815b56e3961a6c02
? src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyIdUnprocessedTerminationPayPeriodsResponse.java
: id: 1471e53e824f
last_write_checksum: sha1:5c2a7d9567fc419f527369c2d0443ec1aace482b
pristine_git_object: 30afe6ea39bfb316da1fa055993fb4bb7921d039
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyUuidContractorsResponse.java:
id: 81b3adfaf815
- last_write_checksum: sha1:4c7c4ce2b076b8583730b15cba9522dac2a5b077
- pristine_git_object: bb08748a3485dcd0c8cb4c16d8e7954f7cbe42bc
+ last_write_checksum: sha1:abe096c34f92ab5d1a6ae0dc1be1184a1568bcf3
+ pristine_git_object: cbf69c7cf938107a18c3ec6dbafb8d10b4f83bb4
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyUuidHolidayPayPolicyResponse.java:
id: 79aab77a0521
last_write_checksum: sha1:8c32c81788b17a85b328295f766e9458ec30ab5f
pristine_git_object: 043c88d5e03393e0b6cbc4be799b8905118d1052
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyUuidSignatoriesResponse.java:
id: c70fa19a4b5d
- last_write_checksum: sha1:8414c5d6a068c4c9f64a41fd7c551c58d834058c
- pristine_git_object: ec594950906b37aab9df9fffa722e2373fcc9e03
+ last_write_checksum: sha1:636af6e1cf440e1b4f501a3d48f198283a8c1c27
+ pristine_git_object: 7299b5cfe3b32579bdbdb27c4e44187ad173c367
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesCompanyUuidTaxRequirementsResponse.java:
id: b64a0b9fd48f
last_write_checksum: sha1:7b42bf3911bc519fe6efca0721b92b80d615075e
@@ -14739,12 +15396,12 @@ trackedFiles:
pristine_git_object: b7466e106371214b5cfaebfe02fa403fe235264f
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesPayrollBlockersCompanyUuidResponse.java:
id: bf24114864d9
- last_write_checksum: sha1:b053673f4862abcbbef7e2104f1e460a08616236
- pristine_git_object: 6bd1e9711cfbd0231a455f71011beaaed0345145
+ last_write_checksum: sha1:76c455100087a25abecb4fdf62ab2e10a4519dc9
+ pristine_git_object: 7bbfaecdab85d03e93eea94d85e02d4a4f0b7228
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompaniesResponse.java:
id: d8a650ae7d8b
- last_write_checksum: sha1:2855aecf6fcd9a8e2406279551ddd0ef317d632f
- pristine_git_object: da24a877a8d6955f425765e2b727c686e6674154
+ last_write_checksum: sha1:ea1acfd757f40fb1bc1c26a4a5670aa943bb6e68
+ pristine_git_object: 76d2bb227cd28a2123911d8113c4fd1329cd65cd
? src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsResponse.java
: id: b26acf5a7fbd
last_write_checksum: sha1:af42da90a8b89052adb46d37b05dffd09bcf7149
@@ -14763,8 +15420,8 @@ trackedFiles:
pristine_git_object: 6465ac9da3ade8015fd7f3cda9161b7434e05dd6
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompanyFinishOnboardingResponse.java:
id: d19a11ff45fa
- last_write_checksum: sha1:4c49a118c3e8044a4a624a6cedbfccd7f70be0e7
- pristine_git_object: ab565a25bc95208378f4d6c48f20309c18a7241f
+ last_write_checksum: sha1:196f154ee5adfb13d6a635b6446059deb43ad23f
+ pristine_git_object: fcbaae5c3ddd0b170769d4ea6c8f51145c454585
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompanyFormPdfResponse.java:
id: 68fba7f75ec6
last_write_checksum: sha1:0f7452d7b0e9a8f74305d3cc9fa0232e524899f8
@@ -14779,20 +15436,20 @@ trackedFiles:
pristine_git_object: bd6f3cae40479d4440bcf1db82e6d065156d59a1
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompanyIndustryResponse.java:
id: c1dabcda84ef
- last_write_checksum: sha1:59458d497f957a59900dd393ce29f7cfb5273ddc
- pristine_git_object: 0bbcd831e3a48aff133d9dc35d08be720b499351
+ last_write_checksum: sha1:3ce6d08035b553e04459d94d9f2364d0a0e840ce
+ pristine_git_object: 42dcdd0da86cf357611452a2fff567af64026cbf
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompanyOnboardingStatusResponse.java:
id: 84ff0e8bb316
- last_write_checksum: sha1:d780b7762095af69a73c1297c02e18f21a5007eb
- pristine_git_object: 564fb09c691c1d959bc3e6f238ca09727e9a49fd
+ last_write_checksum: sha1:1c002d7a8202ce1e2b646dc522280e562ef0bed1
+ pristine_git_object: f01bcb0a8956e6d899fcdd872e01cf08a4a24a75
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompanyPaymentConfigsResponse.java:
id: 5a3d16f48f81
- last_write_checksum: sha1:507352d08c5e82cb71a491f8eacc3b8df82a9bea
- pristine_git_object: eac69441b319b534383a2d3cba40fa9f41d0e937
+ last_write_checksum: sha1:0d1023147e1ba3b1fd5092fd9808471223a669a1
+ pristine_git_object: ce0293559ff2ad090e1c3e023c2ff29303087e06
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1CompensationsCompensationIdResponse.java:
id: 0b2cfd9cdc04
- last_write_checksum: sha1:e96ba00ffe7c2cefb71569b38801789297ef9d13
- pristine_git_object: 8dc3a7481728084dac43a1a903591791616d0aab
+ last_write_checksum: sha1:9616e175f09c068c2289ab47286e526c8c88e2a3
+ pristine_git_object: 7d8b21f611e11309c52cc74e9d4602f77bfd0bcc
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1ContractorDocumentPdfResponse.java:
id: 8e0c7de0bee5
last_write_checksum: sha1:609179590f99ac43b148f47536f0d8999ba1be8d
@@ -14851,8 +15508,8 @@ trackedFiles:
pristine_git_object: 96f9f69f358b69934300e1ccf0d5ab7a2d7ae6ad
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1ContractorsContractorUuidResponse.java:
id: 8e25b4489c55
- last_write_checksum: sha1:202c6db381f1eb5e4326536561ff3e739ae9ece2
- pristine_git_object: 6eecda1ad446ca39fb4936163ef80dd2ae14a126
+ last_write_checksum: sha1:5fe290bde823c1a45037bdce733deebe8c02e657
+ pristine_git_object: 7b52b4a88d6542f11fd7425bdbdedd4cc4ed2f26
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1EmployeeBenefitsEmployeeBenefitIdResponse.java:
id: 563a6b0f6f33
last_write_checksum: sha1:2055c5353864faf4525ef7730c6f27212657c101
@@ -14887,8 +15544,8 @@ trackedFiles:
pristine_git_object: ea013eaea1060220658ec67ac5b3f5245a6757de
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1EmployeesEmployeeIdFederalTaxesResponse.java:
id: f517822e28b3
- last_write_checksum: sha1:236ac1f77a21a1c3b2c3f12267d9cc5377991080
- pristine_git_object: f13fa7d7ffea29a238d614fd67234d92ecaef3fb
+ last_write_checksum: sha1:cea8306b4cf740f73ddd83e8d56cdbd302c33fb0
+ pristine_git_object: 34ee61fdc4dcaf0b4a3b9c7ff646fce5785ee479
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1EmployeesEmployeeIdGarnishmentsResponse.java:
id: 757b6cd3a01d
last_write_checksum: sha1:007f8fcb76798fcfaa6e87f641ca1dc8223c5402
@@ -14899,16 +15556,16 @@ trackedFiles:
pristine_git_object: 7b651e9d30ac77f4e2b0e24653db73299d2cce21
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1EmployeesEmployeeIdI9AuthorizationDocumentOptionsResponse.java:
id: 0fbcc1136b9a
- last_write_checksum: sha1:3dd759b1cfdfd4b7025f7283daf5fd6b607461f8
- pristine_git_object: 218cbc2ceeff191e9be7600f21dc6e5c4d904d63
+ last_write_checksum: sha1:aed9bede467f024ce564473791d6fd13a70884bb
+ pristine_git_object: 851c4ac66268d80e1c821df228d7d8b8e56f0bcb
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1EmployeesEmployeeIdI9AuthorizationDocumentsResponse.java:
id: 2d459474355f
- last_write_checksum: sha1:c28c531e9cf38421987d717b535ee3f8748f1a14
- pristine_git_object: 7686396d89490758f0e68b298ec22597022ae233
+ last_write_checksum: sha1:09ee4b83c75aa30dd465ab80a0940844f49acfe1
+ pristine_git_object: 25c039347e55792d15dc58f11bd0b62cb717c425
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1EmployeesEmployeeIdI9AuthorizationResponse.java:
id: a5000e6fbc91
- last_write_checksum: sha1:badad1f9d8fc15c0ba78ce259d48276884a4d2c2
- pristine_git_object: 74765727a5cb43e292aab89bbdc2368bacd6dfad
+ last_write_checksum: sha1:b74c73509205d99997de6fcdfe507c18133c1d13
+ pristine_git_object: a768e11545e3dff5868b395438dac50cbd6b16d9
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1EmployeesEmployeeIdJobsResponse.java:
id: 9990295b2c63
last_write_checksum: sha1:c10dda50122b336a1602e49f6ebbc7b6bad32c64
@@ -14919,12 +15576,12 @@ trackedFiles:
pristine_git_object: f022cef8ac07f7b29d6f898be3f03442c37dfa01
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1EmployeesEmployeeIdPaymentMethodResponse.java:
id: d3a64bd1991f
- last_write_checksum: sha1:eeb2932b351d2d02ee74657c5c1ade1059c4ea85
- pristine_git_object: 46089d31d22c4bfbbac1d0a32329d867913f5053
+ last_write_checksum: sha1:e2f5ff83750ffab50d7a804ec02cf78ea64fc672
+ pristine_git_object: cc7783fbe804c17fe83b210a36bfd9e959019024
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1EmployeesEmployeeIdRecurringReimbursementsResponse.java:
id: b75c3aa3e53c
- last_write_checksum: sha1:6e7fbee438d854139af0dccddde15e13c16c0dc4
- pristine_git_object: b00d6f221233284af032f9442008072f55535ab9
+ last_write_checksum: sha1:c34edaf512eae23ff4a990535559eed3400ded0c
+ pristine_git_object: 9f42cf6c5e884b1ee922d6c43357529d2f62a29b
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1EmployeesEmployeeIdRehireResponse.java:
id: 207e119a6be2
last_write_checksum: sha1:6c0b78254ffb690826f335b4776ff03b233bd0c1
@@ -14983,8 +15640,8 @@ trackedFiles:
pristine_git_object: 1dfd56b0ef15f6aa55f63b53fe0ee05c30343e51
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1JobsJobIdCompensationsResponse.java:
id: 49c895e85777
- last_write_checksum: sha1:f9151c3bb1c1890fc1bd2ab3fae16f5870ba01d2
- pristine_git_object: bff4083b2bc277e54cc2c6bc46a9f29561753beb
+ last_write_checksum: sha1:c1e0f260c05d42464941c05a2070d8d65b165391
+ pristine_git_object: bcf03451bc843ea77fbb41919eecc136611b2169
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1JobsJobIdResponse.java:
id: 1e5b357cf01e
last_write_checksum: sha1:b928a09bd3cc49bfe1772c5b543754d74b558da1
@@ -14997,22 +15654,26 @@ trackedFiles:
id: 5f1eb3363982
last_write_checksum: sha1:0a3308cada381dc5c7744665de6c266fe2013dfd
pristine_git_object: f5b8966f340b9ceb2a75e5b4bbe0b3bb36aa3110
+ ? src/main/java/com/gusto/embedded_api/models/operations/async/GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessResponse.java
+ : id: c50470845983
+ last_write_checksum: sha1:8357a40d590dc65a743ecd622603d2f3e073ce0f
+ pristine_git_object: 122762ed4e695f974fdc8e841b1684e7516cf96a
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1PaymentReceiptsPayrollsPayrollUuidResponse.java:
id: f58d43055245
- last_write_checksum: sha1:5ba56895c80129cd47be15d911cc65fca5f3fcfe
- pristine_git_object: 15d90f4bfaf61afdde449b467a9811ee484ea150
+ last_write_checksum: sha1:d4305cb748ff9c7b4f074049f2abed126d3d8963
+ pristine_git_object: 7ff11fbebcd17b3d56a8e0d8c19faa5676516fc7
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1PayrollsPayrollUuidEmployeesEmployeeUuidPayStubResponse.java:
id: 7b18a0c2a9f9
last_write_checksum: sha1:da0bc0600fec57f87a1e841239d1e5a098ed3b9b
pristine_git_object: e7b00c14ed37499ade13edd90e3892563187dac2
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1PeopleBatchesPeopleBatchUuidResponse.java:
id: 71af9ba224ad
- last_write_checksum: sha1:9ad421b3bcf76ba120fb73d05616eeec6fc16cbd
- pristine_git_object: f48259bbcb516f3788be60d4d89267e695e6096e
+ last_write_checksum: sha1:c5a59b7d1247f6bfa3fdc9da06386ff3fc94ba47
+ pristine_git_object: f433e08ae01bdbf79f8a1afc24f9c9736e9fadfb
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1RecurringReimbursementsResponse.java:
id: 77adf3b38b91
- last_write_checksum: sha1:7ede65e7c0f7c1c16ace5bd0167aa5efaed21627
- pristine_git_object: eaf6289cfe655bfe17a1c17712800f9c3dddbf9f
+ last_write_checksum: sha1:7b78ee51a90eb6c3fc8953a093ce3f0d0412e7b5
+ pristine_git_object: 831ba3e3b208a6c8e21cd65eb0a7ad70012544de
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1SalaryEstimatesIdResponse.java:
id: f523569942d3
last_write_checksum: sha1:4b3513ffa4b0bbd64a9a0b0c9a9108a67a890970
@@ -15023,16 +15684,16 @@ trackedFiles:
pristine_git_object: 7c73acb0ca049954c2f2d357745bb2aece5920a4
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1TaxLiabilitiesResponse.java:
id: 1372b620aca2
- last_write_checksum: sha1:69eb857c5f3fd6d89ee63f2fc3a65cb063229e87
- pristine_git_object: a1a79e4a61cc173fae8bbefef00ea1d119c6de19
+ last_write_checksum: sha1:6b727472a14900bff963a36dd9ae2951323547ac
+ pristine_git_object: f545a42d03829ebb571fae45aa352871ff4b14db
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1TimeOffPoliciesTimeOffPolicyUuidResponse.java:
id: 37bbcbf7c50f
last_write_checksum: sha1:3c1bda6ccf5c4ad5f5f1bd1b16d1386bc1a7cd79
pristine_git_object: 17addcb9f30dc8b03c9fb230e908f5c3be86f33e
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1TokenInfoResponse.java:
id: 2291d0ca786d
- last_write_checksum: sha1:755af33872d917c8ae937feafb934215dd04eea2
- pristine_git_object: 7ef29396964980d4052450a57d0306b50b49da65
+ last_write_checksum: sha1:59efd52e436ef7804a59adf336c73f3490bcdc27
+ pristine_git_object: 01a121cd2c3cb7c84c40b9e3040e3ef9c5f80fb9
src/main/java/com/gusto/embedded_api/models/operations/async/GetV1WebhookSubscriptionUuidResponse.java:
id: 20339c8afaca
last_write_checksum: sha1:b73b45f7ba65a4848f01fa5342a040ac41a1cf83
@@ -15063,8 +15724,8 @@ trackedFiles:
pristine_git_object: 110a2ab6fd2be6e93cc5bbd945e6d54d2510376c
src/main/java/com/gusto/embedded_api/models/operations/async/OauthAccessTokenResponse.java:
id: 280727b41f96
- last_write_checksum: sha1:7c1876476a83f112b494589858b7f0a5f9c0b943
- pristine_git_object: 76a204de504e5f60ea2a09e0c0f22a7b45649bc3
+ last_write_checksum: sha1:5f775a697d5f1593dcc706c3347f92550e26719e
+ pristine_git_object: 39d5ec80bfe65f7248389090bbb9cebeaaf0ef3f
? src/main/java/com/gusto/embedded_api/models/operations/async/PatchV1CompaniesCompanyIdPayrollsIdPartnerDisbursementsResponse.java
: id: bd22a388c5bb
last_write_checksum: sha1:d2a72ecb6c29401aadb9ddbd8998f0b8a4c49a82
@@ -15101,6 +15762,10 @@ trackedFiles:
: id: be344a1acf2b
last_write_checksum: sha1:548ed1a332d16ba208f0891d18f0543880a7b476
pristine_git_object: 7cf35fe599bbea3c79d08b6f2c69de650d86d82d
+ src/main/java/com/gusto/embedded_api/models/operations/async/PostPayrollsGrossUpPayrollUuidResponse.java:
+ id: 3e69125e20a1
+ last_write_checksum: sha1:c95accadeb85befbdc48fe755731ab14dc8e4282
+ pristine_git_object: ff4a24a5dbb04ae107e0e987632dfc628e5a08bb
src/main/java/com/gusto/embedded_api/models/operations/async/PostPayrollsPayrollUuidReportsGeneralLedgerResponse.java:
id: 37f2c8d5c784
last_write_checksum: sha1:cdfc0c7df47af11b9f0c3cb81a0249bc30224c17
@@ -15115,8 +15780,8 @@ trackedFiles:
pristine_git_object: 601acb8dc3fbbb7ea99106304bb76a77d65aa3b4
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyIdBankAccountsResponse.java:
id: 05cbd743116d
- last_write_checksum: sha1:6b66434a709015e99ad55169e16e0e3eb775c191
- pristine_git_object: c65abf4c2ade4b893f6efb901edc43bdbfbf3e96
+ last_write_checksum: sha1:72d5d47e32f95b670a831a88d3deabcdd38b4b41
+ pristine_git_object: 2c3df56a4669c7e65301c25bfae96abd415cfcd7
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyIdCompanyBenefitsResponse.java:
id: 1314f144897a
last_write_checksum: sha1:fe0065ca816573409c3b6f54b73eb33943a12350
@@ -15131,16 +15796,16 @@ trackedFiles:
pristine_git_object: 19d5ce2b8847adfd173cebdec5d9ffdf7aaec3fd
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyIdContractorPaymentsResponse.java:
id: 6324ab67066b
- last_write_checksum: sha1:414f8d4cc1fbd6c10601dfde9da6dc45a857c93a
- pristine_git_object: 878acb54617398f7c7328545222c5d7a308264af
+ last_write_checksum: sha1:3aa8a50fba969dd75fa38272439a359e13eda8ab
+ pristine_git_object: 93caf8be48f9b357b393a362ef5691c151f1c9b0
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyIdEarningTypesResponse.java:
id: 9bec030b9894
last_write_checksum: sha1:39025b65738d8b0aeccb24059873dda7f0735464
pristine_git_object: 24bfa8dd19f32dded58468596282f1040745d39b
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyIdLocationsResponse.java:
id: f4278c2f03bc
- last_write_checksum: sha1:838009329314d97d78c6da0e536c8e9a0c8ffb4c
- pristine_git_object: 1575a8e61e945b9a578c8d1328756ba51cd344df
+ last_write_checksum: sha1:6abc117af65886bd8d6e1639a1ade4dd0dd4dc00
+ pristine_git_object: fde8445d6af014ec2b03bd170325da00c6714b41
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyIdPaySchedulesAssignResponse.java:
id: aeaad8464ac2
last_write_checksum: sha1:613b5eff69df1a33ffeb33d1e326b1b561714e2e
@@ -15151,48 +15816,48 @@ trackedFiles:
pristine_git_object: f0c50ba467cacf384a36371de6cb02dc0f8905a5
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyIdPaySchedulesResponse.java:
id: c539e51214a9
- last_write_checksum: sha1:73f9fb143aebcb2334dc2f88ef7d7b7358008f71
- pristine_git_object: f0117caaa54b91cc82e62536b0831bcaadb754af
+ last_write_checksum: sha1:523e41c12fa03183f1649b90b40840c356dd5d89
+ pristine_git_object: c4f44ad74de97b7a0f01be5c6630f66e050b110e
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyIdPayrollsResponse.java:
id: 9884317e5d03
- last_write_checksum: sha1:2c0e7f6962b6e0fad069b74a459ec45cfb83fd74
- pristine_git_object: 502f0541acdd7fcabd4bc0c4a5b561ecc0bbe6d5
+ last_write_checksum: sha1:6180eb094707c90b395c369be4e748e149a7882c
+ pristine_git_object: e935b14edeb6a064bb0beafedf9d20e451bcd21b
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyIdPeopleBatchesResponse.java:
id: 4e48c317feb6
- last_write_checksum: sha1:d3ec2024003c72b736ebb62da7e6d10f460d8972
- pristine_git_object: 3710cdb3415dbfc8ce327409ffceab9fa891d8b0
+ last_write_checksum: sha1:5df0a16dd2904afe8cc4fbd9b2cb4acaeaca7a34
+ pristine_git_object: e4044144c38943ee4bf4372495b4477dc9b1245a
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyIdReportsEmployeesAnnualFicaWageResponse.java:
id: 0b05f0732134
last_write_checksum: sha1:6f282e9688d676b34710a43c436a1bbdf65b37f2
pristine_git_object: ad4b93d2e737c80f2322f2931c02d7aaeced01c8
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyUuidContractorsResponse.java:
id: 27710cfd6115
- last_write_checksum: sha1:7119e393785d74eb1090edf521e4aceb4b203f44
- pristine_git_object: a499750ce379c2196bbb0f4291c0e67fc099f212
+ last_write_checksum: sha1:09840bf22ed15193bc7362593ecd0448ce56a92a
+ pristine_git_object: 9b89521ec3e852f0a9d5239497cb9728925bfbcc
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyUuidHolidayPayPolicyResponse.java:
id: 59381c258602
last_write_checksum: sha1:06e9f3218dedbceb38b5d7bdc90af30cc63246a2
pristine_git_object: 9c27527e42c256e2b49c8ad84a91bd7fa3962e17
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyUuidSignatoriesInviteResponse.java:
id: 0fefc79b66f8
- last_write_checksum: sha1:7608513d65bbb1b2e6bd11a915ee28bc55fb4098
- pristine_git_object: f33796d901e92f2ce906c06b0d6ea7a8c9110938
+ last_write_checksum: sha1:73c3a20319c0d9b0581484998511485cf4423f85
+ pristine_git_object: 6e89ebd9cecabee381c4e993571ff1692ce3400a
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompaniesCompanyUuidTimeOffPoliciesResponse.java:
id: 9caceeb36f32
last_write_checksum: sha1:1de68ff1103ed0fb491fbb0e96d60cafd804f953
pristine_git_object: 148db506768ac37c156aebdd1a7da39f5284765b
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompanyFlowsResponse.java:
id: 401da8139fbc
- last_write_checksum: sha1:91194f9d33a18ea730e042e1ebcc8985141ca8d6
- pristine_git_object: 592e97ab7af32bb75da0e1c1d66688bef85a1d86
+ last_write_checksum: sha1:8ad4d87f706cfc570e903a3db5df1ccac70ec685
+ pristine_git_object: 6f6b07c82b8c86c2f53809ba3cf9738541e65675
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompanySignatoriesResponse.java:
id: c25ca1a54f3b
- last_write_checksum: sha1:f7d67dbe6bb69485e4ca925440ce188ab91e52b1
- pristine_git_object: 65734f1e9dc60bc8259ce834c64abe3ba0901c95
+ last_write_checksum: sha1:e6fbb4e57f1fbd031626b443e7b37592e6433631
+ pristine_git_object: 6de727242a8f177674e43248f4c01458e122b995
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1CompensationsCompensationIdResponse.java:
id: e16ce88c39bf
- last_write_checksum: sha1:b530d803e97325854a73a0f043feaf76b843856d
- pristine_git_object: 4689f5c412d9f8ce256e1f18105383ed09cd0d65
+ last_write_checksum: sha1:cceb773cc330f911e183361241a1b18e74393e9c
+ pristine_git_object: d36998a8fd6128432ab12ffbb7677e63152fb617
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1ContractorsContractorUuidBankAccountsResponse.java:
id: 5bef39618e84
last_write_checksum: sha1:5655c8efc6721f4881fbbcbfa41d19cf56e3f855
@@ -15215,8 +15880,8 @@ trackedFiles:
pristine_git_object: d1f0673ab0f8d446d9aa0c2bd274d6ca25e34d7a
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1EmployeesEmployeeIdRecurringReimbursementsResponse.java:
id: 92002bb6da7b
- last_write_checksum: sha1:72fce0e140da6aca9e163d67ca461fe7261cbdd9
- pristine_git_object: ef60e6d2dabe49701a7751fa92c6efc310723cac
+ last_write_checksum: sha1:2d97e79be5ce2394158fd62618f79e27f0f043b3
+ pristine_git_object: 8b95cd0fd87d3c147aa4b0b803dab6a25fc611b3
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1EmployeesEmployeeIdRehireResponse.java:
id: a4d9a3c24887
last_write_checksum: sha1:b1f468a6e5fb0e4003504242a91f967897cad644
@@ -15259,8 +15924,8 @@ trackedFiles:
pristine_git_object: df115bbfa2aa4a9fe0af634b79e58d1557445f20
src/main/java/com/gusto/embedded_api/models/operations/async/PostV1PayrollsPayrollIdCalculateAccruingTimeOffHoursResponse.java:
id: 2244efe7c662
- last_write_checksum: sha1:aaa6db3877741005636d75a37d9b4310108f1793
- pristine_git_object: 896048e9fd2da4ee4d9d7280c8c6a39ddff903e2
+ last_write_checksum: sha1:e502981483adf8d3020c4859b956ad1f6b7d6a52
+ pristine_git_object: 4357819a6e89f595259ff6f8ba1cf45cfbab0374
? src/main/java/com/gusto/embedded_api/models/operations/async/PostV1PayrollsPayrollUuidGeneratedDocumentsPrintablePayrollChecksResponse.java
: id: 59cc0d7bb34a
last_write_checksum: sha1:08fa628e378bf4d6bf32b095bc1b5c5405f3445d
@@ -15291,8 +15956,8 @@ trackedFiles:
pristine_git_object: 1010265138ffac4646dac3ea65d2295e0972c8ca
src/main/java/com/gusto/embedded_api/models/operations/async/PutApiV1CompaniesCompanyIdPayrollsPayrollIdCancelResponse.java:
id: 60337d6bd66e
- last_write_checksum: sha1:7e306fae152769e6b159303df0a23ecd591c9143
- pristine_git_object: a397744e88a637e86b90d4c6c553c3418663b547
+ last_write_checksum: sha1:529e854d0734934509f568d6cb6f257105997427
+ pristine_git_object: ade625711f38960b0db695a305662875f8d75094
src/main/java/com/gusto/embedded_api/models/operations/async/PutDepartmentsResponse.java:
id: c7c047299c4a
last_write_checksum: sha1:b029616b30f7985dbd6b72e08fe0ea600b7f2ba6
@@ -15303,8 +15968,8 @@ trackedFiles:
pristine_git_object: b291d76afccd6cb7a70b55c45095755ea76a198c
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompaniesCompanyIdBankAccountsVerifyResponse.java:
id: 127bc597332b
- last_write_checksum: sha1:6873cbeda54d6cd7d757f9f3ba088ed3640b3fe6
- pristine_git_object: a408a3c50682d4bc29006da0d5f83083290d45e7
+ last_write_checksum: sha1:d1f4faf4497d21135431ceb6c4968cfd17f66bde
+ pristine_git_object: bcfda895e46066d808a1e4c99c38cb90d4cd3e8b
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompaniesCompanyIdEarningTypesEarningTypeUuidResponse.java:
id: 5226867309c6
last_write_checksum: sha1:f612396c47f4aeb93467d936d8f3838db73efb41
@@ -15315,16 +15980,24 @@ trackedFiles:
pristine_git_object: 5d11b34bd1593f76c11ef9298e9d35eedae1016f
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdResponse.java:
id: f03843e422ef
- last_write_checksum: sha1:879c129f338e408e3a264e04d0941a55f8d9a996
- pristine_git_object: dc554718b109c92ef2d3cdeed8fef69265110e41
+ last_write_checksum: sha1:099cf70717e268f8e662abf0efc77eee47937fc1
+ pristine_git_object: 7fae4e8f9caa0f74d70e3b5fb7a50c870f08f818
+ src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompaniesCompanyIdPayrollsPayrollIdCalculateResponse.java:
+ id: d9a0530bc02f
+ last_write_checksum: sha1:1f0e266220cdbeba5075a4ac6fd386d0aac96830
+ pristine_git_object: 1b7fa730975b755c9f6f18c01042b31919e25c40
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareResponse.java:
id: be5a626aaa55
- last_write_checksum: sha1:1b8e544048ac442f1765d194b165fe7c87e625bc
- pristine_git_object: c6d03ddd834925b64f583fe14463836c4db6fc1b
+ last_write_checksum: sha1:9cb88a7d5449e17cf3d1f534f33bea699614b95a
+ pristine_git_object: da682079051188fc37312ebb0ddb49f968c4387e
+ src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompaniesCompanyIdPayrollsPayrollIdSubmitResponse.java:
+ id: ebc0c1e87fac
+ last_write_checksum: sha1:8418e602898aeab98b25cf6dd814c970f998f625
+ pristine_git_object: 0adf44e96f52e42e441c8839efb7f6447eeb9a44
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompaniesCompanyIdPayrollsResponse.java:
id: effab1d9ec83
- last_write_checksum: sha1:e85bc0dcf0128fdc1a5ecfb3c69fd60849fb0a32
- pristine_git_object: bfe780258d838acddf240d08f7189418fd473d26
+ last_write_checksum: sha1:ce8beecb943d59038a7014bf82451bf74a694b4a
+ pristine_git_object: 92e45f53a9cfaa7ba39238c306c2756f44a541b9
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompaniesCompanyUuidHolidayPayPolicyAddResponse.java:
id: c7b02fe71b38
last_write_checksum: sha1:f71fe00ea93e15e326032bb86f9d07b6c4aac019
@@ -15339,16 +16012,16 @@ trackedFiles:
pristine_git_object: 7dccfec32b54479b5f4207b28a5010701236c975
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuidResponse.java:
id: d1e226c53d0b
- last_write_checksum: sha1:2addd70abc19156f29987a6ece67ca835cca84e2
- pristine_git_object: 85cb38e99dbf1821756620fa397c4946d16499cf
+ last_write_checksum: sha1:57b23af74b6690d2fa3670e8015dd77a3a4787bf
+ pristine_git_object: 2176bb8b2fa829cae17901be14141882584b430e
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompaniesCompanyUuidTaxRequirementsStateResponse.java:
id: a2b7630b14ec
last_write_checksum: sha1:1009f467a97da6a9fed7b27e32c362c93a6f0110
pristine_git_object: 06eb6a2b14a4d9422e4fe4a80df9c28e8956e6d5
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompaniesResponse.java:
id: 9d2c5a88d094
- last_write_checksum: sha1:6e7bdfc1f41c2befdbd6e8f6c478aa01f472ab6d
- pristine_git_object: a4b39e0ffaedf50947e5e8abe3b07a27b3e74a31
+ last_write_checksum: sha1:6a5283a3e919ec02d1391e316d0e5519308ac34c
+ pristine_git_object: c1ce2b30f4ff84bd57b045668038ca9aa8ad6ec0
? src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompanyBenefitsCompanyBenefitIdContributionExclusionsResponse.java
: id: e3c63669e455
last_write_checksum: sha1:f8566bf204a377a228acc5ad4f497249d4ed5e72
@@ -15367,16 +16040,16 @@ trackedFiles:
pristine_git_object: e3a85208055b2381729324d74ce188c65dea0d7c
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompanyIndustryResponse.java:
id: 3c3d5ff7e799
- last_write_checksum: sha1:d62e118b0dc51fa7491aa2a93b9e917c45e890c8
- pristine_git_object: 0a628baa650d6baa372dad7540452384082cc9e0
+ last_write_checksum: sha1:cf913b756e7930a2fc1498fa22a416550705b1b0
+ pristine_git_object: 98c980776f63ef12c062250fa7564dcc96fbb3fa
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompanyPaymentConfigsResponse.java:
id: 198f7c6aff08
- last_write_checksum: sha1:71c22642d46d500dc929434ffa53ba1917bb1900
- pristine_git_object: c4244dd6ab1d4042f82e93f99b0ff4ed2d55b061
+ last_write_checksum: sha1:7c671f08a24cde3360e69586e48c6cc4d9fe11cb
+ pristine_git_object: 921c81714c8bac69f8a256a294f22689624d9f86
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1CompensationsCompensationIdResponse.java:
id: d1f9942564c2
- last_write_checksum: sha1:174dd5bcf0bfc6fa4a6731be5a1f0641525f3ab6
- pristine_git_object: a090a14f26911832852d34d6e670a7c5ba82eed3
+ last_write_checksum: sha1:bf908c77cfd1a62ee3b24107c9a3081378fd2121
+ pristine_git_object: a506edd358dc05457594edf33aff07e36f5707a7
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1ContractorDocumentSignResponse.java:
id: e84b84cc2769
last_write_checksum: sha1:edb1dfbe3e85ed7dfc7e26d7c62e9789121a7d50
@@ -15399,8 +16072,8 @@ trackedFiles:
pristine_git_object: e2528eca503d2f30ae921d07eae0aba43d31a45d
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1ContractorsContractorUuidResponse.java:
id: 272e84801262
- last_write_checksum: sha1:03e77fb39db4d43d911f3218ea7174fd89be69d7
- pristine_git_object: 3b9f1d4f08a45e47d3e14ebe415ac82e5dd1209d
+ last_write_checksum: sha1:4309c2ba4f8b17b8bbeb12860a39609e6ad07d9d
+ pristine_git_object: c8bc6cda9f99c125948abd16425356bf384a3e17
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1EmployeeBenefitsEmployeeBenefitIdResponse.java:
id: b86c3dd336ea
last_write_checksum: sha1:12cd997e6f6ff16b74c084a07e2dbb5997d551ea
@@ -15415,32 +16088,32 @@ trackedFiles:
pristine_git_object: 90c4c4eb833abd5af6c6d781716cadc6c216b370
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1EmployeesEmployeeIdFederalTaxesResponse.java:
id: 39c8c8094de3
- last_write_checksum: sha1:224211f89b8c1fde296011cefbff8a06aead9e4c
- pristine_git_object: d843c0b2bb72e8480fbb1860cbd1d9c63eff07b9
+ last_write_checksum: sha1:434d38ce6a240af5e72541db30ba9a7539c7922b
+ pristine_git_object: 0b36e6855a410285081f22b193addfe079fa6a11
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1EmployeesEmployeeIdI9AuthorizationDocumentsResponse.java:
id: dfe2c4b51f02
- last_write_checksum: sha1:eb50d1a032068393063191ef1812a6b01a605fac
- pristine_git_object: 0261fab257eed799b42908d65f054c840ef8f7ab
+ last_write_checksum: sha1:7fd1b2f98510e288178cd27f31d1ec325e34ed56
+ pristine_git_object: 377384230e547533bd2a6dbc3d2742fc03739842
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1EmployeesEmployeeIdI9AuthorizationEmployerSignResponse.java:
id: 563c5cb838aa
- last_write_checksum: sha1:6e2bfafea89a777deeefcf0c4f604b190ad86cf6
- pristine_git_object: 5e658702e93896fdc800dc0c2d520f58f6bd4a3a
+ last_write_checksum: sha1:c42045cda677e4aea320299f299e09d048e7f125
+ pristine_git_object: b6ef6368e3273a8d5507275e153795752628fef3
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1EmployeesEmployeeIdI9AuthorizationResponse.java:
id: 704cb2763d66
- last_write_checksum: sha1:fba6ec1fb761daa73c3ebc0279f33fd11d28c957
- pristine_git_object: 3570c53233293e8de92a7acb7b4a9656c7db165e
+ last_write_checksum: sha1:98e7389bc95e6264fa7d1cf4bd39c0eeb4e6758c
+ pristine_git_object: 41cf6083825ededb67402f18638ebb16304b5d8f
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1EmployeesEmployeeIdOnboardingDocumentsConfigResponse.java:
id: 7cb4e960ecec
- last_write_checksum: sha1:061a6140b38fe11d279298ebe44e005942bee989
- pristine_git_object: e0d453fa071eff8410c82ce1b51008bb0efb47e0
+ last_write_checksum: sha1:749f684d91ec7b4a39774fad6f0177ed99e3569d
+ pristine_git_object: 5482845b520742a753ecfea5926acdd8f085f379
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1EmployeesEmployeeIdOnboardingStatusResponse.java:
id: 1b7a4ef9f84c
last_write_checksum: sha1:bfb26b8497412276fbfa9a990ed7431e689876ef
pristine_git_object: 0eed02fc951989a7bf07fa3ab21c0f3ec1942416
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1EmployeesEmployeeIdPaymentMethodResponse.java:
id: 3e077edeb39a
- last_write_checksum: sha1:7201db7958492564aaed259f09540c6b392655c5
- pristine_git_object: 366c995d5f8af109f1b785ae03b2480ddd052452
+ last_write_checksum: sha1:2ce002f6e5ed2d01dff04e4ba44b3683fd06c382
+ pristine_git_object: 6c60425ec183ed0fb22ee095169aa0102d63ca35
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1EmployeesEmployeeIdRehireResponse.java:
id: 84f3f14aa5d0
last_write_checksum: sha1:6bd742923d2beb97245a7b9a94c0407df177ce54
@@ -15477,14 +16150,10 @@ trackedFiles:
id: a60801d874c8
last_write_checksum: sha1:9cb6026c7134fe2aa77853c34a3121bfb266bd92
pristine_git_object: e3e9581d05bdde4822432fc64dde069e9e5dd322
- src/main/java/com/gusto/embedded_api/models/operations/async/PutV1PartnerManagedCompaniesCompanyUuidMigrateResponse.java:
- id: a4485bd0b46a
- last_write_checksum: sha1:04b9f600e39e96ef76e1a3446d7193f4539fd5b9
- pristine_git_object: 3bcdbe7a605e00f5e645eb19eac6d2f4ecb67133
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1RecurringReimbursementsResponse.java:
id: aef1d0312078
- last_write_checksum: sha1:5a9f6554c6910748fe7e34c0fd2d58be9bebaaa3
- pristine_git_object: 001d78eef5a3ff06d5349b56b973bc105aebe554
+ last_write_checksum: sha1:950f87f2b71a66c84c54710aec8a0121c7a070b4
+ pristine_git_object: e2e996819425b8f396fca65feaee464cc94a2dbb
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1SalaryEstimatesIdResponse.java:
id: a595785a3536
last_write_checksum: sha1:10506105364ae3377f43d67adc488440475315a1
@@ -15495,8 +16164,8 @@ trackedFiles:
pristine_git_object: 0e36848ecd111cae35f2282c41988c59a254a1ee
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1TaxLiabilitiesResponse.java:
id: e13d1bfdd064
- last_write_checksum: sha1:106e86f0ae8ef619b0d3fc1ee980c0d7d8ddb063
- pristine_git_object: bd5e3a96e940e5cbf2400c7d8747a1629473e331
+ last_write_checksum: sha1:8998037f1a006df866da7027874445d976de4e19
+ pristine_git_object: 43a07e290a4012edf15e869f49ab7882905ac612
src/main/java/com/gusto/embedded_api/models/operations/async/PutV1TerminationsEmployeeIdResponse.java:
id: 628169b92ea9
last_write_checksum: sha1:5d6d7e82c67969289b0ef3da5cf3e1411a6c27c6
@@ -15551,92 +16220,92 @@ trackedFiles:
pristine_git_object: aa6c700621d91b0e560cd4001f8ed645db48f1d5
src/main/java/com/gusto/embedded_api/operations/DeleteV1CompaniesCompanyIdBankAccountsBankAccountId.java:
id: 14ffc5531700
- last_write_checksum: sha1:5db3513101311e62b5c49644e10e920491aac3c0
- pristine_git_object: 9d6aec42fd1b207406af964b5a151c7e2359b17c
+ last_write_checksum: sha1:bb2bf9b877f1d84f09e92c14af8382da5a797b4c
+ pristine_git_object: fc2aefe7ec0e5f3b73529b315b4e260355074e07
src/main/java/com/gusto/embedded_api/operations/DeleteV1CompaniesCompanyIdContractorPaymentContractorPayment.java:
id: 55844ade6d3b
- last_write_checksum: sha1:34913bf12ddcbf9749ad59e1cc5118b39d8beb2a
- pristine_git_object: 6d3638eddc1a0f05713a9a48f57bb523cd1c7e56
+ last_write_checksum: sha1:783f20e97524f6a50288c50cfe398acde0743e2f
+ pristine_git_object: d7f64df622ae5db1bcf9caf6e0996bb3c0fc4192
src/main/java/com/gusto/embedded_api/operations/DeleteV1CompaniesCompanyIdEarningTypesEarningTypeUuid.java:
id: a7e7c2b41f24
last_write_checksum: sha1:38dcbc97ee7b7a052ebc54c3bdbd4be637c0bd80
pristine_git_object: 8dd927fda2678b2e1faff432b2e75a8b034d40d2
src/main/java/com/gusto/embedded_api/operations/DeleteV1CompaniesCompanyIdPayrolls.java:
id: 7f417b76f7dd
- last_write_checksum: sha1:6be9225906050be123091fd82d452d5f02d45012
- pristine_git_object: 9b196fa110c5e6230159e36f8094e33c8366e0a1
+ last_write_checksum: sha1:55c9831d6e0af2e0e3e9157f0b03d613094afb13
+ pristine_git_object: 3dc45f40a84010e0f0bd1329c789193c37318dc0
src/main/java/com/gusto/embedded_api/operations/DeleteV1CompaniesCompanyUuidHolidayPayPolicy.java:
id: cc881583ab32
- last_write_checksum: sha1:aedf2cedddc93d6d78ef17e5c3cc491644ca94c9
- pristine_git_object: 5e02574da824de8c0111e63eb5a55d7fda67779a
+ last_write_checksum: sha1:0a7f5cc25baf5b5f70c1b48c4b04e6c14dabc4eb
+ pristine_git_object: 106d568ee541eca2806282ffb8196e3548bef63f
src/main/java/com/gusto/embedded_api/operations/DeleteV1CompaniesCompanyUuidSignatoriesSignatoryUuid.java:
id: e19f0894f67e
- last_write_checksum: sha1:99a502eae8fee5e36a9c8736e02f7cb10e4e1108
- pristine_git_object: b269a25520425c5bfb50a207c5d7780c9c5d7f6c
+ last_write_checksum: sha1:a9778d8d67af2362e36ab4ddd9a6ecb7783264ad
+ pristine_git_object: fbc175e73b3d910d94f5232f0685c99846783ce0
src/main/java/com/gusto/embedded_api/operations/DeleteV1CompanyBenefitsCompanyBenefitId.java:
id: 594123007c6e
- last_write_checksum: sha1:edae09fe7d2a43aa698838739bed804bab2f5dc3
- pristine_git_object: 320198ceff533547fb1c2ea6420864fe346e5d37
+ last_write_checksum: sha1:b745ea02b5c829788f4cc7ca164a9ecfdc04de01
+ pristine_git_object: de10db72e1f22a80b15394f497909ab69f91b5e0
src/main/java/com/gusto/embedded_api/operations/DeleteV1CompensationsCompensationId.java:
id: 0b29c6f23ab5
- last_write_checksum: sha1:08fcd787282d20ac8b2b85b919b5ebb4379fb871
- pristine_git_object: 47d0ba91e5b5107c5e556bf270b9d2f72ac9ac5d
+ last_write_checksum: sha1:ca7b1a6fa4987abf0a806ebf9175d375b1c6e33b
+ pristine_git_object: 7e574d3bf4bf90c44742393244d11a69f790769a
src/main/java/com/gusto/embedded_api/operations/DeleteV1ContractorPaymentGroupsContractorPaymentGroupId.java:
id: 3164f162eb0e
- last_write_checksum: sha1:80f5666c00d2e55c50c28c11f9e29bc5c7b039c1
- pristine_git_object: 5f24664b6939a659924bec329bd36028f72f9463
+ last_write_checksum: sha1:a301f349df57682048e52762f9bc094378267958
+ pristine_git_object: 124494b842f2befe1ffef7e3c9f14adaf99f58d8
src/main/java/com/gusto/embedded_api/operations/DeleteV1ContractorsContractorUuid.java:
id: 5f9a71848f5f
- last_write_checksum: sha1:887a53f046a5bae63c64f7b27a7b7c4aee863807
- pristine_git_object: f6da90b089c30d5a06697c76e31a4457420b61b5
+ last_write_checksum: sha1:a81d19e009d4c9b51a6f3f371f54f6f114ba67b6
+ pristine_git_object: a4de06c1f75ddd3b4d326b974843cef9c7fae73b
src/main/java/com/gusto/embedded_api/operations/DeleteV1Employee.java:
id: 661a70fa860d
- last_write_checksum: sha1:33fd39b1163cda9a4fd4e3f85319ab85ab6d5bae
- pristine_git_object: 1369e6b6fb9f193fcd5b651f14b36e703b5d6253
+ last_write_checksum: sha1:e61221742e8e46706064025c4715dd57a0d39871
+ pristine_git_object: 08fa56357a3aaac764f2068a2c7b04e3aaecf804
src/main/java/com/gusto/embedded_api/operations/DeleteV1EmployeeBenefitsEmployeeBenefitId.java:
id: 253f5f39d8c6
- last_write_checksum: sha1:5abaa9cb6edc675d2d0b55d87e6b8d9fd72b2618
- pristine_git_object: eed547013461ea8183d907759ad315c9d5feeaaf
+ last_write_checksum: sha1:cc48398a25c42060f688ae36d7e7500adc7d7d1a
+ pristine_git_object: c01788ee2bb2ba3fa67f03a5d6a5f37d1fe2204e
src/main/java/com/gusto/embedded_api/operations/DeleteV1EmployeesEmployeeIdBankAccountsBankAccountId.java:
id: b2f96bf796a2
- last_write_checksum: sha1:168b387d4752b451c29068b8a36743581aad3640
- pristine_git_object: 56b43b6a8413341b846359c1b8795d7ff7171097
+ last_write_checksum: sha1:74463adc1b45f9a29b2b2edb53b288b5d7069f78
+ pristine_git_object: f43c49cc047e8900378c6427c9fcd3c8a675e611
src/main/java/com/gusto/embedded_api/operations/DeleteV1EmployeesEmployeeIdI9AuthorizationDocumentsDocumentId.java:
id: ea19f415c3e6
- last_write_checksum: sha1:831640e516217dff48bbc06ecd356c498576f522
- pristine_git_object: aa909e614811dd55f0f7b99ad862d6c32654144f
+ last_write_checksum: sha1:61468eb41586ee603f2ad61a0827e7e138034d33
+ pristine_git_object: 3aba3c9e205e3043e7a6dd0da8b5725504467f74
src/main/java/com/gusto/embedded_api/operations/DeleteV1EmployeesEmployeeIdRehire.java:
id: 7fe054a0a867
- last_write_checksum: sha1:0dda690b4b4063853aee6ed3ae79ae857f0dd363
- pristine_git_object: 24f69e06ab6063fc84e8ee9137aa6895ea5db96a
+ last_write_checksum: sha1:bc89bb658a54c8b8df15fd3299200aef6f8d3f1d
+ pristine_git_object: dfd8f830765d909a3cbca2540213ad0ab1a94417
src/main/java/com/gusto/embedded_api/operations/DeleteV1EmployeesEmployeeIdTerminations.java:
id: 7fa0fad5901a
- last_write_checksum: sha1:52590ad9a9671158a8d5b76448e3d57525126edb
- pristine_git_object: c0bf191e52c304306274fc0ae7ce9917553510e1
+ last_write_checksum: sha1:152c9cd47146ced63b2e182b7bafea4a57504f45
+ pristine_git_object: 7d3b5ef42cd5685ff9631db20b4c46b525ecec53
src/main/java/com/gusto/embedded_api/operations/DeleteV1ExternalPayroll.java:
id: 508360cbe8a1
- last_write_checksum: sha1:f9f23e9e760b17f50747001b6b89dbc47a51b511
- pristine_git_object: 36fe8d3c26f2007f83102823b10c211537c1c8de
+ last_write_checksum: sha1:1f81d8a90040f6d872e1eeaae83fb94d16c14d2d
+ pristine_git_object: 441460f41b7b2665f84afb2b8ff93d32270fd3b4
src/main/java/com/gusto/embedded_api/operations/DeleteV1HomeAddressesHomeAddressUuid.java:
id: a9d9e091324e
- last_write_checksum: sha1:1c9c9bc4d27b598047c86ff9569ddf4f023a2714
- pristine_git_object: 23d862adcd002cf5ac87bf0c8f02710a6135676b
+ last_write_checksum: sha1:3afd0ccdbdfce2c0224a5212c9509d655eb75beb
+ pristine_git_object: 8a97859fbe53d43cdc5589a20e22ec006d836ec5
src/main/java/com/gusto/embedded_api/operations/DeleteV1JobsJobId.java:
id: 82e041c65fb5
- last_write_checksum: sha1:444a7669d24d7ee1a4f7086ceaaa885c138e7fed
- pristine_git_object: 98c95278d377e480d5ff08b9d786ebe00439f156
+ last_write_checksum: sha1:15c1bf855bd5b00d4bb97a2ed9059eb7f18b5ff8
+ pristine_git_object: 1e9a633c24fb230e8e9dbc09d68fbd65d7850c98
src/main/java/com/gusto/embedded_api/operations/DeleteV1RecurringReimbursements.java:
id: 19345eb7e7c8
- last_write_checksum: sha1:d3b403d3cd0fb1d3eab6190dcdcf70863d7c9383
- pristine_git_object: d250e9e4ce48e628d5ee2355779b86b2ad08359e
+ last_write_checksum: sha1:89e44ae4add1bd154af49d623dd7bc434cd6b65a
+ pristine_git_object: 57fc54b8ab6f32bfc28681cadc0ef49efefa327a
src/main/java/com/gusto/embedded_api/operations/DeleteV1WebhookSubscriptionUuid.java:
id: 7cc27abf847c
last_write_checksum: sha1:daa88a83e67b390c4d5b72b4799f1a760a3f1c95
pristine_git_object: ec0d999ddbecc9d3bb6f3240194764d5b218f3e5
src/main/java/com/gusto/embedded_api/operations/DeleteV1WorkAddressesWorkAddressUuid.java:
id: 9e9513850fdf
- last_write_checksum: sha1:2e27db1bc407f4eaa11e31b2cda85bf6b1085a21
- pristine_git_object: 32d433a01e5b711519558f74fd5238276becb1cd
+ last_write_checksum: sha1:dfe08a45ef56c3039ac988fb0cd8d8dc90a4374f
+ pristine_git_object: 21590b4f475f8e48a7460808bc7f1e0d43bffb27
src/main/java/com/gusto/embedded_api/operations/GetAchTransactions.java:
id: a156afd49c51
last_write_checksum: sha1:abcf8a78cc33f1d5a7e1493412378ba45a828c06
@@ -15655,8 +16324,8 @@ trackedFiles:
pristine_git_object: 593e024486010edda162b7b2f2da88af28f7de23
src/main/java/com/gusto/embedded_api/operations/GetCompaniesCompanyUuidSuspensions.java:
id: f2e95e527083
- last_write_checksum: sha1:46b1a4fd88ca4dac7505da0c90446bbdb8491c3e
- pristine_git_object: bbe3afbe3002a5eced1fdd7e67f252455d1e39c8
+ last_write_checksum: sha1:0b6e2bb32382661209c020302ffa117aca5e4237
+ pristine_git_object: 4f0c379f783e576a91af8e67af7a7527841dab6a
src/main/java/com/gusto/embedded_api/operations/GetCompaniesCompanyUuidWireInRequestUuid.java:
id: cb0707aa4d2b
last_write_checksum: sha1:c35847f7d2f18e56fe574c86f5c75ec59ab34c94
@@ -15679,8 +16348,8 @@ trackedFiles:
pristine_git_object: 3cfbde5a65e90bc92aca88509170ab911a0d8895
src/main/java/com/gusto/embedded_api/operations/GetEvents.java:
id: cc6e672b08fd
- last_write_checksum: sha1:c67c28f109dbd15a7db4ca989aa190b899abfdfa
- pristine_git_object: 26afbd99ec5444f07ee726ca50ce63c6c7851efa
+ last_write_checksum: sha1:94cdbcc31145e489af4c8f773e1820a6d501fc8f
+ pristine_git_object: 718722b4f47d2ea91b952a1314537b3e924d5942
src/main/java/com/gusto/embedded_api/operations/GetInformationRequests.java:
id: 68dc4cf7d5df
last_write_checksum: sha1:5b691f7a76f7854ac0807e0c23cd35ebcf3598e7
@@ -15719,8 +16388,8 @@ trackedFiles:
pristine_git_object: f273fa0184921c32302090d4b9c1185f634e946c
src/main/java/com/gusto/embedded_api/operations/GetV1Companies.java:
id: 7b5cf54bede3
- last_write_checksum: sha1:800bad9b8828e8d0e3a5a80a5ea2f99ee40096e5
- pristine_git_object: 6adbcfe54db9959f2b578b87193492d618fa5cf2
+ last_write_checksum: sha1:e81fb342f2558bff3e563cb028a4093d150b5df4
+ pristine_git_object: 11b8bd07816a8668d020cf90d4a91db92cc0228f
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesAttachment.java:
id: 22ba1eccf52c
last_write_checksum: sha1:ff7cda0fa5254808e3e6b64d5335699be45f69fb
@@ -15739,28 +16408,28 @@ trackedFiles:
pristine_git_object: ff2e07ae1345c8f6c76ca4d29e5a845334541134
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdBankAccounts.java:
id: ce16a8daffd9
- last_write_checksum: sha1:f532f598a9bc405d9061d722a37c48b939790113
- pristine_git_object: f29d4ed98d3ff4ed51721990413a89d76b378d79
+ last_write_checksum: sha1:a1e33fd5a4defccba7e6c9dd56130fa7bad3912c
+ pristine_git_object: fbb5002c6e13bd451a0eef159d109d7683469e1e
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdCompanyBenefits.java:
id: 498491e60b60
last_write_checksum: sha1:fd01d603450346af86231cc42ddaab2b1af0d20b
pristine_git_object: f66342fef987791546b3064c5d7e213776262f0e
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdContractorPaymentContractorPayment.java:
id: 3235b00241f1
- last_write_checksum: sha1:a76e82602a6afe66b530ed21e45abfc1f605cddd
- pristine_git_object: 6f2abd58a406ab9ba61df3b5bc8f3ea6a55a1bf2
+ last_write_checksum: sha1:d07ed16b5b4e95370b98847a5237343530bc9059
+ pristine_git_object: 3f64a79914a39ca44eeaa3a17a035cc800fdfe78
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdContractorPaymentGroups.java:
id: 359fb868460d
- last_write_checksum: sha1:0bc7698c0bf4066ca8565da37a1c23dfd6363738
- pristine_git_object: f20261814a21d507fb64f94d5c3581a6b9f62fec
+ last_write_checksum: sha1:cab5a23b1911c2544987d555b813dbb8441fb461
+ pristine_git_object: 786ebde088a2d35c584c73ddf97fea13a81bb741
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdContractorPayments.java:
id: b23205ffbec7
- last_write_checksum: sha1:4f0ece192302ac9fc91829eba8dead59478dd07c
- pristine_git_object: f0eb34c81aa9bc7b3e2505555ce65abb70550e3e
+ last_write_checksum: sha1:3b62e4d0bd7edb3b591010a83a00396a2406afe4
+ pristine_git_object: e93731d24baa052f3773511ef5ee4708fcf967bd
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdContractorsPaymentDetails.java:
id: dcb5774a45c9
- last_write_checksum: sha1:234eb015069d64370079b965a8b06d2f4f9ffcdb
- pristine_git_object: 7bb86d18f1c3a1059c5859e53cf74ddb217e630e
+ last_write_checksum: sha1:8242912b687e44015113add9be335eff126cc52d
+ pristine_git_object: 6c7d0eab5e87da5ac53dc3c9038e27183015c540
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdCustomFields.java:
id: 0e92625b3ade
last_write_checksum: sha1:a4f33d565e80c34f2b8904823c48b4f8ce358fbe
@@ -15771,8 +16440,8 @@ trackedFiles:
pristine_git_object: 5a4d7bf8dc2aeeda7e7a7754567ff212fe6918b4
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdEmployees.java:
id: 1a1b636c031d
- last_write_checksum: sha1:ba195f6e70e3d750c3ad70399b80baa704c7ea3e
- pristine_git_object: d1651c8bfba59a45141cbf227539f0c000306c82
+ last_write_checksum: sha1:e5f172e4062f361eabe7555ae3959bf84901fa46
+ pristine_git_object: df98d9b71dfa1a1ed8dc88866bf0390a800038b2
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdEmployeesPaymentDetails.java:
id: a016c5805141
last_write_checksum: sha1:768882d15f138ab47b55eeb164857ff3f27baacb
@@ -15783,60 +16452,60 @@ trackedFiles:
pristine_git_object: 80aa7f339693f5b3cf5945d8598e55e7824d7e08
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdLocations.java:
id: 7477f27d5b4a
- last_write_checksum: sha1:a1a2dba4b35d737ddd2e38ae6bd751c909aa4a6f
- pristine_git_object: fee099b6efabd6469b39ac528f18d4c8d026bd83
+ last_write_checksum: sha1:2526ca094220a75c7c2fb276ce8dfedb3df1ce27
+ pristine_git_object: 9cc9c3787ef36f5c905fa1ca0f4ec1f97f871d0b
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdPayPeriods.java:
id: bc4b13104716
- last_write_checksum: sha1:4206983109e453bb2ec3de06710e8dc64f37687f
- pristine_git_object: 88afa15192ca0ec2fe7f36009249fade1de84696
+ last_write_checksum: sha1:2f7ccd4403ffde220f1a753d11f0bbc3825721e4
+ pristine_git_object: 2ee4a99d95c3ba1759e010ddbf841116477fd2d6
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdPaySchedules.java:
id: 5ccb32a6a4b5
- last_write_checksum: sha1:d2570bff04d7114ee22be731455f9bf084f875db
- pristine_git_object: 03fa279ced703e7829c2d91768736f243c467f77
+ last_write_checksum: sha1:67950931ceb2695e26a5d2ee779b27c88afdfa84
+ pristine_git_object: 89dbe9c93cede4f3a6d0b1120761d5f657129bcf
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdPaySchedulesAssignments.java:
id: 9a3108e0a9db
last_write_checksum: sha1:59a5ef965ce6b74f8245cb3e4d36a24836d90463
pristine_git_object: 4f54a8d2c17910d3a73fd49b119a58b58c79c572
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdPaySchedulesPayScheduleId.java:
id: 25d0c929f1de
- last_write_checksum: sha1:02e6efbeadb4a446f6aaaeca9c63e9707e3f52e5
- pristine_git_object: b2fe31efeb01bebe7f29c87f8d30dafe2fd3155c
+ last_write_checksum: sha1:3d19c05babd107b09c1721c52efc15f4e65a5dbc
+ pristine_git_object: e9cbe035776b582e2f4f2870e780bf240f70f834
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdPaySchedulesPreview.java:
id: 60c48b5c1e9b
- last_write_checksum: sha1:c6155f0d44b9a6b26a6dc6dd63ea11ecb230deba
- pristine_git_object: 0079b0657dca2dba7a4ed7a842b40e2c890e22d1
+ last_write_checksum: sha1:4cf576672124af945fc198bb96dd557d1c905c3a
+ pristine_git_object: bd3d2032c765d0ad931d2430c09981172aa27f5c
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdPayrollReversals.java:
id: b4e55e8ceaae
last_write_checksum: sha1:4cacca53792008a67068d3b1bc33b1214da27bf3
pristine_git_object: 98d7462b1d1fc6337ba8c3044240f99561e2d874
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdPayrolls.java:
id: 784a99b182f3
- last_write_checksum: sha1:7792a6e5be41c7095dd0b737d16e6350d8e64297
- pristine_git_object: 7864bd6762d781253db65aa49a5c71c523ed551c
+ last_write_checksum: sha1:a062f24c6f7c4d0df3a29ef41afdcd1f38af97bf
+ pristine_git_object: 6c1c7db9252d4a7db350d71519c0a8e38a0bf6b5
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdPayrollsIdPartnerDisbursements.java:
id: dbfdd9a311df
- last_write_checksum: sha1:11d1409f02b28ffda92a893c820bda029dd2f928
- pristine_git_object: ffc0b8a3cd54166c8c110f253d62397ad4df12f1
+ last_write_checksum: sha1:03f17fa0920600de849175f21ebc17ad0d88f805
+ pristine_git_object: e3c9234943f2215ff7cfe48bf70f7010f6c433d2
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdPayrollsPayrollId.java:
id: 37b8aec5303f
- last_write_checksum: sha1:61833f37a0e533fcf80fdee8341bafcfd68d2fa4
- pristine_git_object: 8f40cc32cab39923fb5747cfdfe4109196acbe2a
+ last_write_checksum: sha1:7aeec4d146d23ed0be067a53e492b7311f27f977
+ pristine_git_object: 8da8f9ed1efbcece84c912ef492b7e7111510b48
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyIdUnprocessedTerminationPayPeriods.java:
id: fb48cb5961b0
last_write_checksum: sha1:d5e34012b85f96959ac9168f33ec0ef2b1928943
pristine_git_object: 7ea135eafd6b52797c66323366846ce0e09ae122
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyUuidContractors.java:
id: d3cc4c5c821e
- last_write_checksum: sha1:05507a63d3e4893a0182f75ddb0292a2657f6037
- pristine_git_object: f7144147dbdb8d9803a618a8259f7033638e99aa
+ last_write_checksum: sha1:4ddd8bdce192046bde64fe56b25a6ee3ecbe9760
+ pristine_git_object: 27a8768f1006290b4f0830bc489df0741fc7dca5
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyUuidHolidayPayPolicy.java:
id: 4e3cb9ebe829
- last_write_checksum: sha1:81c4a34c8bef7294a676752d640bc45be22815f6
- pristine_git_object: 08ebff5a8eda3279fed8ec7e9bb3e5609fdaab29
+ last_write_checksum: sha1:61a818e245b540826d7af3bb8282b6ccacfcd3ac
+ pristine_git_object: 749447f0acea0c525a016046936917f3bf408052
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyUuidSignatories.java:
id: 6d0ea55facb3
- last_write_checksum: sha1:10b59dda03817aae9c86e3a11c4aa2c2f7a6532b
- pristine_git_object: c741c40db4ac77e31217ef9de26290dbae96dd67
+ last_write_checksum: sha1:e7a63fe03bedbc40997a47558d7271aad9b466fc
+ pristine_git_object: 1b47394e0651dc7306cda468f3591a36f5b5bd99
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyUuidTaxRequirements.java:
id: 91f253dbd6f4
last_write_checksum: sha1:011f51f34cbb3bcf3ec6608eaef0e72d228ae945
@@ -15847,12 +16516,12 @@ trackedFiles:
pristine_git_object: 8bb8bd03d41091a907bc22f293575c5ebf3d90fa
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesCompanyUuidTimeOffPolicies.java:
id: c662ef2f44c0
- last_write_checksum: sha1:128d6c42f09dfb6297a8046ec27359c6865c219a
- pristine_git_object: 8e48aaec62480933a749f44980e7128190b2eef1
+ last_write_checksum: sha1:46cbaf32436829a6cc9fb3697680dae306fe7403
+ pristine_git_object: 16f115ca15082b3161cbe2bb0cac872d76ba294a
src/main/java/com/gusto/embedded_api/operations/GetV1CompaniesPayrollBlockersCompanyUuid.java:
id: 72b7fc6cfb8c
- last_write_checksum: sha1:d0f87fc87ba7861ae0e4b9a087b776185f0f443b
- pristine_git_object: 62d0d47541e1df383bf129d34a96cbe390726239
+ last_write_checksum: sha1:04df7a7df52d99828a9eb98aa69c6c58e58ec904
+ pristine_git_object: bd0fcd0955c73052678e6d0687cd847a1dd18191
src/main/java/com/gusto/embedded_api/operations/GetV1CompanyBenefitsCompanyBenefitId.java:
id: 0944faac46ef
last_write_checksum: sha1:08533c63b5b2a48e3d0f1577884160b327c0e825
@@ -15871,8 +16540,8 @@ trackedFiles:
pristine_git_object: 926b989b777b7bf97c513ae1af71386575f43b9b
src/main/java/com/gusto/embedded_api/operations/GetV1CompanyFinishOnboarding.java:
id: 39833c15dc2b
- last_write_checksum: sha1:e06605882ff1d5664707398f5d933926b7d369c0
- pristine_git_object: 2669ae618f640e3b770a425201d6f25897a5ba6d
+ last_write_checksum: sha1:c11a1c256c244ad18a7a14fd91620f98f0073b46
+ pristine_git_object: 493b7be148803a3c7daaf6d02728114116adec84
src/main/java/com/gusto/embedded_api/operations/GetV1CompanyForm.java:
id: dfd0540eec6b
last_write_checksum: sha1:e56e7bc21ce0a5cd369bc9ba6fd4822c97aecf75
@@ -15887,20 +16556,20 @@ trackedFiles:
pristine_git_object: 7f583949bf6a495a3ad1d583d73b02173ecc873c
src/main/java/com/gusto/embedded_api/operations/GetV1CompanyIndustry.java:
id: 01d956d5e7e9
- last_write_checksum: sha1:f2fb187b857dc91013e81f1f30fa2d179316d6fc
- pristine_git_object: cc3918b3632cbed2dfab4b819d9935a32becc49b
+ last_write_checksum: sha1:99afcef3603a2221b92894961f8a4a224cc1b1ac
+ pristine_git_object: 09583ab97c67c430bab7ba355408bb2337635ef6
src/main/java/com/gusto/embedded_api/operations/GetV1CompanyOnboardingStatus.java:
id: 8564d1e421e0
- last_write_checksum: sha1:d45f6540b22419abd1865191be3a6eab988651b0
- pristine_git_object: 2ccd369f1f5cb3062680cf6f5f7cfb05c74bf74a
+ last_write_checksum: sha1:a4d40ef8403f96af068ef45acf0613542090c10d
+ pristine_git_object: 1def8eb7a885b4d0f7424d7cb10bc907fdea1533
src/main/java/com/gusto/embedded_api/operations/GetV1CompanyPaymentConfigs.java:
id: a6ce62763239
- last_write_checksum: sha1:2842430c012ea054363544fca4e577dc73d197f9
- pristine_git_object: 47e6fd23546f482167d4d8dabe312296a2caf9a5
+ last_write_checksum: sha1:7a6461842545c8e5da3f4ca18e5c658b2a667556
+ pristine_git_object: a59f0dd69d971ea512d4661d0078ba02bef6c560
src/main/java/com/gusto/embedded_api/operations/GetV1CompensationsCompensationId.java:
id: 46053f9fd1be
- last_write_checksum: sha1:c8c464220222210f1adff2048a5e17f649b5a814
- pristine_git_object: c739ea450f5946d2fb24163faf306818a6241d0f
+ last_write_checksum: sha1:65d80995072e3831d8b851ae00b53da21c6a8eb1
+ pristine_git_object: 1af4f51c29755068b2b58591623a35341f9090d6
src/main/java/com/gusto/embedded_api/operations/GetV1ContractorDocument.java:
id: a06bd95aa2bd
last_write_checksum: sha1:25de67e9a15f587f48a199abed2c2477bb2bb448
@@ -15931,8 +16600,8 @@ trackedFiles:
pristine_git_object: 71684c855d22690e640fcdc72f1a1f540c4167e5
src/main/java/com/gusto/embedded_api/operations/GetV1ContractorPaymentGroupsIdPartnerDisbursements.java:
id: a023fde9ea7c
- last_write_checksum: sha1:d7844897073b44db04569156f3adba6f89b2d11e
- pristine_git_object: d946f2b4acfcf0756725331828d83146a14d854f
+ last_write_checksum: sha1:4e517594ab2ae8393a849c964f2d3212108a44b0
+ pristine_git_object: 53ab1c23130632261cfa316f3f52493bc157055e
src/main/java/com/gusto/embedded_api/operations/GetV1ContractorPaymentsContractorPaymentUuidFund.java:
id: 670c3c211a6a
last_write_checksum: sha1:bef342ac188de905a362b743d25a2e02933f7c1b
@@ -15943,8 +16612,8 @@ trackedFiles:
pristine_git_object: 6e52f3b68ce27bf1497d7392919aeaf6c29b5182
src/main/java/com/gusto/embedded_api/operations/GetV1ContractorsContractorUuid.java:
id: f2e4daacdc33
- last_write_checksum: sha1:245f422de66ad2e8410894804533270cc7de7d7a
- pristine_git_object: 5ebf4923ba2bec49c35f786e9274d2a21c16e819
+ last_write_checksum: sha1:38be6fb53aa711dda0c310ed050b8bf167003893
+ pristine_git_object: 7121cd3b74d64950d2f5a9f52b630e1477645374
src/main/java/com/gusto/embedded_api/operations/GetV1ContractorsContractorUuidAddress.java:
id: aad9d5077ffc
last_write_checksum: sha1:964943f6fdd6a2935c2fa9df9d5e9d525dd8bd7c
@@ -15979,8 +16648,8 @@ trackedFiles:
pristine_git_object: 9925097b1c08164f7fe4ad5f1e6cee1a727684bf
src/main/java/com/gusto/embedded_api/operations/GetV1Employees.java:
id: f58d624bbfda
- last_write_checksum: sha1:0f58afcf6d1fb06c6325a5d8f3e85ce0ddbf3280
- pristine_git_object: 1d23b66b41016b15d0eaca3084bd99f1638a374a
+ last_write_checksum: sha1:0cf36c2e6116a5647ed697d6df4679472a1c7f30
+ pristine_git_object: 25bc4d7a61897b414d389454d1363acdc4796b90
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdBankAccounts.java:
id: b79a3609668b
last_write_checksum: sha1:b06d001a3cc8688ef2fd292e5f13c487fca83fbb
@@ -15995,84 +16664,84 @@ trackedFiles:
pristine_git_object: be32e6a4465cdeb5bb368a896d85fa06ea72deae
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdEmploymentHistory.java:
id: c28d134944fa
- last_write_checksum: sha1:dd3a4ec012ef93e13f8eb25f620771739d02a822
- pristine_git_object: 64c439d64a26870b8efd5997e55db18547b4efab
+ last_write_checksum: sha1:7831472da2e53ec398dcb1b3b014e8a95a4f3691
+ pristine_git_object: cf8af113851700aca24bce5803471e7dfd99d0ac
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdFederalTaxes.java:
id: daf763fca986
- last_write_checksum: sha1:6bb5680d7f22f1b64c046c7bc5393da2675bd91c
- pristine_git_object: 3bcf96a2a3e6fdcf3108de9313a5d5c535295a8b
+ last_write_checksum: sha1:a166696e066544c94779d8f5778bf64c716fce24
+ pristine_git_object: aebd5d5d07e1d97452edb98d25074c7c17c6f027
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdGarnishments.java:
id: 8aec551d3474
last_write_checksum: sha1:a7024b9c3b15557ee45590ba5fe254ef79cf8be4
pristine_git_object: f9fac11c4b1bc5f19b16cc387bb6aa3e5cacbe0f
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdHomeAddresses.java:
id: b2528d5959f3
- last_write_checksum: sha1:ff68966276d505f537dfd2969b23d2973672b5bf
- pristine_git_object: b469f1fb8c46b13041b89240cd1b04c4a35b7c0c
+ last_write_checksum: sha1:f3d0f2f867b45a2f315dcce3a6356c664427ba83
+ pristine_git_object: c9828a6d4d50210819fdabbfd9d7a6d19c0df4dc
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdI9Authorization.java:
id: 413f90465090
- last_write_checksum: sha1:8c5baee4d76715491b6e8442e56ee858b19d3a71
- pristine_git_object: 4033ca432d09289408f8d4e03bdd1b329651d7bd
+ last_write_checksum: sha1:2c4b1a28af563f9696b805c5038c09c9c8cb3b54
+ pristine_git_object: fc30795ebbbd21857e1c221c05abe88d9719b56a
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocumentOptions.java:
id: 62827ddef2ec
- last_write_checksum: sha1:6e7bab3716cf069476f6175cb44abbd2b953253f
- pristine_git_object: 38b02c4b62beb30c08bf1e8af1e0746e8f92ec4e
+ last_write_checksum: sha1:a059677471b984c749d3ab63f1c73aa8cabc4567
+ pristine_git_object: 4e61de70af056b74283e9f350eb968e12d3740cb
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdI9AuthorizationDocuments.java:
id: 08b1af36126e
- last_write_checksum: sha1:af16455a735eb21dd20aaed959b1b89c741664de
- pristine_git_object: 172155d11a35a0c9f8cece2535dec727403fc9b9
+ last_write_checksum: sha1:fa3b7bcfdf9e9595845b7954fb5db79e34f55286
+ pristine_git_object: e9fa8691efdfb83859a673f8dca0bb16048c5b96
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdJobs.java:
id: 81a3546d87f3
last_write_checksum: sha1:0ca335471605e84b4831ceddf42dc22bc09df576
pristine_git_object: d3b5e99cb154e73d7040b0509d603510a2cbd32c
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdOnboardingStatus.java:
id: 30913e449ad4
- last_write_checksum: sha1:0272345135e8804213f415775adbc1525ed7561a
- pristine_git_object: 2fb19d369e4dbfdc9acc00a3fc7ea90b395cd3f7
+ last_write_checksum: sha1:ad17f3ce789748549503714683792ddd5f795819
+ pristine_git_object: 8160cff124cd0a03f1576900d0600310c61fd74e
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdPaymentMethod.java:
id: a834b9343e83
- last_write_checksum: sha1:16c93e63d4ed43d6d7382bba30dfceb3bce560fb
- pristine_git_object: 3026f31714c2f2f70641827209bd635e88ee0b0a
+ last_write_checksum: sha1:3e900c9883cd4758f89451d9b179c47e1edb037c
+ pristine_git_object: a67d39ac659d3ef002009a831410383f425196a5
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdRecurringReimbursements.java:
id: 756eb1909bf5
- last_write_checksum: sha1:69ded49e70cf9ffcce153aaba8c6be49bfbf7dda
- pristine_git_object: a2893d8c55a3e4a4b634b77a4b286245d599210d
+ last_write_checksum: sha1:72f86bf048b02aac41832e7058d7901d94b0aa34
+ pristine_git_object: fc059cdf637135b9b28740ec534987846aa46247
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdRehire.java:
id: e60a27ab97a0
last_write_checksum: sha1:65daeba906d48b9294caaf91aa3d44bd8e0aad43
pristine_git_object: f6779d26e6a10cacc7df3a5a4ff30b4efdab121a
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdStateTaxes.java:
id: a31c95a45431
- last_write_checksum: sha1:cfabc6e3c504d9068883beaff6ea1b470425d708
- pristine_git_object: 9ada91f9575bacdfc15d2de6a4114554d541244e
+ last_write_checksum: sha1:6916170172650e0ea7570c217cd4dba82eff3d56
+ pristine_git_object: 5ccd3c21dc2a55c5574c528ab47e5b28dd8f5d41
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdTerminations.java:
id: 93976f267d51
last_write_checksum: sha1:cf6a18161110e1eaf6dc890173de046c4fd5e1f2
pristine_git_object: f84db3d05cdf2bb6b120fff543a81dc639bce05e
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeIdWorkAddresses.java:
id: ed4af20a12ef
- last_write_checksum: sha1:db6f4e2b8f3229a73ffa7406a4aca2e45166ed3f
- pristine_git_object: 0827b70887c86e54b5df9a45d16652b5bd098c4d
+ last_write_checksum: sha1:052a1f7e491b32bf4b282f735cf607ba0e8efed2
+ pristine_git_object: 2a5e62eb6c92cf4008ce1d27c67af46aef2d79c9
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeUuidPayStubs.java:
id: d9b57bfdde99
- last_write_checksum: sha1:6c6c7d517e54d5e46b2af3dd8c099363600a5ab7
- pristine_git_object: 37b827c8cbb6eba2d4f15a0bd4856c1f40a6c6ce
+ last_write_checksum: sha1:6d3792a9d18016a770e9332f1e2c523c9189fd48
+ pristine_git_object: e809e8651d05d5139c52740c1941b6ece502e1a4
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatuses.java:
id: f32faa9ebbef
- last_write_checksum: sha1:c28c05c1baca9918a1c178b609739d8b86f4543e
- pristine_git_object: 8e233a5114daecf29d8ee6eb293e69a0a16c8959
+ last_write_checksum: sha1:39706c5762b34edc6940539ecd5c42a05bb228d2
+ pristine_git_object: 0a6c2973d36497cfac385ca80951641beb58ecf4
src/main/java/com/gusto/embedded_api/operations/GetV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYear.java:
id: 4b8a1305a888
- last_write_checksum: sha1:2df52cb6f60443f8959f1fb93885a8a9863c7de7
- pristine_git_object: d17b8e8528efef64acf695e06a03dba97c705691
+ last_write_checksum: sha1:45b6dcacb55b843127b8b4521f765d80c2a2b37f
+ pristine_git_object: 940740dd4fa393df68c641104ccd66f38c37e19d
src/main/java/com/gusto/embedded_api/operations/GetV1ExternalPayroll.java:
id: e9315c943772
last_write_checksum: sha1:ab7deba6e4e2cb49fff1de6cf1fa0c7dc7f0f9a8
pristine_git_object: 00a444fc23254abd7d6811075119499ef59b9955
src/main/java/com/gusto/embedded_api/operations/GetV1ExternalPayrollCalculateTaxes.java:
id: d92c2faa3f6b
- last_write_checksum: sha1:63ddb53b84c14ab325f514f348b850ec81e9bce7
- pristine_git_object: 372f952e3029aa43733ec5fdd0c373b8e99ff962
+ last_write_checksum: sha1:36b70bf5b9c9f816a82a22f64595c138475e3ddc
+ pristine_git_object: e82484563989912541f1568783f4bdfd8b4ed0ce
src/main/java/com/gusto/embedded_api/operations/GetV1GarnishmentsChildSupport.java:
id: 782d244e795b
last_write_checksum: sha1:66b6cf40bbdf76b30eb61e25b8cd179d716e03e6
@@ -16087,60 +16756,64 @@ trackedFiles:
pristine_git_object: 771bad6915d91a43b7db097f7a1b772fa32fbe97
src/main/java/com/gusto/embedded_api/operations/GetV1HomeAddressesHomeAddressUuid.java:
id: 77dfd404231c
- last_write_checksum: sha1:77606355774413e38ce50367058eb0b7785db162
- pristine_git_object: 5846a14ad0eed87af5861b5aaaaa9696763261f1
+ last_write_checksum: sha1:24fa61f71c7da109c7e6665a0bb530544a4e553f
+ pristine_git_object: d1e3fc409381177500d174ff733ed3925e6d90cf
src/main/java/com/gusto/embedded_api/operations/GetV1JobsJobId.java:
id: 48e111684072
last_write_checksum: sha1:65b56bc9159b653f255abd2630c8c8e18a4038d4
pristine_git_object: bc374551388902a62e2584a05da67566a48f7e88
src/main/java/com/gusto/embedded_api/operations/GetV1JobsJobIdCompensations.java:
id: 64ae6cf93697
- last_write_checksum: sha1:9016b450f7da29e9dbed65bf16b5ff2b581e8380
- pristine_git_object: 793c3717f397c18a7c1fe3fc8eb081473aee099b
+ last_write_checksum: sha1:a50033df42ca0216f1e7d0fcfa88c69140e658a1
+ pristine_git_object: 4fe48f9955b623c003a12bc92c151673a6af99c4
src/main/java/com/gusto/embedded_api/operations/GetV1LocationsLocationId.java:
id: 2b1d8d6f86c8
- last_write_checksum: sha1:7594b48144a28c12bc970ec0e38f2d93e5c39dd0
- pristine_git_object: 99005a37418f8b8fa8706bd3833f7a32a9a36aba
+ last_write_checksum: sha1:cbb5d31b232f8d1c726316560755b166599d8528
+ pristine_git_object: dd5d324ca25bed33bd7064a209ed851c343bd32a
src/main/java/com/gusto/embedded_api/operations/GetV1LocationsLocationUuidMinimumWages.java:
id: 3c4106847ac1
- last_write_checksum: sha1:060ade07c4dde3c086496bf952ed3e1f564422b8
- pristine_git_object: 244d4948d311b3b7e1329808da5d6554859c3722
+ last_write_checksum: sha1:ecadc8ef42cb084f6d152f9f20ea60fd3e366610
+ pristine_git_object: dd487b819abe09db07c75fbdfd91f40ce73d22c8
+ src/main/java/com/gusto/embedded_api/operations/GetV1PartnerManagedCompaniesCompanyUuidMigrationReadiness.java:
+ id: ebf8a530bb89
+ last_write_checksum: sha1:ce1b746d4ad9506cc41f2ea506fbcc4e723450b7
+ pristine_git_object: a280f115afba03e3416df138c8573da4b20eb242
src/main/java/com/gusto/embedded_api/operations/GetV1PaymentReceiptsPayrollsPayrollUuid.java:
id: a113bd62e891
- last_write_checksum: sha1:afbbf3a3ceaaf17218eb0500505b4c7b9a6a5a1c
- pristine_git_object: 86c21a30e76e5fbb09dc428c225dc2eaccc7e106
+ last_write_checksum: sha1:cd57339c4362a0f9f97db393fd39c03aa76ecdc9
+ pristine_git_object: e71b00b408d18167da56dfceeabe236d4a5b01a8
src/main/java/com/gusto/embedded_api/operations/GetV1PayrollsPayrollUuidEmployeesEmployeeUuidPayStub.java:
id: e4b4875fc356
- last_write_checksum: sha1:d24fb21c6771935bb205a2b3e8576616024587e3
- pristine_git_object: aebe272d9c477ecde5925f76c46bac2f6bc86295
+ last_write_checksum: sha1:446169cc90814d049a4dc0fbf4e55f1447c702b2
+ pristine_git_object: 526c1b37bad691ba5da6626f93bb3af8b8a84630
src/main/java/com/gusto/embedded_api/operations/GetV1PeopleBatchesPeopleBatchUuid.java:
id: d0f7a76204c0
- last_write_checksum: sha1:ed621a0a9a661b040313fd24bacf03d99374a43e
- pristine_git_object: 469751bcc2d6ad0502761baa5ec3e2da8d3e98fc
+ last_write_checksum: sha1:9f63ab53c7f817bd3e0accb347c4617ae5877647
+ pristine_git_object: 4b729d099479c34ba5f900ef9ec83a08324d0347
src/main/java/com/gusto/embedded_api/operations/GetV1RecurringReimbursements.java:
id: dbf72afcea5b
- last_write_checksum: sha1:cadf251ea553b38429e965d2efd820ee4402e6c9
- pristine_git_object: 98c7672b4189e2e7d7499f8da6ff29a4b9199764
+ last_write_checksum: sha1:ee53b4f6678fda11d462c17050eacd4f9acb7a67
+ pristine_git_object: f26bf1b31bf78a8432808f877010236a12db033e
src/main/java/com/gusto/embedded_api/operations/GetV1SalaryEstimatesId.java:
id: 702baa7975a2
- last_write_checksum: sha1:6e29cdd3144b8195b22bb2d05677e1c9499006c2
- pristine_git_object: 084f6751225d035714687ce9d299262811de0533
+ last_write_checksum: sha1:19904484ebacf9462e133c9791ee00cb544efd3b
+ pristine_git_object: 7ac14f6f890b4ecdd9051e71dc76aa68b3cadaf7
src/main/java/com/gusto/embedded_api/operations/GetV1SalaryEstimatesOccupations.java:
id: df007926ffc3
last_write_checksum: sha1:d2b3c258465aae170f3ec39ea4f6bcbfffdfed69
pristine_git_object: 6a909d69a71336b5f2e343386a893fa4fe249d6f
src/main/java/com/gusto/embedded_api/operations/GetV1TaxLiabilities.java:
id: 90a8d0bdc9c8
- last_write_checksum: sha1:5fd381d9323c419560d4bca5b14775983d1fd393
- pristine_git_object: c4cbe14967bb6517624ed0d055b88cfc106e2ca5
+ last_write_checksum: sha1:d99f3354522bae95773121a65cea358ac5e3f1fd
+ pristine_git_object: 97b12c41f998f504b05917dbe4cee93356b4172d
src/main/java/com/gusto/embedded_api/operations/GetV1TimeOffPoliciesTimeOffPolicyUuid.java:
id: 8fe35409abf8
- last_write_checksum: sha1:c8ea6dcf01dcff70c030a800233b50b544d61a67
- pristine_git_object: 667def14223609a152b2da0f03c68f4f05bc267a
+ last_write_checksum: sha1:b7f736aa8a896c73db728f86cc4cd97e077b975b
+ pristine_git_object: a3bde2fbc7aa5090d3f732146504019c39f9ded5
src/main/java/com/gusto/embedded_api/operations/GetV1TokenInfo.java:
id: 105ab6efcb15
- last_write_checksum: sha1:4a8752fb8760c7d146cc9cdafe19a15a088be5c0
- pristine_git_object: 50806f86d87a360054c02601da368adde382d29e
+ last_write_checksum: sha1:2798dba9f6159102b832c650dd57e94115e9176e
+ pristine_git_object: c0cd3e4a50e4366aa2898011ae46ed23917ffb3f
src/main/java/com/gusto/embedded_api/operations/GetV1WebhookSubscriptionUuid.java:
id: 0378fbdb3f6b
last_write_checksum: sha1:5a2c4268ad007eb34d192620ef980313fa296281
@@ -16159,8 +16832,8 @@ trackedFiles:
pristine_git_object: d224c4db376a52bd0c07b179d27a77e881e3baeb
src/main/java/com/gusto/embedded_api/operations/GetV1WorkAddressesWorkAddressUuid.java:
id: 91bc5d2fde66
- last_write_checksum: sha1:2ac803f6cd1a6454d3c567cb62e303cda4aa267e
- pristine_git_object: aff26ef30c87fa455683acda7258a83e173a04c1
+ last_write_checksum: sha1:35b006b5e24a7908e82b982451d24c61c0942ca9
+ pristine_git_object: fc7a86c93628f4f1eaa89cf0517a601904fcd992
src/main/java/com/gusto/embedded_api/operations/GetVersionEmployeesTimeOffActivities.java:
id: f4a69b3384c0
last_write_checksum: sha1:76a54c2d178c67c9850d53a465d75a900cef6e99
@@ -16179,16 +16852,16 @@ trackedFiles:
pristine_git_object: f1e661def0cbb995161a7aaa3883995a21d01a45
src/main/java/com/gusto/embedded_api/operations/PatchV1CompaniesCompanyIdPayrollsIdPartnerDisbursements.java:
id: 3817decc34bd
- last_write_checksum: sha1:018c9b7c06fbea8b8d691e544a49b2a33eb0ab13
- pristine_git_object: faee5c2450b1dca9da819fd0d45ff52cad889d7a
+ last_write_checksum: sha1:91747c6e38291f2bd39e75ecfa84be82cf003e35
+ pristine_git_object: eb0c9eb915b9c03a809ccdae0501af59e6723f17
src/main/java/com/gusto/embedded_api/operations/PatchV1ContractorPaymentGroupsIdPartnerDisbursements.java:
id: 16fa4d4e3284
last_write_checksum: sha1:4bb36772c3a1a33bf6af53f7395915eef9121870
pristine_git_object: cda176c0ef3c60a12d9e904a1586401d4fd79322
src/main/java/com/gusto/embedded_api/operations/PatchV1EmployeesEmployeeUuidSection603HighEarnerStatusesEffectiveYear.java:
id: 039094476fd7
- last_write_checksum: sha1:5a4f11cdf67108d38239ace574b68621aaeb93c1
- pristine_git_object: c71f648d60890b51fa2c34add98df04c6a72dec4
+ last_write_checksum: sha1:f911c4648d91d77ac2d53a44e0fb880d86e3a11a
+ pristine_git_object: 82640baa8c648380bfb50644baef3e54943b144a
src/main/java/com/gusto/embedded_api/operations/PostCompaniesCompanyUuidReports.java:
id: a81205a99ab1
last_write_checksum: sha1:5fd374c0823d0246108b29d07947cc74da35e480
@@ -16213,6 +16886,10 @@ trackedFiles:
id: ca429ac034f2
last_write_checksum: sha1:406e0b19e37edac935cc93a6fc113f218e98385c
pristine_git_object: 3b5e6925458684b4a4cd09b7de0e634efdd77b89
+ src/main/java/com/gusto/embedded_api/operations/PostPayrollsGrossUpPayrollUuid.java:
+ id: 7af4051a73b9
+ last_write_checksum: sha1:315150024cb8156755b4576fdd13be14481aac45
+ pristine_git_object: 2dbaa2e713933fdc524404f4ec81bca233c02ed1
src/main/java/com/gusto/embedded_api/operations/PostPayrollsPayrollUuidReportsGeneralLedger.java:
id: 002c9122af11
last_write_checksum: sha1:ada997f4abb3e97ca9f51d60cbf089e86e1c7add
@@ -16227,36 +16904,36 @@ trackedFiles:
pristine_git_object: 5ed14c4bff7fffe675705a914f0ade07dfc30fb9
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyIdBankAccounts.java:
id: 13d1a72b302a
- last_write_checksum: sha1:bb2ee4be06f65813cfc4c3892932d47a0040e61c
- pristine_git_object: 1ec4fb91f0329cc17a8573e540b0d2c845801c6a
+ last_write_checksum: sha1:6b36933405684ebbfd713350a05096742b1e1b61
+ pristine_git_object: 321cda00e83b09d347f63fd4380cb4c9c0c90066
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyIdCompanyBenefits.java:
id: 67d8538076cd
last_write_checksum: sha1:574b9b23bb6a4b9e9107d2dc26bb64cf97e4165e
pristine_git_object: 0e73c44e595c1d10cae2bdf5f93a125ef0dc3462
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyIdContractorPaymentGroups.java:
id: 13067fd130ec
- last_write_checksum: sha1:3f1fe8d91795327adccc8e966b431ccfec50d39d
- pristine_git_object: 589af2ecf5c4adecefb2428b1bd13412fdc7e403
+ last_write_checksum: sha1:761e99e5c0ec7b79b2ac86b9ed88f8ef1b09043a
+ pristine_git_object: dd8819c11ff239298e9dc48e3844ffeb96e4897d
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyIdContractorPaymentGroupsPreview.java:
id: 4c8fd19659e4
last_write_checksum: sha1:98d5f833ed9a4aa7e5e217039aaa3d9f5d634464
pristine_git_object: eb24ef422b003fbd244259c885c80aa60ad15e27
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyIdContractorPayments.java:
id: 98738df6ad3f
- last_write_checksum: sha1:da61c7e8f67f747de3ec053c580e214649c33f85
- pristine_git_object: 9f5f3468c82f826f5cb97fddc2da68535b2b6988
+ last_write_checksum: sha1:5e5307bf4bd36563abd88e6018c094a61c9ee613
+ pristine_git_object: fd0ee0c94d12433a5d4c913595681d7d87d5f9b4
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyIdEarningTypes.java:
id: 21ecc46d587f
last_write_checksum: sha1:bd1952a0113c15fde8c6957bc0a775df8e97711a
pristine_git_object: 799013ef101412eb988e19b21511af19d9c95eb2
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyIdLocations.java:
id: 4be3dcd21770
- last_write_checksum: sha1:78ed96f713ccf8414d7c6345936b707fa2bf1713
- pristine_git_object: 4ae759faf6bbbe234912b840324e0228b2ca679a
+ last_write_checksum: sha1:92c16387faa72c79698cb25df31f9efb8691a354
+ pristine_git_object: 8747d4a8ed68b16df1158e35544a399a692c5309
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyIdPaySchedules.java:
id: 92a8f0b78442
- last_write_checksum: sha1:c32ecd34e24ed5b0f0c901fe391a430a886dda66
- pristine_git_object: 448fd20bf1fee09c6941e201fe4c3a9c766767ea
+ last_write_checksum: sha1:f9aa5567a76a5b400660efbbe82aaf69d3231361
+ pristine_git_object: b1f94cd4059ca923a6583da5338fd37c4127e279
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyIdPaySchedulesAssign.java:
id: 7f431a8fcd7e
last_write_checksum: sha1:de32c9e6ecd3000fe2c0c51c767846ce0de99175
@@ -16267,52 +16944,52 @@ trackedFiles:
pristine_git_object: 29239d8f104ff7a1d35af7f9cccc8c2ab2e005dd
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyIdPayrolls.java:
id: 575a97b71093
- last_write_checksum: sha1:081a6b56a3a23fc3755ccd1f2ddc40e153bf6a9d
- pristine_git_object: 10690407c829ac3eadd7575b89deb3368e993a12
+ last_write_checksum: sha1:9b8f92907e665f6b083b86fda278b7d43a75bcc3
+ pristine_git_object: 217da22870f7806104c0d521f17045aa887f9e4c
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyIdPeopleBatches.java:
id: f143efc4db50
- last_write_checksum: sha1:28eead581b11a3a0f1b44716a60744e034b35e3c
- pristine_git_object: fa9234bbe3c5e4e2a98a8509d15f178fbdb977ef
+ last_write_checksum: sha1:1417bcf2d64a7f4c6c0880f07506275d788c4407
+ pristine_git_object: a0a9cb0ba7011d62c9bdc330b8e3ae0ac68f97ec
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyIdReportsEmployeesAnnualFicaWage.java:
id: 7f3d0762087b
- last_write_checksum: sha1:e60194acee99b648c550122076f5ba6be1fd87e0
- pristine_git_object: a024246009488f5b9057025e2905389319a9314d
+ last_write_checksum: sha1:a58089015ffb4c244104519a75366037a563add9
+ pristine_git_object: b89f6c462734f33350ff0f27296755bd76aaf6c8
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyUuidContractors.java:
id: 0832502ed6ec
- last_write_checksum: sha1:d6e9f0adc0c3e55747c5ce96ee9e136139291bf4
- pristine_git_object: 694a66cb9c4fd4831c7b022cf94d0b0b132b44eb
+ last_write_checksum: sha1:cb60bf7b7496e6b8d74650c901b14cc2eee8ab00
+ pristine_git_object: ceadba3f7f3ec39bb1066ab37638003853f5efcd
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyUuidHolidayPayPolicy.java:
id: 9c6f340d1efa
- last_write_checksum: sha1:d550b6afa6b6ff614968f20b1f3d3cb2bc0a5cf2
- pristine_git_object: a67610565f923c645b5f49c300c83010219fe8b5
+ last_write_checksum: sha1:71ca5674d439a40fcffdf1414e312eac88a65f7b
+ pristine_git_object: 46d59899d08e6a2a136e7e332749eefc7ca27644
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyUuidSignatoriesInvite.java:
id: 22457b28c725
- last_write_checksum: sha1:0d35132b6b22c83cf2cc361e0e0ac526d6120842
- pristine_git_object: c0ed5650b58e3c500b6949eb0c0dd80d9e02e178
+ last_write_checksum: sha1:242ab4908c1ac018c5c48f972b5c685503ef6453
+ pristine_git_object: ba1cc4876053d3c450d34db5a1fc9296cdf76436
src/main/java/com/gusto/embedded_api/operations/PostV1CompaniesCompanyUuidTimeOffPolicies.java:
id: 732bfed756dc
- last_write_checksum: sha1:e1a1d41a489442afaf9fb844772b4ae41aee8b99
- pristine_git_object: 100c0ebf808e7c03c474a89083afc08288dd8c47
+ last_write_checksum: sha1:f5052e8bdbeb9e7d42b38efe163486bc69f68dc0
+ pristine_git_object: 7ee36ec4f90fb5f1a822a6064cff77b0b1f28c50
src/main/java/com/gusto/embedded_api/operations/PostV1CompanyFlows.java:
id: 3fb95020a72d
- last_write_checksum: sha1:35991379df1c99d06a2b1868bf341c89475b857f
- pristine_git_object: bff3bec84418de367462859e36af9972ddcae3d3
+ last_write_checksum: sha1:a730199bce53e6274e5b24433c97b17b5e4ceb88
+ pristine_git_object: d0f970039cf66d101a5967c233411ab05d4ab05f
src/main/java/com/gusto/embedded_api/operations/PostV1CompanySignatories.java:
id: 48e1fba449da
- last_write_checksum: sha1:8e22ab579a50d504be5a93141616654849d492af
- pristine_git_object: 193a9f12c5695009a87032a858ff21bd27766499
+ last_write_checksum: sha1:36aa46cf0633f6fbab3e9a5196490eea40fb4998
+ pristine_git_object: 304601eec88e9ad695a915ff00f3ef91c1f6b1cd
src/main/java/com/gusto/embedded_api/operations/PostV1CompensationsCompensationId.java:
id: 6158dfce641c
- last_write_checksum: sha1:443e291ac0a8886671c25dc26a7fe79a47b36630
- pristine_git_object: 9ec29be51acd9fb1fbaba31e65b2af4454a60e62
+ last_write_checksum: sha1:0e533e8784b77fe190416a68d7ebbc59542dcb4a
+ pristine_git_object: 34a9e35fe949eed87b85a62ae6f0e1c15ac450d0
src/main/java/com/gusto/embedded_api/operations/PostV1ContractorsContractorUuidBankAccounts.java:
id: ee672a537f98
last_write_checksum: sha1:c79d1bca5b36e505f6f328b66a6e1190b013c1ce
pristine_git_object: a3bf16a80ede50564ca50924891b496911b0a2cc
src/main/java/com/gusto/embedded_api/operations/PostV1Employees.java:
id: 716ca3917f45
- last_write_checksum: sha1:fc935ba6d51d29eb55ae90fa6fc6ce1a029b3f1f
- pristine_git_object: a923f9c4ffa381dd7a93c5365914a77b6339b276
+ last_write_checksum: sha1:41b5d7903e69c15d0377fa484ce6b4040b1fa205
+ pristine_git_object: 9c360bff51ec3509c628d09b71d8a4c8b7d22e96
src/main/java/com/gusto/embedded_api/operations/PostV1EmployeesEmployeeIdBankAccounts.java:
id: 5cc17cb52e79
last_write_checksum: sha1:7f19ce1ee30a989fff12600e729be06a552aaba3
@@ -16327,32 +17004,32 @@ trackedFiles:
pristine_git_object: 2dbed4a35aebbac35e445ae90df73ca3138e3eb1
src/main/java/com/gusto/embedded_api/operations/PostV1EmployeesEmployeeIdHomeAddresses.java:
id: 90b5a84eafd9
- last_write_checksum: sha1:8df30cc4a4ac5e1beda55d2938c42b161eca7c3d
- pristine_git_object: dbdaa0b908e0390247aacbddeff1ff2272fdc641
+ last_write_checksum: sha1:9da618e8dc542a8f376502d814183c26d0560004
+ pristine_git_object: ab6b20243211060f7969d0cd42a38cd19be98d21
src/main/java/com/gusto/embedded_api/operations/PostV1EmployeesEmployeeIdRecurringReimbursements.java:
id: 6ca2dba9227f
- last_write_checksum: sha1:78087792d7adb0c0c487ef987a15843358327239
- pristine_git_object: c00715b77346a09e8eafce14e9fc26ffbad27575
+ last_write_checksum: sha1:8cf6379f663132b63f1a168fa7f08a4f348d4e7c
+ pristine_git_object: 5102f2e11d5adbc281ba37f379ba3c7b4019afb1
src/main/java/com/gusto/embedded_api/operations/PostV1EmployeesEmployeeIdRehire.java:
id: 6e7b56e51c7e
last_write_checksum: sha1:9c6a4518ca3b4f52d30f86821e3a1ec820607d30
pristine_git_object: ef4381cc258798edad8506159b1cd50812a66e31
src/main/java/com/gusto/embedded_api/operations/PostV1EmployeesEmployeeIdSalaryEstimates.java:
id: f1103ef3fe89
- last_write_checksum: sha1:0f55e8ea448f8631dd085f489349712f36630f5a
- pristine_git_object: e8dbc080c62abe2d4dafe482bb7439ea1e62855a
+ last_write_checksum: sha1:b630969f3206a89b4c257bcf941cc039b229ff3d
+ pristine_git_object: 42fed379ed4cfd65b3ac8e16baf373c7cc3eb715
src/main/java/com/gusto/embedded_api/operations/PostV1EmployeesEmployeeIdTerminations.java:
id: f7f6f26e0aab
last_write_checksum: sha1:fdacccbfeeff17a2414a31d7d170f7f1531d9fc4
pristine_git_object: de0785208d9040fba34ccd211cb43a43683bb72b
src/main/java/com/gusto/embedded_api/operations/PostV1EmployeesEmployeeIdWorkAddresses.java:
id: d573a08a271a
- last_write_checksum: sha1:a8e2c9d8fc3eb8e814b4beca174cdb274aa86aa3
- pristine_git_object: bf85f0117d7c3da8056e72260bb9b3ab336b8108
+ last_write_checksum: sha1:7d9c766c3a0b73cc048e14c6dc6b76039a961f0e
+ pristine_git_object: 711827ad471d392d935173cd642703d5fe595a74
src/main/java/com/gusto/embedded_api/operations/PostV1EmployeesEmployeeUuidSection603HighEarnerStatuses.java:
id: 1415b9f349d1
- last_write_checksum: sha1:78cd8645250729e3ce2f3b06b9e16e112d2577f9
- pristine_git_object: ea20fd68233455a85a015717906679986c6642f4
+ last_write_checksum: sha1:30407adbf6639c40ac541101ae4926319b62af2c
+ pristine_git_object: 18518c9b0ba66133d8e9bf55f8b24500bab324aa
src/main/java/com/gusto/embedded_api/operations/PostV1ExternalPayroll.java:
id: 86b12cd755e9
last_write_checksum: sha1:07fd768801c6af60220fbda641044b87c626dcd8
@@ -16371,8 +17048,8 @@ trackedFiles:
pristine_git_object: 8559171e2c4347142cc7d0965a1fda5745abe707
src/main/java/com/gusto/embedded_api/operations/PostV1PayrollsPayrollIdCalculateAccruingTimeOffHours.java:
id: 69bf7af16908
- last_write_checksum: sha1:c468c73b2b9967e97084956812662a95960abe70
- pristine_git_object: 0d3ada158870d2ad754711a0c9ddfda471e067da
+ last_write_checksum: sha1:ecc4a04be7df00502c0e787591c00059d8acdb2c
+ pristine_git_object: 6c5864aeeaaa07dc0fc6037e10188cd8db27a257
src/main/java/com/gusto/embedded_api/operations/PostV1PayrollsPayrollUuidGeneratedDocumentsPrintablePayrollChecks.java:
id: e396f2d3e534
last_write_checksum: sha1:3a615f4decbf4fed694f6fa092f884fcf607f208
@@ -16383,8 +17060,8 @@ trackedFiles:
pristine_git_object: e129b36df800a9ee97c822c90831338159480eb1
src/main/java/com/gusto/embedded_api/operations/PostV1SalaryEstimatesUuidAccept.java:
id: 65d0906887ff
- last_write_checksum: sha1:9cdd5a69575cdedb3c3f80dcf6363a4c25052ba7
- pristine_git_object: 6380c41263b301a4b5548d9815a0514a13b8f895
+ last_write_checksum: sha1:155b5f3af457c3fe2877b72fb210e15c6f5d4857
+ pristine_git_object: 451abaf4c2f6a4575b9b009bd6a8e3d60d5396d4
src/main/java/com/gusto/embedded_api/operations/PostV1SandboxGenerate1099.java:
id: 7cf76413c056
last_write_checksum: sha1:5bab2853f3141b8b9711adb7f7eb1966036d183e
@@ -16403,8 +17080,8 @@ trackedFiles:
pristine_git_object: 0278745fb1bbd5fa2edea4d317a201cb826f46cd
src/main/java/com/gusto/embedded_api/operations/PutApiV1CompaniesCompanyIdPayrollsPayrollIdCancel.java:
id: 84cb7b847f84
- last_write_checksum: sha1:9fc700d86b2361604854ae94830e6f5449951b0e
- pristine_git_object: 4e9f8dd465736a903ab6219f5cfc783d7c604b86
+ last_write_checksum: sha1:a0e0e91590c2e2514e3936787f5f4e81d2e8b57e
+ pristine_git_object: 9800e817734d0a803e33a978f99a1a7215881787
src/main/java/com/gusto/embedded_api/operations/PutDepartments.java:
id: 2ebb336a7aba
last_write_checksum: sha1:2ad0c3e16f9823f7b332f185b0e15b959abbf9a3
@@ -16415,12 +17092,12 @@ trackedFiles:
pristine_git_object: 01d19c6e651d788ecaa3dc8a24733afcc1991042
src/main/java/com/gusto/embedded_api/operations/PutV1Companies.java:
id: 164683ee5504
- last_write_checksum: sha1:2d4c3d7591c375ef5a0c5de376f9c61d98e130d1
- pristine_git_object: 561675c8ed1209f19a2508be04b1adf17362761f
+ last_write_checksum: sha1:577d64d8b1f73b7cacbc6a1eeb8753303e60b62c
+ pristine_git_object: dbc5eeee70bdf77981f31b10ce8f29669ba11ba4
src/main/java/com/gusto/embedded_api/operations/PutV1CompaniesCompanyIdBankAccountsVerify.java:
id: 561fca953800
- last_write_checksum: sha1:925ed72966d23ebf9eafbaa2bd816196a7b079eb
- pristine_git_object: d76207036c60da1717b84cd61deae6c151809a12
+ last_write_checksum: sha1:10f41ec905d2bec8050f146a0964f5ac3d0baed2
+ pristine_git_object: 6357f949b336e33350a109eab0cee657f4aae0d4
src/main/java/com/gusto/embedded_api/operations/PutV1CompaniesCompanyIdEarningTypesEarningTypeUuid.java:
id: 1b01f1dc85fe
last_write_checksum: sha1:3c3bf1140e7b83c8409c7b815a571f51cd788f3d
@@ -16431,32 +17108,40 @@ trackedFiles:
pristine_git_object: 11c4b1dad58cd71fa266fe819ae9bafb59eeb49e
src/main/java/com/gusto/embedded_api/operations/PutV1CompaniesCompanyIdPaySchedulesPayScheduleId.java:
id: b80469755ff2
- last_write_checksum: sha1:28cd9858cc4208fc3d3cab139eda366509462606
- pristine_git_object: ec63a21685cf2b3bcb8fac6abdb039cbb4b60612
+ last_write_checksum: sha1:66affde1b3d67784e344c10c9e7434ff52f7d4bd
+ pristine_git_object: b0a781e8fc7ff29a1700d47bc0d52caf73ba1221
src/main/java/com/gusto/embedded_api/operations/PutV1CompaniesCompanyIdPayrolls.java:
id: cb42efad0c49
- last_write_checksum: sha1:a5deb54177e94547194da13567e99c087e994054
- pristine_git_object: 00175f2937386f946ee2f867d5338cf82455039b
+ last_write_checksum: sha1:ac8fbe12bfb78ce8df3f5baa84428f1605bc59d4
+ pristine_git_object: e54475e8cb61d26d256eeba5e5c9893dd1e0e7bd
+ src/main/java/com/gusto/embedded_api/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdCalculate.java:
+ id: 2a775edb3206
+ last_write_checksum: sha1:8305316046e7a26fc194da69b9365bff5fff5f77
+ pristine_git_object: a6a5773dad10b938891974357ffedd696be32067
src/main/java/com/gusto/embedded_api/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdPrepare.java:
id: 186941594f24
- last_write_checksum: sha1:a244c8ac8bb8d256a3fa2cd70ab5a8a1e3a9fb64
- pristine_git_object: 4872355adf5e781221c4937b21ea55e9235df2f3
+ last_write_checksum: sha1:2b01f552857c5063af03dc41deae898c3b275404
+ pristine_git_object: e7b9b6d8aa6f37535e64df99acd8f91d63156c78
+ src/main/java/com/gusto/embedded_api/operations/PutV1CompaniesCompanyIdPayrollsPayrollIdSubmit.java:
+ id: c5b8cefaf263
+ last_write_checksum: sha1:38a28e965a86305e2b3402e4a9ea1aca59c12fe2
+ pristine_git_object: adb886c894d53c371f183822d7b2727e0d9c2344
src/main/java/com/gusto/embedded_api/operations/PutV1CompaniesCompanyUuidHolidayPayPolicy.java:
id: 252fedd00700
- last_write_checksum: sha1:c6307ed6015906c88bc99ecc1e2c5e29cf0a1766
- pristine_git_object: 0328eabf1ee280d1c2a26d40f4724a7909e609f6
+ last_write_checksum: sha1:7c6be68068f19646820a377581ada1ff9f66e60a
+ pristine_git_object: 514a2b94a1ba25bf72a5e4c049231611180c9a7e
src/main/java/com/gusto/embedded_api/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyAdd.java:
id: dbc35581f3db
- last_write_checksum: sha1:be148c166a64dbfad3f1edb9b43da4c1c108ee9c
- pristine_git_object: 036876262660eb9042c38ed48f2b5d9cfba6d06d
+ last_write_checksum: sha1:51e0b0caa4f7fc0a7cbf90032cfeaa7af4b1d1a3
+ pristine_git_object: 521301a72b282b5cb82202f438accce16e83275f
src/main/java/com/gusto/embedded_api/operations/PutV1CompaniesCompanyUuidHolidayPayPolicyRemove.java:
id: f31f26f1368a
- last_write_checksum: sha1:0325024bee9596aba2675705d53ebe2efa0e1975
- pristine_git_object: 83960876c49378d905fa20521217f322913b41d2
+ last_write_checksum: sha1:d30b2f3ad973b45e3837b16b05372743373f0591
+ pristine_git_object: acb7a794c753ded960cf9b85850d1ee0871ac268
src/main/java/com/gusto/embedded_api/operations/PutV1CompaniesCompanyUuidSignatoriesSignatoryUuid.java:
id: 30120a7c96ad
- last_write_checksum: sha1:de362fbd05e37277a3d1a0325da034145e5eb8a2
- pristine_git_object: 7be44fa66d687bf4581d92ef59572ea3a7136189
+ last_write_checksum: sha1:07e426605e722659c73da7e05cef207a5a12d172
+ pristine_git_object: 322478ff64ea28de8228a03eb07ec8e46e4d70b6
src/main/java/com/gusto/embedded_api/operations/PutV1CompaniesCompanyUuidTaxRequirementsState.java:
id: 0ecb4125e20b
last_write_checksum: sha1:b2dbf9ddd31d31604d32f623a3b5e18135d4c1f0
@@ -16479,16 +17164,16 @@ trackedFiles:
pristine_git_object: 1b2d8be05a455ca9c57a2c7db03dcb723010bb96
src/main/java/com/gusto/embedded_api/operations/PutV1CompanyIndustry.java:
id: 7908d55644c2
- last_write_checksum: sha1:f2f5857162e52c3134ce0889dd670beed2b80b3a
- pristine_git_object: 0ffec23ff782b2463fece60c09a6047d059bf61d
+ last_write_checksum: sha1:15c98a260975ea9d464c88d1d20e21ba5deb612a
+ pristine_git_object: 44ab587a1a4ab4579d1a678f9db4b84ae6ee8b27
src/main/java/com/gusto/embedded_api/operations/PutV1CompanyPaymentConfigs.java:
id: 25248358134d
- last_write_checksum: sha1:565916b97aa56b92030a9c606ad7d1441201329f
- pristine_git_object: a643aea6c872e575bcaf9bae27194f6ada82a526
+ last_write_checksum: sha1:78a26f48b5deb02ab7cadd95cb9c498e17449095
+ pristine_git_object: 6fc7a7d0caa7a301fa1836400f1e04e9f4c757c0
src/main/java/com/gusto/embedded_api/operations/PutV1CompensationsCompensationId.java:
id: 02cbdd2dac2d
- last_write_checksum: sha1:2b9e4e4ec74b0c131d4efc5501321ac648bfc4dc
- pristine_git_object: f244367a1bff31c50cad6466c90b54befe15c557
+ last_write_checksum: sha1:817df75e3be199466c82180dddcb8c2b08f88807
+ pristine_git_object: 8eee98536f6099e0de962ff07321bd8ef2f586b7
src/main/java/com/gusto/embedded_api/operations/PutV1ContractorDocumentSign.java:
id: 81296dd00dc8
last_write_checksum: sha1:96f9ad40ab7a71f8a813388d090906e9cfd7e2a2
@@ -16503,8 +17188,8 @@ trackedFiles:
pristine_git_object: b360f9257b73f6296f65d2585450cecfd8d042cf
src/main/java/com/gusto/embedded_api/operations/PutV1ContractorsContractorUuid.java:
id: 7771621c1d3d
- last_write_checksum: sha1:b0637f865f0783f4c4a827652e97a992c99b0140
- pristine_git_object: 02569f28fd30d1c4aac963711e5b20720ac2f73b
+ last_write_checksum: sha1:69ee2d56d63d075cd7d48af3b5c2c30c32a2f3c3
+ pristine_git_object: 7ec0addb3d431bcccd540be115d20cc9fd9a7249
src/main/java/com/gusto/embedded_api/operations/PutV1ContractorsContractorUuidAddress.java:
id: 08101968ad70
last_write_checksum: sha1:129751e31e86e12cfd0209c689294215ca2114f0
@@ -16523,48 +17208,48 @@ trackedFiles:
pristine_git_object: 186d922eebea5795a8739019c0b15a1d42817b91
src/main/java/com/gusto/embedded_api/operations/PutV1Employees.java:
id: b56fc2d9d808
- last_write_checksum: sha1:8d1b21ddad74e8c7804e3a2a890c8dbe45633729
- pristine_git_object: 3a243f80dd16b4b313d1e6eed6f66f52c0d85ad5
+ last_write_checksum: sha1:b225f2cae5f0ab8c98081932adb23f6380bbda05
+ pristine_git_object: e0bf9421c6335b06af048a51ad7b3f08c15d1340
src/main/java/com/gusto/embedded_api/operations/PutV1EmployeesEmployeeIdBankAccounts.java:
id: 63c10e728f65
last_write_checksum: sha1:7162bcde3a34d4ac054cde1c97175e431f8a1eeb
pristine_git_object: b1d8dd34213dd2ddec6c64eac0a589c24e897129
src/main/java/com/gusto/embedded_api/operations/PutV1EmployeesEmployeeIdFederalTaxes.java:
id: 89fdef694d43
- last_write_checksum: sha1:ddad8336bc3374b34bb4f0808da999652babcc24
- pristine_git_object: 65c60a75226ec19cdebbdc1f4ac0186298386fd8
+ last_write_checksum: sha1:8ee547ca3927e51f940d74820037bce712ccf0f8
+ pristine_git_object: 3518f38968ca56a8ceb706774195fbe7027babf8
src/main/java/com/gusto/embedded_api/operations/PutV1EmployeesEmployeeIdI9Authorization.java:
id: 11b872886e65
- last_write_checksum: sha1:ccba0d8e02fc8531f4a4d86c2439d1fee113c34b
- pristine_git_object: 705412eaf892c0abc3f1f88e19c14b4e38cef8d8
+ last_write_checksum: sha1:7695fb5201542e877ee0b273f9f5ed090844ebf3
+ pristine_git_object: ecb9c3c4945094a5123ca60d8f422d1097d32424
src/main/java/com/gusto/embedded_api/operations/PutV1EmployeesEmployeeIdI9AuthorizationDocuments.java:
id: 057f49c8b4b4
- last_write_checksum: sha1:e031e03dc9bb2c08c8afde2ef4b936f6b47c5c6b
- pristine_git_object: c5211cc401cc7a63884155c3a3aeb753bcfeadff
+ last_write_checksum: sha1:2d2acc3e4c835323aba7e44a4fd5908bdf681f21
+ pristine_git_object: 28f0553b5c4323ee3406215d02ca2341034c4911
src/main/java/com/gusto/embedded_api/operations/PutV1EmployeesEmployeeIdI9AuthorizationEmployerSign.java:
id: b8874696550e
- last_write_checksum: sha1:f11b7fc9f03d7e7b6ea4bafa5cc15f593cceb6d3
- pristine_git_object: 2d52ccfe76f5ac4f0c6f25e74adacdf6b75b9ceb
+ last_write_checksum: sha1:cfce0e3f661da2e0c668de57e4666540d8cad2ec
+ pristine_git_object: 8af0e2acf1087ff94ab107ba7196bc0c21a0d147
src/main/java/com/gusto/embedded_api/operations/PutV1EmployeesEmployeeIdOnboardingDocumentsConfig.java:
id: 8b46f4a620c8
- last_write_checksum: sha1:11448421660971d709f7790e59932bfdfb8561de
- pristine_git_object: 4b4ccd9bc432ab261794e52e702bd8161f4a258e
+ last_write_checksum: sha1:15091df23380c4ea13612bc024a083fd93d49fc8
+ pristine_git_object: c1c0dcfb46e676d11c66063666b2ebec0bd4a5db
src/main/java/com/gusto/embedded_api/operations/PutV1EmployeesEmployeeIdOnboardingStatus.java:
id: 7ccc9985822d
- last_write_checksum: sha1:46b8848c3d7536e617c4911d385a3d040d858c88
- pristine_git_object: 806379daa7e2f77c92b6d0df2b40ec287ff54a77
+ last_write_checksum: sha1:182a4071ca28ee4b8a8d06767ea0d1c3e4e854b1
+ pristine_git_object: 08f01ce4202e812d0d7d555a3cd79f872f57b1f0
src/main/java/com/gusto/embedded_api/operations/PutV1EmployeesEmployeeIdPaymentMethod.java:
id: 7fa5ac956cbb
- last_write_checksum: sha1:68e0760e9043ecd18ea5fd7def13a676c9ec698a
- pristine_git_object: be60f83102cfd62bcfe6ecfc983931bcea6961bd
+ last_write_checksum: sha1:73533bb7afb1a8ab49f66eaad666aff2db68c376
+ pristine_git_object: 519fd5b7f11cd2eaba6a3fbbb466a558973a3645
src/main/java/com/gusto/embedded_api/operations/PutV1EmployeesEmployeeIdRehire.java:
id: 949667e24637
last_write_checksum: sha1:a21b92dceee17213f4e1ff3eb50a00fda83ae558
pristine_git_object: a694b5c07bbc98efa8cb8dfc3e9e9ee77ff321d6
src/main/java/com/gusto/embedded_api/operations/PutV1EmployeesEmployeeIdStateTaxes.java:
id: 573c668e54b3
- last_write_checksum: sha1:a4692bc8b7ee7633c0a2991f5fa982431f58350e
- pristine_git_object: bd48f18895781a6541b489bf26f59cb788f600e4
+ last_write_checksum: sha1:e3eeb99b23697489b10a7a10c7cc8f516f6d6a06
+ pristine_git_object: 0d88c023073b2f069239f7544fcaa942b96085a5
src/main/java/com/gusto/embedded_api/operations/PutV1ExternalPayroll.java:
id: c65c506057be
last_write_checksum: sha1:563f498997c758b4b0ef3c1bc5fa839829334be2
@@ -16579,32 +17264,28 @@ trackedFiles:
pristine_git_object: 3359c8c315d90b1541ad42de6fd2865c85e71397
src/main/java/com/gusto/embedded_api/operations/PutV1HomeAddressesHomeAddressUuid.java:
id: 3f703b999ae9
- last_write_checksum: sha1:7b2b8320481d75bd875cf2316e9be16ea2bdaf05
- pristine_git_object: abc16e813fe3b4ebe36205ea7f5b7c5c689698bc
+ last_write_checksum: sha1:9a25043eafb2a6362083492fca26336d5454f8b2
+ pristine_git_object: 0e35459c4df48f564a51686a3eafc4e2d38a91a1
src/main/java/com/gusto/embedded_api/operations/PutV1JobsJobId.java:
id: 365cc0f41e1d
last_write_checksum: sha1:4f81ea4e31bd574c176a5ebb336ffd806ec7316d
pristine_git_object: 147df8e6ab2d4c896749e2970006e97c47220f74
src/main/java/com/gusto/embedded_api/operations/PutV1LocationsLocationId.java:
id: bc7045eaf7a1
- last_write_checksum: sha1:d1973b1f18313bfb508d16e5fb22ebee65858c6a
- pristine_git_object: f870be116e7db34222014b926e89c478eb515c15
- src/main/java/com/gusto/embedded_api/operations/PutV1PartnerManagedCompaniesCompanyUuidMigrate.java:
- id: d23fab2c5987
- last_write_checksum: sha1:d493f1df795adbccbc5d8861b92f5b442620da3e
- pristine_git_object: f953ec9a04ff3824a2e2297c203c73813c289f7d
+ last_write_checksum: sha1:19c3745b594add53eda81917bf9a813ab0b739a7
+ pristine_git_object: 8b7e86e6e57a0e48a42f5e8efb56e065f414d084
src/main/java/com/gusto/embedded_api/operations/PutV1RecurringReimbursements.java:
id: fb569411f4c1
- last_write_checksum: sha1:9bacb851daa38a5baa536fcddab9c0cffa1598f6
- pristine_git_object: 6b9e6a9424ca485d82bc42fa86908d0e35464bb9
+ last_write_checksum: sha1:ac7c4f84f13aacb0764d8d1834a9ffc05e523ac6
+ pristine_git_object: 3450d9e8fc2bd5dc76cfd6ded3c696b83513304e
src/main/java/com/gusto/embedded_api/operations/PutV1SalaryEstimatesId.java:
id: 4d8fb6c17a2c
- last_write_checksum: sha1:aa01f775cdf0d455238c09a8346c13a348138c8a
- pristine_git_object: 201d940de192003d691aa77272b010ee5af2b86b
+ last_write_checksum: sha1:8647164e9481c175ec257613c193290195382b98
+ pristine_git_object: f1e98b2b34f4cd4703c79d6c0dcc3572ff76967a
src/main/java/com/gusto/embedded_api/operations/PutV1TaxLiabilities.java:
id: 1e98c442b1e1
- last_write_checksum: sha1:22513d5660bf60323c4ac8d7cd13c9fa148204c7
- pristine_git_object: 7e9de66decf3f6729e05898949f380d9039d4175
+ last_write_checksum: sha1:46a6a41aa9238c38e8ea3d8bcfb18672a6b61fde
+ pristine_git_object: 6b501b2f205763955c6301c098a3bfdcfd41dfd8
src/main/java/com/gusto/embedded_api/operations/PutV1TaxLiabilitiesFinish.java:
id: 2f9944edbe57
last_write_checksum: sha1:661a6571d1eb4f73e5e9fafc212fd0a34128e6a7
@@ -16615,24 +17296,24 @@ trackedFiles:
pristine_git_object: bfea50489acff4b4a13842c0867e0f11e591a00d
src/main/java/com/gusto/embedded_api/operations/PutV1TimeOffPoliciesTimeOffPolicyUuid.java:
id: 12ca94158551
- last_write_checksum: sha1:f909d9f40a8309ee1d0d32ef2c96a7db01c129f6
- pristine_git_object: df002242b185c82ecddee8757aaf021ee2810658
+ last_write_checksum: sha1:fbb4783126671d5227ee1fe6f4cabfed182a76b2
+ pristine_git_object: 3d9074a4ccffb56b420eb2e070f2f0b90186073f
src/main/java/com/gusto/embedded_api/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidAddEmployees.java:
id: dc773024aa72
- last_write_checksum: sha1:739153bc7e3c795ecade2638299c87bd87d700c3
- pristine_git_object: 8d32f82507288d1e8fed0a24be28d662ade7c29a
+ last_write_checksum: sha1:03c81dc01b4c7cac52eb6f16180a0ed1ccd30c84
+ pristine_git_object: 416dd7209573ba6ff539acdf84d368a00b67de98
src/main/java/com/gusto/embedded_api/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidBalance.java:
id: 2b5f7327648e
- last_write_checksum: sha1:323ab8fb32162d328fe7592e29e9db65eb62cdcd
- pristine_git_object: d8e5fce0f4441009e56610d38f9a1923b1d9ffa4
+ last_write_checksum: sha1:df5b6865ae73c1aea2c0fcb9612c35cd9a4bba79
+ pristine_git_object: 61aa38334151a4fcd809b43a957b89e2b9b2347d
src/main/java/com/gusto/embedded_api/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidDeactivate.java:
id: 2062285d50ea
- last_write_checksum: sha1:cb861fe039c3c4f25497101df8d965f8889ebc18
- pristine_git_object: 05118313f3cd836eb4a6779757fe94a775e2d3ab
+ last_write_checksum: sha1:a90788cd2595e449d96a39f8941295077c575a19
+ pristine_git_object: 0d8bd24d5984489c11f4204a2828c10b38ad506a
src/main/java/com/gusto/embedded_api/operations/PutV1TimeOffPoliciesTimeOffPolicyUuidRemoveEmployees.java:
id: f8a70bf3c888
- last_write_checksum: sha1:97d204104e9f532847da4953d7ca1ef4d5520cd3
- pristine_git_object: 6f0c0ce72b4d40277a1a24748b1784ffb7d25fe9
+ last_write_checksum: sha1:a9d1ac741861f58333ebe7d62bb7922badb8bdc8
+ pristine_git_object: a584123555e9ab518f2989eeacfe63d19055ec99
src/main/java/com/gusto/embedded_api/operations/PutV1VerifyWebhookSubscriptionUuid.java:
id: dcc39a4e9a2a
last_write_checksum: sha1:f895d616e7b4bad16e580dd739169a5dac1d3eac
@@ -16643,8 +17324,8 @@ trackedFiles:
pristine_git_object: cc87986e9cb2579e4abf59391649987081bdbb52
src/main/java/com/gusto/embedded_api/operations/PutV1WorkAddressesWorkAddressUuid.java:
id: 9d937613a7dd
- last_write_checksum: sha1:105073b931d2eaf75094427781a3a60a4429a8ff
- pristine_git_object: 985b484942470070028a4d977b4474c71a692160
+ last_write_checksum: sha1:8291b2d7a79447519862c3be84d7bd883bd03319
+ pristine_git_object: e1dbb9fd771646fde9abdad13eb0545f1e9eddec
src/main/java/com/gusto/embedded_api/operations/PutWireInRequestsWireInRequestUuid.java:
id: f41610d58ac7
last_write_checksum: sha1:4b88da7a2d93ce6188b4a2a2b790708838d4cf6d
@@ -16671,8 +17352,8 @@ trackedFiles:
pristine_git_object: 907dea4e35dfb26a9cd5209a7597d982f24a77e6
src/main/java/com/gusto/embedded_api/utils/AsyncRetries.java:
id: 16d036b2ba97
- last_write_checksum: sha1:4749c814d85329374f96a2b8f205cfdb1e02ee2b
- pristine_git_object: ce2921944bccdf3e5fc55b629a3e78f0414a21e9
+ last_write_checksum: sha1:62ffab234abc9a36949f3647b90bf355593f1229
+ pristine_git_object: 39e2c224ed87362a90fd69eca0578a280ecc543b
src/main/java/com/gusto/embedded_api/utils/AsyncRetryableException.java:
id: 36c34e655982
last_write_checksum: sha1:18fa49083d7fecb5743cfc0577e82880c16f8f1b
@@ -16711,12 +17392,12 @@ trackedFiles:
pristine_git_object: a7531dca1a460213dc3106fe6dcb2b5d11de755d
src/main/java/com/gusto/embedded_api/utils/EventStream.java:
id: cb0b20d3fcbf
- last_write_checksum: sha1:a0412acf375092f23cde9e3ccc63e0a584d5933b
- pristine_git_object: 233770b73287aafb97349e28f932edc77ca35371
+ last_write_checksum: sha1:c1eeca68353fdbd20122ba1282af641d02676d77
+ pristine_git_object: 3a9bc4bb74a1a9202a00534a080e7df2a2679e1b
src/main/java/com/gusto/embedded_api/utils/EventStreamMessage.java:
id: d54e7afb080c
- last_write_checksum: sha1:52826734c046f23ef304d8ef8e0fde304b3fc739
- pristine_git_object: ad8d6b9859c0998b1788fb048253ae1adc556101
+ last_write_checksum: sha1:ccae0e83ce44b24b2baf3e62d62e012231c186c1
+ pristine_git_object: 35e7b0e1503190263b5076c2c836080e0cbef47e
src/main/java/com/gusto/embedded_api/utils/Exceptions.java:
id: 3320999b6bed
last_write_checksum: sha1:03aae0409b655723ec2fa57cf32fe6250df6378f
@@ -16725,10 +17406,18 @@ trackedFiles:
id: e4b8d13a1c07
last_write_checksum: sha1:9040b02d6fb78c0a548a51447bd45971d5e6f8d0
pristine_git_object: 33d6bedc9ed02fcd91207f5a77faeb1d26cc1a93
+ src/main/java/com/gusto/embedded_api/utils/GenericTypeIdResolver.java:
+ id: e68d10dd5862
+ last_write_checksum: sha1:636f23d961c43b51b600f9e9acc1c07f1fb4074f
+ pristine_git_object: 5b584ab9cf32cd2059114fbcfc67c245e27dfe00
src/main/java/com/gusto/embedded_api/utils/Globals.java:
id: 6c99d36c08f4
last_write_checksum: sha1:51a4bf02e0373e0ea8c9cd9da285d67171c779ae
pristine_git_object: 4f037fe8e5c5064ac033ccf802a483011b11ea65
+ src/main/java/com/gusto/embedded_api/utils/GustoEmbeddedJacksonModule.java:
+ id: "211302530200"
+ last_write_checksum: sha1:3343b900c160e2e89600ed470673ac91e42e8331
+ pristine_git_object: d0c15eb9a4a51f081662440daf259fab551082d2
src/main/java/com/gusto/embedded_api/utils/HTTPClient.java:
id: bf75a063bc4a
last_write_checksum: sha1:be6f4764b697b94444929129532cb940e142192c
@@ -16831,8 +17520,8 @@ trackedFiles:
pristine_git_object: bfe2960b77f2da20b3795e20261067d3c503fa9e
src/main/java/com/gusto/embedded_api/utils/RequestBody.java:
id: aa77ceec9897
- last_write_checksum: sha1:722e5aed442db08b2d3b1966882e134e0eff293c
- pristine_git_object: f5102e93b451d07e7aee2dada91fccfec4fcb778
+ last_write_checksum: sha1:d21928f6776d7afc0fc1e4d8002b3d7182e1ce98
+ pristine_git_object: 57adb41ab27290219ccb471bac1c744b196f00c3
src/main/java/com/gusto/embedded_api/utils/RequestMetadata.java:
id: 4b1c4bfe1c19
last_write_checksum: sha1:81503c2ba5da6a0b0c12b43f66d6302dd5aba639
@@ -16847,8 +17536,8 @@ trackedFiles:
pristine_git_object: 71066c808de0a91ece50233a5286eaec3193203a
src/main/java/com/gusto/embedded_api/utils/Retries.java:
id: 70963fb29954
- last_write_checksum: sha1:fd90686f24a1fd332dbdfbf24c99e05693253947
- pristine_git_object: c98e399a18f905a2c6df2ddd4cdf655aead42f09
+ last_write_checksum: sha1:8b43f18898be16278db6a5f470b9677a958cf9a7
+ pristine_git_object: d12de68409a657d7490519e40a0d61d6c2f49954
src/main/java/com/gusto/embedded_api/utils/RetryConfig.java:
id: f7af4b5b9a01
last_write_checksum: sha1:e46ba1f045c7d2d2316db89e7d378731e39811ce
@@ -16859,8 +17548,8 @@ trackedFiles:
pristine_git_object: 69d49446cc4c94f1d301e7168d37aef632c8dc17
src/main/java/com/gusto/embedded_api/utils/Security.java:
id: a034624ef845
- last_write_checksum: sha1:057a49d674b9fe5e2a3d3382d24313dbf872e256
- pristine_git_object: 1a311cb2c7c4d921a06c6926d528cee080be856f
+ last_write_checksum: sha1:f084da7957cc8240ce528e43360475e1f565c536
+ pristine_git_object: 329647b20c13132f6db04f930da169b8d2662cdc
src/main/java/com/gusto/embedded_api/utils/SecurityMetadata.java:
id: 816582357bd8
last_write_checksum: sha1:ce62d52ac1ac6b8cc8bc6021d48d847673ed0fdf
@@ -16875,8 +17564,8 @@ trackedFiles:
pristine_git_object: 0f4cf989e704ed4f15afdc5ad6baa65f694eefd0
src/main/java/com/gusto/embedded_api/utils/SpeakeasyHTTPClient.java:
id: 948d0f4903e2
- last_write_checksum: sha1:f9e51fed49e4a4193bf6c115933cb19b625c9a1b
- pristine_git_object: e4ebad39025b88e27688fa88cd8fb7b106985447
+ last_write_checksum: sha1:e98a2053b651fcc86b8cf04b51d3e4db8798438e
+ pristine_git_object: f64093addbdeb724a6593751e21ba88364f0fde6
src/main/java/com/gusto/embedded_api/utils/SpeakeasyLogger.java:
id: 726f9916a24d
last_write_checksum: sha1:366e456a8a7d6a39347170c3f54582a50f2772d8
@@ -16887,8 +17576,8 @@ trackedFiles:
pristine_git_object: 4c0b7cbed17249ec1129a0de7623e000bbf957dc
src/main/java/com/gusto/embedded_api/utils/StreamingParser.java:
id: 424b591f63da
- last_write_checksum: sha1:409653e897a48528b1239b719a9065557932620d
- pristine_git_object: 40c6ef642f357f448aa4c0ee07fd792916dbe399
+ last_write_checksum: sha1:308feb965bb246b717688e740309ff71631478ad
+ pristine_git_object: c61e65636d28ff4a92f10a5ce9f769c41e3b20ec
src/main/java/com/gusto/embedded_api/utils/TypedObject.java:
id: 1518a3fca10b
last_write_checksum: sha1:473e779621338fc220aeef04fd1e690ec0f3b08b
@@ -16897,18 +17586,22 @@ trackedFiles:
id: 23c67284e553
last_write_checksum: sha1:3fcdf966de60ab2692edc59973d5127521c61d57
pristine_git_object: f0e6086424456c009bebbce8de0ee9f4d65f72a7
+ src/main/java/com/gusto/embedded_api/utils/UnknownType.java:
+ id: cff8eee946ee
+ last_write_checksum: sha1:0f180e0436f992b06f5f868ea5a51f262b03ca66
+ pristine_git_object: ebdfab88f5c59aa503da9a997c111cd0ec32fcd4
src/main/java/com/gusto/embedded_api/utils/Utf8UrlEncoder.java:
id: a40e0bf84115
last_write_checksum: sha1:1e0077c51061a50dd154385a4c8e88ae82ee59ee
pristine_git_object: 981c2b1d15630137ccafcdfa46d040b71d21043d
src/main/java/com/gusto/embedded_api/utils/Utils.java:
id: 77074f8e1326
- last_write_checksum: sha1:7bf5ac38b55666be6fbf00abc36f6efbcbde4e88
- pristine_git_object: 787a90f2ecc23efd3926c9947e4e895f9167d79e
+ last_write_checksum: sha1:b1dac8767226fcc10d189a355a83433eddc19764
+ pristine_git_object: dc29254f48ab251e3ee5991ad25962aa11a5d98e
src/main/java/com/gusto/embedded_api/utils/reactive/EventStream.java:
id: a61e7418b4d8
- last_write_checksum: sha1:26d2820080e66cd2682d250e3f89059474a0a7ee
- pristine_git_object: 2616f27dd6f219b5fe49b8938dafb3af7b512820
+ last_write_checksum: sha1:8fdb470bd8a0069d1a9697a5ee42abaabf43aa00
+ pristine_git_object: 73d3c6cd5367e186ac16126e81760719a640433b
src/main/java/com/gusto/embedded_api/utils/reactive/ReactiveUtils.java:
id: 2767d54eabad
last_write_checksum: sha1:0f24bfa473bc73695d8e278bcd90cb59e51e5379
@@ -16926,7 +17619,7 @@ examples:
speakeasy-default-oauth-access-token:
parameters:
header:
- X-Gusto-API-Version: "2024-04-01"
+ X-Gusto-API-Version: "2025-06-15"
requestBody:
application/json: {"client_id": "qr6L_9FRkbMVL_GdwvrMW6Ef8tcU6NUxjWpOfqXqOG8", "client_secret": "3aQSHRB3596nZhm6NdNBELZ1u9xbZmvCrKpBhbZYq6w", "grant_type": "system_access"}
responses:
@@ -16992,6 +17685,17 @@ examples:
responses:
"200":
application/json: {"ein": "00-0000001", "entity_type": "C-Corporation", "contractor_only": false, "tier": "core", "is_suspended": false, "company_status": "Approved", "uuid": "c7a07c73-a703-4462-9343-1b181182b6e0", "name": "Shoppe Studios LLC", "slug": "record-shoppe", "trade_name": "Record Shoppe", "is_partner_managed": false, "pay_schedule_type": "by_department", "join_date": "2023-03-01", "funding_type": "ach", "locations": [{"street_1": "412 Kiera Stravenue", "street_2": "Suite 391", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA"}, {"street_1": "644 Fay Vista", "street_2": "Suite 842", "city": "Richmond", "state": "VA", "zip": "23218", "country": "USA"}], "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": "8a2ed9c2-9d1e-443a-8e56-a490d8bf73bb", "first_name": "Alda", "middle_initial": "", "last_name": "Carter", "phone": "1-565-710-7558", "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"}}
+ speakeasy-default-get-v1-companies:
+ parameters:
+ path:
+ company_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {"uuid": "857fc43b-f393-48fa-8786-d1b8f708ab35", "compensations": {"hourly": [{"name": "Overtime", "multiple": 1.5}], "fixed": [{"name": "Bonus"}], "paid_time_off": [{"name": "Vacation Hours"}]}}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
put-v1-companies:
Example:
parameters:
@@ -17037,6 +17741,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-put-v1-companies:
+ parameters:
+ path:
+ company_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"contractor_only": true}
+ responses:
+ "200":
+ application/json: {"uuid": "1bbb7825-2825-4e10-a785-096283e86d85", "compensations": {"hourly": [{"name": "Overtime", "multiple": 1.5}], "fixed": [{"name": "Bonus"}], "paid_time_off": [{"name": "Vacation Hours"}]}}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": []}
put-v1-partner-managed-companies-company-uuid-migrate:
Basic:
parameters:
@@ -17271,6 +17990,19 @@ examples:
responses:
"200":
application/json: {"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": "Enter Your Federal Tax Information", "id": "federal_tax_setup", "required": true, "completed": true, "completed_at": "2025-02-18T10:00:00Z", "skippable": false, "requirements": []}, {"title": "Select Industry", "id": "select_industry", "required": true, "completed": true, "completed_at": "2025-02-18T10:00:00Z", "skippable": false, "requirements": []}, {"title": "Add Your Bank Account", "id": "add_bank_info", "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 State Tax Information", "id": "state_setup", "required": true, "completed": false, "completed_at": null, "skippable": false, "requirements": ["add_addresses", "add_employees"]}, {"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"]}]}
+ speakeasy-default-get-v1-company-onboarding-status:
+ parameters:
+ path:
+ company_uuid: "7b1d0df1-6403-4a06-8768-c1dd7d24d27a"
+ query:
+ additional_steps: "external_payroll"
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {"uuid": "587343d0-7722-43bb-aa84-017b64e506f2"}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-company-finish-onboarding:
Example:
parameters:
@@ -17308,6 +18040,19 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-get-v1-company-finish-onboarding:
+ parameters:
+ path:
+ company_uuid: "7b1d0df1-6403-4a06-8768-c1dd7d24d27a"
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {"uuid": "6e39890e-5509-4cdb-ae76-7606e09fa272"}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": []}
get-v1-companies-company_id-custom_fields:
Example:
parameters:
@@ -17523,6 +18268,17 @@ examples:
responses:
"200":
application/json: {"company_uuid": "423dd616-6dbc-4724-938a-403f6217a933", "naics_code": "611420", "sic_codes": ["8243"], "title": "Computer Training"}
+ speakeasy-default-get-v1-company-industry:
+ parameters:
+ path:
+ company_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {"naics_code": "611420", "sic_codes": ["8243"], "title": "Computer Training"}
+ "404":
+ application/json: {"errors": []}
put-v1-company-industry:
Example:
parameters:
@@ -17568,6 +18324,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-put-v1-company-industry:
+ parameters:
+ path:
+ company_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"title": "Computer Training", "naics_code": "611420", "sic_codes": ["8243"]}
+ responses:
+ "201":
+ application/json: {"naics_code": "611420", "sic_codes": ["8243"], "title": "Computer Training"}
+ "404":
+ application/json: {"errors": []}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
post-v1-company-signatories:
Example:
parameters:
@@ -17613,6 +18384,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-post-v1-company-signatories:
+ parameters:
+ path:
+ company_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"first_name": "Ed", "last_name": "Reichert", "title": "", "phone": "914.468.8146 x29683", "birthday": "2026-11-04", "email": "Mariah_Huel64@gmail.com", "ssn": "", "home_address": {"street_1": "", "city": "East Paxtonborough", "state": "Rhode Island", "zip": "37195", "country": "USA"}}
+ responses:
+ "200":
+ application/json: {"uuid": "167c3c66-f9a0-48bf-a2b5-5f5e88cb8029"}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": []}
get-v1-companies-company_uuid-signatories:
Example:
parameters:
@@ -17623,6 +18409,17 @@ examples:
responses:
"200":
application/json: [{"uuid": "f8c653dc-0094-41fb-8670-45d6399afade", "first_name": "Bob", "last_name": "Johnson", "title": "Owner", "phone": "4239879876", "email": "olin.okuneva@denesik.us", "birthday": "2002-10-31", "is_admin": false, "has_ssn": true, "version": "49ea586f528411f5cfadfd54452b2423", "identity_verification_status": "Skipped", "home_address": {"street_1": "524 Roob Divide", "street_2": "Suite 565", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA"}}]
+ speakeasy-default-get-v1-companies-company-uuid-signatories:
+ parameters:
+ path:
+ company_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: [{"uuid": "b92e13e9-c310-4685-9208-400448f81134"}]
+ "404":
+ application/json: {"errors": []}
post-v1-companies-company_uuid-signatories-invite:
Example:
parameters:
@@ -17668,6 +18465,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-post-v1-companies-company-uuid-signatories-invite:
+ parameters:
+ path:
+ company_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"first_name": "Madelyn", "last_name": "Littel", "email": "Harmon_Heidenreich@yahoo.com"}
+ responses:
+ "200":
+ application/json: {"uuid": "e6a9e87c-2098-439e-9e23-7f593502c04d"}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": []}
put-v1-companies-company_uuid-signatories-signatory_uuid:
Example:
parameters:
@@ -17717,6 +18529,22 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-put-v1-companies-company-uuid-signatories-signatory-uuid:
+ parameters:
+ path:
+ company_uuid: ""
+ signatory_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"version": ""}
+ responses:
+ "200":
+ application/json: {"uuid": "a766000e-94dc-49cb-96b4-250e118e1275"}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "409":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
delete-v1-companies-company_uuid-signatories-signatory_uuid:
speakeasy-default-delete-v1-companies-company-uuid-signatories-signatory-uuid:
parameters:
@@ -17725,6 +18553,9 @@ examples:
signatory_uuid: ""
header:
X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
post-v1-company-flows:
Example:
parameters:
@@ -17783,6 +18614,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-post-v1-company-flows:
+ parameters:
+ path:
+ company_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"flow_type": "company_onboarding"}
+ responses:
+ "201":
+ application/json: {}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
post-v1-companies-company_id-locations:
Example:
parameters:
@@ -17828,6 +18674,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-post-v1-companies-company-id-locations:
+ parameters:
+ path:
+ company_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"street_1": "300 3rd Street", "street_2": "Apartment 318", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "USA", "phone_number": "8009360383"}
+ responses:
+ "201":
+ application/json: {"uuid": "8d71d26f-73bf-4698-b828-f1dd44974aea", "country": "USA"}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": []}
get-v1-companies-company_id-locations:
Example:
parameters:
@@ -17838,6 +18699,17 @@ examples:
responses:
"200":
application/json: [{"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": "2023-09-12T16:42:25.000-07:00", "updated_at": "2023-09-12T16:42:25.000-07:00", "active": true}, {"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": false, "filing_address": false, "created_at": "2023-09-12T16:42:25.000-07:00", "updated_at": "2023-09-12T16:42:25.000-07:00", "active": true}]
+ speakeasy-default-get-v1-companies-company-id-locations:
+ parameters:
+ path:
+ company_id: "7b1d0df1-6403-4a06-8768-c1dd7d24d27a"
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: [{"uuid": "67b90da8-cb40-4a0f-ac19-1de1c043872f", "country": "USA"}]
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-locations-location_id:
speakeasy-default-get-v1-locations-location-id:
parameters:
@@ -17864,6 +18736,8 @@ examples:
application/json: {"uuid": "ced517c9-1c22-4468-88f7-bea752987d03", "country": "USA"}
"404":
application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "409":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-locations-location_uuid-minimum_wages:
speakeasy-default-get-v1-locations-location-uuid-minimum-wages:
parameters:
@@ -17904,6 +18778,10 @@ examples:
application/json: {"uuid": "035098fc-43ca-4e65-9b38-e0b3c4343abe"}
"404":
application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "200":
+ application/json: {"uuid": "b035098f-c43c-4ae6-b5b3-8e0b3c4343ab"}
+ "422":
+ application/json: {"errors": []}
put-v1-companies-company_id-bank-accounts-verify:
Example:
parameters:
@@ -17953,6 +18831,22 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-put-v1-companies-company-id-bank-accounts-verify:
+ parameters:
+ path:
+ company_id: ""
+ bank_account_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"deposit_1": 8299.3, "deposit_2": 7367.9}
+ responses:
+ "200":
+ application/json: {"uuid": "34ef573d-73e2-46f0-bccf-f8e3e5587349"}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": []}
post-v1-plaid-processor_token:
Create a company bank account:
parameters:
@@ -18014,6 +18908,8 @@ examples:
responses:
"404":
application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
post-v1-external-payroll:
Example:
parameters:
@@ -18088,6 +18984,39 @@ examples:
external_payroll_id: ""
header:
X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "422":
+ application/json: {"errors": []}
+ Basic:
+ parameters:
+ path:
+ company_uuid: ""
+ external_payroll_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "base", "category": "payroll_blocker", "message": "Company must complete all onboarding requirements in order to run payroll.", "metadata": {"key": "needs_onboarding"}}]}
+ Resource:
+ parameters:
+ path:
+ company_uuid: ""
+ external_payroll_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "first_name", "category": "invalid_attribute_value", "message": "First name is required"}, {"error_key": "date_of_birth", "category": "invalid_attribute_value", "message": "Date of birth is not a valid date"}]}
+ Nested:
+ parameters:
+ path:
+ company_uuid: ""
+ external_payroll_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
put-v1-external-payroll:
Example:
parameters:
@@ -18148,6 +19077,36 @@ examples:
responses:
"200":
application/json: [{"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"}]}]
+ Basic:
+ parameters:
+ path:
+ company_uuid: ""
+ external_payroll_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "base", "category": "payroll_blocker", "message": "Company must complete all onboarding requirements in order to run payroll.", "metadata": {"key": "needs_onboarding"}}]}
+ Resource:
+ parameters:
+ path:
+ company_uuid: ""
+ external_payroll_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "first_name", "category": "invalid_attribute_value", "message": "First name is required"}, {"error_key": "date_of_birth", "category": "invalid_attribute_value", "message": "Date of birth is not a valid date"}]}
+ Nested:
+ parameters:
+ path:
+ company_uuid: ""
+ external_payroll_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
get-v1-tax-liabilities:
Example:
parameters:
@@ -18157,7 +19116,7 @@ examples:
X-Gusto-API-Version: "2025-06-15"
responses:
"200":
- application/json: [[{"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"}]}]]
+ application/json: [{"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"}]}]
put-v1-tax-liabilities:
Example:
parameters:
@@ -18169,7 +19128,7 @@ examples:
application/json: {"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}]}
responses:
"200":
- application/json: [[{"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"}]}]]
+ application/json: [{"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"}]}]
Basic:
parameters:
path:
@@ -18250,6 +19209,17 @@ examples:
responses:
"200":
application/json: {"company_uuid": "423dd616-6dbc-4724-938a-403f6217a933", "partner_uuid": "556f05d0-48e0-4c47-bce5-db9aea923043", "fast_payment_limit": "5000", "payment_speed": "2-day", "earned_fast_ach_blockers": [{"blocker_type": "minimum_days", "threshold": 15}, {"blocker_type": "minimum_funded_payments", "threshold": 1}]}
+ speakeasy-default-get-v1-company-payment-configs:
+ parameters:
+ path:
+ company_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
put-v1-company-payment-configs:
Example:
parameters:
@@ -18295,6 +19265,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-put-v1-company-payment-configs:
+ parameters:
+ path:
+ company_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {}
+ responses:
+ "200":
+ application/json: {}
+ "404":
+ application/json: {"errors": []}
+ "422":
+ application/json: {"errors": []}
post-v1-companies-company_id-pay_schedules:
Example:
parameters:
@@ -18340,6 +19325,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-post-v1-companies-company-id-pay-schedules:
+ parameters:
+ path:
+ company_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"frequency": "Every week", "anchor_pay_date": "2026-02-12", "anchor_end_of_pay_period": "2025-08-20"}
+ responses:
+ "201":
+ application/json: {"uuid": "02e58204-0da1-4731-832a-c65dbb982797"}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": []}
get-v1-companies-company_id-pay_schedules:
Example:
parameters:
@@ -18350,6 +19350,17 @@ examples:
responses:
"200":
application/json: [{"uuid": "2097fe08-407a-46d7-b35c-a32402a2355e", "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, "version": "68934a3e9455fa72420237eb05902327"}, {"uuid": "8fc9f556-74fa-4271-97f6-4bfbfc5a5352", "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, "version": "68934a3e9455fa72420237eb05902320"}, {"uuid": "0e07d35a-af11-4123-bfcb-4dd5f2f12ee1", "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, "version": "68934a3e9455fa72420237eb05902323"}]
+ speakeasy-default-get-v1-companies-company-id-pay-schedules:
+ parameters:
+ path:
+ company_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: [{"uuid": "5f000301-7174-45f8-959b-338453088053"}]
+ "404":
+ application/json: {"errors": []}
get-v1-companies-company_id-pay_schedules-preview:
speakeasy-default-get-v1-companies-company-id-pay-schedules-preview:
parameters:
@@ -18364,6 +19375,10 @@ examples:
responses:
"200":
application/json: {}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": []}
get-v1-companies-company_id-pay_schedules-pay_schedule_id:
Example:
parameters:
@@ -18375,6 +19390,18 @@ examples:
responses:
"200":
application/json: {"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, "version": "68934a3e9455fa72420237eb05902327"}
+ speakeasy-default-get-v1-companies-company-id-pay-schedules-pay-schedule-id:
+ parameters:
+ path:
+ company_id: ""
+ pay_schedule_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {"uuid": "5ba77021-748f-41bc-a785-113bec9bf337"}
+ "404":
+ application/json: {"errors": []}
put-v1-companies-company_id-pay_schedules-pay_schedule_id:
Example:
parameters:
@@ -18424,6 +19451,22 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-put-v1-companies-company-id-pay-schedules-pay-schedule-id:
+ parameters:
+ path:
+ company_id: ""
+ pay_schedule_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"version": ""}
+ responses:
+ "200":
+ application/json: {"uuid": "c62ff402-38a1-4781-aedc-1bb1b2f194e0"}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "409":
+ application/json: {"errors": []}
get-v1-companies-company_id-pay_periods:
Example:
parameters:
@@ -18437,6 +19480,19 @@ examples:
responses:
"200":
application/json: [{"start_date": "2020-01-11", "end_date": "2020-01-24", "pay_schedule_uuid": "00ebc4a4-ec88-4435-8f45-c505bb63e501", "payroll": {"payroll_uuid": "bfd8aad4-9c3f-4ca3-b072-a1b2b3ea689f", "check_date": "2020-01-30", "processed": true, "payroll_deadline": "2020-01-28", "payroll_type": "regular"}}, {"start_date": "2020-12-12", "end_date": "2020-12-25", "pay_schedule_uuid": "cb53db72-612f-4eb1-9b85-389e79cfa510", "payroll": {"payroll_uuid": "7ed29b45-4bb1-4d38-bd94-4d607d49fd21", "check_date": "2020-12-30", "processed": true, "payroll_deadline": "2020-12-28", "payroll_type": "regular"}}]
+ speakeasy-default-get-v1-companies-company-id-pay-periods:
+ parameters:
+ path:
+ company_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: [{}]
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-companies-company_id-unprocessed_termination_pay_periods:
Example:
parameters:
@@ -18582,6 +19638,8 @@ examples:
application/json: {"uuid": "9f634ba6-53c8-4290-8751-3ec38c369860", "first_name": "Lela", "last_name": "Graham", "eligible_paid_time_off": [{"accrual_unit": "Hour", "accrual_method": "unlimited", "accrual_period": "Year"}], "payment_method": "Check"}
"404":
application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-companies-company_id-employees-payment_details:
speakeasy-default-get-v1-companies-company-id-employees-payment-details:
parameters:
@@ -18676,6 +19734,8 @@ examples:
application/json: {"uuid": "2953c680-3178-4466-8441-8947dce42145", "first_name": "Pearl", "last_name": "Volkman", "eligible_paid_time_off": [{"accrual_unit": "Hour", "accrual_method": "unlimited", "accrual_period": "Year"}], "payment_method": "Check"}
"404":
application/json: {"errors": []}
+ "409":
+ application/json: {"errors": []}
delete-v1-employee:
speakeasy-default-delete-v1-employee:
parameters:
@@ -18686,6 +19746,8 @@ examples:
responses:
"404":
application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-employees-employee_id-custom_fields:
speakeasy-default-get-v1-employees-employee-id-custom-fields:
parameters:
@@ -18708,6 +19770,17 @@ examples:
responses:
"200":
application/json: {"i9_document": "true"}
+ speakeasy-default-put-v1-employees-employee-id-onboarding-documents-config:
+ parameters:
+ path:
+ employee_id: "7b1d0df1-6403-4a06-8768-c1dd7d24d27a"
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-employees-employee_id-onboarding_status:
speakeasy-default-get-v1-employees-employee-id-onboarding-status:
parameters:
@@ -18734,6 +19807,8 @@ examples:
application/json: {"uuid": "66aca799-a6b4-44d8-9d21-a3c9f6ca4c66"}
"404":
application/json: {"errors": []}
+ "422":
+ application/json: {"errors": []}
get-version-employees-time_off_activities:
example:
parameters:
@@ -19220,6 +20295,8 @@ examples:
application/json: {"uuid": "b552472e-2d5c-4e19-bf31-49aeeb888b6e", "country": "USA", "version": ""}
"404":
application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-home_addresses-home_address_uuid:
speakeasy-default-get-v1-home-addresses-home-address-uuid:
parameters:
@@ -19246,6 +20323,8 @@ examples:
application/json: {"uuid": "d9fd058f-e693-4c4a-905f-3b5654a55589", "country": "USA", "version": ""}
"404":
application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
delete-v1-home_addresses-home_address_uuid:
speakeasy-default-delete-v1-home-addresses-home-address-uuid:
parameters:
@@ -19256,6 +20335,8 @@ examples:
responses:
"404":
application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-employees-employee_id-work_addresses:
speakeasy-default-get-v1-employees-employee-id-work-addresses:
parameters:
@@ -19282,6 +20363,8 @@ examples:
application/json: {"uuid": "e02ec014-1e6b-41a8-ba57-7e102baa2d06", "version": "", "country": "USA"}
"404":
application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-work_addresses-work_address_uuid:
speakeasy-default-get-v1-work-addresses-work-address-uuid:
parameters:
@@ -19308,6 +20391,8 @@ examples:
application/json: {"uuid": "27c58f85-7f90-4597-bc74-193b0a8d024d", "version": "", "country": "USA"}
"404":
application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": []}
delete-v1-work_addresses-work_address_uuid:
speakeasy-default-delete-v1-work-addresses-work-address-uuid:
parameters:
@@ -19318,6 +20403,8 @@ examples:
responses:
"404":
application/json: {"errors": []}
+ "422":
+ application/json: {"errors": []}
get-v1-employees-employee_id-federal_taxes:
Example:
parameters:
@@ -19328,6 +20415,17 @@ examples:
responses:
"200":
application/json: {"version": "56a489ce86ed6c1b0f0cecc4050a0b01", "w4_data_type": "rev_2020_w4", "filing_status": "Single", "extra_withholding": "0.0", "two_jobs": true, "dependents_amount": "0.0", "other_income": "0.0", "deductions": "0.0"}
+ speakeasy-default-get-v1-employees-employee-id-federal-taxes:
+ parameters:
+ path:
+ employee_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {"version": "", "w4_data_type": "pre_2020_w4", "additional_withholding": ""}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
put-v1-employees-employee_id-federal_taxes:
Example:
parameters:
@@ -19373,6 +20471,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-put-v1-employees-employee-id-federal-taxes:
+ parameters:
+ path:
+ employee_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"version": "56a489ce86ed6c1b0f0cecc4050a0b01", "filing_status": "Single", "w4_data_type": "rev_2020_w4"}
+ responses:
+ "200":
+ application/json: {"version": "", "w4_data_type": "pre_2020_w4", "additional_withholding": ""}
+ "404":
+ application/json: {"errors": []}
+ "409":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-employees-employee_id-state_taxes:
speakeasy-default-get-v1-employees-employee-id-state-taxes:
parameters:
@@ -19399,6 +20512,8 @@ examples:
application/json: [{}]
"404":
application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": []}
post-v1-employees-employee_id-bank_accounts:
Example:
parameters:
@@ -19409,16 +20524,59 @@ examples:
requestBody:
application/json: {"name": "BoA Checking Account", "routing_number": "266905059", "account_number": "5809431207", "account_type": "Checking"}
responses:
- "201":
- application/json: {"uuid": "1531e824-8d9e-4bd8-9f90-0d04608125d7", "employee_uuid": "9fcf1b1d-8886-4691-9283-383d3bdd4fd9", "account_type": "Checking", "name": "BoA Checking Account", "routing_number": "266905059", "hidden_account_number": "XXXX1207"}
+ "201":
+ application/json: {"uuid": "1531e824-8d9e-4bd8-9f90-0d04608125d7", "employee_uuid": "9fcf1b1d-8886-4691-9283-383d3bdd4fd9", "account_type": "Checking", "name": "BoA Checking Account", "routing_number": "266905059", "hidden_account_number": "XXXX1207"}
+ Basic:
+ parameters:
+ path:
+ employee_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"name": "", "routing_number": "", "account_number": "", "account_type": "Checking"}
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "base", "category": "payroll_blocker", "message": "Company must complete all onboarding requirements in order to run payroll.", "metadata": {"key": "needs_onboarding"}}]}
+ Resource:
+ parameters:
+ path:
+ employee_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"name": "", "routing_number": "", "account_number": "", "account_type": "Checking"}
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "first_name", "category": "invalid_attribute_value", "message": "First name is required"}, {"error_key": "date_of_birth", "category": "invalid_attribute_value", "message": "Date of birth is not a valid date"}]}
+ Nested:
+ parameters:
+ path:
+ employee_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"name": "", "routing_number": "", "account_number": "", "account_type": "Checking"}
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ delete-v1-employees-employee_id-bank_accounts-bank_account_id:
+ speakeasy-default-delete-v1-employees-employee-id-bank-accounts-bank-account-id:
+ parameters:
+ path:
+ employee_id: ""
+ bank_account_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
Basic:
parameters:
path:
employee_id: ""
+ bank_account_uuid: ""
header:
X-Gusto-API-Version: "2025-06-15"
- requestBody:
- application/json: {"name": "", "routing_number": "", "account_number": "", "account_type": "Checking"}
responses:
"422":
application/json: {"errors": [{"error_key": "base", "category": "payroll_blocker", "message": "Company must complete all onboarding requirements in order to run payroll.", "metadata": {"key": "needs_onboarding"}}]}
@@ -19426,10 +20584,9 @@ examples:
parameters:
path:
employee_id: ""
+ bank_account_uuid: ""
header:
X-Gusto-API-Version: "2025-06-15"
- requestBody:
- application/json: {"name": "", "routing_number": "", "account_number": "", "account_type": "Checking"}
responses:
"422":
application/json: {"errors": [{"error_key": "first_name", "category": "invalid_attribute_value", "message": "First name is required"}, {"error_key": "date_of_birth", "category": "invalid_attribute_value", "message": "Date of birth is not a valid date"}]}
@@ -19437,21 +20594,12 @@ examples:
parameters:
path:
employee_id: ""
+ bank_account_uuid: ""
header:
X-Gusto-API-Version: "2025-06-15"
- requestBody:
- application/json: {"name": "", "routing_number": "", "account_number": "", "account_type": "Checking"}
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
- delete-v1-employees-employee_id-bank_accounts-bank_account_id:
- speakeasy-default-delete-v1-employees-employee-id-bank-accounts-bank-account-id:
- parameters:
- path:
- employee_id: ""
- bank_account_uuid: ""
- header:
- X-Gusto-API-Version: "2025-06-15"
put-v1-employees-employee_id-bank_accounts:
Example:
parameters:
@@ -19511,6 +20659,17 @@ examples:
responses:
"200":
application/json: {"version": "63859768485e218ccf8a449bb60f14ed", "type": "Direct Deposit", "split_by": "Amount", "splits": [{"uuid": "e88f9436-b74e-49a8-87e9-777b9bfe715e", "name": "BoA Checking Account", "priority": 1, "split_amount": 500}, {"uuid": "0d2b7f73-05d6-4184-911d-269edeecc30a", "name": "Chase Checking Account", "priority": 2, "split_amount": 1000}, {"uuid": "1531e824-8d9e-4bd8-9f90-0d04608125d7", "name": "US Bank Checking Account", "priority": 3, "split_amount": null}]}
+ speakeasy-default-get-v1-employees-employee-id-payment-method:
+ parameters:
+ path:
+ employee_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {}
+ "404":
+ application/json: {"errors": []}
put-v1-employees-employee_id-payment_method:
example-1:
parameters:
@@ -19595,6 +20754,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-put-v1-employees-employee-id-payment-method:
+ parameters:
+ path:
+ employee_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"version": "63859768485e218ccf8a449bb60f14ed", "type": "Check"}
+ responses:
+ "200":
+ application/json: {}
+ "404":
+ application/json: {"errors": []}
+ "409":
+ application/json: {"errors": []}
get-v1-employees-employee_id-bank_accounts:
Example:
parameters:
@@ -19722,6 +20896,36 @@ examples:
job_id: ""
header:
X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "422":
+ application/json: {"errors": []}
+ Basic:
+ parameters:
+ path:
+ job_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "base", "category": "payroll_blocker", "message": "Company must complete all onboarding requirements in order to run payroll.", "metadata": {"key": "needs_onboarding"}}]}
+ Resource:
+ parameters:
+ path:
+ job_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "first_name", "category": "invalid_attribute_value", "message": "First name is required"}, {"error_key": "date_of_birth", "category": "invalid_attribute_value", "message": "Date of birth is not a valid date"}]}
+ Nested:
+ parameters:
+ path:
+ job_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "422":
+ application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
get-v1-jobs-job_id-compensations:
Example:
parameters:
@@ -19732,6 +20936,17 @@ examples:
responses:
"200":
application/json: [{"uuid": "db57832c-d8bc-43a7-ae99-0a04480ff037", "version": "98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872", "job_uuid": "d8f8fbe7-496d-4b69-86f0-1e2d1b73a086", "rate": "70.00", "payment_unit": "Hour", "flsa_status": "Nonexempt", "effective_date": "2020-12-11", "adjust_for_minimum_wage": false, "minimum_wages": []}, {"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"}]}]
+ speakeasy-default-get-v1-jobs-job-id-compensations:
+ parameters:
+ path:
+ job_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: [{"uuid": "2fcb56b8-ecbd-4dc5-a396-52d318a3416f"}]
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
post-v1-compensations-compensation_id:
Exempt:
parameters:
@@ -19788,6 +21003,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-post-v1-compensations-compensation-id:
+ parameters:
+ path:
+ job_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"rate": "70000.00", "payment_unit": "Year", "flsa_status": "Nonexempt", "effective_date": "2023-01-01", "title": "Software Engineer"}
+ responses:
+ "201":
+ application/json: {"uuid": "38e4a145-cc99-4d5b-b918-9ab9224540f3"}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-compensations-compensation_id:
Exempt:
parameters:
@@ -19807,6 +21037,17 @@ examples:
responses:
"200":
application/json: {"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"}]}
+ speakeasy-default-get-v1-compensations-compensation-id:
+ parameters:
+ path:
+ compensation_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {"uuid": "93050ffc-af62-48df-9071-86aa49648769"}
+ "404":
+ application/json: {"errors": []}
put-v1-compensations-compensation_id:
Exempt:
parameters:
@@ -19863,6 +21104,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-put-v1-compensations-compensation-id:
+ parameters:
+ path:
+ compensation_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"version": "56d00c178bc7393b2a206ed6a86afcb4", "rate": "70000.00", "payment_unit": "Year", "effective_date": "2023-01-01", "title": "Software Engineer"}
+ responses:
+ "200":
+ application/json: {"uuid": "cbf23004-6b95-4c12-aa3a-b2e66e6bb216"}
+ "404":
+ application/json: {"errors": []}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
delete-v1-compensations-compensation_id:
speakeasy-default-delete-v1-compensations-compensation-id:
parameters:
@@ -19870,6 +21126,11 @@ examples:
compensation_id: ""
header:
X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
post-v1-companies-company_id-earning_types:
Example:
parameters:
@@ -20064,6 +21325,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-post-v1-companies-company-uuid-contractors:
+ parameters:
+ path:
+ company_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"type": "Individual", "wage_type": "Hourly", "start_date": "2020-01-11", "hourly_rate": "40.0", "self_onboarding": false, "file_new_hire_report": false}
+ responses:
+ "201":
+ application/json: {"uuid": "dab2ac34-b5e4-4577-aaf6-ee525de18376", "is_active": true, "hourly_rate": "50.0"}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": []}
get-v1-companies-company_uuid-contractors:
Example:
parameters:
@@ -20074,6 +21350,17 @@ examples:
responses:
"200":
application/json: [{"uuid": "c9fc1ad3-c107-4e7b-aa21-2dd4b00a7a07", "company_uuid": "b7457fec-3b76-43bb-9c6e-69cca4688942", "wage_type": "Fixed", "is_active": false, "version": "63859768485e218ccf8a449bb60f14ed", "type": "Individual", "first_name": "Kory", "last_name": "Gottlieb", "middle_initial": "P", "business_name": null, "ein": null, "has_ein": false, "email": "keira.west@mckenzie.org", "start_date": "2022-01-01", "address": {"street_1": "621 Jast Row", "street_2": "Apt. 281", "city": "Coral Springs", "state": "FL", "zip": "33065", "country": "USA"}, "hourly_rate": "0.00", "file_new_hire_report": false, "work_state": null, "onboarded": true, "onboarding_status": "onboarding_completed", "has_ssn": true, "department_uuid": "1802465d-4f68-4865-920c-1307ab095f12", "department": "Backup Dancer"}, {"uuid": "183a86f4-a803-4b38-9357-cd9b78e2560c", "company_uuid": "afdd5d98-581b-4fc0-b988-706b7d23b2a5", "wage_type": "Fixed", "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, "email": "jonatan@kerluke.info", "start_date": "2022-01-01", "address": {"street_1": "1625 Bednar Center", "street_2": "Apt. 480", "city": "Port Charlotte", "state": "FL", "zip": "33954", "country": "USA"}, "hourly_rate": "0.00", "file_new_hire_report": false, "work_state": null, "onboarded": true, "onboarding_status": "onboarding_completed", "has_ssn": false}, {"uuid": "ea1c2d65-b622-4899-bcb7-5cd0fe0232aa", "company_uuid": "281c763d-a2ba-4f51-b9e8-b1ed61576d62", "wage_type": "Fixed", "is_active": true, "version": "b48c46abfed1487b873b442334b3c4ff", "type": "Individual", "first_name": "Chanel", "last_name": "Boyle", "middle_initial": "X", "business_name": null, "ein": null, "has_ein": false, "email": "loyal@hettinger.biz", "address": {"street_1": "35913 Darrick Run", "street_2": "Apt. 913", "city": "Cypress", "state": "TX", "zip": "77433", "country": "USA"}, "hourly_rate": "0.00", "file_new_hire_report": true, "work_state": "TX", "onboarded": true, "onboarding_status": "onboarding_completed", "has_ssn": true}]
+ speakeasy-default-get-v1-companies-company-uuid-contractors:
+ parameters:
+ path:
+ company_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: [{"uuid": "a6edce1b-e746-4849-9e4c-c411fc9f2b64", "is_active": true, "hourly_rate": "50.0"}]
+ "404":
+ application/json: {"errors": []}
get-v1-contractors-contractor_uuid:
Individual Contractor:
parameters:
@@ -20093,6 +21380,17 @@ examples:
responses:
"200":
application/json: {"uuid": "c7c0659c-21a6-4b4e-b74c-9252576fc68c", "company_uuid": "0ec4ae6e-e436-460d-b63c-94a14503d16f", "wage_type": "Fixed", "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, "email": "jonatan@kerluke.info", "start_date": "2022-01-01", "address": null, "hourly_rate": "0.00", "file_new_hire_report": false, "work_state": null, "onboarded": false, "onboarding_status": "admin_onboarding_incomplete", "payment_method": "Direct Deposit", "has_ssn": false}
+ speakeasy-default-get-v1-contractors-contractor-uuid:
+ parameters:
+ path:
+ contractor_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {"uuid": "765d1ea9-b1c2-4bc3-9c85-0fe2ef9cb086", "is_active": true, "hourly_rate": "50.0"}
+ "404":
+ application/json: {"errors": []}
put-v1-contractors-contractor_uuid:
Update an Individual Contractor:
parameters:
@@ -20175,6 +21473,21 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-put-v1-contractors-contractor-uuid:
+ parameters:
+ path:
+ contractor_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ requestBody:
+ application/json: {"version": "56d00c178bc7393b2a206ed6a86afcb4", "type": "Individual", "start_date": "2020-01-11", "hourly_rate": "40.0", "self_onboarding": false, "file_new_hire_report": false}
+ responses:
+ "200":
+ application/json: {"uuid": "1c0f975f-b446-4219-b9c7-27da3fb56262", "is_active": true, "hourly_rate": "50.0"}
+ "404":
+ application/json: {"errors": []}
+ "422":
+ application/json: {"errors": []}
delete-v1-contractors-contractor_uuid:
speakeasy-default-delete-v1-contractors-contractor-uuid:
parameters:
@@ -20182,6 +21495,11 @@ examples:
contractor_uuid: ""
header:
X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-contractors-contractor_uuid-onboarding_status:
Example:
parameters:
@@ -20449,7 +21767,7 @@ examples:
application/json: {"url": "https://partner-app.com/subscriber", "subscription_types": ["Company", "Employee"]}
responses:
"201":
- application/json: {"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"]}
+ application/json: {"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", "PayrollSync", "PaySchedule", "Signatory"]}
Basic:
parameters:
header:
@@ -20484,7 +21802,7 @@ examples:
X-Gusto-API-Version: "2025-06-15"
responses:
"200":
- application/json: [{"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"]}]
+ application/json: [{"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", "PayrollSync", "PaySchedule", "Signatory"]}]
put-v1-webhook-subscription-uuid:
Example:
parameters:
@@ -20496,7 +21814,7 @@ examples:
application/json: {"subscription_types": ["Company", "Employee"]}
responses:
"200":
- application/json: {"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"]}
+ application/json: {"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", "PayrollSync", "PaySchedule", "Signatory"]}
Basic:
parameters:
path:
@@ -20539,7 +21857,7 @@ examples:
X-Gusto-API-Version: "2025-06-15"
responses:
"200":
- application/json: {"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"]}
+ application/json: {"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", "PayrollSync", "PaySchedule", "Signatory"]}
delete-v1-webhook-subscription-uuid:
speakeasy-default-delete-v1-webhook-subscription-uuid:
parameters:
@@ -20558,7 +21876,7 @@ examples:
application/json: {"verification_token": "asefasedfe23e234easd"}
responses:
"200":
- application/json: {"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"]}
+ application/json: {"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", "PayrollSync", "PaySchedule", "Signatory"]}
Basic:
parameters:
path:
@@ -20904,6 +22222,8 @@ examples:
application/json: {}
"404":
application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-companies-company_id-payroll_reversals:
Example:
parameters:
@@ -20942,6 +22262,8 @@ examples:
application/json: {}
"404":
application/json: {"errors": []}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
delete-v1-companies-company_id-payrolls:
speakeasy-default-delete-v1-companies-company-id-payrolls:
parameters:
@@ -20964,6 +22286,20 @@ examples:
responses:
"200":
application/json: {"payroll_deadline": "2022-02-18T22:00:00Z", "check_date": "2021-02-22", "processed": false, "processed_date": null, "calculated_at": null, "uuid": "b50e611d-8f3d-4f24-b001-46675f7b5777", "payroll_uuid": "b50e611d-8f3d-4f24-b001-46675f7b5777", "company_uuid": "6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb", "off_cycle": false, "off_cycle_reason": null, "auto_pilot": false, "external": false, "pay_period": {"start_date": "2021-02-01", "end_date": "2021-02-15", "pay_schedule_uuid": "00ebc4a4-ec88-4435-8f45-c505bb63e501"}, "payroll_status_meta": {"cancellable": false, "expected_check_date": "2022-02-22", "initial_check_date": "2022-02-22", "expected_debit_time": "2022-02-18T22:00:00Z", "payroll_late": false, "initial_debit_cutoff_time": "2022-02-18T22:00:00Z"}, "employee_compensations": [{"employee_uuid": "187412e1-3dbe-491a-bb2f-2f40323a7067", "excluded": false, "version": "4ba36d23a78c7393b4900ef38019d8ff", "first_name": "Patricia", "preferred_first_name": "Patricia", "last_name": "Hamil", "payment_method": "Direct Deposit", "fixed_compensations": [{"name": "Bonus", "amount": "100.00", "job_uuid": "94e0d15e-9ed2-4077-98f6-64554f242ba5"}, {"name": "Reimbursement", "amount": "100.00", "job_uuid": "91bc3b43-ded0-4ee7-98fe-215499e909ba"}], "hourly_compensations": [{"name": "Regular Hours", "hours": "40.000", "job_uuid": "bd378298-3e0c-4145-904a-baadf8a91fa3", "compensation_multiplier": 1, "flsa_status": "Nonexempt"}, {"name": "Overtime", "hours": "15.000", "job_uuid": "9d3760f0-d1f9-4700-8817-0fe2dce5cf23", "compensation_multiplier": 1.5, "flsa_status": "Nonexempt"}, {"name": "Double overtime", "hours": "0.000", "job_uuid": "b5eef9a9-4a87-4649-a80d-14878c05f44e", "compensation_multiplier": 2, "flsa_status": "Nonexempt"}, {"name": "Regular Hours", "hours": "40.000", "job_uuid": "332bd171-9efc-432b-abbb-a75c9dba706a", "compensation_multiplier": 1, "flsa_status": "Nonexempt"}, {"name": "Overtime", "hours": "5.000", "job_uuid": "ca9b3dc1-57ac-4736-901a-9b1c9634b9d5", "compensation_multiplier": 1.5, "flsa_status": "Nonexempt"}, {"name": "Double overtime", "hours": "0.000", "job_uuid": "1bad01e2-140c-49ed-9542-2388ce4a19b3", "compensation_multiplier": 2, "flsa_status": "Nonexempt"}], "paid_time_off": [{"name": "Vacation Hours", "hours": "20.000"}, {"name": "Sick Hours", "hours": "0.000"}, {"name": "Holiday Hours", "hours": "0.000"}]}, {"employee_uuid": "187412e1-3dbe-491a-bb2f-2f40323a7012", "excluded": false, "version": "ff083257a5583291fb86656ad0df1b42", "first_name": "Soren", "preferred_first_name": "Soren", "last_name": "Keck", "payment_method": "Direct Deposit", "fixed_compensations": [{"name": "Bonus", "amount": "100.00", "job_uuid": "94e0d15e-9ed2-4077-98f6-64554f242b34"}, {"name": "Reimbursement", "amount": "100.00", "job_uuid": "91bc3b43-ded0-4ee7-98fe-215499e90955"}], "hourly_compensations": [{"name": "Regular Hours", "hours": "40.000", "job_uuid": "bd378298-3e0c-4145-904a-baadf8a91fa3", "compensation_multiplier": 1, "flsa_status": "Commission Only Exempt"}], "paid_time_off": [{"name": "Vacation Hours", "hours": "20.000"}, {"name": "Sick Hours", "hours": "0.000"}, {"name": "Holiday Hours", "hours": "0.000"}]}, {"employee_uuid": "187412e1-3dbe-491a-bb2f-2f40323a7781", "excluded": false, "version": "259816479e3729bf855318af9b9adddf", "first_name": "Patty", "preferred_first_name": "Patty", "last_name": "Tam", "payment_method": "Direct Deposit", "fixed_compensations": [{"name": "Bonus", "amount": "100.00", "job_uuid": "94e0d15e-9ed2-4077-98f6-64554f242bab"}, {"name": "Reimbursement", "amount": "100.00", "job_uuid": "91bc3b43-ded0-4ee7-98fe-215499e909cd"}], "hourly_compensations": [{"name": "Regular Hours", "hours": "40.000", "job_uuid": "bd378298-3e0c-4145-904a-baadf8a91fa3", "compensation_multiplier": 1, "flsa_status": "Exempt"}], "paid_time_off": [{"name": "Vacation Hours", "hours": "20.000"}, {"name": "Sick Hours", "hours": "0.000"}, {"name": "Holiday Hours", "hours": "0.000"}]}], "created_at": "2022-02-01T22:00:00Z", "fixed_compensation_types": [{"name": "Bonus"}, {"name": "Commission"}, {"name": "Paycheck Tips"}, {"name": "Cash Tips"}, {"name": "Correction Payment"}, {"name": "Anniversary Bonus"}, {"name": "Internet Stipend"}, {"name": "Reimbursement"}], "processing_request": null}
+ speakeasy-default-put-v1-companies-company-id-payrolls-payroll-id-prepare:
+ parameters:
+ path:
+ company_id: ""
+ payroll_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-payment-receipts-payrolls-payroll_uuid:
speakeasy-default-get-v1-payment-receipts-payrolls-payroll-uuid:
parameters:
@@ -20986,6 +22322,17 @@ examples:
responses:
"200":
application/json: [{"key": "eftps_in_error", "message": "We could not make payments to the Electronic Federal Tax Payment System."}, {"key": "geocode_error", "message": "Company or employee address could not be verified. Please ensure all addresses are valid."}, {"key": "geocode_needed", "message": "Company or employee address verification is missing. Please ensure all addresses are entered correctly."}, {"key": "pay_schedule_setup_not_complete", "message": "Some employees don’t have a pay schedule set up yet. Please complete this step to run payroll."}, {"key": "invalid_signatory", "message": "A signatory who is authorized to sign documents on behalf of your company is required. Please ensure their identity verification is successful."}, {"key": "suspended", "message": "Company is suspended and cannot run payroll."}, {"key": "soft_suspended", "message": "Company is placed in a 'soft' suspension state and requires missing/incorrect information to be corrected."}, {"key": "pending_payroll_review", "message": "Payroll is blocked. We are reviewing payroll information in your account. Please contact support if you believe this is an error."}, {"key": "pending_recovery_case", "message": "Payroll is blocked due to an open recovery case. Please contact support if you believe this is an error."}, {"key": "pending_information_request", "message": "Payroll is blocked due to an open information request. Please contact support if you believe this is an error."}, {"key": "needs_approval", "message": "Company needs to be approved to run payroll."}, {"key": "missing_addresses", "message": "Company must add addresses in order to run payroll."}, {"key": "missing_federal_tax_setup", "message": "Company must complete federal tax setup in order to run payroll."}, {"key": "missing_industry_selection", "message": "Company must complete industry selection in order to run payroll."}, {"key": "missing_bank_info", "message": "Company must have a bank account in order to run payroll."}, {"key": "missing_employee_setup", "message": "Company must add employees in order to run payroll."}, {"key": "missing_state_tax_setup", "message": "Company must complete state tax setup in order to run payroll."}, {"key": "missing_pay_schedule", "message": "Company must have a pay schedule in order to run payroll."}, {"key": "missing_forms", "message": "Company forms must be signed in order to run payroll."}, {"key": "missing_bank_verification", "message": "Company bank account must be verified in order to run payroll."}, {"key": "missing_signatory", "message": "Company must have a verified signatory in order to run payroll."}]
+ speakeasy-default-get-v1-companies-payroll-blockers-company-uuid:
+ parameters:
+ path:
+ company_uuid: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: [{"key": "needs_approval", "message": "Company needs to be approved to run payroll."}]
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
put-api-v1-companies-company_id-payrolls-payroll_id-cancel:
Unprocessed:
parameters:
@@ -21037,6 +22384,20 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-put-api-v1-companies-company-id-payrolls-payroll-id-cancel:
+ parameters:
+ path:
+ company_id: ""
+ payroll_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {}
+ "404":
+ application/json: {"errors": []}
+ "422":
+ application/json: {"errors": []}
get-v1-payrolls-payroll_uuid-employees-employee_uuid-pay_stub:
speakeasy-default-get-v1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub:
parameters:
@@ -21073,7 +22434,7 @@ examples:
application/json: {"printing_format": "top"}
responses:
"200":
- application/json: {"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}]}
+ application/json: {"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}]}
Basic:
parameters:
path:
@@ -21135,6 +22496,8 @@ examples:
application/json: {}
"404":
application/json: {"errors": []}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
post-v1-payrolls-payroll_id-calculate_accruing_time_off_hours:
Example:
parameters:
@@ -21184,13 +22547,27 @@ examples:
responses:
"422":
application/json: {"errors": [{"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "72ae4617-daa9-4ed7-85e0-18ed5d0ee835"}, "errors": [{"error_key": "hours", "category": "invalid_attribute_value", "message": "Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]}, {"error_key": "contractor_payments", "category": "nested_errors", "metadata": {"contractor_uuid": "2d7bf62c-babf-4a12-8292-340e2d9cab28"}, "errors": [{"error_key": "wage", "category": "invalid_attribute_value", "message": "Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}
+ speakeasy-default-post-v1-payrolls-payroll-id-calculate-accruing-time-off-hours:
+ parameters:
+ path:
+ payroll_id: ""
+ employee_id: ""
+ header:
+ X-Gusto-API-Version: "2025-06-15"
+ responses:
+ "200":
+ application/json: {"hours_earned": []}
+ "404":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
+ "422":
+ application/json: {"errors": [{"error_key": "", "category": ""}]}
get-v1-time_off_policies-time_off_policy_uuid:
speakeasy-default-get-v1-time-off-policies-time-off-policy-uuid:
parameters:
path:
time_off_policy_uuid: ""
header:
- X-Gusto-API-Version: "2024-04-01"
+ X-Gusto-API-Version: "2025-06-15"
responses:
"200":
application/json: {"uuid": "3005443d-25ff-489a-ad76-0bb4465782c5", "company_uuid": "", "name": "", "policy_type": "vacation", "accrual_method": "", "is_active": false, "employees": []}
@@ -21202,7 +22579,7 @@ examples:
path:
time_off_policy_uuid: ""
header:
- X-Gusto-API-Version: "2024-04-01"
+ X-Gusto-API-Version: "2025-06-15"
requestBody:
application/json: {"name": "Vacation Policy", "version": "56d00c178bc7393b2a206ed6a86afcb4"}
responses:
@@ -21210,13 +22587,15 @@ examples:
application/json: {"uuid": "ac96e9e3-e5ef-4d38-b257-e45dfba89ad4", "company_uuid": "", "name": "", "policy_type": "sick", "accrual_method": "", "is_active": true, "employees": [{}]}
"404":
application/json: {"errors": []}
+ "422":
+ application/json: {"errors": []}
get-v1-companies-company_uuid-time_off_policies:
speakeasy-default-get-v1-companies-company-uuid-time-off-policies:
parameters:
path:
company_uuid: ""
header:
- X-Gusto-API-Version: "2024-04-01"
+ X-Gusto-API-Version: "2025-06-15"
responses:
"200":
application/json: [{"uuid": "05a4ae6a-2b56-4594-8aa7-7c9def38256e", "company_uuid": "", "name": "", "policy_type": "vacation", "accrual_method": "", "is_active": false, "employees": [{}]}]
@@ -21228,7 +22607,7 @@ examples:
path:
company_uuid: ""
header:
- X-Gusto-API-Version: "2024-04-01"
+ X-Gusto-API-Version: "2025-06-15"
requestBody:
application/json: {"name": "Vacation Policy", "policy_type": "vacation", "accrual_method": "per_pay_period"}
responses:
@@ -21236,13 +22615,15 @@ examples:
application/json: {"uuid": "0c43306b-31ee-4dbe-ac89-52c19e0746e3", "company_uuid": "", "name": "", "policy_type": "vacation", "accrual_method": "", "is_active": false, "employees": []}
"404":
application/json: {"errors": []}
+ "422":
+ application/json: {"errors": []}
put-v1-time_off_policies-time_off_policy_uuid-add_employees:
speakeasy-default-put-v1-time-off-policies-time-off-policy-uuid-add-employees:
parameters:
path:
time_off_policy_uuid: ""
header:
- X-Gusto-API-Version: "2024-04-01"
+ X-Gusto-API-Version: "2025-06-15"
requestBody:
application/json: {"employees": []}
responses:
@@ -21250,13 +22631,15 @@ examples:
application/json: {"uuid": "1d6a2760-0f42-4d8f-8b83-4cf64af727e8", "company_uuid": "", "name": "", "policy_type": "sick", "accrual_method": "", "is_active": true, "employees": []}
"404":
application/json: {"errors": []}
+ "422":
+ application/json: {"errors": []}
put-v1-time_off_policies-time_off_policy_uuid-remove_employees:
speakeasy-default-put-v1-time-off-policies-time-off-policy-uuid-remove-employees:
parameters:
path:
time_off_policy_uuid: ""
header:
- X-Gusto-API-Version: "2024-04-01"
+ X-Gusto-API-Version: "2025-06-15"
requestBody:
application/json: {"employees": []}
responses:
@@ -21264,13 +22647,15 @@ examples:
application/json: {"uuid": "6d3bc664-30a4-4198-8da5-195d780d44f9", "company_uuid": "", "name": "", "policy_type": "sick", "accrual_method": "", "is_active": false, "employees": [{}]}
"404":
application/json: {"errors": [{"error_key": "