Create a single deduction loan | Deel

Create a single deduction loan Token scopes: benefits:write

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

Legal entity id which employee/contract belongs

contract_idstringRequired

Contract id from the employee

plan_idstringRequired

Plan id to enroll the employee into

Request

This endpoint expects an object.

valuedoubleRequired

Value of of the deduction.

currencyenumRequired

Currency.

Allowed values:

Response

Successful operation.

idstring or null

Unique identifier for the recurring item.

amountdouble or null

Amount of the recurring item.

end_datestring or nullformat: "date-time"

End date of the recurring item, if applicable.

is_activeboolean or null

Indicates whether the recurring item is active.

created_atstring or nullformat: "date-time"

Timestamp when the item was created.

start_datestring or nullformat: "date-time"

Start date of the recurring item.

updated_atstring or nullformat: "date-time"

Timestamp when the item was last updated.

employment_idstring or null

Unique identifier for the employment associated with the item.

payroll_report_column_idstring or null

Identifier for the payroll report column related to this item.

1	import requests
2
3	url = "https://api.letsdeel.com/rest/v2/benefits/legal-entities/3f4b5f6e8/contracts/3f4b5f6e8/plans/3f4b5f6e8/deductions"
4
5	payload = {
6	"value": 100,
7	"currency": "USD"
8	}
9	headers = {
10	"Authorization": "Bearer <token>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.post(url, json=payload, headers=headers)
15
16	print(response.json())

1	{
2	"id": "3f4b5f6e8",
3	"amount": 100,
4	"end_date": "2020-12-31T23:59:59Z",
5	"is_active": true,
6	"created_at": "2020-12-31T23:59:59Z",
7	"start_date": "2020-12-31T23:59:59Z",
8	"updated_at": "2020-12-31T23:59:59Z",
9	"employment_id": "3f4b5f6e8",
10	"payroll_report_column_id": "3f4b5f6e8"
11	}

Authentication

Authentication

Path parameters

Request

Response

Errors

Authentication