Deel

App · 25 actions

Work with your Deel organization from workflows: find people and contracts, request and approve time off, log and approve contractors' timesheets, add bonuses and expenses to invoices, and read invoices and payments.

Actions

ActionWhat it does
Add invoice adjustmentAdd a bonus, expense, deduction or other amount to a contractor's next invoice.
Add timesheetLog hours on a contractor's contract.
Approve or decline timesheetApprove a timesheet entry, so it is paid on the next invoice, or decline it.
Approve or reject time offApprove or reject a time-off request that is waiting for approval.
Cancel time-off requestCancel a time-off request, whether it is waiting or approved.
Change time-off requestChange the days, policy or description of a time-off request.
Change timesheetChange the hours and description of a timesheet entry.
Delete invoice adjustmentDelete an invoice adjustment before it is invoiced.
Delete timesheetDelete a timesheet entry for good.
Get contractGet one contract with its worker, job title, pay, dates and status.
Get organizationGet your Deel organization's name and id.
Get personGet one person's details: job, department, manager, legal entity and current contract.
Get time-off balancesGet how much time off a person has, has used and has left on each of their policies.
List contractsList contracts, optionally only some statuses or types, one legal entity or team, or those matching a name.
List departmentsList the departments in your Deel organization.
List invoice adjustmentsList bonuses, expenses, deductions and other lines added to contractors' invoices, optionally for one contract, type, status or date range.
List invoicesList invoices: paid ones, or every invoice, optionally those issued in a date range.
List legal entitiesList the companies (legal entities) in your Deel organization.
List paymentsList the payments your organization made to Deel, with their totals and how they were paid.
List peopleList the contractors and employees in Deel, optionally only those matching a name, in a team, or hired a certain way.
List time-off policiesList your organization's time-off policies and how many people each covers.
List time-off requestsList time-off requests across your organization, optionally only some statuses, those in a date range, or those changed since a time.
List timesheetsList contractors' timesheet entries, optionally for one contract, in some statuses, or for work in a date range.
Request time offRequest time off for a person under one of their policies.
Set contract IDSave your own id on a contract, such as an employee number from your HR or finance system, to find it by later.

Add invoice adjustment

Add a bonus, expense, deduction or other amount to a contractor's next invoice. It waits for review unless you approve it right away.

Inputs

Contractcontract_idtextRequired
The contractor's contract. Pick one, or give its id from 'List contracts'.
Typeadjustment_typetextRequired
What the amount is for.One of: bonus, commission, expense, overtime, deduction, time_off (Time off), other.
AmountamountnumberRequired
The amount, in the contract's currency.At least 0.01.
DescriptiondescriptiontextRequired
What it is for. It shows on the invoice.
Datedate_submitteddate
The day it applies to. Defaults to today.
Approve right awayapprovetrue/false
Approve it now instead of leaving it for review. Approved items are paid on the next invoice.Default: false.

Outputs

created_attext
When it was added
invoice_adjustment_idtext
The new adjustment's id
statustext
Its status, such as pending
Example output
{
  "created_at": "2026-06-29T14:22:08.512Z",
  "invoice_adjustment_id": "abcdef01-2345-6789-abcd-ef0123456789",
  "status": "pending"
}

Add timesheet

Log hours on a contractor's contract. The entry waits for review unless you approve it right away.

Inputs

Contractcontract_idtextRequired
The contractor's contract. Pick one, or give its id from 'List contracts'.
HourshoursnumberRequired
Hours worked (or other units, as the contract counts them), such as 7.5.At least 0.01.
DescriptiondescriptiontextRequired
What the work was. It shows on the invoice.
Work datework_datedate
The day the work was done. Defaults to today.
Approve right awayapprovetrue/false
Approve it now instead of leaving it for review. Approved items are paid on the next invoice.Default: false.

Outputs

created_attext
When it was added
statustext
Its status, such as pending
timesheet_idtext
The new timesheet's id
Example output
{
  "created_at": "2026-06-29T14:22:08.512Z",
  "status": "pending",
  "timesheet_id": "12345678-abcd-fedc-dcba-987654321abc"
}

