@deel-developers/deel

v1.0.1

Published

5 months ago

Deelsdk - Deel REST API

Downloads

0High
0Medium
0Low

deel-developers

Deelsdk Typescript SDK 1.0.1

The Typescript SDK for Deelsdk.

API version: 1.0.1
SDK version: 1.0.1

About the API

Deel REST API

Installation

npm install deel

Authentication

To see whether an endpoint needs a specific type of authentication check the endpoint's documentation.

Access Token

The Deelsdk API uses access tokens as a form of authentication. You can set the access token when initializing the SDK through the constructor:

const sdk = new Deelsdk('YOUR_ACCESS_TOKEN')

Or through the setAccessToken method:

const sdk = new Deelsdk()
sdk.setAccessToken('YOUR_ACCESS_TOKEN')

You can also set it for each service individually:

const sdk = new Deelsdk()
sdk.accounting.setAccessToken('YOUR_ACCESS_TOKEN')

Sample Usage

Here is a simple program demonstrating usage of this SDK. It can also be found in the examples/src/index.ts file in this directory.

When running the sample make sure to use npm install to install all the dependencies.

import { Deelsdk } from '@deel-developers/deel';


const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  try {
    const result = await sdk.accounting
      .getInvoiceList();
    console.log(result);
  } catch (err) {
    const error = err as Error;
    console.error(error.message);
  }
})();

Environments

Here is the list of all available environments:

DEFAULT = 'https://api.letsdeel.com/rest/v2',
DEMO = 'https://api-staging.letsdeel.com/rest/v2',
PRODUCTION = 'https://api.letsdeel.com/rest/v2'

How to set the environment:

const sdk = new Deelsdk();
sdk.setEnvironment(Environment.DEFAULT);

Deelsdk Services

A list of all services and services methods.

Accounting

Managers

People

Eor

GlobalPayroll

Contractors

Adjustments

Candidates

PartnerManaged

Contracts

Tasks

Timesheets

Milestones

OffCyclePayments

TimeOff

Invoices

Organizations

Lookups

Webhooks

Token

Carta

All Methods

getInvoiceList

Retrieve invoices

HTTP Method: GET
Endpoint: /invoices

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Return Type

InvoiceListContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.accounting.getInvoiceList({
    issuedFromDate: 'issued_from_date',
    issuedToDate: 'issued_to_date',
    entities: ['et deserunt', 'et eiusmod ipsum'],
    limit: 10,
    offset: 42,
  });
  console.log(result);
})();

getDeelInvoiceList

Retrieve Deel invoices

HTTP Method: GET
Endpoint: /invoices/deel

Required Parameters

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Return Type

DeelInvoiceListContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.accounting.getDeelInvoiceList('contract_id', { limit: 10, offset: 42 });
  console.log(result);
})();

getBillingInvoiceDownloadLink

Download invoice PDF

HTTP Method: GET
Endpoint: /invoices/{invoice_id}/download

Required Parameters

Return Type

InvoiceDownloadLinkContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.accounting.getBillingInvoiceDownloadLink('invoice_id');
  console.log(result);
})();

getPaymentList

Retrieve payment reciepts

HTTP Method: GET
Endpoint: /payments

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Return Type

PaymentListContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.accounting.getPaymentList({
    dateFrom: '1999-12-31',
    dateTo: '1999-12-31',
    currencies: 'foo',
    entities: ['adipisicing in', 'consectetur ut aute anim'],
  });
  console.log(result);
})();

getPaymentsBreakDownById

Retrieve a payment breakdown

HTTP Method: GET
Endpoint: /payments/{payment_id}/breakdown

Required Parameters

Return Type

PaymentBreakDownContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.accounting.getPaymentsBreakDownById('payment_id');
  console.log(result);
})();

createManager

Create a manager

HTTP Method: POST
Endpoint: /managers

Required Parameters

| input | object | Request body. |

Return Type

CreateAdminUserResponseContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.managers.createManager(input);
  console.log(result);
})();

getManagers

List of managers

HTTP Method: GET
Endpoint: /managers

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Return Type

AdminUsersContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.managers.getManagers({ limit: '50', offset: '0' });
  console.log(result);
})();

