@deel-developers/deel

Deelsdk Typescript SDK 1.0.1

The Typescript SDK for Deelsdk.

• API version: 1.0.1
• SDK version: 1.0.1

Table of Contents

• About the API
• Installation
• Authentication
  • Access Token
• API Endpoint Services
• API Models
• Sample Usage
• Environments
• Deelsdk Services
• License

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.

• Services

  • Accounting

  • Managers

  • People

  • Eor

  • GlobalPayroll

  • Contractors

  • Adjustments

  • Candidates

  • PartnerManaged

  • Contracts

  • Tasks

  • Timesheets

  • Milestones

  • OffCyclePayments

  • TimeOff

  • Invoices

  • Organizations

  • Lookups

  • Webhooks

  • Token

  • Carta

• All Methods

Accounting

Method	Description
getInvoiceList	Retrieve invoices
getDeelInvoiceList	Retrieve Deel invoices
getBillingInvoiceDownloadLink	Download invoice PDF
getPaymentList	Retrieve payment reciepts
getPaymentsBreakDownById	Retrieve a payment breakdown

Managers

Method	Description
createManager	Create a manager
getManagers	List of managers

People

Method	Description
createDirectEmployee	Create a new Hris direct employee
getInternalPeopleList	Get internal people list
getPeopleList	List of people
getPeopleById	Retrieve a single person
updatePeopleDepartment	Update department
updatePeopleWorkingLocation	Update working location
getPeople	Get my current profile
createTimeOffsForEmployee	Add a time off request
getTimeOffsForEmployee	List of time off entries
getTimeOffsEntitlementsForEmployee	List of time off entitlements
updateTimeOffsForEmployee	Edit a time off request
deleteTimeOffsForEmployee	Delete a time off request
reviewTimeOffsForEmployee	Review a time off request
getTimeOffsPoliciesForEmployee	List of time off policies

Eor

Method	Description
getEorCountryValidations	Retrieve country guide
getEorWorkerPayslips	Retrieve employee payslips
getEorWorkerPayslipDownloadUrl	Download payslip PDF
calculateEorEmploymentCost	Employee Cost Calculator
getEorContractBenefits	Get EOR contract benefits
createEorContract	Create an EOR contract

GlobalPayroll

Method	Description
createGpContract	Create a contract
getWorkerPayslips	Retrieve employee payslips
updateGpEmployeeAddress	Update address
addGpBankAccount	Add bank account
getGpBankAccounts	Retrieve bank accounts
patchGpBankAccount	Modify bank account
getGpBankGuide	Retrieve bank guide
updateGpEmployeeCompensation	Update compensation
updateGpEmployeePto	Update PTO policy
updateGpEmployeeInformation	Update employee information
getDownloadUrlForGpPayslip	Download payslip PDF
getGpLegalEntities	List payroll events by legal entity
getGrossToNetGpReports	List gross-to-net report
downloadGrossToNetGpReport	Download gross-to-net report
requestTermination	Request termination

Contractors

Method	Description
createContractTimeBased	Create a new contract (time-based)
createContractTaskBased	Create a new contract (task-based)
createContractMilestoneBased	Create a new contract (milestone-based)
createContractFixedRate	Create a new contract (fixed-rate)
getContractPreview	Preview a contract agreement
amendContractDetails	Amend contract
terminateContract	Terminate contract
addPremium	Upgrade to Premium
removePremiumFromContract	Downgrade from Premium

Adjustments

Method	Description
createAdjustment	Create a new adjustment
getAdjustmentsById	Retrieve an adjustment
updateAdjustment	Update an adjustment
deleteAdjustment	Delete an adjustment
getCategories	Retrieve categories
createFileRef	Upload file to Deel
getAdjustments	Retrieve adjustments

Candidates

Method	Description
addCandidate	Add Candidate
patchCandidate	Update Candidate

PartnerManaged

Method	Description
addEmployeeAdditionalInformation	Add additional information
signEmployeeContract	Sign a contract
requestCustomVerificationLetter	Request custom verification letter
getHrVerificationLettersAndDocuments	List HR verification letters and documents
downloadHrVerificationLettersAndDocuments	Download HR verification letters and documents
getOfferLetterPreview	Preview job offer letter
getEmployeeAgreementPreview	Preview employee agreement
getEmployeeAgreementDownloadLink	Download employee agreement PDF
getBankAccountGuide	Bank account form
addBankAccount	Add bank account
patchBankAccount	Modify bank account for an EOR employee
getEmployeePayslips	Get list of payslips for an EOR employee
getEmployeeComplianceDocuments	List of employee compliance documents
uploadEmployeeComplianceDocument	Upload employee compliance document
getEmployeeComplianceDocumentTemplate	Download employee compliance document template
getEmployeeTaxDocuments	List of tax documents for an employee

Contracts

Method	Description
createContract	Create a new contract
getContractList	List of contracts
getContractById	Retrieve a single contract
attachExternalId	External Id
addContractDocument	Attach a file to contract
editContractDocument	Edit the file attached to contract document.
getAlternateEmailsByContractId	Find contract emails by ID
signContract	Sign a contract
archiveContract	Archive a contract
inviteToSignContract	Send contract to worker
uninviteToSignContract	Remove invite
calculateFinalPayment	Calculate final payment
postContractEstimate	Calculate first payment amount
getContractTemplates	Get contract templates
getWorkerDocumentsById	List of worker documents
getDownloadWorkerDocumentsById	Download worker document

Tasks

Method	Description
createContractPgoTak	Create new task
getTasksByContract	List of tasks
createTaskManyReview	Review multiple tasks
createTaskReviewById	Review a single task
deleteContractPgoTak	Delete task

Timesheets

Method	Description
getTimesheetsByContract	List of timesheets by contract
createTimesheet	Create a timesheet entry
getTimesheets	List of timesheets
getTimesheetById	Retrieve a single timesheet entry
updateTimesheetById	Update a timesheet entry
deleteTimesheetById	Delete a timesheet entry
createTimesheetReview	Review a single timesheet
createTimesheetReviews	Review multiple timesheets

