> This page is for API, version 2026-01-01 (Stable) (default). > For other versions, use one of these documentation indexes: > - 2026-01-01 (Stable) (default): https://docs.deel.wtf/api/stable/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.deel.wtf/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.deel.wtf/_mcp/server. # Retrieve gross-to-net report data for a payroll cycle GET https://api.letsdeel.com/rest/reports/payroll/cycles/{cycle_id}/gross-to-net 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` Reference: https://docs.deel.wtf/api/reference/endpoints/reports/gets-g-2-n-report-data-for-a-given-payroll-cycle-by-its-id-v-2026-01-01 ## Authentication - `Authorization` header (bearer token, required) — ## 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.deel.training/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication) - `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/ ## Servers - `https://api.letsdeel.com/rest` (Production, default) - `https://api-staging.letsdeel.com/rest` (Demo) ## Request ### Path parameters - `cycle_id` (string, required) — The unique identifier for the payroll event. ### Query parameters - `limit` (integer, optional, default: 20) — Maximum number of items to return. Defaults to 20. - `cursor` (string, optional) — Cursor for pagination of results. ## Response ### 200 Successful operation. - `data` (list of ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems, required) — List of contracts associated with the payroll event. - `has_more` (boolean, required) — Indicates whether more pages are available. - `created_at` (string, required) — Timestamp when the report was generated - `updated_at` (string, required) — Timestamp when the report was updated - `next_cursor` (string, required, nullable) — Pagination cursor to fetch the next page of results. - `items_per_page` (integer, required) — The number of items per page. ## Errors ### 400 Bad Request Error Bad Request. - `errors` (list of ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems, optional) ### 401 Unauthorized Error Operation failed. - `request` (ApiErrorRequest, optional) - `errors` (list of ApiError, optional) ### 403 Forbidden Error Operation failed. - `request` (ApiErrorRequest, optional) - `errors` (list of ApiError, optional) ### 404 Not Found Error Resource not found. - `errors` (list of ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems, optional) ### 500 Internal Server Error Internal Server Error. - `errors` (list of ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems, optional) ## Types ### ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems - `items` (list of ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItems, optional) — List of payroll-related items. - `currency` (string, optional) — Currency associated with the payroll event. - `contract_oid` (string, optional) — Unique identifier for the contract. - `payment_data` (ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsPaymentData, optional, nullable) — Payment details associated with the payroll event. Null if no payment data is available. ### ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems - `code` (string, optional) — Machine-readable error code. - `message` (string, optional) — Human-readable explanation of the server error. ### ApiErrorRequest - `method` (string, optional) — The HTTP method of the failed request - `url` (string, optional) — The relative URL of the failed request - `status` (double, optional) — The status code of the response - `api_req_id` (string, optional) — The request ID of the failed request - `docs` (string, optional) — A link to the official documentation for the requested endpoint resource - `source` (string, optional) — The source handler which produced the returned error - `code` (double, optional) — The code of the source handler which produced the returned error ### ApiError - `message` (string, optional) — A description of the returned error - `path` (string, optional) — The JSON path where input validation failed ### ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItems - `label` (string, optional) — Label of the payroll item. - `value` (double, optional) — Value associated with the payroll item. - `category` (string, optional) — Category of the item. - `sub_category` (string, optional) — Sub-category of the item. - `category_group` (enum, optional) — Category group for the reporting label. - Allowed values: `ADDITIONS`, `DEDUCTIONS`, `BENEFITS`, `INFOS`, `CONTRIBUTIONS`, `TOTALS` ### ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsPaymentData Payment details associated with the payroll event. Null if no payment data is available. - `conversion_rate` (string, optional) — Conversion rate applied between the payroll currency and the payment currency. - `payment_currency` (string, optional) — Currency in which the payment is made. ## Examples **Response** ```json { "data": [ { "items": [ { "label": "Allowance", "value": 1200.5, "category": "Gross (Taxable)", "sub_category": "Bonus", "category_group": "DEDUCTIONS" } ], "currency": "USD", "contract_oid": "72aa50d", "payment_data": { "conversion_rate": "1.08", "payment_currency": "EUR" } } ], "has_more": true, "created_at": "2025-10-15T09:12:00Z", "updated_at": "2025-10-15T09:12:00Z", "next_cursor": "cursor_bf35c551", "items_per_page": 20 } ``` **SDK Code** ```python import requests url = "https://api.letsdeel.com/rest/reports/payroll/cycles/bcde50dc-3540-4f9a-a395-3486d2f54ee8/gross-to-net" querystring = {"cursor":"x5d0c4eax5d0c4eax5d0c4eax5d0c4ea","limit":"20"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.letsdeel.com/rest/reports/payroll/cycles/bcde50dc-3540-4f9a-a395-3486d2f54ee8/gross-to-net?cursor=x5d0c4eax5d0c4eax5d0c4eax5d0c4ea&limit=20'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.letsdeel.com/rest/reports/payroll/cycles/bcde50dc-3540-4f9a-a395-3486d2f54ee8/gross-to-net?cursor=x5d0c4eax5d0c4eax5d0c4eax5d0c4ea&limit=20" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.letsdeel.com/rest/reports/payroll/cycles/bcde50dc-3540-4f9a-a395-3486d2f54ee8/gross-to-net?cursor=x5d0c4eax5d0c4eax5d0c4eax5d0c4ea&limit=20") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.letsdeel.com/rest/reports/payroll/cycles/bcde50dc-3540-4f9a-a395-3486d2f54ee8/gross-to-net?cursor=x5d0c4eax5d0c4eax5d0c4eax5d0c4ea&limit=20") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.letsdeel.com/rest/reports/payroll/cycles/bcde50dc-3540-4f9a-a395-3486d2f54ee8/gross-to-net?cursor=x5d0c4eax5d0c4eax5d0c4eax5d0c4ea&limit=20', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.letsdeel.com/rest/reports/payroll/cycles/bcde50dc-3540-4f9a-a395-3486d2f54ee8/gross-to-net?cursor=x5d0c4eax5d0c4eax5d0c4eax5d0c4ea&limit=20"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/reports/payroll/cycles/bcde50dc-3540-4f9a-a395-3486d2f54ee8/gross-to-net?cursor=x5d0c4eax5d0c4eax5d0c4eax5d0c4ea&limit=20")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```