External HR Time Off Synchronization | Deel

curl -X POST https://api.letsdeel.com/rest/v2/time_offs/global-payroll/sync \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "body": {
    "data": {
      "time_offs": [
        {
          "external_id": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
          "contract_oid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "start_date": "2024-07-01",
          "end_date": "2024-07-05",
          "policy_type": "Vacation",
          "amount": 4,
          "is_paid": true,
          "approved_at": "2024-06-20",
          "description": "Family summer vacation",
          "policy_name": "Annual leave",
          "requested_at": "2024-06-15",
          "entitlement_unit": "BUSINESS_DAY"
        },
        {
          "external_id": "b2c3d4e5-f678-9012-abcd-2345678901fa",
          "contract_oid": "d94f3f01-2c1b-4a7a-9f3e-1a2b3c4d5e6f",
          "start_date": "2024-08-15",
          "end_date": "2024-08-15",
          "policy_type": "Sick leave",
          "amount": 1,
          "is_paid": true,
          "approved_at": "2024-08-14",
          "description": "Flu recovery day",
          "policy_name": "Sick leave",
          "requested_at": "2024-08-13",
          "entitlement_unit": "BUSINESS_DAY"
        },
        {
          "external_id": "c3d4e5f6-7890-1234-abcd-3456789012fb",
          "contract_oid": "a1234567-89ab-cdef-0123-456789abcdef",
          "deleted": true
        }
      ]
    }
  }
}'

{
  "data": {
    "deleted": 1,
    "updated": 1,
    "inserted": 1
  }
}

Synchronize time off requests from an external HRIS to Deel. Only Global Payroll contracts are allowed for this operation. This endpoint can perform 2 different operations with the provided time off list: i) upsert - time off requests identified by an external ID will be either inserted or updated at Deel. ii) delete - existing time off requests identified by an external ID with the parameter ‘deleted: true’ will be deleted. Deel will identify the impacts of each operation on each payroll cycle. Token scopes: time-off:write

Synchronize time off requests from an external HRIS to Deel. Only Global Payroll contracts are allowed for this operation. This endpoint can perform 2 different operations with the provided time off list: i) upsert - time off requests identified by an external ID will be either inserted or updated at Deel. ii) delete - existing time off requests identified by an external ID with the parameter 'deleted: true' will be deleted. Deel will identify the impacts of each operation on each payroll cycle. **Token scopes**: `time-off:write`

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

1 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Request

This endpoint expects an object.

dataobjectOptional

Response

Successful operation time offs returned

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2	-H 'Authorization: Bearer YOUR-TOKEN-HERE'