Milestones

Method	Description
createMilestone	Create a milestone
getMilestonesByContract	List of milestones by contract
getMilestonesByContractAndId	Retrieve a single milestone
deleteMilestoneById	Delete a milestone
createMilestoneReview	Review a single milestone
createMilestoneReviews	Review multiple milestones

OffCyclePayments

Method	Description
createOffCyclePayment	Add off-cycle payment
getOffCyclePaymentsByContract	List of off-cycle payments
getOffCyclePaymentByContractAndId	Retrieve a single off-cycle payment

TimeOff

Method	Description
createEorTimeOffs	Add a time off request (obsolete)
getEorTimeOffs	List time off by contract (obsolete)
deleteEorTimeOffs	Cancel a time off request (obsolete)
editEorTimeOffs	Edit a time off request (obsolete)
getEorEntitlements	List time off entitlements (obsolete)
getEorClientTimeOffs	List of time offs (obsolete)
reviewTimeoff	Review a time off request (obsolete)

Invoices

Method	Description
getInvoiceAdjustmentsByContractId	Invoice line items by contract
createInvoiceAdjustment	Create an invoice adjustment
getInvoiceAdjustments	List invoice adjustments
updateInvoiceAdjustmentById	Update an invoice adjustment
deleteInvoiceAdjustmentById	Delete an invoice adjustment
createInvoiceAdjustmentReview	Review an invoice adjustment
createInvoiceAdjustmentReviews	Bulk review invoice adjustments
getInvoiceAdjustmentsAttachment	Retrieve Attachment file url.

Organizations

Method	Description
getLegalEntityList	List of legal entities
getOrganizations	Get current organization
getTeams	Get team list
getAgreements	Get agreements with Deel.
getDepartments	Retrieve departments
getWorkingLocations	Retrieve working locations

Lookups

Method	Description
getCountries	Country list
getCurrencies	Currency list
getJobTitleList	Job titles list
getSeniorityList	Seniority levels
getTimeoffTypeList	Time-off types

Webhooks

Method	Description
createWebhook	Create a webhook
getAllWebhooks	List of webhooks
webhookControllerGetById	Retrieve a single webhook
webhookControllerEditById	Edit a webhook
webhookControllerDeleteById	Delete a webhook
getAllWebhookEventTypes	List of webhook event types

Token

Method	Description
createPublicToken	Create a public token

Carta

Method	Description
getEquityStakeholders	Retrieve stakeholders

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'}

Name	Type	Description
issuedFromDate	string	to get records created after given issue date
issuedToDate	string	to get records created before given issued date
entities	Entities	Filter by legal entity type; company, or individual
limit	number	Return a page of results with given number of records; NOTE technically ALL query parameters are strings or array of strings
offset	number	Return a page of results after given index of row; NOTE technically ALL query parameters are strings or array of strings'

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

Name	Type	Description
contractId	string	Deel contract id.

Optional Parameters

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

Name	Type	Description
limit	number	Return a page of results with given number of records; NOTE technically ALL query parameters are strings or array of strings
offset	number	Return a page of results after given index of row; NOTE technically ALL query parameters are strings or array of strings'

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

Name	Type	Description
invoiceId	string	ID of an existing invoice

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'}

Name	Type	Description
dateFrom	string	Filtered results will include records created on or after the provided date.
dateTo	string	Filtered results will include records created before the provided date.
currencies	Currencies	Currency codes of contracts to filter.
entities	Entities	Filter by legal entity type; company, or individual

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

Name	Type	Description
paymentId	string

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'}

Name	Type	Description
limit	string	Maximum number of records to return.
offset	string	Offset/index of record for the next page of records to return.

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'}

Name	Type	Description
offset	number	Return a page of results with given number of records.
limit	number	Return a page of results with given number of records.

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'}

Name	Type	Description
offset	number	Return a page of results with given number of records.
limit	number	Return a page of results with given number of records.
search	string	Include a contract if by name or contractor name contains given search term.
sortBy	PeopleSortByEnum	Sort people by given field name.
sortOrder	SortDirEnum	Order direction of results; ascending or descending.
hiringStatuses_	HiringStatusEnum	Employee's current hiring status.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.
input	object	Request body.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.
input	object	Request body.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.
input	object	Request body.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.

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

Name	Type	Description
timeoffId	string	Unique identifier for a time-off in Deel.
workerId	string	Unique identifier for a worker.
input	object	Request body.

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

Name	Type	Description
timeoffId	string	Unique identifier for a time-off in Deel.
workerId	string	Unique identifier for a worker.

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

Name	Type	Description
timeoffId	string	Unique identifier for a time-off in Deel.
workerId	string	Unique identifier for a worker.
input	object	Request body.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.

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

Name	Type	Description
countryCode	string	Country code.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.
payslipId	string	Unique identifier for a payslip.

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

Name	Type	Description
contractId	string	Deel contract id.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.
input	object	Request body.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.
input	object	Request body.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.
bankId	string	Bank Account id.
input	object	Request body.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.
input	object	Request body.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.
input	object	Request body.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.
input	object	Request body.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.
payslipId	string	Unique identifier for a payslip.

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

Name	Type	Description
legalEntityId	string	Id of an legal entity.

Optional Parameters

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

Name	Type	Description
startDate	string	Start date of payroll report.

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

Name	Type	Description
gpReportId	string	Id of gp report.

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

Name	Type	Description
gpReportId	string	Id of gp report.

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

Name	Type	Description
workerId	string	Unique identifier for a worker.
input	object	Request body.

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

Name	Type	Description
contractId	string	Deel contract id.

Optional Parameters

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

Name	Type	Description
templateId	string	ID of an existing contract template.

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

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

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

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

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

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

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

Name	Type	Description
contractId	string	Deel contract id.

