Jump to Content
Home
Guides
API Reference
Changelog
Discussions
v1.0.0
Home
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
stable
Guides
API Reference
Changelog
Discussions
expense.created
Search
All
Pages
Start typing to search…
JUMP TO
Getting Started
Welcome to Remote API
Authentication
OAuth2
Token
post
Identity
Get token identity
get
Magic link
Magic links generator
post
SSO Configuration
Show the current SSO Configuration
get
Create the SSO Configuration
post
Show the SSO Configuration Details
get
sso_configuration.disabled
post
sso_configuration.enabled
post
sso_configuration.updated
post
Company Management
Companies
List all companies
get
Create a company
post
Show form schema
get
Show a company
get
Update a company
patch
Update a company
put
company.activated
post
company.archived
post
company.eor_hiring.additional_information_required
post
company.eor_hiring.reserve_payment_requested
post
company.eor_hiring.verification_completed
post
company.manager_created
post
company.manager_deleted
post
company.manager_updated
post
company.eor_hiring.no_reserve_payment_requested
post
company.eor_hiring.referred
post
Company Currencies
List company supported currencies
get
Company Department
List Company Departments
get
Create New Department
post
Company Managers
List Company Managers
get
Create and invite a Company Manager
post
Deletes a Company Manager user
delete
Show company manager user
get
Employment Company Structure Node
List company structure nodes
get
employment_company_structure_node.updated
post
Country Management
Countries
List countries
get
List all holidays of a country
get
Show form schema
get
Customization & Integrations
Custom Fields
Lists custom fields definitions
get
Create Custom Field Definition
post
Show a custom field value
get
Update a Custom Field Value
patch
Update a Custom Field Value
put
List custom field value for an employment
get
custom_field.value_updated
post
Webhook Callbacks
Create a Webhook Callback
post
Delete a Webhook Callback
delete
Update a Webhook Callback
patch
Employee Onboarding
Onboarding
Cancel onboarding
post
Cost Calculator
List countries
get
Creates a cost estimation of employments
post
Creates PDF cost estimation of employments
post
Show region fields
get
Identity Verification
Get Employment Profile
get
Decline Identity Verification
post
Verify Employment Identity
post
identity_verification.verification_required
post
Employee Probation
Probation
employment.probation.period_ending_reminder_sent
post
Probation Extensions
Create Probation Extension
post
Show Probation Extension
get
employment.probation_period_extension.cancelled
post
employment.probation_period_extension.completed
post
employment.probation_period_extension.submitted
post
Probation Completion Letters
Create probation completion letter
post
Show probation completion letter
get
employment.probation_completion_letter.cancelled
post
employment.probation_completion_letter.completed
post
employment.probation_completion_letter.submitted
post
Employments
employment.user_status.invited
post
Employment Management
Employments
List employments
get
Create employment
post
Show employment
get
Update employment
patch
Update employment
put
Invite employment
post
Complete onboarding
post
employment.account.updated
post
employment.administrative_details.updated
post
employment.details.updated
post
employment.employment_agreement.available
post
employment.eor_hiring.invoice_created
post
employment.eor_hiring.proof_of_payment_accepted
post
employment.no_longer_eligible_for_onboarding_cancellation
post
employment.onboarding.cancelled
post
employment.onboarding.completed
post
employment.onboarding_task.completed
post
employment.personal_information.updated
post
employment.start_date.changed
post
employment.user_status.activated
post
employment.user_status.deactivated
post
employment.user_status.initiated
post
Employment Job
Show employment job
get
Employee Offboarding
Offboarding
List Offboarding
get
Create Offboarding
post
Show Offboarding
get
offboarding.completed
post
offboarding.deleted
post
offboarding.done
post
offboarding.review_started
post
offboarding.submitted
post
offboarding.submitted_to_payroll
post
Resignation
Show Resignation
get
Download a resignation letter
get
Validate resignation request
put
Contracts & Legal
Contract Amendments
List Contract Amendment
get
Create Contract Amendment
post
Automatable Contract Amendment
post
Show form schema
get
Show Contract Amendment
get
contract_amendment.canceled
post
contract_amendment.deleted
post
contract_amendment.done
post
contract_amendment.review_started
post
contract_amendment.submitted
post
Employment Contracts
List Employment Contract.
get
Get employment contract pending changes
get
employment_contract.active_contract_updated
post
Travel Letters
List travel letter requests
get
Show travel letter request
get
Updates a travel letter request
patch
Updates a travel letter request
put
travel_letter.approved_by_manager
post
travel_letter.approved_by_remote
post
travel_letter.declined_by_manager
post
travel_letter.declined_by_remote
post
travel_letter.requested
post
Work Authorization
List work authorization requests
get
Show work authorization request
get
Update work authorization request
patch
Update work authorization request
put
work_authorization.approved_by_manager
post
work_authorization.approved_by_remote
post
work_authorization.cancelled
post
work_authorization.declined_by_manager
post
work_authorization.declined_by_remote
post
work_authorization.requested
post
Employments
employment_contract.adjusted_during_onboarding
post
Contractor Management
Contractor Invoice Schedules
List Contractor Invoice Schedules
get
Create Contractor Invoice Schedules
post
Show Contractor Invoice Schedule
get
Updates Contractor Invoice Schedule
patch
Updates Contractor Invoice Schedule
put
Contractor Invoices
List Contractor Invoices
get
Show Contractor Invoice
get
Payroll
Incentives
List Incentives
get
Create Incentive
post
Delete an Incentive
delete
Show Incentive
get
Update Incentive
patch
Update Incentive
put
incentive.created
post
incentive.deleted
post
incentive.paid
post
incentive.processing_started
post
incentive.updated
post
Recurring Incentives
List Recurring Incentive
get
Create Recurring Incentive
post
Delete a Recurring Incentive
delete
Payroll Calendars
List EOR Payroll Calendar
get
List Company Payroll Calendar
get
Payslips
List payslips
get
Show payslip
get
Download payslip in the PDF format
get
payslip.released
post
Payroll Runs
Show Company Payroll Runs
get
List Company Payroll Runs
get
Benefits
Benefit Offers By Employment
List Benefit Offers By Employment
get
Benefit Offers
List Benefit Offers
get
Get employment benefit offers
get
Upserts employment benefit offers
put
Get a employment benefit offers JSON schema
get
Benefit Renewal Requests
List Benefit Renewal Requests
get
Show Benefit Renewal Request
get
Updates a Benefit Renewal Request Response
post
Show benefit renewal request schema
get
benefit_renewal_request.created
post
HRIS
Expenses
List expenses
get
Create expense
post
Download a receipt
get
Download a receipt by id
get
Show expense
get
Update an expense
patch
Update an expense
put
expense.approved
post
expense.created
post
expense.declined
post
expense.deleted
post
expense.reimbursed
post
expense.submitted
post
expense.updated
post
Leave Policies
List Leave Policies Summary
get
Time Off
List Time Off
get
Create Time Off
post
List Time Off Types
get
Show Time Off
get
Update Time Off
patch
Update Time Off
put
Approve Time Off
post
Cancel Time Off
post
Approve a time off cancellation request
post
Decline a time off cancellation request
post
Decline Time Off
post
timeoff.approved
post
timeoff.canceled
post
timeoff.cancellation_requested
post
timeoff.date_changed
post
timeoff.declined
post
timeoff.requested
post
timeoff.started
post
timeoff.taken
post
timeoff.updated
post
Time Off Balances
Show Time Off Balance
get
Timesheets
List timesheets
get
Show timesheet
get
Approve timesheet
post
Send back a timesheet for review or modification
post
timesheet.submitted
post
Billing
Billing Documents
List Billing Documents
get
Show Billing Document
get
Get Billing Document Breakdown
get
Download a billing document PDF
get
billing_document.issued
post
Documents
Files
Upload file
post
Download file
get
Testing
Test Data Synchronization
Get latest data sync events
get
Create test data sync job
post
Sandbox
Creates a Benefit Renewal Request
post
Pass KYB
post
Approve Contract Amendment
put
Cancel Contract Amendment
put
Create employment
post
Update employment
patch
Update employment
put
Trigger a Webhook
post
Test Json Schema
Get a mock JSON Schema
get
Employment Lifecycle
Employments
employment.user_status.invited
post
expense.created
wbhk
expense.created
This event is triggered when a draft expense is created.
