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

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.

1 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## 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.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

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_datestringformat: "date"

The end date of the pay period.

employeeslist of objects

start_datestringformat: "date"

The start date of the pay period.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	curl -G https://api.letsdeel.com/rest/v2/benefits/legal-entities/123/year-to-date-pay \
2	-H "Authorization: Bearer <token>" \
3	-d date_start=2021-01-01 \
4	-d date_end=2022-01-01

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	}

1	curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2	-H 'Authorization: Bearer YOUR-TOKEN-HERE'