Optional Parameters

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

Name	Type	Description
reason	string	Reason for deleting an existing Deel Premium from a contract.

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

Name	Type	Description
adjustmentId	string	Adjustment id.

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

Name	Type	Description
adjustmentId	string	Adjustment id.
input	object	Request body.

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

Name	Type	Description
adjustmentId	string	Adjustment id.

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

OutputToCreateFileRefContainer

Example Usage Code Snippet

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

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

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

getAdjustments

Retrieve adjustments

• HTTP Method: GET
• Endpoint: /contracts/{contract_id}/adjustments

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

Optional Parameters

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

Name	Type	Description
from_	string	Filter adjustments by start date.
to	string	Filter adjustments by end date.

Return Type

AdjustmentsContainer

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.getAdjustments('contract_id', {
    from: '1962-09-03',
    to: '1931-09-16',
  });
  console.log(result);
})();

addCandidate

Add Candidate

• HTTP Method: POST
• Endpoint: /candidates

Required Parameters

| input | object | Request body. |

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.candidates.addCandidate(input);
  console.log(result);
})();

patchCandidate

Update Candidate

• HTTP Method: PATCH
• Endpoint: /candidates/{candidate_id}

Required Parameters

Name	Type	Description
candidateId	string	Candidate id.
input	object	Request body.

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.candidates.patchCandidate(input, 'candidate_id');
  console.log(result);
})();

addEmployeeAdditionalInformation

Add additional information

• HTTP Method: POST
• Endpoint: /partner-managed/employees/{employee_id}/contracts/{contract_id}/additional-information

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.
contractId	string	Deel contract id.
input	object	Request body.

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 result = await sdk.partnerManaged.addEmployeeAdditionalInformation(
    'employee_id',
    'contract_id',
  );
  console.log(result);
})();

signEmployeeContract

Sign a contract

• HTTP Method: POST
• Endpoint: /partner-managed/employees/{employee_id}/contracts/{contract_id}/signatures

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.
contractId	string	Deel contract id.
input	object	Request body.

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.partnerManaged.signEmployeeContract(input, 'employee_id', 'contract_id');
  console.log(result);
})();

requestCustomVerificationLetter

Request custom verification letter

• HTTP Method: POST
• Endpoint: /partner-managed/employees/{employee_id}/contracts/{contract_id}/custom-verification-letter

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.
contractId	string	Deel contract id.
input	object	Request body.

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.partnerManaged.requestCustomVerificationLetter(
    input,
    'employee_id',
    'contract_id',
  );
  console.log(result);
})();

getHrVerificationLettersAndDocuments

List HR verification letters and documents

• HTTP Method: GET
• Endpoint: /partner-managed/employees/{employee_id}/contracts/{contract_id}/hr-documents

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.
contractId	string	Deel contract id.

Return Type

HrVerificationLettersAndDocumentsListContainer

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.partnerManaged.getHrVerificationLettersAndDocuments(
    'employee_id',
    'contract_id',
  );
  console.log(result);
})();

downloadHrVerificationLettersAndDocuments

Download HR verification letters and documents

• HTTP Method: GET
• Endpoint: /partner-managed/employees/{employee_id}/contracts/{contract_id}/hr-documents/{document_id}/download

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.
contractId	string	Deel contract id.
documentId	number	Unique identifier for a compliance document in Deel.

Return Type

EmployeeAgreementDownloadContainer

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.partnerManaged.downloadHrVerificationLettersAndDocuments(
    'employee_id',
    'contract_id',
    85944009.06556347,
  );
  console.log(result);
})();

getOfferLetterPreview

Preview job offer letter

• HTTP Method: GET
• Endpoint: /partner-managed/employees/{employee_id}/contracts/{contract_id}/offer-letter

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.
contractId	string	Deel contract id.

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.partnerManaged.getOfferLetterPreview('employee_id', 'contract_id');
  console.log(result);
})();

getEmployeeAgreementPreview

Preview employee agreement

• HTTP Method: GET
• Endpoint: /partner-managed/employees/{employee_id}/contracts/{contract_id}/employee-agreement

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.
contractId	string	Deel contract id.

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.partnerManaged.getEmployeeAgreementPreview('employee_id', 'contract_id');
  console.log(result);
})();

getEmployeeAgreementDownloadLink

Download employee agreement PDF

• HTTP Method: GET
• Endpoint: /partner-managed/employees/{employee_id}/contracts/{contract_id}/employee-agreement/download

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.
contractId	string	Deel contract id.

Return Type

EmployeeAgreementDownloadContainer

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.partnerManaged.getEmployeeAgreementDownloadLink(
    'employee_id',
    'contract_id',
  );
  console.log(result);
})();

getBankAccountGuide

Bank account form

• HTTP Method: GET
• Endpoint: /partner-managed/employees/{employee_id}/banks/guide

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.

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.partnerManaged.getBankAccountGuide('employee_id');
  console.log(result);
})();

addBankAccount

Add bank account

• HTTP Method: POST
• Endpoint: /partner-managed/employees/{employee_id}/banks

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.
input	object	Request body.

Return Type

BankAccountAddedContainer

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.partnerManaged.addBankAccount(input, 'employee_id');
  console.log(result);
})();

patchBankAccount

Modify bank account for an EOR employee

• HTTP Method: PATCH
• Endpoint: /partner-managed/employees/{employee_id}/banks/{bank_id}

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.
bankId	string	Bank Account id.
input	object	Request body.

Return Type

BankAccountAddedContainer

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.partnerManaged.patchBankAccount(input, 'employee_id', 'bank_id');
  console.log(result);
})();

getEmployeePayslips

Get list of payslips for an EOR employee

• HTTP Method: GET
• Endpoint: /partner-managed/employees/{employee_id}/payslips

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.

Return Type

EmployeePayslipsListContainer

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.partnerManaged.getEmployeePayslips('employee_id');
  console.log(result);
})();

