Get Payroll Report | Deel

curl -G https://api.letsdeel.com/rest/v2/cycles/cycle_id/payroll-report \
     -H "Authorization: Bearer <token>" \
     -d contract_oids=LnjP6kYv \
     --data-urlencode "search=Luis Aguado" \
     -d employee_status=ACTIVE \
     -d limit=100

{
  "data": {
    "count": 1,
    "event_entity_items": [
      {
        "id": "c57dde3d84d9640b09530582c7be34",
        "type": "earnings",
        "label": "Gross Salary",
        "scope": "EMPLOYMENT",
        "status": "ACTIVE",
        "tooltip": "Monthly gross salary",
        "countries": [
          "US"
        ],
        "is_global": false,
        "created_at": "2026-03-18T12:00:00.000Z",
        "item_order": 1,
        "updated_at": "2026-03-18T12:00:00.000Z",
        "description": "Total gross salary",
        "system_name": "gross_salary",
        "deel_enabled": true,
        "is_adjustable": true,
        "appears_on_g2n": true,
        "client_enabled": true,
        "unit_of_measure": "CURRENCY",
        "can_be_recurring": true,
        "employer_cost_type": "TAX",
        "add_to_employer_cost": true,
        "included_in_g2n_report": true,
        "payroll_legal_entity_id": 456,
        "is_recurring_in_offcycle": false,
        "appears_on_recurring_items": true,
        "client_payroll_report_label": "Client Gross Salary",
        "supported_in_payroll_report": true,
        "payroll_report_sub_category_id": "subcat_123",
        "adjustment_payroll_report_column_id": "adj_col_123"
      }
    ],
    "employment_payroll_events": [
      {
        "contract": {
          "id": 12345,
          "oid": "ctr_abc123",
          "status": "active",
          "hris_profile": {
            "oid": "hris_profile_123"
          },
          "contract_type": "employee",
          "completion_date": "2026-03-18T12:00:00.000Z"
        },
        "employment": {
          "employee": {
            "last_name": "Doe",
            "first_name": "Jane",
            "middle_name": "Q"
          },
          "employment_id": "employment_123",
          "employee_status": "ACTIVE",
          "employee_recurring_items": [
            {
              "id": "pri_recurring_123",
              "amount": "100.00",
              "unit_of_measure": "CURRENCY",
              "payroll_report_column": {
                "id": "c57dde3d84d9640b09530582c7be34"
              },
              "payroll_report_column_id": "c57dde3d84d9640b09530582c7be34"
            }
          ]
        },
        "payroll_report_items": [
          {
            "id": "pri_123",
            "value": "2500.00",
            "source": "MANUAL",
            "qtd_value": "6000.00",
            "ytd_value": "12000.00",
            "created_at": "2026-03-18T12:00:00.000Z",
            "updated_at": "2026-03-18T12:00:00.000Z",
            "is_prorated": false,
            "is_recurring": true,
            "is_overwritten": false,
            "last_change_by": 101,
            "unit_of_measure": "CURRENCY",
            "updated_by_profile": {
              "name": "Jane Doe",
              "email": "jane@deel.com",
              "user_id": 101
            },
            "payroll_report_column": {
              "id": "c57dde3d84d9640b09530582c7be34",
              "type": "earnings",
              "label": "Gross Salary",
              "scope": "EMPLOYMENT",
              "status": "ACTIVE",
              "tooltip": "Monthly gross salary",
              "countries": [
                "US"
              ],
              "is_global": false,
              "created_at": "2026-03-18T12:00:00.000Z",
              "item_order": 1,
              "updated_at": "2026-03-18T12:00:00.000Z",
              "description": "Total gross salary",
              "system_name": "gross_salary",
              "deel_enabled": true,
              "is_adjustable": true,
              "appears_on_g2n": true,
              "client_enabled": true,
              "unit_of_measure": "CURRENCY",
              "can_be_recurring": true,
              "employer_cost_type": "TAX",
              "add_to_employer_cost": true,
              "included_in_g2n_report": true,
              "payroll_legal_entity_id": 456,
              "is_recurring_in_offcycle": false,
              "appears_on_recurring_items": true,
              "client_payroll_report_label": "Client Gross Salary",
              "supported_in_payroll_report": true,
              "payroll_report_sub_category_id": "subcat_123",
              "adjustment_payroll_report_column_id": "adj_col_123"
            },
            "payroll_report_column_id": "c57dde3d84d9640b09530582c7be34",
            "employment_payroll_event_id": 899472
          }
        ],
        "previous_payroll_report_items": [
          {
            "id": "pri_456",
            "value": "2400.00",
            "source": "MANUAL",
            "qtd_value": "4500.00",
            "ytd_value": "9500.00",
            "created_at": "2026-02-18T12:00:00.000Z",
            "updated_at": "2026-02-18T12:00:00.000Z",
            "is_prorated": false,
            "is_overwritten": false,
            "last_change_by": 101,
            "unit_of_measure": "CURRENCY",
            "payroll_report_column": {
              "id": "c57dde3d84d9640b09530582c7be34"
            },
            "payroll_report_column_id": "c57dde3d84d9640b09530582c7be34",
            "employment_payroll_event_id": 899471
          }
        ]
      }
    ],
    "cursor": "cursor_123",
    "overview": {}
  }
}

Get payroll report data for a payroll cycle, including available columns, employee row values, and optional previous report items. Use this response to discover payroll_report_column_id and payroll_id before updating entries. Token scopes: global-payroll: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.

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/

Path parameters

cycle_idstringRequired

Payroll event/cycle id.

Query parameters

contract_oidslist of stringsOptional

Contract OID(s) to filter report rows.

searchstringOptional

Filter by employee name.

employee_statuslist of stringsOptional

Employee status filter.

limitintegerOptional1-200Defaults to 100

Maximum number of report rows.

cursorstring or doubleOptional

Cursor for pagination.

Response

Successful response

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'