0

List gross-to-net report.

by
Published Oct 17, 2025

Get a list of global payroll reports detailing gross-to-net calculations. Supports pagination through limit and offset query parameters. **Token scopes**: `global-payroll:read`

Script deel Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
/**
3
 * List gross-to-net report.
4
 * Get a list of global payroll reports detailing gross-to-net calculations. Supports pagination through limit and offset query parameters.
5
 **Token scopes**: `global-payroll:read`
6
 */
7
export async function main(
8
	auth: RT.Deel,
9
	id: string,
10
	currency?: string | undefined,
11
	limit?: string | undefined,
12
	offset?: string | undefined
13
) {
14
	const url = new URL(`https://api.letsdeel.com/rest/v2/gp/reports/${id}/gross_to_net`)
15
	for (const [k, v] of [
16
		['currency', currency],
17
		['limit', limit],
18
		['offset', offset]
19
	]) {
20
		if (v !== undefined && v !== '') {
21
			url.searchParams.append(k, v)
22
		}
23
	}
24
	const response = await fetch(url, {
25
		method: 'GET',
26
		headers: {
27
			Authorization: 'Bearer ' + auth.apiKey
28
		},
29
		body: undefined
30
	})
31
	if (!response.ok) {
32
		const text = await response.text()
33
		throw new Error(`${response.status} ${text}`)
34
	}
35
	return await response.json()
36
}
37