getEmployeeComplianceDocuments

List of employee compliance documents

• HTTP Method: GET
• Endpoint: /partner-managed/employees/{employee_id}/compliance-documents

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.

Return Type

GetEmployeeComplianceDocumentsContainer

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.partnerManaged.getEmployeeComplianceDocuments('employee_id');
  console.log(result);
})();

uploadEmployeeComplianceDocument

Upload employee compliance document

• HTTP Method: POST
• Endpoint: /partner-managed/employees/{employee_id}/compliance-documents/{document_id}

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.
documentId	number	Unique identifier for a compliance document in Deel.
input	object	Request body.

Return Type

UploadEmployeeComplianceDocumentContainer

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.partnerManaged.uploadEmployeeComplianceDocument(
    input,
    'employee_id',
    87785624.46084926,
  );
  console.log(result);
})();

getEmployeeComplianceDocumentTemplate

Download employee compliance document template

• HTTP Method: GET
• Endpoint: /partner-managed/employees/{employee_id}/compliance-documents/{document_id}/templates/download

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.
documentId	number	Unique identifier for a compliance document in Deel.

Return Type

GetEmployeeComplianceDocumentTemplateDownloadLinkContainer

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.partnerManaged.getEmployeeComplianceDocumentTemplate(
    'employee_id',
    -69005078.64054286,
  );
  console.log(result);
})();

getEmployeeTaxDocuments

List of tax documents for an employee

• HTTP Method: GET
• Endpoint: /partner-managed/employees/{employee_id}/tax-documents

Required Parameters

Name	Type	Description
employeeId	string	Unique identifier for an employee in Deel.

Return Type

EmployeeTaxDocumentsListContainer

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.partnerManaged.getEmployeeTaxDocuments('employee_id');
  console.log(result);
})();

createContract

Create a new contract

• HTTP Method: POST
• Endpoint: /contracts

Required Parameters

| input | object | Request body. |

Return Type

ContractContainer

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.contracts.createContract();
  console.log(result);
})();

getContractList

List of contracts

• HTTP Method: GET
• Endpoint: /contracts

Optional Parameters

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

Name	Type	Description
afterCursor	string	Return next page of results after given cursor.
limit	number	Return a page of results with given number of records; NOTE technically ALL query parameters are strings or array of strings
orderDirection	SortDirEnum	Order direction of results; ascending or descending.
types	ContractTypeEnumList	You can filter contracts by type, a contract is included in results if its type is in this list.
statuses	ContractStatusEnumList	You can filter contracts by current status, a contract is included in results if its status is in this list.
teamId	string	Filter contracts for given team ID; NOTE: technically ALL query parameters are strings or array of strings
externalId	string	Filter contracts for given external ID
countries	string[]	Country codes of contracts to filter.
currencies	Currencies	Currency codes of contracts to filter.
search	string	Include a contract if by name or contractor name contains given search term.
sortBy	ContractsSortByEnum	Sort contracts by given field name.

Return Type

ContractListContainer

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.contracts.getContractList({
    afterCursor: 'after_cursor',
    limit: 10,
    orderDirection: 'asc',
    types: ['aliquip esse', 'fugiat consequat voluptate'],
    statuses: ['dolor id aliqua qui nostrud', 'voluptate irure ex nostrud'],
    teamId: 'team_id',
    externalId: 'external_id',
    countries: ['US', 'US'],
    currencies: 'foo',
    search: 'search',
    sortBy: 'contract_title',
  });
  console.log(result);
})();

getContractById

Retrieve a single contract

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

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

Return Type

ContractContainer

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.contracts.getContractById('contract_id');
  console.log(result);
})();

attachExternalId

External Id

• HTTP Method: PATCH
• Endpoint: /contracts/{contract_id}

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

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.contracts.attachExternalId(input, 'contract_id');
  console.log(result);
})();

addContractDocument

Attach a file to contract

• HTTP Method: POST
• Endpoint: /contracts/{contract_id}/documents

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

Return Type

ContractDocumentContainer

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.contracts.addContractDocument(input, 'contract_id');
  console.log(result);
})();

editContractDocument

Edit the file attached to contract document.

• HTTP Method: PUT
• Endpoint: /contracts/{contract_id}/documents

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

Return Type

ContractDocumentContainer

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.contracts.editContractDocument(input, 'contract_id');
  console.log(result);
})();

getAlternateEmailsByContractId

Find contract emails by ID

• HTTP Method: GET
• Endpoint: /contracts/{contract_id}/alternate_emails

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

Return Type

AlternateEmailList

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.contracts.getAlternateEmailsByContractId('contract_id');
  console.log(result);
})();

signContract

Sign a contract

• HTTP Method: POST
• Endpoint: /contracts/{contract_id}/signatures

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

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.contracts.signContract(input, 'contract_id');
  console.log(result);
})();

archiveContract

Archive a contract

• HTTP Method: PATCH
• Endpoint: /contracts/{contract_id}/archive

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

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 result = await sdk.contracts.archiveContract('contract_id');
  console.log(result);
})();

inviteToSignContract

Send contract to worker

• HTTP Method: POST
• Endpoint: /contracts/{contract_id}/invitations

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

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.contracts.inviteToSignContract(input, 'contract_id');
  console.log(result);
})();

uninviteToSignContract

Remove invite

• HTTP Method: DELETE
• Endpoint: /contracts/{contract_id}/invitations

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

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.contracts.uninviteToSignContract('contract_id');
  console.log(result);
})();

calculateFinalPayment

Calculate final payment

• HTTP Method: GET
• Endpoint: /contracts/{contract_id}/final-payments

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

Optional Parameters

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

Name	Type	Description
endDate	string	The day to end the contract.
calculationType	CalculationType	The days to calculate.
workweekStart	string	The day the work week starts, 0 to 6
workweekEnd	string	The day the work week ends, 0 to 6

Return Type

