Retrieve adjustments

GET

/contracts/:contract_id/adjustments

GET

/rest/contracts/:contract_id/adjustments

curl -G https://api.letsdeel.com/rest/contracts/m3jk2j/adjustments \
     -H "Authorization: Bearer <token>" \
     -d from=2023-11-01 \
     -d to=2023-11-15

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "file": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "your_file_name",
        "fileType": "pdf"
      },
      "title": "Your title here",
      "amount": "1234.56",
      "status": "open",
      "created_at": "2020-11-02T12:00:00.000Z",
      "updated_at": "2020-11-02T12:00:00.000Z",
      "contract_id": "m3jk2j",
      "description": "Your description here",
      "cycle_reference": "your_cycle_reference",
      "move_next_cycle": true,
      "date_of_adjustment": "2023-11-02",
      "actual_end_cycle_date": "2023-11-15T00:00:00.000Z",
      "adjustment_category_id": "c9cf4c2c0165f48f494415390c3b49",
      "actual_start_cycle_date": "2023-11-01T00:00:00.000Z"
    }
  ]
}

Retrieves all adjustments associated with a specific contract, optionally scoped to a date range.

Token scopes: adjustments:read

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.

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

Learn more about authentication

AuthorizationBearer

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

Path parameters

contract_idstringRequired

Deel adjustment id.

Query parameters

fromstringOptionalformat: "date"

Filter adjustments by start date.

tostringOptionalformat: "date"

Filter adjustments by end date.

Response

Successful operation.

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error