createDirectEmployee

Create a new Hris direct employee

HTTP Method: POST
Endpoint: /hris/direct-employees

Required Parameters

| input | object | Request body. |

Return Type

HrisDirectEmployeeContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = {
    compensation: {},
    contract: {},
    employee_details: {},
    job_information: {},
    team_information: {},
    vacation_info: {
      vacation_accrual_start_date: '1925-12-02',
      vacation_yearly_policy: 195.35794022086918,
    },
  };
  const result = await sdk.people.createDirectEmployee(input);
  console.log(result);
})();

getInternalPeopleList

Get internal people list

HTTP Method: GET
Endpoint: /internal/people

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Return Type

InternalPeopleContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.people.getInternalPeopleList({ offset: 42, limit: 150.66499168902195 });
  console.log(result);
})();

getPeopleList

List of people

HTTP Method: GET
Endpoint: /people

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Return Type

PeopleContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.people.getPeopleList({
    offset: 42,
    limit: 56.60816787039617,
    search: 'search',
    sortBy: 'job_title',
    sortOrder: 'asc',
    hiringStatuses: 'inactive',
  });
  console.log(result);
})();

getPeopleById

Retrieve a single person

HTTP Method: GET
Endpoint: /people/{worker_id}

Required Parameters

Return Type

PeopleByIdContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.people.getPeopleById('worker_id');
  console.log(result);
})();

updatePeopleDepartment

Update department

HTTP Method: PUT
Endpoint: /people/{worker_id}/department

Required Parameters

Return Type

GenericResultUpdated

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.people.updatePeopleDepartment(input, 'worker_id');
  console.log(result);
})();

updatePeopleWorkingLocation

Update working location

HTTP Method: PUT
Endpoint: /people/{worker_id}/working-location

Required Parameters

Return Type

GenericResultUpdated

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.people.updatePeopleWorkingLocation(input, 'worker_id');
  console.log(result);
})();

getPeople

Get my current profile

HTTP Method: GET
Endpoint: /people/me

Return Type

PeopleMe

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.people.getPeople();
  console.log(result);
})();

createTimeOffsForEmployee

Add a time off request

HTTP Method: POST
Endpoint: /people/{worker_id}/time-offs

Required Parameters

Return Type

EmployeeTimeoffsCreationContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = {};
  const result = await sdk.people.createTimeOffsForEmployee(input, 'worker_id');
  console.log(result);
})();

getTimeOffsForEmployee

List of time off entries

HTTP Method: GET
Endpoint: /people/{worker_id}/time-offs

Required Parameters

Return Type

EmployeeTimeoffsContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.people.getTimeOffsForEmployee('worker_id');
  console.log(result);
})();

getTimeOffsEntitlementsForEmployee

List of time off entitlements

HTTP Method: GET
Endpoint: /people/{worker_id}/time-offs/entitlements

Required Parameters

Return Type

EmployeeTimeoffsEntitlementsContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.people.getTimeOffsEntitlementsForEmployee('worker_id');
  console.log(result);
})();

updateTimeOffsForEmployee

Edit a time off request

HTTP Method: PATCH
Endpoint: /people/{worker_id}/time-offs/{timeoff_id}

Required Parameters

Return Type

EmployeeTimeoffsCreationContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = {};
  const result = await sdk.people.updateTimeOffsForEmployee(input, 'timeoff_id', 'worker_id');
  console.log(result);
})();

deleteTimeOffsForEmployee

Delete a time off request

HTTP Method: DELETE
Endpoint: /people/{worker_id}/time-offs/{timeoff_id}

Required Parameters

Return Type

GenericResultDeleted

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.people.deleteTimeOffsForEmployee('timeoff_id', 'worker_id');
  console.log(result);
})();

reviewTimeOffsForEmployee

Review a time off request

HTTP Method: PATCH
Endpoint: /people/{worker_id}/time-offs/{timeoff_id}/review

Required Parameters

Return Type

EmployeeTimeoffsContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.people.reviewTimeOffsForEmployee(input, 'timeoff_id', 'worker_id');
  console.log(result);
})();

getTimeOffsPoliciesForEmployee

List of time off policies