FinalPaymentCalculatedContainer

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.contracts.calculateFinalPayment('contract_id', {
    endDate: '1999-12-31',
    calculationType: 'WORK_DAYS',
    workweekStart: 'workweek_start',
    workweekEnd: 'workweek_end',
  });
  console.log(result);
})();

postContractEstimate

Calculate first payment amount

• HTTP Method: POST
• Endpoint: /contracts/estimate

Required Parameters

| input | object | Request body. |

Return Type

ResponseEstimateFirstPaymentContainer

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.contracts.postContractEstimate(input);
  console.log(result);
})();

getContractTemplates

Get contract templates

• HTTP Method: GET
• Endpoint: /contract-templates

Return Type

ContractTemplateListContainer

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.contracts.getContractTemplates();
  console.log(result);
})();

getWorkerDocumentsById

List of worker documents

• HTTP Method: GET
• Endpoint: /workers/{worker_id}/documents

Required Parameters

Name	Type	Description
workerId	string	Unique identifier for a worker.

Return Type

WorkerDocumentsByIdContainer

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.contracts.getWorkerDocumentsById('worker_id');
  console.log(result);
})();

getDownloadWorkerDocumentsById

Download worker document

• HTTP Method: GET
• Endpoint: /workers/{worker_id}/documents/{document_id}/download

Required Parameters

Name	Type	Description
workerId	string	Unique identifier for a worker.
documentId	number	Unique identifier for a compliance document in Deel.

Return Type

DownloadWorkerDocumentsByIdContainer

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.contracts.getDownloadWorkerDocumentsById(
    'worker_id',
    15072411.865135968,
  );
  console.log(result);
})();

createContractPgoTak

Create new task

• HTTP Method: POST
• Endpoint: /contracts/{contract_id}/tasks

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

Return Type

TaskCreatedContainer

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.tasks.createContractPgoTak(input, 'contract_id');
  console.log(result);
})();

getTasksByContract

List of tasks

• HTTP Method: GET
• Endpoint: /contracts/{contract_id}/tasks

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

Return Type

TaskListContainer

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.tasks.getTasksByContract('contract_id');
  console.log(result);
})();

createTaskManyReview

Review multiple tasks

• HTTP Method: POST
• Endpoint: /contracts/{contract_id}/tasks/many/reviews

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

Return Type

TaskListContainer

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.tasks.createTaskManyReview(input, 'contract_id');
  console.log(result);
})();

createTaskReviewById

Review a single task

• HTTP Method: POST
• Endpoint: /contracts/{contract_id}/tasks/{task_id}/reviews

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
taskId	string	ID of task entity.
input	object	Request body.

Return Type

TaskListContainer

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.tasks.createTaskReviewById(input, 'contract_id', 'task_id');
  console.log(result);
})();

deleteContractPgoTak

Delete task

• HTTP Method: DELETE
• Endpoint: /contracts/{contract_id}/tasks/{task_id}

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
taskId	string	ID of task entity.

Optional Parameters

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

Name	Type	Description
reason	string	Reason for deleting an existing task

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.tasks.deleteContractPgoTak('contract_id', 'task_id', {
    reason: 'reason',
  });
  console.log(result);
})();

getTimesheetsByContract

List of timesheets by contract

• HTTP Method: GET
• Endpoint: /contracts/{contract_id}/timesheets

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

Optional Parameters

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

Name	Type	Description
contractTypes	ContractTypeEnumList	Types of contracts to filter.
statuses	TimesheetStatusEnumList	Statuses of timesheets to filter.
reporterId	string	ID of an existing profile; NOTE: technically ALL query parameters are strings or array of strings
dateFrom	string	Filtered results will include records created on or after the provided date.
dateTo	string	Filtered results will include records created before the provided date.
limit	number	Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings
offset	number	Return a page of results after given index of row

Return Type

TimesheetListContainer

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.timesheets.getTimesheetsByContract('contract_id', {
    contractTypes: ['Ut eu', 'eu enim in'],
    statuses: ['aliquip ut aliqua', 'deserunt Duis commodo qui tempor'],
    reporterId: 'reporter_id',
    dateFrom: '1999-12-31',
    dateTo: '1999-12-31',
    limit: 99,
    offset: 42,
  });
  console.log(result);
})();

createTimesheet

Create a timesheet entry

• HTTP Method: POST
• Endpoint: /timesheets

Required Parameters

| input | object | Request body. |

Return Type

InvoiceAdjustmentCreatedContainer

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.timesheets.createTimesheet(input);
  console.log(result);
})();

getTimesheets

List of timesheets

• HTTP Method: GET
• Endpoint: /timesheets

Optional Parameters

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

Name	Type	Description
contractId	string	Id of a Deel contract.
contractTypes	ContractTypeEnumList	Types of contracts to filter.
statuses	TimesheetStatusEnumList	Statuses of timesheets to filter.
reporterId	string	ID of an existing profile; NOTE: technically ALL query parameters are strings or array of strings
dateFrom	string	Filtered results will include records created on or after the provided date.
dateTo	string	Filtered results will include records created before the provided date.
limit	number	Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings
offset	number	Return a page of results after given index of row

Return Type

TimesheetListContainer

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.timesheets.getTimesheets({
    contractId: 'contract_id',
    contractTypes: ['id', 'qui consequat reprehenderit sed'],
    statuses: ['mollit elit pariatur magna', 'dolor deserunt commodo'],
    reporterId: 'reporter_id',
    dateFrom: '1999-12-31',
    dateTo: '1999-12-31',
    limit: 99,
    offset: 42,
  });
  console.log(result);
})();

getTimesheetById

Retrieve a single timesheet entry

• HTTP Method: GET
• Endpoint: /timesheets/{timesheet_id}

Required Parameters

Name	Type	Description
timesheetId	string	ID of an existing timesheet

Return Type

TimesheetContainer

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.timesheets.getTimesheetById('timesheet_id');
  console.log(result);
})();

updateTimesheetById

Update a timesheet entry