Approve or decline timesheet

Approve a timesheet entry, so it is paid on the next invoice, or decline it.

Inputs

Timesheet IDtimesheet_idtextRequired
The timesheet's id, from 'List timesheets' or 'Add timesheet'.
DecisiondecisiontextRequired
Approve or decline the entry.One of: approved (Approve), declined (Decline).
Reasonreasontext
Why, shown to the contractor. Most useful when declining.

Outputs

statustext
approved or declined
timesheet_idtext
The timesheet reviewed
Example output
{
  "status": "approved",
  "timesheet_id": "00000000-0000-0000-0000-000000000000"
}

Approve or reject time off

Approve or reject a time-off request that is waiting for approval. A rejection can't be undone.

Inputs

Time-off request IDtime_off_idtextRequired
The request's id, from 'List time-off requests', 'Request time off' or a trigger.
DecisiondecisiontextRequired
Approve or reject the request.One of: APPROVED (Approve), REJECTED (Reject).

Outputs

statustext
Its status now: APPROVED, USED or REJECTED
time_off_idtext
The request reviewed
Example output
{
  "status": "APPROVED",
  "time_off_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}

Cancel time-off request

Cancel a time-off request, whether it is waiting or approved. This can't be undone.

Inputs

Time-off request IDtime_off_idtextRequired
The request's id, from 'List time-off requests', 'Request time off' or a trigger.

Outputs

canceledtrue/false
True once canceled
time_off_idtext
The request canceled
Example output
{
  "canceled": true,
  "time_off_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}

Change time-off request

Change the days, policy or description of a time-off request.

Inputs

Time-off request IDtime_off_idtextRequired
The request's id, from 'List time-off requests', 'Request time off' or a trigger.
First daystart_datedateRequired
The first day off.
Last dayend_datedate
The last day off. Defaults to the first day, for a single day.
Time-off policypolicy_idtext
A different policy for it. Leave empty to keep its policy.
Descriptiondescriptiontext
A note for the approver. Some policies require one.

Outputs

time_offobject
The time-off request
Example output
{
  "time_off": {
    "amount": 1.0,
    "approved_at": "",
    "canceled_at": "",
    "contract_id": "d290f1ee6c54",
    "created_at": "2021-07-01T11:22:33.444Z",
    "description": "Vacation",
    "end_date": "2021-08-01",
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "is_paid": false,
    "person_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "policy_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "reason": "Sick leave - Doctor appointment",
    "requested_at": "2021-07-01",
    "start_date": "2021-08-01",
    "status": "REQUESTED",
    "time_off_type": "Vacation",
    "time_off_type_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "unit": "CALENDAR_DAY",
    "updated_at": "2021-07-01T11:22:33.444Z"
  }
}

Change timesheet

Change the hours and description of a timesheet entry.

Inputs

Timesheet IDtimesheet_idtextRequired
The timesheet's id, from 'List timesheets' or 'Add timesheet'.
HourshoursnumberRequired
Hours worked (or other units, as the contract counts them), such as 7.5.At least 0.01.
DescriptiondescriptiontextRequired
What the work was. It shows on the invoice.

Outputs

timesheet_idtext
The timesheet changed
updatedtrue/false
True once changed
Example output
{
  "timesheet_id": "00000000-0000-0000-0000-000000000000",
  "updated": true
}

Delete invoice adjustment

Delete an invoice adjustment before it is invoiced.

Inputs

Invoice adjustment IDinvoice_adjustment_idtextRequired
The adjustment's id, from 'List invoice adjustments' or 'Add invoice adjustment'.

Outputs

deletedtrue/false
True once deleted
invoice_adjustment_idtext
The adjustment deleted
Example output
{
  "deleted": true,
  "invoice_adjustment_id": "550e8400-e29b-41d4-a716-446655440000"
}

Delete timesheet

Delete a timesheet entry for good.

Inputs

Timesheet IDtimesheet_idtextRequired
The timesheet's id, from 'List timesheets' or 'Add timesheet'.
Reasonreasontext
Why it was deleted, kept on record.

Outputs

deletedtrue/false
True once deleted
timesheet_idtext
The timesheet deleted
Example output
{
  "deleted": true,
  "timesheet_id": "00000000-0000-0000-0000-000000000000"
}

Get contract

Get one contract with its worker, job title, pay, dates and status.

Inputs

Contractcontract_idtextRequired
Pick a contract, or give its id from 'List contracts' or an earlier step.

Outputs

contractobject
The contract
Example output
{
  "contract": {
    "amount": 100.0,
    "created_at": "2022-01-01T00:00:00Z",
    "currency": "GBP",
    "external_id": "external_id",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "is_archived": false,
    "job_title": "Backend Developer",
    "legal_entity_id": "team-xyz789",
    "legal_entity_name": "Engineering Team",
    "pay_scale": "hourly",
    "start_date": "2022-01-01",
    "status": "in_progress",
    "team_id": "team-xyz789",
    "team_name": "Engineering Team",
    "termination_date": "2022-01-01",
    "title": "Software Development Contract",
    "type": "ongoing_time_based",
    "worker_email": "client@example.com",
    "worker_id": "team-abc123",
    "worker_name": "Acme Corp"
  }
}

Get organization

Get your Deel organization's name and id.

Inputs

None.

Outputs

organizationobject
The organization
Example output
{
  "organization": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Example Organization"
  }
}

Get person

Get one person's details: job, department, manager, legal entity and current contract.

Inputs

Personperson_idtextRequired
Pick someone, or give a person id from 'List people' or an earlier step.

Outputs

personobject
The person
Example output
{
  "person": {
    "contract_id": "mzj524j",
    "contract_status": "waiting_for_client_sign",
    "country": "USA",
    "created_at": "2023-03-21T10:27:25.950Z",
    "department_id": "00000000-0000-0000-0000-000000000000",
    "department_name": "Delivery team",
    "email": "work.email@example.com",
    "external_id": "9b9fc43a-a90c-4615-ac50-baf1e314b53e",
    "first_name": "John",
    "full_name": "John Doe",
    "hiring_status": "onboarding",
    "hiring_type": "contractor",
    "id": "9b9fc43a-a90c-4615-ac50-baf1e314b53e",
    "job_title": "Access Field Technician",
    "last_name": "Doe",
    "legal_entity_id": "00000000-0000-0000-0000-000000000000",
    "legal_entity_name": "Acme Corporation",
    "manager_id": "642b0547-9d80-4d35-a085-fd977ef209ef",
    "manager_name": "Doe John",
    "start_date": "2023-03-20",
    "worker_id": "123"
  }
}

Get time-off balances

Get how much time off a person has, has used and has left on each of their policies.

Inputs

Personperson_idtextRequired
Pick someone, or give a person id from 'List people' or an earlier step.
As ofon_datedate
The balances for the period this day falls in. Defaults to the current period.

Outputs

balanceslist
One balance per policy
countnumber
How many are in this answer
person_idtext
The person
Example output
{
  "balances": [
    {
      "allowance": 0.0,
      "approved": 0.0,
      "available": 0.0,
      "period_end": "2022-01-01",
      "period_start": "2022-01-01",
      "policy_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "policy_name": "Policy name",
      "policy_type": "Policy type name",
      "requested": 0.0,
      "unit": "HOUR",
      "unlimited": false,
      "used": 0.0
    }
  ],
  "count": 1,
  "person_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}

List contracts

List contracts, optionally only some statuses or types, one legal entity or team, or those matching a name.

Inputs

Statusstatuseslist
Only contracts in these statuses. Leave empty for all.One or more of: in_progress (Active), new, under_review (Under review), waiting_for_client_sign (Waiting for your signature), waiting_for_contractor_sign (Waiting for the contractor's signature), waiting_for_employee_sign (Waiting for the employee's signature), waiting_for_eor_sign (Waiting for Deel's signature), waiting_for_employee_contract (Waiting for the employment contract), processing_payment (Processing payment), awaiting_deposit_payment (Waiting for the deposit), and 7 more.
Typetypeslist
Only contracts of these types. Leave empty for all.One or more of: ongoing_time_based (Contractor, fixed rate), pay_as_you_go_time_based (Contractor, pay as you go), payg_tasks (Contractor, paid per task), milestones (Contractor, milestones), payg_milestones (Contractor, pay-as-you-go milestones), commission (Contractor, commission), contractor_outside_deel (Contractor paid outside Deel), eor (Employee of record (EOR)), global_payroll (Global Payroll employee), peo (PEO employee), hris_direct_employee (Direct employee).
Legal entitylegal_entity_idtext
Only contracts with this legal entity.
Teamteamtext
Only contracts in this team.
Searchsearchtext
Part of the contract's title or the worker's name.
Your IDexternal_idtext
Only the contract with this id of your own (see 'Set contract ID').
Page sizelimitnumber
How many to return, 1 to 150. Defaults to 50.From 1 to 150.
Next pagecursortext
Leave empty for the first page. For the next one, use 'next_cursor' from the page before.

Outputs

contractslist
The contracts
countnumber
How many are in this answer
has_moretrue/false
Whether there are more to read
next_cursortext
What to put in 'Next page' for the next page
totalnumber
How many there are in all
Example output
{
  "contracts": [
    {
      "amount": 0.0,
      "created_at": "2019-03-21T13:45:07.515Z",
      "currency": "",
      "external_id": "123456",
      "id": "d0377f58-f152-413a-aa9f-997bdfc61fc2",
      "is_archived": false,
      "job_title": "",
      "legal_entity_id": "d0377f58-f152-413a-aa9f-997bdfc61fc2",
      "legal_entity_name": "Acme Inc.",
      "pay_scale": "weekly",
      "start_date": "",
      "status": "waiting_for_client_sign",
      "team_id": "d0377f58-f152-413a-aa9f-997bdfc61fc2",
      "team_name": "Ken",
      "termination_date": "2022-10-21",
      "title": "Ken",
      "type": "ongoing_time_based",
      "worker_email": "test@example.com",
      "worker_id": "28da9a07-102c-4a69-9781-3182a514f669",
      "worker_name": "John Doe"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "total": 1
}

List departments

List the departments in your Deel organization.

Inputs

None.

Outputs

countnumber
How many are in this answer
departmentslist
The departments
Example output
{
  "count": 2,
  "departments": [
    {
      "id": "c1f4d8ce-66b9-4b98-9054-815237118cbc",
      "name": "Engineering",
      "parent_id": ""
    },
    {
      "id": "facc9050-f4c9-4250-bc95-b7584e411a00",
      "name": "Software Development",
      "parent_id": "1"
    }
  ]
}

List invoice adjustments

List bonuses, expenses, deductions and other lines added to contractors' invoices, optionally for one contract, type, status or date range.

Inputs

Contractcontract_idtext
Only those for this contract. Leave empty for all.
Typetypeslist
Only these types. Leave empty for all.One or more of: bonus, commission, expense, overtime, deduction, time_off (Time off), other, vat.
Statusstatuseslist
Only these statuses. Leave empty for all.One or more of: pending (Waiting for review), approved, declined, processing, paid, not_payable (Not payable).
Fromstart_datedate
Only those on or after this day.
Toend_datedate
Only those on or before this day.
Page sizelimitnumber
How many to return, 1 to 150. Defaults to 50.From 1 to 150.
Skipoffsetnumber
How many to skip, to get a later page. Use 'next_offset' from the page before.At least 0.

Outputs

countnumber
How many are in this answer
has_moretrue/false
Whether there are more to read
invoice_adjustmentslist
The invoice adjustments
next_offsetnumber
What to put in 'Skip' for the next page (0 when none)
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "has_more": false,
  "invoice_adjustments": [
    {
      "contract_id": "contract_123",
      "contract_title": "Senior Backend Engineer",
      "created_at": "2025-12-19T10:30:00Z",
      "currency": "USD",
      "date_submitted": "2025-12-18",
      "description": "Performance bonus for September",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "invoice_id": "102938",
      "reported_by": "John Doe",
      "status": "approved",
      "total_amount": 200.0,
      "type": "bonus"
    }
  ],
  "next_offset": 0,
  "total": 1
}

List invoices

List invoices: paid ones, or every invoice, optionally those issued in a date range.

Inputs

Include unpaidinclude_unpaidtrue/false
Also list invoices not yet paid. Deel lists only paid ones otherwise.Default: false.
Issued fromissued_fromdate
Only invoices issued on or after this day.
Issued toissued_todate
Only invoices issued on or before this day.
Page sizelimitnumber
How many to return, 1 to 50. Defaults to 25.From 1 to 50.
Skipoffsetnumber
How many to skip, to get a later page. Use 'next_offset' from the page before.At least 0.

Outputs

countnumber
How many are in this answer
has_moretrue/false
Whether there are more to read
invoiceslist
The invoices
next_offsetnumber
What to put in 'Skip' for the next page (0 when none)
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "has_more": false,
  "invoices": [
    {
      "amount": 1000.0,
      "contract_id": "37nex2x",
      "created_at": "2022-05-24T09:38:46.235Z",
      "currency": "GBP",
      "deel_fee": 10.0,
      "due_date": "2022-05-24",
      "id": "GqaY5BHQJUAM2Jg9kq2j2",
      "is_overdue": true,
      "issued_at": "2022-05-24T09:38:46.235Z",
      "legal_entity_id": "2c275e07-4846-490e-b2e4-6e84139032c3",
      "number": "INV-2023-4",
      "paid_at": "",
      "status": "paid",
      "total": 1000.0,
      "vat_total": 210.0
    }
  ],
  "next_offset": 0,
  "total": 1
}

List the companies (legal entities) in your Deel organization.

Inputs

None.

Outputs

countnumber
How many are in this answer
legal_entitieslist
The legal entities
Example output
{
  "count": 1,
  "legal_entities": [
    {
      "country": "US",
      "created_at": "2024-01-01T12:00:00Z",
      "entity_type": "company",
      "id": "b61f6b35-7670-4515-b667-066f02b7b8a0",
      "name": "Deel US",
      "status": "active"
    }
  ]
}

List payments

List the payments your organization made to Deel, with their totals and how they were paid.

Inputs

Statusstatuseslist
Only payments in these statuses. Leave empty for all.One or more of: paid, processing.
Fromstart_datedate
Only those on or after this day.
Toend_datedate
Only those on or before this day.
Next pagecursortext
Leave empty for the first page. For the next one, use 'next_cursor' from the page before.

Outputs

countnumber
How many are in this answer
has_moretrue/false
Whether there are more to read
next_cursortext
What to put in 'Next page' for the next page
paymentslist
The payments
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "payments": [
    {
      "created_at": "2022-05-23T14:45:30.123Z",
      "currency": "GBP",
      "id": "34d7Y48Ymu44g66fghN9F",
      "label": "REC-2024-3",
      "method": "bank_transfer",
      "paid_at": "2022-05-24T09:38:46.235Z",
      "reference": "DEEL72T6KJ",
      "status": "paid",
      "total": 1500.0,
      "total_due": 1400.0
    }
  ],
  "total": 1
}

List people

List the contractors and employees in Deel, optionally only those matching a name, in a team, or hired a certain way.

Inputs

Searchsearchtext
A name or email to look for.
Teamteamtext
Only people in this team.
Hired ashiring_typeslist
Only people hired these ways. Leave empty for everyone.One or more of: contractor, eor (Employee of record (EOR)), direct_employee (Direct employee), hris_direct_employee (Direct employee (HR only)), hris_direct_contractor (Direct contractor (HR only)), peo (PEO employee), contractor_outside_deel (Contractor paid outside Deel), person_without_contract (Person without a contract).
Page sizelimitnumber
How many to return, 1 to 200. Defaults to 50.From 1 to 200.
Skipoffsetnumber
How many to skip, to get a later page. Use 'next_offset' from the page before.At least 0.

Outputs

countnumber
How many are in this answer
has_moretrue/false
Whether there are more to read
next_offsetnumber
What to put in 'Skip' for the next page (0 when none)
peoplelist
The people
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "people": [
    {
      "contract_id": "mzj524j",
      "contract_status": "waiting_for_client_sign",
      "country": "USA",
      "created_at": "2023-03-21T10:27:25.950Z",
      "department_id": "00000000-0000-0000-0000-000000000000",
      "department_name": "Delivery team",
      "email": "work.email@example.com",
      "external_id": "9b9fc43a-a90c-4615-ac50-baf1e314b53e",
      "first_name": "John",
      "full_name": "John Doe",
      "hiring_status": "onboarding",
      "hiring_type": "contractor",
      "id": "9b9fc43a-a90c-4615-ac50-baf1e314b53e",
      "job_title": "Access Field Technician",
      "last_name": "Doe",
      "legal_entity_id": "00000000-0000-0000-0000-000000000000",
      "legal_entity_name": "Acme Corporation",
      "manager_id": "642b0547-9d80-4d35-a085-fd977ef209ef",
      "manager_name": "Doe John",
      "start_date": "2023-03-20",
      "worker_id": "123"
    }
  ],
  "total": 1
}

List time-off policies

List your organization's time-off policies and how many people each covers.

Inputs

None.

Outputs

countnumber
How many are in this answer
policieslist
The time-off policies
Example output
{
  "count": 1,
  "policies": [
    {
      "assigned_people": 42,
      "description": "This policy provides standard paid time off for employees",
      "description_required": true,
      "id": "f7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b",
      "leave_type": "SHORT_TERM_LEAVE",
      "name": "Standard PTO Policy",
      "payment_type": "PAID",
      "policy_type": "Paid Time Off",
      "tracking_unit": "YEAR"
    }
  ]
}

List time-off requests

List time-off requests across your organization, optionally only some statuses, those in a date range, or those changed since a time.

Inputs

Statusstatuseslist
Only requests in these statuses. Leave empty for all.One or more of: REQUESTED (Waiting for approval), APPROVED, REJECTED, USED (Taken), CANCELED.
Fromstart_datedate
Only time off from this day on.
Toend_datedate
Only time off up to this day.
Changed sinceupdated_sincedate and time
Only requests created or changed at or after this time.
Page sizelimitnumber
How many to return, 5 to 200. Defaults to 50.From 5 to 200.
Next pagecursortext
Leave empty for the first page. For the next one, use 'next_cursor' from the page before.

Outputs

countnumber
How many are in this answer
has_moretrue/false
Whether there are more to read
next_cursortext
What to put in 'Next page' for the next page
time_off_requestslist
The time-off requests
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "time_off_requests": [
    {
      "amount": 1.0,
      "approved_at": "",
      "canceled_at": "",
      "contract_id": "d290f1ee6c54",
      "created_at": "2021-07-01T11:22:33.444Z",
      "description": "Vacation",
      "end_date": "2021-08-01",
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "is_paid": false,
      "person_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "policy_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "reason": "Sick leave - Doctor appointment",
      "requested_at": "2021-07-01",
      "start_date": "2021-08-01",
      "status": "REQUESTED",
      "time_off_type": "Vacation",
      "time_off_type_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "unit": "CALENDAR_DAY",
      "updated_at": "2021-07-01T11:22:33.444Z"
    }
  ]
}

