Jump to Content
Guides
API Reference
Changelog
v0.1
v1
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1
Guides
API Reference
Changelog
benefits.enrollment_enrolled
Search
All
Pages
Start typing to 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
Time Off
Retrieve entitlements for individual engagement
get
Retrieve entitlements
get
Retrieve public holidays
get
Approve request
post
Upload Time Off Request Attachment
post
Reject request
post
Retrieve an individual request
get
Create time off request
post
Retrieve all requests
get
Contract Changes
Cancel request
post
Retrieve an individual contract change request
get
Create request
post
Retrieve all contract changes
get
Employments
Delete The Uploaded Employment Commission Plan
delete
Retrieve an individual agreement
get
Upload Employment Commission Plan
post
Verify agreement
post
Delete The Uploaded Employment Document
delete
Retrieve all agreements for employment
get
Delete The Uploaded Employment Work Permit
delete
Delete employment
delete
Upload Employment Work Permit
post
Retrieve an individual employment
get
Submit employment
post
Update employment
patch
Upload Employment Document
post
Create employment
post
Mark onboarding form as complete
post
Rulesets for updating employment of particular country and subdivision
get
Fetch the onboarding form
get
Role types for updating employment
get
Update the onboarding form
patch
Upload a document to the onboarding form
put
Invite team member
post
Get a document from the onboarding form
get
Fetch the employment onboarding form
get
Offboarding
Attach documents to a draft offboarding
post
Request cancellation for an initiated offboarding
post
Initiate 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
Retrieve an individual payroll
get
Retrieve all payroll
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
Reseller
Create customer
post
Retrieve all customers
get
Update customer
patch
Company
Retrieve company details
get
Departments
Retrieve all departments
get
Engagements
Retrieve an individual engagement
get
Retrieve all engagements
get
Operations
Retrieve an operation
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
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_enrolled
wbhk
benefits.enrollment_enrolled
