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
benefits.enrollment_canceled
Search
All
Pages
Start typing to search…
JUMP TO
Authentication
Authentication
Create or refresh an access token
post
Endpoints
Expenses
Retrieve all expenses
get
Create expense
post
Retrieve an individual expense
get
Approve expense
post
Decline expense
post
Contract Changes
Retrieve all contract changes
get
Create request
post
Retrieve rulesets for creating a contract change
get
Retrieve an individual contract change request
get
Cancel request
post
Reseller
Retrieve all customers
get
Create customer
post
Update customer
patch
Benefits
Retrieve an engagement's enrollments
get
Request benefits
post
Retrieve an employment's available benefits offerings
get
Retrieve an employment's provisioned benefits
get
Provision benefits
put
Retrieve an enrollment
get
Retrieve benefits ruleset
get
Engagements
Retrieve rulesets for creating a self-service document request
get
Retrieve all engagements
get
Retrieve a document request for an engagement
get
Retrieve an individual engagement
get
Retrieve document requests for an engagement
get
Create a document request for an engagement
post
Retrieve documents for engagement
get
Retrieve payslips for engagement
get
Cost Estimate
Retrieve annual cost estimates for an employment
get
Retrieve monthly cost estimates for an employment
get
Employments
Update personal details
patch
Create employment
post
Fetch the employment onboarding form
get
Rulesets for updating employment of particular country and subdivision
get
Delete employment
delete
Retrieve an individual employment
get
Update employment
patch
Retrieve all agreements for employment
get
Retrieve an individual agreement
get
Upload dummy service agreement document
post
Verify agreement
post
Delete The Uploaded Employment Commission Plan
delete
Upload Employment Commission Plan
post
Upload Employment Document
post
Delete The Uploaded Employment Document
delete
Fetch the onboarding form
get
Update the onboarding form
patch
Mark onboarding form as complete
post
Upload a document to the onboarding form
put
Get a document from the onboarding form
get
Submit employment
post
Get hiring process tasks for an employment
get
Invite team member
post
Delete The Uploaded Employment Work Permit
delete
Upload Employment Work Permit
post
Role types for updating employment
get
Credit notes
Retrieve all credit notes
get
Retrieve credit notes rulesets for source statuses
get
Retrieve credit notes rulesets for source types
get
Retrieve an credit note
get
Invoices
Retrieve all invoices
get
Retrieve invoices rulesets for source statuses
get
Retrieve invoices rulesets for source types
get
Retrieve an invoice
get
Approve invoice
post
Dispute invoice
post
Retrieve invoice line items
get
Identity Verification
Retrieve the latest identity verification for an engagement
get
Create or resume a verification session
post
Offboarding
Returns list of offboardings
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
Create a draft termination for a payroll team member
post
Retrieve rulesets for drafting an offboarding for a payroll team member
get
Returns list of offboarding categories
get
Returns list of offboarding pay types
get
Returns an offboarding
get
Returns list of agreements for an offboarding
get
Request cancellation for an initiated offboarding
post
Attach documents to a draft offboarding
post
Initiate offboarding
post
Bank Accounts
Retrieve bank accounts
get
Create bank account
post
Retrieve bank account rulesets
get
Delete bank account
delete
Retrieve Bank Account details
get
Update bank account
patch
Payroll Changes
Retrieve all payroll changes
get
Create payroll change
post
Retrieve payroll changes ruleset
get
Retrieve default payroll changes ruleset
get
Retrieve default payroll changes rulesets for source types
get
Retrieve payroll changes rulesets for source types
get
Delete payroll change
delete
Retrieve a payroll change
get
Update a payroll change
patch
Company
Retrieve company details
get
Departments
Retrieve all departments
get
Webhooks
Retrieve all webhook endpoints
get
Create a webhook endpoint
post
Retrieve all webhook dispatches
get
Delete a webhook endpoint
delete
Update a webhook endpoint
patch
Send a test payload to a webhook endpoint
post
Time Off
Retrieve public holidays
get
Create time off request
post
Upload Time Off Request Attachment
post
Cancel request
post
Payments
Retrieve all charge groups
get
Retrieve a charge group
get
Retrieve charge group charges
get
Revoke wire sent confirmation
delete
Confirm wire sent
post
Retrieve a charge
get
Retrieve a payout
get
Webhook Events
Benefits
benefits.provisioning_updated
post
benefits.enrollment_applied
post
benefits.enrollment_canceled
post
benefits.enrollment_enrolled
post
benefits.enrollment_finished
post
benefits.enrollment_opted_out
post
benefits.enrollment_processing_initiated
post
benefits.enrollment_requested
post
Contract Changes
contract.change_requested
post
contract.change_updated
post
Engagements
engagements.document_deleted
post
engagements.document_request_ready
post
engagements.document_updated
post
engagements.document_uploaded
post
engagements.payslip_deleted
post
engagements.payslip_updated
post
engagements.payslip_uploaded
post
Expenses
expenses.expense_approved
post
expenses.expense_declined
post
expenses.expense_review_reverted
post
expenses.expense_created
post
Hiring
hiring.agreement_drafted
post
hiring.agreement_signed
post
hiring.agreement_updated
post
hiring.agreement_verified
post
hiring.employment_engaged
post
hiring.employment_onboarding_completed
post
hiring.employment_submitted
post
hiring.oyster_invitation_accepted
post
hiring.task_updated
post
Identity Verification
identity_verification.approved
post
identity_verification.declined
post
identity_verification.in_progress
post
identity_verification.resubmission_required
post
Invoicing
invoicing.credit_note_applied
post
invoicing.credit_note_issued
post
invoicing.credit_note_refund_initiated
post
invoicing.credit_note_refunded
post
invoicing.credit_note_voided
post
invoicing.credit_note_unapplied
post
invoicing.invoice_approved
post
invoicing.invoice_disputed
post
invoicing.invoice_issued
post
invoicing.invoice_modified
post
invoicing.invoice_reinstated
post
invoicing.invoice_voided
post
Offboarding
offboarding.agreement_generated
post
offboarding.agreement_sent_for_signature
post
offboarding.agreement_signed
post
offboarding.approved
post
offboarding.cancellation_requested
post
offboarding.cancelled
post
offboarding.engagement_terminated
post
offboarding.initiated
post
offboarding.request_updated
post
Operations
async_operation_completed
post
Payments
payments.charge_direct_debit_initiated
post
payments.charge_failed
post
payments.charge_marked_as_overdue
post
payments.charge_paid
post
payments.charge_unpaid
post
payments.charge_wire_transfer_requested
post
Time Off
time_off.request_attachment_modified
post
time_off.request_created
post
time_off.request_modified
post
time_off.request_status_changed
post
Powered by
benefits.enrollment_canceled
wbhk
benefits.enrollment_canceled
