Jump to Content
Guides
API Reference
Changelog
v0.1
v1
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Public Beta
Guides
API Reference
Changelog
offboarding.agreement_generated
Search
JUMP TO
Authentication
Authentication
Create or refresh an access token
post
Endpoints
Expenses
Approve expense
post
Decline expense
post
Retrieve an individual expense
get
Create expense
post
Retrieve all expenses
get
Contract Changes
Cancel request
post
Retrieve an individual contract change request
get
Create request
post
Retrieve all contract changes
get
Retrieve rulesets for creating a contract change
get
Reseller
Create customer
post
Retrieve all customers
get
Update customer
patch
Benefits
Retrieve an employment's available benefits offerings
get
Retrieve an employment's provisioned benefits
get
Provision benefits
put
Retrieve benefits ruleset
get
Cost Estimate
Retrieve annual cost estimates for an employment
get
Retrieve monthly cost estimates for an employment
get
Employments
Retrieve an individual agreement
get
Verify agreement
post
Retrieve all agreements for employment
get
Delete The Uploaded Employment Commission Plan
delete
Upload Employment Commission Plan
post
Delete The Uploaded Employment Document
delete
Delete employment
delete
Retrieve an individual employment
get
Update employment
patch
Delete The Uploaded Employment Work Permit
delete
Upload Employment Work Permit
post
Mark onboarding form as complete
post
Fetch the onboarding form
get
Update the onboarding form
patch
Upload a document to the onboarding form
put
Submit employment
post
Upload Employment Document
post
Create employment
post
Fetch the employment onboarding form
get
Rulesets for updating employment of particular country and subdivision
get
Role types for updating employment
get
Credit notes
Retrieve all credit notes
get
Invoices
Retrieve all invoices
get
Retrieve an invoice
get
Identity Verification
Create or resume a verification session
post
Retrieve the latest identity verification for an engagement
get
Offboarding
Attach documents to a draft offboarding
post
Request cancellation for an initiated offboarding
post
Initiate a draft offboarding
post
Returns an offboarding
get
Create a draft resignation for a contractor
post
Create a draft termination for a contractor
post
Create a draft resignation for an employment
post
Create a draft termination for an employment
post
Returns list of offboardings
get
Create a draft termination for a payroll team member
post
Returns list of offboarding categories
get
Returns list of offboarding pay types
get
Bank Accounts
Delete bank account
delete
Retrieve Bank Account details
get
Update bank account
patch
Create bank account
post
Retrieve bank accounts
get
Retrieve bank account rulesets
get
Payroll Changes
Create payroll change
post
Retrieve all payroll changes
get
Delete payroll change
delete
Update a payroll change
patch
Retrieve a payroll change
get
Retrieve payroll changes ruleset
get
Retrieve default payroll changes ruleset
get
Retrieve payroll changes rulesets for source types
get
Retrieve default payroll changes rulesets for source types
get
Company
Retrieve company details
get
Departments
Retrieve all departments
get
Engagements
Retrieve documents for engagement
get
Retrieve payslips for engagement
get
Retrieve an individual engagement
get
Retrieve all engagements
get
Webhooks
Delete a webhook endpoint
delete
Update a webhook endpoint
patch
Send a test payload to a webhook endpoint
post
Create a webhook endpoint
post
Retrieve all webhook endpoints
get
Retrieve all webhook dispatches
get
Time Off
Retrieve public holidays
get
Upload Time Off Request Attachment
post
Cancel request
post
Create time off request
post
Webhook Events
Hiring
hiring.employment_engaged
post
hiring.oyster_invitation_accepted
post
hiring.employment_submitted
post
hiring.agreement_drafted
post
hiring.agreement_signed
post
hiring.agreement_updated
post
hiring.agreement_verified
post
hiring.employment_onboarding_completed
post
Invoicing
invoicing.invoice_issued
post
invoicing.invoice_approved
post
invoicing.invoice_voided
post
invoicing.invoice_disputed
post
invoicing.credit_note_issued
post
Payments
payments.charge_paid
post
payments.charge_failed
post
payments.charge_unpaid
post
payments.charge_direct_debit_initiated
post
payments.charge_wire_transfer_requested
post
Identity Verification
identity_verification.approved
post
identity_verification.declined
post
identity_verification.in_progress
post
identity_verification.resubmission_required
post
Expenses
expenses.expense_created
post
expenses.expense_approved
post
expenses.expense_declined
post
expenses.expense_review_reverted
post
Contract Changes
contract.change_requested
post
contract.change_updated
post
Time Off
time_off.request_status_changed
post
time_off.request_attachment_modified
post
time_off.request_created
post
time_off.request_modified
post
Engagements
engagements.document_uploaded
post
engagements.document_updated
post
engagements.document_deleted
post
engagements.payslip_uploaded
post
engagements.payslip_updated
post
engagements.payslip_deleted
post
Operations
async_operation_completed
post
Offboarding
offboarding.agreement_generated
post
offboarding.agreement_sent_for_signature
post
offboarding.agreement_signed
post
Powered by
offboarding.agreement_generated
wbhk
offboarding.agreement_generated