List timesheets

List contractors' timesheet entries, optionally for one contract, in some statuses, or for work in a date range.

Inputs

Contractcontract_idtext
Only those for this contract. Leave empty for all.
Statusstatuseslist
Only entries in these statuses. Leave empty for all.One or more of: pending (Waiting for review), approved, declined, processing, paid, not_payable (Not payable).
Fromstart_datedate
Only those on or after this day.
Toend_datedate
Only those on or before this day.
Page sizelimitnumber
How many to return, 1 to 150. Defaults to 50.From 1 to 150.
Skipoffsetnumber
How many to skip, to get a later page. Use 'next_offset' from the page before.At least 0.

Outputs

countnumber
How many are in this answer
has_moretrue/false
Whether there are more to read
next_offsetnumber
What to put in 'Skip' for the next page (0 when none)
timesheetslist
The timesheet entries
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "timesheets": [
    {
      "contract_id": "contract_abc123",
      "contract_title": "Senior Backend Engineer",
      "created_at": "2022-05-04T03:45:27.108Z",
      "currency": "GBP",
      "description": "Backend development work for sprint 42",
      "hours": 8.0,
      "id": "00000000-0000-0000-0000-000000000000",
      "reported_by": "John Smith",
      "review_note": "Approved after verification",
      "reviewed_by": "Jane Smith",
      "status": "approved",
      "total_amount": 200.0,
      "work_date": "2022-05-24"
    }
  ],
  "total": 1
}

