Get year to date payment for benefits 401k. | Deel

Get year to date from employees from organization integrated with external benefits vendor Token scopes: organizations:read

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

AuthorizationBearer

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

Path parameters

idstringRequired

Id from the legal entity to fetch data

Query parameters

date_startstringRequired

Start date to fetch aggregated pay data

date_endstringRequired

End date to fetch aggregated pay data

Response

Successful operation.

end_datestring or nullformat: "date"

The end date of the pay period.

employeeslist of objects or null

start_datestring or nullformat: "date"

The start date of the pay period.

1	import requests
2
3	url = "https://api.letsdeel.com/rest/v2/benefits/legal-entities/123/year-to-date-pay"
4
5	querystring = {"date_start":"2021-01-01","date_end":"2022-01-01"}
6
7	headers = {"Authorization": "Bearer <token>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"end_date": "2021-01-15",
3	"employees": [
4	{
5	"gross_pay": 1000,
6	"contract_id": "123",
7	"employee_id": "123e4567-e89b-12d3-a456-426614174000",
8	"hours_worked": 40,
9	"contributions": [
10	{
11	"name": "401k",
12	"type": "roth",
13	"amount": 10
14	}
15	],
16	"employer_contributions": [
17	{
18	"name": "401k",
19	"type": "match_rate",
20	"amount": 10
21	}
22	]
23	}
24	],
25	"start_date": "2021-01-01"
26	}

Authentication

Authentication

Path parameters

Query parameters

Response

Errors

Authentication