• HTTP Method: PATCH
• Endpoint: /timesheets/{timesheet_id}

Required Parameters

Name	Type	Description
timesheetId	string	ID of an existing timesheet
input	object	Request body.

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.timesheets.updateTimesheetById(input, 'timesheet_id');
  console.log(result);
})();

deleteTimesheetById

Delete a timesheet entry

• HTTP Method: DELETE
• Endpoint: /timesheets/{timesheet_id}

Required Parameters

Name	Type	Description
timesheetId	string	ID of an existing timesheet

Optional Parameters

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

Name	Type	Description
reason	string	Reason for deleting an existing timesheet

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.timesheets.deleteTimesheetById('timesheet_id', { reason: 'reason' });
  console.log(result);
})();

createTimesheetReview

Review a single timesheet

• HTTP Method: POST
• Endpoint: /timesheets/{timesheet_id}/reviews

Required Parameters

Name	Type	Description
timesheetId	string	ID of an existing timesheet
input	object	Request body.

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.timesheets.createTimesheetReview(input, 'timesheet_id');
  console.log(result);
})();

createTimesheetReviews

Review multiple timesheets

• HTTP Method: POST
• Endpoint: /timesheets/many/reviews

Required Parameters

| input | object | Request body. |

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.timesheets.createTimesheetReviews(input);
  console.log(result);
})();

createMilestone

Create a milestone

• HTTP Method: POST
• Endpoint: /contracts/{contract_id}/milestones

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

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.milestones.createMilestone(input, 'contract_id');
  console.log(result);
})();

getMilestonesByContract

List of milestones by contract

• HTTP Method: GET
• Endpoint: /contracts/{contract_id}/milestones

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

Return Type

MilestoneListContainer

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.milestones.getMilestonesByContract('contract_id');
  console.log(result);
})();

getMilestonesByContractAndId

Retrieve a single milestone

• HTTP Method: GET
• Endpoint: /contracts/{contract_id}/milestones/{milestone_id}

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
milestoneId	string	ID of milestone to return

Return Type

MilestoneContainer

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.milestones.getMilestonesByContractAndId('contract_id', 'milestone_id');
  console.log(result);
})();

deleteMilestoneById

Delete a milestone

• HTTP Method: DELETE
• Endpoint: /contracts/{contract_id}/milestones/{milestone_id}

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
milestoneId	string	ID of milestone to return

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.milestones.deleteMilestoneById('contract_id', 'milestone_id');
  console.log(result);
})();

createMilestoneReview

Review a single milestone

• HTTP Method: POST
• Endpoint: /contracts/{contract_id}/milestones/{milestone_id}/reviews

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
milestoneId	string	ID of milestone to return
input	object	Request body.

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.milestones.createMilestoneReview(input, 'contract_id', 'milestone_id');
  console.log(result);
})();

createMilestoneReviews

Review multiple milestones

• HTTP Method: POST
• Endpoint: /contracts/{contract_id}/milestones/many/reviews

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

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.milestones.createMilestoneReviews(input, 'contract_id');
  console.log(result);
})();

createOffCyclePayment

Add off-cycle payment

• HTTP Method: POST
• Endpoint: /contracts/{contract_id}/off-cycle-payments

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

Return Type

GenericResultCreatedWithId

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.offCyclePayments.createOffCyclePayment(input, 'contract_id');
  console.log(result);
})();

getOffCyclePaymentsByContract

List of off-cycle payments

• HTTP Method: GET
• Endpoint: /contracts/{contract_id}/off-cycle-payments

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

Return Type

OffCyclePaymentListContainer

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.offCyclePayments.getOffCyclePaymentsByContract('contract_id');
  console.log(result);
})();

getOffCyclePaymentByContractAndId

Retrieve a single off-cycle payment

• HTTP Method: GET
• Endpoint: /contracts/{contract_id}/off-cycle-payments/{offcycle_payment_id}

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
offcyclePaymentId	string	ID of off-cycle payment to return

Return Type

OffCyclePaymentContainer

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.offCyclePayments.getOffCyclePaymentByContractAndId(
    'contract_id',
    'offcycle_payment_id',
  );
  console.log(result);
})();

createEorTimeOffs

Add a time off request (obsolete)

• HTTP Method: POST
• Endpoint: /contracts/{contract_id}/time-offs

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
input	object	Request body.

Return Type

EorTimeoffsItemContainer

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.timeOff.createEorTimeOffs(input, 'contract_id');
  console.log(result);
})();

getEorTimeOffs

List time off by contract (obsolete)

• HTTP Method: GET
• Endpoint: /contracts/{contract_id}/time-offs

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

Return Type

EorTimeoffsContainer

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.timeOff.getEorTimeOffs('contract_id');
  console.log(result);
})();

deleteEorTimeOffs

Cancel a time off request (obsolete)

• HTTP Method: DELETE
• Endpoint: /contracts/{contract_id}/time-offs/{timeoff_id}

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
timeoffId	string	Time off Id

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.timeOff.deleteEorTimeOffs('contract_id', 'timeoff_id');
  console.log(result);
})();

editEorTimeOffs

Edit a time off request (obsolete)

• HTTP Method: PUT
• Endpoint: /contracts/{contract_id}/time-offs/{timeoff_id}

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.
timeoffId	string	Time off Id
input	object	Request body.

Return Type

EorTimeoffsItemContainer

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.timeOff.editEorTimeOffs(input, 'contract_id', 'timeoff_id');
  console.log(result);
})();

getEorEntitlements

List time off entitlements (obsolete)

• HTTP Method: GET
• Endpoint: /contracts/{contract_id}/entitlements

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

Return Type

EorEntitlementsContainer

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.timeOff.getEorEntitlements('contract_id');
  console.log(result);
})();

getEorClientTimeOffs

List of time offs (obsolete)

• HTTP Method: GET
• Endpoint: /time-offs

Return Type