HTTP Method: GET
Endpoint: /people/{worker_id}/time-offs/policies

Required Parameters

Return Type

EmployeeTimeoffsPoliciesContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.people.getTimeOffsPoliciesForEmployee('worker_id');
  console.log(result);
})();

getEorCountryValidations

Retrieve country guide

HTTP Method: GET
Endpoint: /eor/validations/{country_code}

Required Parameters

Return Type

EorCountryValidationsContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.eor.getEorCountryValidations('US');
  console.log(result);
})();

getEorWorkerPayslips

Retrieve employee payslips

HTTP Method: GET
Endpoint: /eor/workers/{worker_id}/payslips

Required Parameters

Return Type

EorPayslipsListContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.eor.getEorWorkerPayslips('worker_id');
  console.log(result);
})();

getEorWorkerPayslipDownloadUrl

Download payslip PDF

HTTP Method: GET
Endpoint: /eor/workers/{worker_id}/payslips/{payslip_id}/download

Required Parameters

Return Type

EorPayslipDownloadUrlContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.eor.getEorWorkerPayslipDownloadUrl('worker_id', 'payslip_id');
  console.log(result);
})();

calculateEorEmploymentCost

Employee Cost Calculator

HTTP Method: POST
Endpoint: /eor/employment_cost

Required Parameters

| input | object | Request body. |

Return Type

EorEmployeeCostCalculationResponseContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.eor.calculateEorEmploymentCost(input);
  console.log(result);
})();

getEorContractBenefits

Get EOR contract benefits

HTTP Method: GET
Endpoint: /eor/{contract_id}/benefits

Required Parameters

Return Type

EorContractBenefitsContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.eor.getEorContractBenefits('contract_id');
  console.log(result);
})();

createEorContract

Create an EOR contract

HTTP Method: POST
Endpoint: /eor

Required Parameters

| input | object | Request body. |

Return Type

EorContractCreatedContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.eor.createEorContract(input);
  console.log(result);
})();

createGpContract

Create a contract

HTTP Method: POST
Endpoint: /contracts/gp

Required Parameters

| input | object | Request body. |

Return Type

GpContractCreatedContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.globalPayroll.createGpContract(input);
  console.log(result);
})();

getWorkerPayslips

Retrieve employee payslips

HTTP Method: GET
Endpoint: /gp/workers/{worker_id}/payslips

Required Parameters

Return Type

GpPayslipsListContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.globalPayroll.getWorkerPayslips('worker_id');
  console.log(result);
})();

updateGpEmployeeAddress

Update address

HTTP Method: PATCH
Endpoint: /gp/workers/{worker_id}/address

Required Parameters

Return Type

GpEmployeeAddressUpdatedContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.globalPayroll.updateGpEmployeeAddress(input, 'worker_id');
  console.log(result);
})();

addGpBankAccount

Add bank account

HTTP Method: POST
Endpoint: /gp/workers/{worker_id}/banks

Required Parameters

Return Type

BankAccountUpdatedContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.globalPayroll.addGpBankAccount(input, 'worker_id');
  console.log(result);
})();

getGpBankAccounts

Retrieve bank accounts

HTTP Method: GET
Endpoint: /gp/workers/{worker_id}/banks

Required Parameters

Return Type

WorkerBankAccountsInfoContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.globalPayroll.getGpBankAccounts('worker_id');
  console.log(result);
})();

patchGpBankAccount

Modify bank account

HTTP Method: PATCH
Endpoint: /gp/workers/{worker_id}/banks/{bank_id}

Required Parameters

Return Type

BankAccountUpdatedContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.globalPayroll.patchGpBankAccount(input, 'worker_id', 'bank_id');
  console.log(result);
})();

getGpBankGuide

Retrieve bank guide

HTTP Method: GET
Endpoint: /gp/workers/{worker_id}/banks/guide

Required Parameters

Return Type

BankAccountGuideContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.globalPayroll.getGpBankGuide('worker_id');
  console.log(result);
})();

updateGpEmployeeCompensation

Update compensation

HTTP Method: PATCH
Endpoint: /gp/workers/{worker_id}/compensation

Required Parameters

Return Type

GpEmployeeCompensationUpdatedContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.globalPayroll.updateGpEmployeeCompensation(input, 'worker_id');
  console.log(result);
})();

updateGpEmployeePto

Update PTO policy

HTTP Method: PATCH
Endpoint: /gp/workers/{worker_id}/pto-policy

Required Parameters

Return Type

GenericResultUpdated

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.globalPayroll.updateGpEmployeePto(input, 'worker_id');
  console.log(result);
})();

updateGpEmployeeInformation

Update employee information

HTTP Method: PATCH
Endpoint: /gp/workers/{worker_id}/employee-information

Required Parameters

Return Type

GpEmployeeInformationUpdatedContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.globalPayroll.updateGpEmployeeInformation(input, 'worker_id');
  console.log(result);
})();

getDownloadUrlForGpPayslip

Download payslip PDF

HTTP Method: GET
Endpoint: /gp/workers/{worker_id}/payslips/{payslip_id}/download

Required Parameters

Return Type

GpPayslipDownloadUrlContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.globalPayroll.getDownloadUrlForGpPayslip('worker_id', 'payslip_id');
  console.log(result);
})();

getGpLegalEntities

List payroll events by legal entity

HTTP Method: GET
Endpoint: /gp/legal-entities/{legal_entity_id}/reports

Required Parameters

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Return Type

GpPayrollEventReportContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.globalPayroll.getGpLegalEntities(
    '285df33d-e27d-f5e2-16e5-83d49651a250',
    { startDate: '1999-12-31' },
  );
  console.log(result);
})();

getGrossToNetGpReports

List gross-to-net report

HTTP Method: GET
Endpoint: /gp/reports/{gp_report_id}/gross_to_net

Required Parameters

Return Type

GlobalPayrollG2NReportContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.globalPayroll.getGrossToNetGpReports(
    '92ab5283-e503-cc7f-f46a-b0fb87e3de40',
  );
  console.log(result);
})();

downloadGrossToNetGpReport

Download gross-to-net report

HTTP Method: GET
Endpoint: /gp/reports/{gp_report_id}/gross_to_net/csv

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.globalPayroll.downloadGrossToNetGpReport(
    '190fae10-595f-afe0-d7a3-27d3c8d3194c',
  );
  console.log(result);
})();

requestTermination

Request termination

HTTP Method: POST
Endpoint: /gp/workers/{worker_id}/terminations

Required Parameters

Return Type

WorkerTerminationContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.globalPayroll.requestTermination(input, 'worker_id');
  console.log(result);
})();

createContractTimeBased

Create a new contract (time-based)

HTTP Method: POST
Endpoint: /contracts/time-based

Required Parameters

| input | object | Request body. |

Return Type

ContractContainerPayAsYouGoTimeBased

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.contractors.createContractTimeBased(input);
  console.log(result);
})();

createContractTaskBased

Create a new contract (task-based)

HTTP Method: POST
Endpoint: /contracts/task-based

Required Parameters

| input | object | Request body. |

Return Type

ContractContainerPaygTasks

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.contractors.createContractTaskBased(input);
  console.log(result);
})();

createContractMilestoneBased

Create a new contract (milestone-based)

HTTP Method: POST
Endpoint: /contracts/milestone-based

Required Parameters

| input | object | Request body. |

Return Type

ContractContainerPaygMilestones

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.contractors.createContractMilestoneBased(input);
  console.log(result);
})();

createContractFixedRate

Create a new contract (fixed-rate)

HTTP Method: POST
Endpoint: /contracts/fixed-rate

Required Parameters

| input | object | Request body. |

Return Type

ContractContainerOngoingTimeBased

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.contractors.createContractFixedRate(input);
  console.log(result);
})();

getContractPreview

Preview a contract agreement

HTTP Method: GET
Endpoint: /contracts/{contract_id}/preview

Required Parameters

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.contractors.getContractPreview('contract_id', {
    templateId: 'templateId',
  });
  console.log(result);
})();

amendContractDetails

Amend contract

HTTP Method: POST
Endpoint: /contracts/{contract_id}/amendments

Required Parameters

Return Type

GenericResultCreated

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.contractors.amendContractDetails(input, 'contract_id');
  console.log(result);
})();

