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
contract.change_amendment_process_started
Search
All
Pages
Start typing to search…
JUMP TO
Authentication
Authentication
Create or refresh an access token
post
Endpoints
Company
Retrieve company details
get
Departments
Retrieve all departments
get
Reseller
Retrieve all customers
get
Create customer
post
Update customer
patch
Hiring & Onboarding
Get hiring process tasks for an employment
get
Retrieve an individual employment
get
Invite team member
post
Create employment
post
Submit employment
post
Update employment
patch
Delete employment
del
Identity Verification
Retrieve the latest identity verification for an engagement
get
Create or resume a verification session
post
Cost Estimate
Retrieve annual cost estimates for an employment
get
Retrieve monthly cost estimates for an employment
get
Onboarding Forms
Get a document from the onboarding form
get
Fetch the onboarding form
get
Fetch the employment onboarding form
get
Mark onboarding form as complete
post
Update the onboarding form
patch
Agreements
Retrieve an individual agreement
get
Retrieve all agreements for employment
get
Verify agreement
post
Upload a document to the onboarding form
put
Documents
Upload Employment Commission Plan
post
Upload Employment Document
post
Upload Employment Work Permit
post
Delete The Uploaded Employment Work Permit
del
Delete The Uploaded Employment Document
del
Delete The Uploaded Employment Commission Plan
del
Rulesets
Rulesets for updating employment of particular country and subdivision
get
Role types for updating employment
get
Team Member Management
Team Member Information
Retrieve all engagements
get
Retrieve an individual engagement
get
Retrieve allowances for engagement
get
Retrieve bonuses for engagement
get
Update personal details
patch
Documents
Retrieve documents for engagement
get
Retrieve individual document for engagement
get
Retrieve a document request for an engagement
get
Retrieve document requests for an engagement
get
Retrieve payslips for engagement
get
Create a document request for an engagement
post
Contract Changes
Retrieve all contract changes
get
Retrieve an individual contract change request
get
Create request
post
Cancel request
post
Benefits
Retrieve an engagement's enrollments
get
Retrieve an employment's available benefits offerings
get
Retrieve an employment's provisioned benefits
get
Retrieve an enrollment
get
Request benefits
post
Provision benefits
put
Expenses
Retrieve all expenses
get
Retrieve an individual expense
get
Create expense
post
Approve expense
post
Decline expense
post
Time Off
Retrieve public holidays
get
Create time off request
post
Upload Time Off Request Attachment
post
Cancel request
post
Time Tracking
Retrieve all time sheets
get
Retrieve an individual time sheet
get
Create a time sheet
post
Create time sheet entry
post
Submit time sheet
post
Confirm a time sheet
post
Update time sheet entry
patch
Delete time sheet entry
del
Delete an individual time sheet
del
Rulesets
Retrieve time tracking rulesets for engagement
get
Retrieve time tracking sources by source type for engagement
get
Retrieve rulesets for creating a contract change
get
Retrieve benefits ruleset
get
Retrieve rulesets for creating a self-service document request
get
Offboarding
Returns list of offboardings
get
Returns list of agreements for an offboarding
get
Returns an offboarding
get
Request cancellation for an initiated offboarding
post
Attach documents to a draft offboarding
post
Initiate offboarding
post
Resignation
Create a draft resignation for an employment
post
Create a draft resignation for a contractor
post
Termination
Create a draft termination for a contractor
post
Create a draft termination for a payroll team member
post
Create a draft termination for an employment
post
Rulesets
Returns list of offboarding pay types
get
Returns list of offboarding categories
get
Retrieve rulesets for drafting an offboarding for a payroll team member
get
Finance
Bank Accounts
Retrieve bank accounts
get
Retrieve Bank Account details
get
Create bank account
post
Update bank account
patch
Delete bank account
del
Credit notes
Retrieve all credit notes
get
Retrieve credit notes rulesets for source statuses
get
Retrieve credit notes rulesets for source types
get
Retrieve a credit note
get
Invoices
Retrieve all invoices
get
Retrieve an invoice
get
Retrieve invoice breakdown
get
Approve invoice
post
Dispute invoice
post
Rulesets
Retrieve bank account rulesets
get
Retrieve invoices rulesets for source types
get
Retrieve invoices rulesets for source statuses
get
Payments
Retrieve all charge groups
get
Retrieve charge group charges
get
Retrieve a charge group
get
Retrieve a charge
get
Retrieve a payout
get
Confirm wire sent
post
Revoke wire sent confirmation
del
Payroll
Retrieve payroll records for individual payroll
get
Payroll Changes
Retrieve all payroll changes
get
Retrieve a payroll change
get
Create payroll change
post
Update a payroll change
patch
Cancel payroll change
del
Cancel payroll change
post
Rulesets
Retrieve default payroll changes rulesets for source types
get
Retrieve default payroll changes ruleset
get
Retrieve payroll changes ruleset
get
Retrieve payroll changes rulesets for source types
get
API Operations
Retrieve an operation
get
Webhooks
Retrieve all webhook endpoints
get
Retrieve all webhook dispatches
get
Create a webhook endpoint
post
Send a test payload to a webhook endpoint
post
Update a webhook endpoint
patch
Delete a webhook endpoint
del
Calculators
Calculate cost of employment
post
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
contract.change_amendment_process_started
post
contract.change_applied
post
contract.change_approved
post
contract.change_cancelled
post
contract.change_pending_cancellation
post
contract.change_submitted
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
hiring.agreement_accepted
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
payments.charge_group_paid
post
payments.charge_group_unpaid
post
payments.charge_group_wire_transfer_requested
post
Payroll
payroll.contractor_fees_invoice_generated
post
payroll.contractor_fees_invoicing_initialized
post
payroll.pre_funding_invoice_created
post
payroll.settlement_invoice_created
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
Time Tracking
time_tracking.time_sheet_amendment_added
post
time_tracking.time_sheet_amendment_removed
post
time_tracking.time_sheet_approved
post
time_tracking.time_sheet_pending_approval
post
time_tracking.time_sheet_pending_submission
post
time_tracking.time_sheet_submitted
post
time_tracking.time_sheet_created
post
time_tracking.time_sheet_deleted
post
time_tracking.time_sheet_entries_modified
post
time_tracking.time_sheet_reviewed
post
Powered by
contract.change_amendment_process_started
wbhk
contract.change_amendment_process_started
