Jump to Content
Guides
Recipes
API Reference
Changelog
v2.13.2
v2.13.3
v2.14.0
v2.15.0
v2.15.1
v2.15.2
v2.16.0
v2.16.1
v2.16.2
v2.16.3
v2.17.0
v2.18.0
v2.18.1
v2.18.2
v2.19.0
v2.19.1
v2.19.2
API Reference
Moon (Dark Mode)
Sun (Light Mode)
v2.19.2
Guides
Recipes
API Reference
Changelog
Amendments
Search
JUMP TO
Contractors
Terminations
List contract termination reasons
get
Terminate contract
post
Contractors
Create a new contract
post
Amend contract
post
Preview a contract agreement
get
Invoices
Delete adjustment
del
Update an invoice adjustment
patch
Create an invoice adjustment
post
Invoice line item by Id
get
List invoice adjustments
get
Review a single invoice adjustment
post
Invoice line items by contract
get
Milestones
Create a Milestone
post
Retrieve Milestones by Contract
get
Retrieve a single milestone
get
Delete a Milestone
del
Off-cycle Payments
Add off-cycle payment
post
List of off-cycle payments
get
Retrieve a single off-cycle payment
get
Tasks
Review multiple tasks
post
Create a new task
post
Update Task By ID
patch
List of tasks
get
Delete task
del
Review a single task
post
Timesheets
List of timesheets
get
Update Hourly Report Preset
patch
Get Hourly Report Preset by ID
get
Update a timesheet entry
patch
Create Hourly Report Root Preset
post
Create Hourly Report Preset
post
Get Hourly Report Presets
get
Create a timesheet entry
post
Retrieve a single timesheet entry
get
Delete a timesheet entry
del
List of timesheets by contract
get
Review a single timesheet
post
Employee of Record
Hiring
Get EOR Additional Costs
get
Retrieve EOR Contract Details
get
List of job scope templates for EOR contracts
get
Calculate Employee Costs Globally
post
Retrieve detailed hiring guide for a country
get
Update EOR Contract
patch
Cancel EOR Contract
post
Delay EOR employee onboarding
patch
Amendments
Retrieve Effective Date Limitations
get
Accept a contract amendment on behalf of the client.
post
Cancel amendment
del
Confirm an existing contract amendment
post
Create an EOR contract amendment
post
Get EOR Contract Amendment PDF Download Link for Client and Employee
get
List all amendments for an EOR contract
get
Validate amendment data points
post
Sign a contract amendment (employee)
post
View information about amendment
get
Update a specific EOR contract amendment
patch
Terminations
Request EOR Contract Resignation
post
Termination Request
post
Get termination
get
Payslips
Retrieve payslip PDF download link
get
Retrieve employee payslip records
get
EOR
List of tax documents for an employee
get
Fetch Start Date for EOR Contracts
get
Retrieve Benefits by Country
get
Retrieve bank account guide
get
Create an EOR contract
post
Add bank account
post
Fetch EOR contract documents
get
Create EOR Worker
post
Acknowledge a compliance document
post
Update additional information
patch
Retrieve bank account guide
get
Retrieve Offboarding Request
get
Upload employee compliance document
post
Request job scope validation
post
Create magic link
post
Sign EOR contract document
post
Submit employee sign-off review for offboarding documents
post
List HR verification letters and documents
get
Accept EOR project assignment as client
post
Update Employee Information for EOR Contract
patch
Retrieve Benefits for Employee
get
Get amendment validation settings for an EOR contract
get
Retrieve worker resignations
get
Retrieve Benefits for EOR Contract
get
Preview job offer letter
get
Change EOR Mailbox Password
post
Fetch EOR contract document
get
Download submitted compliance document
get
Fetch EOR project assignment PDF
get
Sign a contract
post
Retrieve Employee Time Off Data for Offboarding
get
Download employee agreement PDF
get
Download employee compliance document template
get
Add additional information
post
Sign Resignation Letter
post
List of employee compliance documents
get
Get additional information required to request employee termination
get
Initiate EOR contract termination request
post
Submit employee resignation PTO review
post
Review, approve, or request changes to EOR offboarding documents
post
Submit EOR Worker Resignation
post
Preview Resignation Letter
get
Retrieve restricted offboarding dates
get
Request contract resignation
post
Retrieve offboarding attachment
get
Submit Project Assignment Checkin Questionnaire Data
post
Fetch Project Assignment Checkin Questionnaire Data
get
HRX Documents
Retrieve HRX documents
get
Download HRX documents
get
Global Payroll
Hiring
Create a contract
post
Bank Accounts
Add bank account
post
Retrieve bank accounts
get
Retrieve bank guide
get
Modify bank account
patch
Terminations
Request termination
post
G2N Reports
Download gross to net report
get
List payroll events by legal entity
get
List gross-to-net report.
get
Payslips
Retrieve employee payslips
get
Download payslip PDF
get
Global Payroll
Update address
patch
Update PTO policy
patch
Update employee information
patch
Retrieve additional information fields for GP workers by country
get
Update compensation
patch
Update GP Workers Additional Information
patch
Add GP Workers Additional Information
post
Time Tracking Shifts
Create shifts
post
Update raw shift
patch
Delete a Shift by External ID
del
Create raw shifts
post
List of shifts
get
Get shift details
get
Update a shift
patch
Time Tracking Rates
Update a shift rate
patch
Retrieve a Shift Rate by External ID
get
Delete a ShiftRate by external ID
del
Retrieve a Paginated List of Shift Rates
get
Create a New Shift Rate
post
people
Custom Fields
Update custom field value
put
Retrieve custom fields for a contract
get
Update custom field value
put
List all custom fields
get
Delete Contract custom field by Id
del
Retrieve custom fields for a worker
get
Get custom fields from contracts
get
Delete the custom field value from Worker by Id
del
Get custom field from people by id
get
List all custom fields
get
Organization structure
Update organization structure
put
Get Organization Structure
get
Time Off
List time-off requests
get
Get Time Off Events for Profile
get
List time-off requests for Organization
get
Validate time-off request
post
Retrieve policy validation templates
get
List policies
get
Get Profile Entitlements
get
Approve/Reject time-off requests
post
Create time-off request
post
Update time-off request
patch
Cancel time-off request
del
External HR Time Off Synchronization
post
Get Work Schedule and Holidays
get
Managers
Retrieve List of Managers
get
Create a Manager
post
Generate magic link for manager login
post
People
Create a person without a contract
post
Update personal information
patch
Update working location
put
Create a direct employee
post
List of people
get
Get personal information by id
get
Get my current personal profile
get
Retrieve a single person
get
Update personal information by external id
patch
Get worker profile by external ID
get
Adjustments
Create a new adjustment
post
Update an adjustment
patch
Retrieve an adjustment
get
Delete an adjustment
del
Retrieve adjustments
get
Retrieve categories
get
Worker Relations
List of worker relations
get
Delete a worker relation
del
Delete a worker relation by external id
del
Fetch Worker Relations of a given HrisProfile by external id
get
Update a worker relation type
patch
Delete a worker relation type
del
Create a parent worker relation with external id
put
Create child worker relation
put
Create a parent worker relation
put
Create worker relation with external Ids
post
Create a worker relation
post
Delete a worker relation type by external id
del
Update a worker relation type by external id
patch
Create worker relation type
post
Retrieve all worker relation types
get
Create child worker relation with external Id
put
Offboarding
Retrieve termination details
get
Retrieve termination details
get
Retrieve offboarding list
get
Deel IT
IT assets
Retrieve an IT asset
get
List IT assets
get
IT policies
List IT hardware policies
get
IT orders
Retrieve an IT order
get
List IT orders
get
Deel REST API
Contracts
Get an estimate of withholding amount given an equity event.
get
External Id
patch
Sign worker contract
post
Retrieve contract templates
get
Retrieve a single contract
get
Get worker invite link
get
Sign amendment
post
Send contract to worker
post
Remove invite
del
List contract amendments
get
Attach a file to contract
post
Retrieve contractor payment dates
get
Reject contract
post
Retrieve contract PDF download link
get
Sign a contract
post
List of contracts
get
Candidates
Add Candidate
post
Immigration
Immigration case details
get
Retrieve onboarding right-to-work case for a worker
get
Create an immigration case
post
Retrieve a required document for a case
get
Immigration visa types
get
Upload a required immigration document
post
Immigration document
get
Onboarding
Get onboarding details by employee HRIS profile ID
get
Get onboarding details by onboarding tracker ID
get
List onboarding employees
get
Payouts
Change the auto-withdrawal setting
patch
Get the auto-withdrawal setting
get
Request to withdraw funds
post
List Contractor Balances
get
Reports
Detailed payments report
get
Screenings
Create Veriff session
post
Get worker's KYC details
get
AML API for Whitelabel - Data retrieval
get
Submit external KYC
post
Get verification method
get
Create manual verification screening
post
ATS
Retrieve a list of ATS job postings
get
Retrieve paginated list of ATS Rejection/Archivation reasons
get
Retrieve a list of ATS application sources
get
Retrieve a list of ATS offers
get
Retrieve paginated list of ATS attachment files
get
Retrieve a list of ATS jobs
get
Retrieve paginated list of ATS Candidates
get
Retrieve ATS job posting
get
Retrieve a list of ATS applications
get
Learning
Retrieve worker's actionable journeys
get
Projects
Delete Hourly Report Preset
del
Get Hourly Report Root Presets
get
Get Hourly Report Root Preset by ID
get
Equity Tokens
Create equity or token tax event
post
Forms
Fetch EOR Contract form
get
Get worker additional fields for (EOR)
get
Fetch multiple EOR Contract forms
post
Treasury
Create Vendor Bill
post
Upload Vendor Bill Attachment
post
Knowledge Hub
Get Knowledge Hub Country Guides by Country Code
get
Cost Centers
Get cost centers by legal entity
get
Sync cost centers for legal entity
post
Accounting API
Accounting
Retrieve a payment breakdown
get
Get invoice by id
get
Retrieve invoices
get
Download invoice PDF
get
Retrieve Deel invoices
get
Retrieve payment receipts
get
Deel HRIS SCIM API
User
List users
get
Retrieve a single User
get
Organization
Groups
Delete a group
del
Clone a Group
post
Edit a group
patch
Return list of groups
get
Create a group
post
Legal Entities
Get legal entity payroll settings from organization integrated with external benefits vendor
get
Create a new legal entity
post
List of all industry subcategories.
get
Delete a legal entity
del
Edit a legal entity
patch
Lookups
Retrieve Seniority Levels
get
Retrieve Time-Off Types
get
Retrieve Supported Currency List
get
Retrieve lookup information for currencies, countries, entity types, etc
get
Job titles list
get
Retrieve Country List
get
Organizations
Get Current Organization
get
Create child organization
post
Retrieve working locations
get
Retrieve Departments
get
Get Team List
get
List of legal entities
get
Webhooks
Webhooks
List of webhooks
get
Create a webhook
post
Retrieve a single webhook
get
Edit a webhook
patch
Delete a webhook
del
List of webhook event types
get
Powered by
Amendments
