Skip to navigation

Retrieve gross-to-net report data for a payroll cycle

Retrieve the gross-to-net breakdown of a payroll cycle so you can reconcile payroll cost against your own accounting, finance, or reporting systems. Each entry covers one contract in the cycle, listing its payroll items grouped by category group, category, sub-category, and label, the cycle’s payroll currency, and — where a payment exists — the payment currency and the conversion rate applied. Call this once the cycle’s gross-to-net report has been generated; use next_cursor together with has_more to page through large cycles.

Token scopes: payslips: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.deel.training/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

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

Path parameters

cycle_idstringRequiredformat: "uuid"
The unique identifier for the payroll event.

Query parameters

limitintegerOptional1-100Defaults to 20
Maximum number of items to return. Defaults to 20.
cursorstringOptional
Cursor for pagination of results.

Response

Successful operation.
datalist of objects
List of contracts associated with the payroll event.
has_moreboolean
Indicates whether more pages are available.
created_atstringformat: "date-time"
Timestamp when the report was generated
updated_atstringformat: "date-time"
Timestamp when the report was updated
next_cursorstring or null
Pagination cursor to fetch the next page of results.
items_per_pageinteger
The number of items per page.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error