EorClientTimeoffsContainer

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.timeOff.getEorClientTimeOffs();
  console.log(result);
})();

reviewTimeoff

Review a time off request (obsolete)

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

Required Parameters

Name	Type	Description
timeoffId	string	Time off Id
input	object	Request body.

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.timeOff.reviewTimeoff(input, 'timeoff_id');
  console.log(result);
})();

getInvoiceAdjustmentsByContractId

Invoice line items by contract

• HTTP Method: GET
• Endpoint: /contracts/{contract_id}/invoice-adjustments

Required Parameters

Name	Type	Description
contractId	string	Deel contract id.

Optional Parameters

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

Name	Type	Description
contractTypes	ContractTypeEnumList	types of contracts to filter
types	InvoiceAdjustmentTypeEnumList	types of invoice adjustments to filter
statuses	InvoiceAdjustmentStatusEnumList	statuses of invoice adjustment to filter
invoiceId	string	ID of an existing invoice; NOTE: technically ALL query parameters are strings or array of strings
reporterId	string	ID of an existing profile; NOTE: technically ALL query parameters are strings or array of strings
dateFrom	string	to get invoice adjustments submitted on or after given start date (inclusive)
dateTo	string	to get invoice adjustments submitted before given end date (excludes records submitted on this date)
limit	number	Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings
offset	number	Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings

Return Type

InvoiceAdjustmentListContainer

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.invoices.getInvoiceAdjustmentsByContractId('contract_id', {
    contractTypes: [
      'pariatur adipisicing consequat fugiat non',
      'reprehenderit nulla aliquip labore officia',
    ],
    types: ['mollit', 'do dolore'],
    statuses: ['ullamco Excepteur', 'adipisicing irure nisi voluptate'],
    invoiceId: 'invoice_id',
    reporterId: 'reporter_id',
    dateFrom: '1999-12-31',
    dateTo: '1999-12-31',
    limit: 10,
    offset: 42,
  });
  console.log(result);
})();

createInvoiceAdjustment

Create an invoice adjustment

• HTTP Method: POST
• Endpoint: /invoice-adjustments

Required Parameters

| input | object | Request body. |

Optional Parameters

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

Name	Type	Description
recurring	boolean	Add this invoice adjustment as recurring

Return Type

InvoiceAdjustmentCreatedContainer

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.invoices.createInvoiceAdjustment(input, { recurring: true });
  console.log(result);
})();

getInvoiceAdjustments

List invoice adjustments

• HTTP Method: GET
• Endpoint: /invoice-adjustments

Optional Parameters

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

Name	Type	Description
contractId	string	Id of an Deel contract.
contractTypes	ContractTypeEnumList	types of contracts to filter
types	InvoiceAdjustmentTypeEnumList	types of invoice adjustments to filter
statuses	InvoiceAdjustmentStatusEnumList	statuses of invoice adjustment to filter
invoiceId	string	ID of an existing invoice; NOTE: technically ALL query parameters are strings or array of strings
reporterId	string	ID of an existing profile; NOTE: technically ALL query parameters are strings or array of strings
dateFrom	string	to get invoice adjustments submitted on or after given start date (inclusive)
dateTo	string	to get invoice adjustments submitted before given end date (excludes records submitted on this date)
limit	number	Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings
offset	number	Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings

Return Type

InvoiceAdjustmentListContainer

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.invoices.getInvoiceAdjustments({
    contractId: 'contract_id',
    contractTypes: ['aliqua sunt laboris minim Ut', 'adipisicing'],
    types: ['in occaecat ea', 'fugiat ipsum magna culpa adipisicing'],
    statuses: ['eu dolore', 'mollit laboris culpa qui incididunt'],
    invoiceId: 'invoice_id',
    reporterId: 'reporter_id',
    dateFrom: '1999-12-31',
    dateTo: '1999-12-31',
    limit: 10,
    offset: 42,
  });
  console.log(result);
})();

updateInvoiceAdjustmentById

Update an invoice adjustment

• HTTP Method: PATCH
• Endpoint: /invoice-adjustments/{invoice_adjustment_id}

Required Parameters

Name	Type	Description
invoiceAdjustmentId	string	ID of an existing invoice adjustment
input	object	Request body.

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.invoices.updateInvoiceAdjustmentById(input, 'invoice_adjustment_id');
  console.log(result);
})();

deleteInvoiceAdjustmentById

Delete an invoice adjustment

• HTTP Method: DELETE
• Endpoint: /invoice-adjustments/{invoice_adjustment_id}

Required Parameters

Name	Type	Description
invoiceAdjustmentId	string	ID of an existing invoice adjustment

Optional Parameters

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

Name	Type	Description
reason	string	Reason for deleting an existing invoice adjustment

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.invoices.deleteInvoiceAdjustmentById('invoice_adjustment_id', {
    reason: 'reason',
  });
  console.log(result);
})();

createInvoiceAdjustmentReview

Review an invoice adjustment

• HTTP Method: POST
• Endpoint: /invoice-adjustments/{invoice_adjustment_id}/reviews

Required Parameters

Name	Type	Description
invoiceAdjustmentId	string	ID of an existing invoice adjustment
input	object	Request body.

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.invoices.createInvoiceAdjustmentReview(input, 'invoice_adjustment_id');
  console.log(result);
})();

createInvoiceAdjustmentReviews

Bulk review invoice adjustments

• HTTP Method: POST
• Endpoint: /invoice-adjustments/many/reviews

Required Parameters

| input | object | Request body. |

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.invoices.createInvoiceAdjustmentReviews(input);
  console.log(result);
})();

getInvoiceAdjustmentsAttachment

Retrieve Attachment file url.

• HTTP Method: GET
• Endpoint: /invoice-adjustments/{invoice_adjustment_id}/attachment

Required Parameters

Name	Type	Description
invoiceAdjustmentId	string	ID of an existing invoice adjustment

Return Type

