JUMP TOGetting StartedWelcome to Remote APIAuthenticationOAuth2TokenpostIdentityGet token identitygetMagic linkMagic links generatorpostSSO ConfigurationShow the current SSO ConfigurationgetCreate the SSO ConfigurationpostShow the SSO Configuration Detailsgetsso_configuration.disabledpostsso_configuration.enabledpostsso_configuration.updatedpostBenefitsBenefit Offers By EmploymentList Benefit Offers By EmploymentgetBenefit OffersList Benefit OffersgetGet employment benefit offersgetUpserts employment benefit offersputGet a employment benefit offers JSON schemagetBenefit Renewal RequestsList Benefit Renewal RequestsgetShow Benefit Renewal RequestgetUpdates a Benefit Renewal Request ResponsepostShow benefit renewal request schemagetbenefit_renewal_request.createdpostBillingBilling DocumentsList Billing DocumentsgetShow Billing DocumentgetGet Billing Document BreakdowngetDownload a billing document PDFgetbilling_document.issuedpostCompany ManagementCompaniesList all companiesgetCreate a companypostShow form schemagetShow a companygetUpdate a companypatchUpdate a companyputcompany.activatedpostcompany.archivedpostcompany.eor_hiring.additional_information_requiredpostcompany.eor_hiring.reserve_payment_requestedpostcompany.eor_hiring.verification_completedpostcompany.manager_createdpostcompany.manager_deletedpostcompany.manager_updatedpostCompany CurrenciesList company supported currenciesgetCompany DepartmentList Company DepartmentsgetCreate New DepartmentpostCompany ManagersList Company ManagersgetCreate and invite a Company ManagerpostDeletes a Company Manager userdeleteShow company manager usergetEmploymentCompanyStructureNodesList company structure nodesgetEmployment Company Structure Nodeemployment_company_structure_node.updatedpostContractor ManagementContractor Invoice SchedulesList Contractor Invoice SchedulesgetCreate Contractor Invoice SchedulespostShow Contractor Invoice SchedulegetUpdates Contractor Invoice SchedulepatchUpdates Contractor Invoice ScheduleputContractor InvoicesList Contractor InvoicesgetShow Contractor InvoicegetContracts & LegalContract AmendmentsList Contract AmendmentgetCreate Contract AmendmentpostAutomatable Contract AmendmentpostShow form schemagetShow Contract Amendmentgetcontract_amendment.canceledpostcontract_amendment.deletedpostcontract_amendment.donepostcontract_amendment.review_startedpostcontract_amendment.submittedpostEmployment ContractsList Employment Contract.getGet employment contract pending changesgetemployment_contract.active_contract_updatedpostTravel LettersList travel letter requestsgetShow travel letter requestgetUpdates a travel letter requestpatchUpdates a travel letter requestputtravel_letter.approved_by_managerposttravel_letter.approved_by_remoteposttravel_letter.declined_by_managerposttravel_letter.declined_by_remoteposttravel_letter.requestedpostWork AuthorizationList work authorization requestsgetShow work authorization requestgetUpdate work authorization requestpatchUpdate work authorization requestputwork_authorization.approved_by_managerpostwork_authorization.approved_by_remotepostwork_authorization.cancelledpostwork_authorization.declined_by_managerpostwork_authorization.declined_by_remotepostwork_authorization.requestedpostEmploymentsemployment_contract.adjusted_during_onboardingpostCountry ManagementCountriesList countriesgetList all holidays of a countrygetShow form schemagetCustomization & IntegrationsCustom FieldsLists custom fields definitionsgetCreate Custom Field DefinitionpostShow a custom field valuegetUpdate a Custom Field ValuepatchUpdate a Custom Field ValueputList custom field value for an employmentgetcustom_field.value_updatedpostWebhook CallbacksCreate a Webhook CallbackpostDelete a Webhook CallbackdeleteUpdate a Webhook CallbackpatchDocumentsFilesUpload filepostDownload filegetEmployee LifecycleEmploymentsemployment.user_status.invitedpostEmployee OffboardingOffboardingList OffboardinggetCreate OffboardingpostShow Offboardinggetoffboarding.completedpostoffboarding.deletedpostoffboarding.donepostoffboarding.review_startedpostoffboarding.submittedpostoffboarding.submitted_to_payrollpostResignationShow ResignationgetDownload a resignation lettergetValidate resignation requestputEmployee OnboardingOnboardingCancel onboardingpostCost CalculatorList countriesgetCreates a cost estimation of employmentspostCreates PDF cost estimation of employmentspostShow region fieldsgetIdentity VerificationGet Employment ProfilegetDecline Identity VerificationpostVerify Employment Identitypostidentity_verification.verification_requiredpostProbation Completion LettersCreate probation completion letterpostShow probation completion lettergetemployment.probation_completion_letter.cancelledpostemployment.probation_completion_letter.completedpostemployment.probation_completion_letter.submittedpostProbation ExtensionsCreate Probation ExtensionpostShow Probation Extensiongetemployment.probation_period_extension.cancelledpostemployment.probation_period_extension.completedpostemployment.probation_period_extension.submittedpostEmploymentsemployment.probation.period_ending_reminder_sentpostEmployment LifecycleEmploymentsList employmentsgetCreate employmentpostShow employmentgetUpdate employmentpatchUpdate employmentputInvite employmentpostComplete onboardingpostemployment.account.updatedpostemployment.administrative_details.updatedpostemployment.details.updatedpostemployment.employment_agreement.availablepostemployment.eor_hiring.invoice_createdpostemployment.eor_hiring.proof_of_payment_acceptedpostemployment.no_longer_eligible_for_onboarding_cancellationpostemployment.onboarding.cancelledpostemployment.onboarding.completedpostemployment.onboarding_task.completedpostemployment.personal_information.updatedpostemployment.start_date.changedpostemployment.user_status.activatedpostemployment.user_status.deactivatedpostemployment.user_status.initiatedpostEmploymentJobShow employment jobgetHRISExpensesList expensesgetCreate expensepostDownload a receiptgetDownload a receipt by idgetShow expensegetUpdate an expensepatchUpdate an expenseputexpense.approvedpostexpense.createdpostexpense.declinedpostexpense.deletedpostexpense.reimbursedpostexpense.submittedpostexpense.updatedpostLeave PoliciesList Leave Policies SummarygetTime OffList Time OffgetCreate Time OffpostList Time Off TypesgetShow Time OffgetUpdate Time OffpatchUpdate Time OffputApprove Time OffpostCancel Time OffpostApprove a time off cancellation requestpostDecline a time off cancellation requestpostDecline Time Offposttimeoff.approvedposttimeoff.canceledposttimeoff.cancellation_requestedposttimeoff.date_changedposttimeoff.declinedposttimeoff.requestedposttimeoff.startedposttimeoff.takenposttimeoff.updatedpostTime Off BalancesShow Time Off BalancegetTimesheetsList timesheetsgetShow timesheetgetApprove timesheetpostSend back a timesheet for review or modificationposttimesheet.submittedpostPayrollIncentivesList IncentivesgetCreate IncentivepostDelete an IncentivedeleteShow IncentivegetUpdate IncentivepatchUpdate Incentiveputincentive.createdpostincentive.deletedpostincentive.paidpostincentive.processing_startedpostincentive.updatedpostRecurring IncentivesList Recurring IncentivegetCreate Recurring IncentivepostDelete a Recurring IncentivedeletePayroll CalendarsList EOR Payroll CalendargetList Company Payroll CalendargetPayslipsList payslipsgetShow payslipgetDownload payslip in the PDF formatgetpayslip.releasedpostPayroll RunsShow Company Payroll RunsgetList Company Payroll RunsgetTestingTest Data SynchronizationGet latest data sync eventsgetCreate test data sync jobpostSandboxCreates a Benefit Renewal RequestpostPass KYBpostApprove Contract AmendmentputCancel Contract AmendmentputCreate employmentpostUpdate employmentpatchUpdate employmentputTrigger a WebhookpostTest Json SchemaGet a mock JSON Schemagetoffboarding.submitted_to_payrollwbhk offboarding.submitted_to_payrollThis event is triggered when an offboarding request has been submitted to payroll.
