Introduction

The Adjustments API is a powerful tool designed to streamline the process of managing payroll adjustments such as expenses, bonuses, and other modifications. This article serves as a step-by-step guide to help you get started with the Adjustments API.

Step 1: Understand Adjustments in Deel

Before diving in, familiarize yourself with what payroll adjustments are and how they impact employee payroll. Adjustments can be additions or deductions like bonuses, expenses, or custom adjustments specific to your organization.

We recommend exploring Deel in your sandbox to familiarize yourself with adjustments.

Step 2: Set Up Your Sandbox

Ensure your sandbox environment is ready. Follow this guide to create your Deel Sandbox.

Step 3: Authentication

It's required to authenticate your API requests. You can do this by obtaining an API key or by integrating OAuth 2.0.

For an API key, refer to our detailed guide on API Token Generation which will walk you through the process of obtaining and using your unique key.

If you prefer OAuth 2.0, our OAuth 2.0 Integration Guide provides comprehensive instructions on setting up and using OAuth 2.0 with the Adjustments API.

Both methods ensure secure and authenticated access to the API functionalities.

Step 4: Create a test Adjustment

Start by creating a simple adjustment. The following code block show how to create an adjustment using the API.

curl --location 'https://api-sandbox.demo.letsdeel.com/rest/v2/adjustments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data '{
    "data": {
        "contract_id": "34ywdw6",
        "adjustment_category_id": "c6816f1bad6384ada82bf4e41de469",
        "title": "Keyboard",
        "description": "I bought a keyboard",
        "amount": 80,
        "move_next_cycle": true,
        "date_of_adjustment": "2024-01-24"
    }
}'

Step 7: Explore API Reference

Each API has unique features and limitations. Read the Adjustments API documentation thoroughly. It's your best resource for understanding specific endpoints.