terminateContract

Terminate contract

HTTP Method: POST
Endpoint: /contracts/{contract_id}/terminations

Required Parameters

Return Type

ContractTerminationResultContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.contractors.terminateContract(input, 'contract_id');
  console.log(result);
})();

addPremium

Upgrade to Premium

HTTP Method: POST
Endpoint: /contracts/{contract_id}/premium

Required Parameters

Return Type

PremiumResultAddedContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.contractors.addPremium(input, 'contract_id');
  console.log(result);
})();

removePremiumFromContract

Downgrade from Premium

HTTP Method: DELETE
Endpoint: /contracts/{contract_id}/premium

Required Parameters

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Return Type

GenericResultDeleted

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.contractors.removePremiumFromContract('contract_id', {
    reason: 'reason',
  });
  console.log(result);
})();

createAdjustment

Create a new adjustment

HTTP Method: POST
Endpoint: /adjustments

Required Parameters

| input | object | Request body. |

Return Type

AdjustmentCreatedContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = {};
  const result = await sdk.adjustments.createAdjustment(input);
  console.log(result);
})();

getAdjustmentsById

Retrieve an adjustment

HTTP Method: GET
Endpoint: /adjustments/{adjustment_id}

Required Parameters

Return Type

AdjustmentCreatedContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.adjustments.getAdjustmentsById('adjustment_id');
  console.log(result);
})();

updateAdjustment

Update an adjustment

HTTP Method: PATCH
Endpoint: /adjustments/{adjustment_id}

Required Parameters

Return Type

GenericResultUpdated

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {} };
  const result = await sdk.adjustments.updateAdjustment(input, 'adjustment_id');
  console.log(result);
})();

deleteAdjustment

Delete an adjustment

HTTP Method: DELETE
Endpoint: /adjustments/{adjustment_id}

Required Parameters

Return Type

GenericResultDeleted

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.adjustments.deleteAdjustment('adjustment_id');
  console.log(result);
})();

getCategories

Retrieve categories

HTTP Method: GET
Endpoint: /adjustments/categories

Return Type

AdjustmentsCategoriesContainer

Example Usage Code Snippet

import { Deelsdk } from '@deel-developers/deel';

const sdk = new Deelsdk({ accessToken: process.env.DEELSDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.adjustments.getCategories();
  console.log(result);
})();

createFileRef

Upload file to Deel

HTTP Method: POST
Endpoint: /attachments

Required Parameters

| input | object | Request body. |

Return Type

OutputToCreate

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Deelsdk Typescript SDK 1.0.1

Table of Contents

About the API

Installation

Authentication

Access Token

Sample Usage

Environments

Deelsdk Services

Accounting

Managers

People

Eor

GlobalPayroll

Contractors

Adjustments

Candidates

PartnerManaged

Contracts

Tasks

Timesheets

Milestones

OffCyclePayments

TimeOff

Invoices

Organizations

Lookups

Webhooks

Token

Carta

All Methods

getInvoiceList

getDeelInvoiceList

getBillingInvoiceDownloadLink

getPaymentList

getPaymentsBreakDownById

createManager

getManagers

createDirectEmployee

getInternalPeopleList

getPeopleList

getPeopleById

updatePeopleDepartment

updatePeopleWorkingLocation

getPeople

createTimeOffsForEmployee

getTimeOffsForEmployee

getTimeOffsEntitlementsForEmployee

updateTimeOffsForEmployee

deleteTimeOffsForEmployee

reviewTimeOffsForEmployee

getTimeOffsPoliciesForEmployee

getEorCountryValidations

getEorWorkerPayslips

getEorWorkerPayslipDownloadUrl

calculateEorEmploymentCost

getEorContractBenefits

createEorContract

createGpContract

getWorkerPayslips

updateGpEmployeeAddress

addGpBankAccount

getGpBankAccounts

patchGpBankAccount

getGpBankGuide

updateGpEmployeeCompensation

updateGpEmployeePto

updateGpEmployeeInformation

getDownloadUrlForGpPayslip

getGpLegalEntities

getGrossToNetGpReports

downloadGrossToNetGpReport

requestTermination

createContractTimeBased