InvoiceAdjustmentAttachmentContainer

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.invoices.getInvoiceAdjustmentsAttachment('invoice_adjustment_id');
  console.log(result);
})();

getLegalEntityList

List of legal entities

• HTTP Method: GET
• Endpoint: /legal-entities

Optional Parameters

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

Name	Type	Description
type_	string	Return list of global payroll legal entities if provided

Return Type

LegalEntityListContainer

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.organizations.getLegalEntityList({ type: 'type' });
  console.log(result);
})();

getOrganizations

Get current organization

• HTTP Method: GET
• Endpoint: /organizations

Return Type

OrganizationListContainer

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.organizations.getOrganizations();
  console.log(result);
})();

getTeams

Get team list

• HTTP Method: GET
• Endpoint: /teams

Return Type

TeamListContainer

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.organizations.getTeams();
  console.log(result);
})();

getAgreements

Get agreements with Deel.

• HTTP Method: GET
• Endpoint: /agreements

Optional Parameters

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

Name	Type	Description
contractId	string	Deel contract id.
limit	string	Maximum number of records to return.
offset	string	Offset/index of record for the next page of records to return.

Return Type

AgreementListContainer

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.organizations.getAgreements({
    contractId: 'contract_id',
    limit: '50',
    offset: '0',
  });
  console.log(result);
})();

getDepartments

Retrieve departments

• HTTP Method: GET
• Endpoint: /departments

Return Type

DepartmentsContainer

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.organizations.getDepartments();
  console.log(result);
})();

getWorkingLocations

Retrieve working locations

• HTTP Method: GET
• Endpoint: /working-locations

Return Type

WorkingLocationsContainer

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.organizations.getWorkingLocations();
  console.log(result);
})();

getCountries

Country list

• HTTP Method: GET
• Endpoint: /lookups/countries

Return Type

CountryListContainer

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.lookups.getCountries();
  console.log(result);
})();

getCurrencies

Currency list

• HTTP Method: GET
• Endpoint: /lookups/currencies

Return Type

CurrencyListContainer

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.lookups.getCurrencies();
  console.log(result);
})();

getJobTitleList

Job titles list

• HTTP Method: GET
• Endpoint: /lookups/job-titles

Optional Parameters

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

Name	Type	Description
limit	number	Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings
afterCursor	string	Return next page of results after given cursor

Return Type

JobTitleListContainer

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.lookups.getJobTitleList({ limit: 99, afterCursor: 'after_cursor' });
  console.log(result);
})();

getSeniorityList

Seniority levels

• HTTP Method: GET
• Endpoint: /lookups/seniorities

Optional Parameters

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

Name	Type	Description
limit	number	Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings

Return Type

SeniorityListContainer

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.lookups.getSeniorityList({ limit: 50 });
  console.log(result);
})();

getTimeoffTypeList

Time-off types

• HTTP Method: GET
• Endpoint: /lookups/time-off-types

Return Type

TimeoffTypeListContainer

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.lookups.getTimeoffTypeList();
  console.log(result);
})();

createWebhook

Create a webhook

• HTTP Method: POST
• Endpoint: /webhooks

Required Parameters

| input | object | Request body. |

Return Type

WebhookItemResponse

Example Usage Code Snippet

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

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

(async () => {
  const input = {
    api_version: 'v2',
    description: 'I like it very much.',
    events: ['contract.created'],
    name: 'My first webhook.',
    signing_key: 'signing_key',
    status: 'enabled',
    url: 'https://mywebhook.com',
  };
  const result = await sdk.webhooks.createWebhook(input);
  console.log(result);
})();

getAllWebhooks

List of webhooks

• HTTP Method: GET
• Endpoint: /webhooks

Return Type

WebhookListResponse

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.webhooks.getAllWebhooks();
  console.log(result);
})();

webhookControllerGetById

Retrieve a single webhook

• HTTP Method: GET
• Endpoint: /webhooks/{id}

Required Parameters

Name	Type	Description
id	string

Return Type

WebhookItemResponse

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.webhooks.webhookControllerGetById('id');
  console.log(result);
})();

webhookControllerEditById

Edit a webhook

• HTTP Method: PATCH
• Endpoint: /webhooks/{id}

Required Parameters

Name	Type	Description
id	string
input	object	Request body.

Return Type

WebhookItemResponse

Example Usage Code Snippet

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

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

(async () => {
  const input = {
    api_version: 'v2',
    description: 'My first webhook',
    events: ['contract.created'],
    name: 'Demo webhook',
    signing_key: 'signing_key',
    status: 'enabled',
    url: 'https://mywebhook.com/listening',
  };
  const result = await sdk.webhooks.webhookControllerEditById(input, 'id');
  console.log(result);
})();

webhookControllerDeleteById

Delete a webhook

• HTTP Method: DELETE
• Endpoint: /webhooks/{id}

Required Parameters

Name	Type	Description
id	string

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.webhooks.webhookControllerDeleteById('id');
  console.log(result);
})();

getAllWebhookEventTypes

List of webhook event types

• HTTP Method: GET
• Endpoint: /webhooks/events/types

Return Type

WebhookEventTypeListResponse

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.webhooks.getAllWebhookEventTypes();
  console.log(result);
})();

createPublicToken

Create a public token

• HTTP Method: POST
• Endpoint: /public-tokens

Required Parameters

| input | object | Request body. |

Return Type

PublicTokenCreatedContainer

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.token.createPublicToken(input);
  console.log(result);
})();

getEquityStakeholders

Retrieve stakeholders

• HTTP Method: GET
• Endpoint: /equity/stakeholders

Optional Parameters

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

Name	Type	Description
limit	number	Return a page of results with given number of records; NOTE technically ALL query parameters are strings or array of strings
cursor	string	Return next page of results after given cursor.

Return Type

EquityStakeholdersContainer

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.carta.getEquityStakeholders({ limit: 10, cursor: 'cursor' });
  console.log(result);
})();

License

License: MIT. See license in LICENSE.