For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeel Home
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
  • Resources
    • Blog
    • Community
    • API spec
  • Global Payroll
    • Introduction
    • Time Tracking
    • Adjustments
  • Common Use Cases
    • Reimburse expenses
  • Endpoints
      • GETDownload gross to net report
      • GETList gross-to-net report.
      • GETList payroll events by legal entity
LogoLogo
SupportDeel Home
EndpointsReports

Download gross to net report

GET
/gp/reports/:id/gross_to_net/csv
GET
/rest/v2/gp/reports/:id/gross_to_net/csv
$curl -G https://api.letsdeel.com/rest/v2/gp/reports/clbuuabvg63543201r3310y322c/gross_to_net/csv \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d currency=USD
1"Employee ID,Employee Name,Country,Pay Period,Gross Salary,Tax Deductions,Social Security,Other Deductions,Net Salary,Currency\n12345,John Doe,United States,2024-05,8000.00,1200.00,500.00,100.00,6200.00,USD\n67890,Jane Smith,Canada,2024-05,7500.00,1100.00,450.00,90.00,5860.00,CAD\n11223,Max Müller,Germany,2024-05,7000.00,1300.00,400.00,80.00,5220.00,EUR"

Downloads the gross-to-net calculation report for the specified payroll report as a CSV file, with optional currency conversion applied. Token scopes: global-payroll:read

Was this page helpful?
Previous

List gross-to-net report.

Next
Built with

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.

1curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2 -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

idstringRequired
Id of the gp payroll report.

Query parameters

currencystringOptional
Currency to be used in the report calculation.

Response

Successful operation.

Errors

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

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