Request time off

Request time off for a person under one of their policies. It waits for approval unless you mark it approved.

Inputs

Personperson_idtextRequired
Pick someone, or give a person id from 'List people' or an earlier step.
Time-off policypolicy_idtextRequired
The policy the time off comes from, such as paid time off. It must be one the person is on.
First daystart_datedateRequired
The first day off.
Last dayend_datedate
The last day off. Defaults to the first day, for a single day.
Descriptiondescriptiontext
A note for the approver. Some policies require one.
Statusstatustext
Leave it waiting for approval, or record it as already approved.One of: REQUESTED (Waiting for approval (default)), APPROVED. Default: REQUESTED.

Outputs

countnumber
How many are in this answer
time_offobject
The request (the first, if Deel split it)
time_offslist
Every request made: Deel splits one across a year end
Example output
{
  "count": 1,
  "time_off": {
    "amount": 1.0,
    "approved_at": "",
    "canceled_at": "",
    "contract_id": "d290f1ee6c54",
    "created_at": "2021-07-01T11:22:33.444Z",
    "description": "Vacation",
    "end_date": "2021-08-01",
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "is_paid": false,
    "person_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "policy_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "reason": "Sick leave - Doctor appointment",
    "requested_at": "2021-07-01",
    "start_date": "2021-08-01",
    "status": "REQUESTED",
    "time_off_type": "Vacation",
    "time_off_type_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "unit": "CALENDAR_DAY",
    "updated_at": "2021-07-01T11:22:33.444Z"
  },
  "time_offs": [
    {
      "amount": 1.0,
      "approved_at": "",
      "canceled_at": "",
      "contract_id": "d290f1ee6c54",
      "created_at": "2021-07-01T11:22:33.444Z",
      "description": "Vacation",
      "end_date": "2021-08-01",
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "is_paid": false,
      "person_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "policy_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "reason": "Sick leave - Doctor appointment",
      "requested_at": "2021-07-01",
      "start_date": "2021-08-01",
      "status": "REQUESTED",
      "time_off_type": "Vacation",
      "time_off_type_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "unit": "CALENDAR_DAY",
      "updated_at": "2021-07-01T11:22:33.444Z"
    }
  ]
}

Set contract ID

Save your own id on a contract, such as an employee number from your HR or finance system, to find it by later.

Inputs

Contractcontract_idtextRequired
Pick a contract, or give its id from 'List contracts' or an earlier step.
Your IDexternal_idtext
Your id for this contract. It must be unique. Leave empty to remove the one it has.

Outputs

contractobject
The contract
Example output
{
  "contract": {
    "amount": 100.0,
    "created_at": "2022-01-01T00:00:00Z",
    "currency": "GBP",
    "external_id": "external_id",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "is_archived": false,
    "job_title": "Backend Developer",
    "legal_entity_id": "team-xyz789",
    "legal_entity_name": "Engineering Team",
    "pay_scale": "hourly",
    "start_date": "2022-01-01",
    "status": "in_progress",
    "team_id": "team-xyz789",
    "team_name": "Engineering Team",
    "termination_date": "2022-01-01",
    "title": "Software Development Contract",
    "type": "ongoing_time_based",
    "worker_email": "client@example.com",
    "worker_id": "team-abc123",
    "worker_name": "Acme Corp"
  }
}

On this page