Skip to content

letsdeel/deel-api-java-sdk

BranchesTags

Repository files navigation

deel-api-java-sdk

Deel REST API

  • API version: 1.25.0
    • Build date: 2025-01-30T13:28:39.821439594Z[GMT]
    • Generator version: 7.11.0

Deel REST API

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.deel</groupId>
  <artifactId>deel-api-java-sdk</artifactId>
  <version>2.1.37</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'deel-api-java-sdk' jar has been published to maven central.
    mavenLocal()       // Needed if the 'deel-api-java-sdk' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.deel:deel-api-java-sdk:2.1.37"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/deel-api-java-sdk-2.1.37.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AccountingApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.letsdeel.com/rest/v2");
    
    // Configure HTTP bearer authorization: deelToken
    HttpBearerAuth deelToken = (HttpBearerAuth) defaultClient.getAuthentication("deelToken");
    deelToken.setBearerToken("BEARER TOKEN");

    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    AccountingApi apiInstance = new AccountingApi(defaultClient);
    String id = "abcd1234efgh5678"; // String | The invoice ID used to identify the invoice to be downloaded.
    try {
      GetBillingInvoiceDownloadLink200Response result = apiInstance.getBillingInvoiceDownloadLink(id)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountingApi#getBillingInvoiceDownloadLink");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://api.letsdeel.com/rest/v2

Class Method HTTP request Description
AccountingApi getBillingInvoiceDownloadLink GET /invoices/{id}/download Download invoice PDF
AccountingApi getDeelInvoiceList GET /invoices/deel Retrieve Deel invoices
AccountingApi getInvoiceList GET /invoices Retrieve invoices
AccountingApi getPaymentList GET /payments Retrieve payment receipts
AccountingApi getPaymentsBreakDownById GET /payments/{payment_id}/breakdown Retrieve a payment breakdown
AdjustmentsApi createAdjustment POST /adjustments Create a new adjustment
AdjustmentsApi deleteAdjustment DELETE /adjustments/{id} Delete an adjustment
AdjustmentsApi getAdjustments GET /contracts/{contract_id}/adjustments Retrieve adjustments
AdjustmentsApi getAdjustmentsById GET /adjustments/{id} Retrieve an adjustment
AdjustmentsApi getCategories GET /adjustments/categories Retrieve categories
AdjustmentsApi updateAdjustment PATCH /adjustments/{id} Update an adjustment
BackgroundChecksApi createBackgroundCheckForContracts POST /background-checks/regular Create background check
BackgroundChecksApi getBackgroundChecksByContractId GET /background-checks/{contract_id} List background checks by contract
BackgroundChecksApi getBackgroundChecksOptions GET /background-checks/options List of background check options
CandidatesApi addCandidate POST /candidates Add Candidate
CandidatesApi patchCandidate PATCH /candidates/{candidate_id} Update Candidate
CartaApi getEquityStakeholders GET /equity/stakeholders Retrieve stakeholders
Class401KPlansApi cleanUpPlan POST /benefits/legal-entities/{id}/401k/plans/clean-up Clean up plan for a given legal entity
Class401KPlansApi createBenefitProviderIntegrationClient POST /benefits/legal-entities/{id}/benefits/401k/activate Activate the 401k integration for the legal entity
Class401KPlansApi delete401kPlanDefinition DELETE /benefits/legal-entities/{id}/401k/plans/{plan_id} Delete a 401k plan
Class401KPlansApi get401kPlansDefinition GET /benefits/legal-entities/{id}/401k/plans Get 401k plans for legal entity
Class401KPlansApi post401kPlansDefinition POST /benefits/legal-entities/{id}/401k/plans Create 401k plan for legal entity
Class401KPlansApi put401kPlansDefinition PUT /benefits/legal-entities/{id}/401k/plans/{plan_id} Update 401k plan
ConsentApi createConsentToken POST /consent_token Create a consent token
ContractorsApi addPremium POST /contracts/{contract_id}/premium Upgrade to Premium
ContractorsApi amendContractDetails POST /contracts/{contract_id}/amendments Amend contract
ContractorsApi createContract POST /contracts Create a new contract
ContractorsApi getContractPreview GET /contracts/{contract_id}/preview Preview a contract agreement
ContractorsApi removePremiumFromContract DELETE /contracts/{contract_id}/premium Downgrade from Premium
ContractorsApi terminateContract POST /contracts/{contractId}/terminations Terminate contract
ContractsApi addContractDocument POST /contracts/{contract_id}/documents Attach a file to contract
ContractsApi approveExerciseEquity PATCH /equity/exercise/{public_id} Approve an equity exercise
ContractsApi archiveContract PATCH /contracts/{contract_id}/archive Archive a contract
ContractsApi attachExternalId PATCH /contracts/{contract_id} External Id
ContractsApi editContractDocument PUT /contracts/{contract_id}/documents Edit the file attached to contract document.
ContractsApi getAlternateEmailsByContractId GET /contracts/{contract_id}/alternate_emails Find contract emails by ID
ContractsApi getContractById GET /contracts/{contract_id} Retrieve a single contract
ContractsApi getContractEquityWithholdingAmount GET /contracts/{contract_id}/equity_withholding_estimate Get an estimate of equity withholding amount.
ContractsApi getContractList GET /contracts List of contracts
ContractsApi getContractPaymentDates GET /contracts/{contract_id}/payment_cycles Retrieve contractor payment dates
ContractsApi getContractTemplates GET /contract-templates Retrieve contract templates
ContractsApi getDownloadWorkerDocumentsById GET /workers/{worker_id}/documents/{document_id}/download Download worker document
ContractsApi getInviteLink GET /contracts/{contract_id}/invite Get worker invite link
ContractsApi getWorkerDocumentsById GET /workers/{worker_id}/documents List of worker documents
ContractsApi inviteToSignContract POST /contracts/{contract_id}/invitations Send contract to worker
ContractsApi requestExerciseEquity POST /equity/exercise Create a request to exercise equity.
ContractsApi signContract POST /contracts/{contract_id}/signatures Sign a contract
ContractsApi uninviteToSignContract DELETE /contracts/{contract_id}/invitations Remove invite
CustomFieldsApi deleteContractCustomField DELETE /contracts/{contract_id}/custom_fields/{id} Delete Contract custom field by Id
CustomFieldsApi deleteCustomFieldValueFromWorker DELETE /people/{worker_id}/custom_fields/{id} Delete the custom field value from Worker by Id
CustomFieldsApi getCustomFieldFromContractsById GET /contracts/custom_fields/{id} Get custom fields from contracts
CustomFieldsApi getCustomFieldFromPeopleById GET /people/custom_fields/{id} Get custom field from people by id
CustomFieldsApi getCustomFieldValuesFromContract GET /contracts/{contract_id}/custom_fields Retrieve custom fields for a contract
CustomFieldsApi getCustomFieldValuesFromWorker GET /people/{worker_id}/custom_fields Retrieve custom fields for a worker
CustomFieldsApi getCustomFieldsFromContracts GET /contracts/custom_fields List all custom fields
CustomFieldsApi getCustomFieldsFromPeople GET /people/custom_fields List all custom fields
CustomFieldsApi upsertCustomFieldValueFromContracts PUT /contracts/{contract_id}/custom_fields Update custom field value
CustomFieldsApi upsertCustomFieldValueFromWorker PUT /people/{worker_id}/custom_fields Update custom field value
DeelAsAServiceApi addDaasEmployeeAdditionalInformation POST /daas/contracts/{contract_id}/additional-information Add additional information
DeelAsAServiceApi addEORBankAccount POST /daas/banks Add bank account
DeelAsAServiceApi daasSignEmployeeContract POST /daas/contracts/{contract_id}/signatures Sign a contract
DeelAsAServiceApi getDaasEmployeeAgreementDownloadLink GET /daas/contracts/{contract_id}/employee-agreement/download Download employee agreement PDF
DeelAsAServiceApi getDaasHrVerificationLettersAndDocuments GET /daas/contracts/{contract_id}/hr-documents List HR verification letters and documents
DeelAsAServiceApi getDaasOfferLetterPreview GET /daas/contracts/{contract_id}/offer-letter Preview job offer letter
DeelAsAServiceApi getEORBankAccountGuide GET /daas/banks/guide Retrieve bank account guide
DeelAsAServiceApi getEOREmployeeComplianceDocumentTemplate GET /daas/compliance-documents/{document_id}/templates/download Download employee compliance document template
DeelAsAServiceApi getEorEmployeeComplianceDocuments GET /daas/compliance-documents List of employee compliance documents
DeelAsAServiceApi getEorEmployeePayslips GET /daas/payslips Get list of payslips for an EOR employee
DeelAsAServiceApi getEorEmployeeTaxDocuments GET /daas/tax-documents List of tax documents for an employee
DeelAsAServiceApi patchEORBankAccount PATCH /daas/banks/{bank_id} Modify bank account for an EOR employee
DefaultApi addEditBankDetails POST /payouts/employees/methods Add/Edit Bank Details
DefaultApi deleteBankDetails DELETE /payouts/employees/methods/{id} Delete Bank Details
DefaultApi dynamicRequirements POST /payouts/employees/methods/bank_transfers/requirements Dynamic Requirements
DefaultApi getBankDetails GET /payouts/employees/methods Get Bank Details
DefaultApi profiles PATCH /profiles Profiles
EmployeesApi getBenefitEmployee GET /benefits/legal-entities/{id}/employees/{employee_id} Get employee from organization integrated with external benefits vendor
EmployeesApi getBenefitEmployees GET /benefits/legal-entities/{id}/employees Get employees from organization integrated with external benefits vendor
EnrollmentsApi delete401kEnrollmentsDefinition DELETE /benefits/legal-entities/{id}/contracts/{contract_id}/plans/{plan_id} Delete enrollment settings from an employee in a 401k plan
EnrollmentsApi get401kEnrollmentsDefinition GET /benefits/legal-entities/{id}/contracts/{contract_id}/plans/{plan_id} Get enrollment settings from an employee in a 401k plan
EnrollmentsApi post401kEnrollmentsDefinition POST /benefits/legal-entities/{id}/contracts/{contract_id}/plans/{plan_id} Enroll an employee in a 401k plan
EnrollmentsApi put401kEnrollmentsDefinition PUT /benefits/legal-entities/{id}/contracts/{contract_id}/plans/{plan_id} Change enrollment settings from an employee in a 401k plan
EorApi calculateEorEmploymentCost POST /eor/employment_cost Calculate Employee Costs Globally
EorApi cancelEorContract POST /eor/contract/{oid}/cancel Cancel EOR Contract
EorApi createEorContract POST /eor Create an EOR contract
EorApi delayEorEmployeeOnboarding PATCH /eor/contract/{oid}/delay-onboarding Delay EOR employee onboarding
EorApi eorResignationRequest POST /eor/{oid}/terminations/resignation Request EOR Contract Resignation
EorApi eorTerminationRequest POST /eor/{oid}/terminations/regular Termination Request
EorApi getEORContractBenefits GET /eor/{contract_id}/benefits Retrieve Benefits for EOR Contract
EorApi getEORWorkerPayslipDownloadUrl GET /eor/workers/{worker_id}/payslips/{payslip_id}/download Retrieve payslip PDF download link
EorApi getEORWorkerPayslips GET /eor/workers/{worker_id}/payslips Retrieve employee payslip records
EorApi getEorCountryValidations GET /eor/validations/{country_code} Retrieve detailed hiring guide for a country
EorApi getEorTermination GET /eor/{oid}/terminations/{terminationId} Get termination
EorApi requestEorContractResignationMadeByEmployee POST /eor/{oid}/terminations/resignation-by-employee Request EOR Contract Resignation Made by Employee
EorApi updateEorContract PATCH /eor/contract/{oid} Update EOR Contract
GlobalPayrollApi addGpBankAccount POST /gp/workers/{worker_id}/banks Add bank account
GlobalPayrollApi createGPContract POST /contracts/gp Create a contract
GlobalPayrollApi downloadGrossToNetGPReport GET /gp/reports/{gp_report_id}/gross_to_net/csv Download gross-to-net report
GlobalPayrollApi getDownloadUrlForGPPayslip GET /gp/workers/{id}/payslips/{payslipId}/download Download payslip PDF
GlobalPayrollApi getGPLegalEntities GET /gp/legal-entities/{id}/reports List payroll events by legal entity
GlobalPayrollApi getGpBankAccounts GET /gp/workers/{worker_id}/banks Retrieve bank accounts
GlobalPayrollApi getGpBankGuide GET /gp/workers/{worker_id}/banks/guide Retrieve bank guide
GlobalPayrollApi getGrossToNetGPReports GET /gp/reports/{id}/gross_to_net List gross-to-net report
GlobalPayrollApi getWorkerPayslips GET /gp/workers/{id}/payslips Retrieve employee payslips
GlobalPayrollApi patchGpBankAccount PATCH /gp/workers/{worker_id}/banks/{bank_id} Modify bank account
GlobalPayrollApi requestTermination POST /gp/workers/{worker_id}/terminations Request termination
GlobalPayrollApi updateGPEmployeeAddress PATCH /gp/workers/{worker_id}/address Update address
GlobalPayrollApi updateGPEmployeeCompensation PATCH /gp/workers/{worker_id}/compensation Update compensation
GlobalPayrollApi updateGPEmployeeInformation PATCH /gp/workers/{worker_id}/employee-information Update employee information
GlobalPayrollApi updateGPEmployeePto PATCH /gp/workers/{worker_id}/pto-policy Update PTO policy
GroupsApi createGroup POST /groups Create a group
GroupsApi deleteGroup DELETE /groups/{id} Delete a group
GroupsApi editGroup PATCH /groups/{id} Edit a group
GroupsApi getGroups GET /groups Return list of groups
ImmigrationApi createCase POST /immigration/client/cases Create an immigration case
ImmigrationApi immigrationCaseDetails GET /immigration/client/cases/{id} Immigration case details
ImmigrationApi immigrationDocument GET /immigration/documents/{id} Immigration document
ImmigrationApi immigrationVisaTypes GET /immigration/visa-types/{country_code} Immigration visa types
IntegrationsApi getConsent GET /integrations/consent Get integration consent
InvoicesApi createInvoiceAdjustment POST /invoice-adjustments Create an invoice adjustment
InvoicesApi createInvoiceAdjustmentReviews POST /invoice-adjustments/many/reviews Bulk review invoice adjustments
InvoicesApi getInvoiceAdjustments GET /invoice-adjustments List invoice adjustments
InvoicesApi getInvoiceAdjustmentsByContractId GET /contracts/{contract_id}/invoice-adjustments Invoice line items by contract
InvoicesApi updateInvoiceAdjustment PATCH /invoice-adjustments/{id} Update an invoice adjustment
InvoicesApi updateInvoiceAdjustmentById POST /invoice-adjustments/{id}/reviews Update an invoice adjustment
LegalEntitiesApi createLegalEntity POST /legal-entities Create a new legal entity
LegalEntitiesApi deleteLegalEntity DELETE /legal-entities/{id} Delete a legal entity
LegalEntitiesApi editLegalEntity PATCH /legal-entities/{id} Edit a legal entity
LegalEntitiesApi getLegalEntity GET /benefits/legal-entities/{id} Get legal entity data from organization integrated with external benefits vendor
LegalEntitiesApi getLegalEntityPayrollSettings GET /benefits/legal-entities/{id}/payroll-settings Get legal entity payroll settings from organization integrated with external benefits vendor
LoansApi post401kSingleDeductionDefinition POST /benefits/legal-entities/{id}/contracts/{contract_id}/plans/{plan_id}/deductions Create a single deduction loan
LookupsApi getCountries GET /lookups/countries Retrieve Country List
LookupsApi getCurrencies GET /lookups/currencies Retrieve Supported Currency List
LookupsApi getJobTitleList GET /lookups/job-titles Job titles list
LookupsApi getLookups GET /lookups Retrieve lookup information for currencies, countries, entity types, etc
LookupsApi getSeniorityList GET /lookups/seniorities Retrieve Seniority Levels
LookupsApi getTimeoffTypeList GET /lookups/time-off-types Retrieve Time-Off Types
ManagersApi createManager POST /managers Create a Manager
ManagersApi getManagers GET /managers Retrieve List of Managers
MilestonesApi createMilestone POST /contracts/{contract_id}/milestones Create a Milestone
MilestonesApi createMilestoneReview POST /contracts/{contract_id}/milestones/{milestone_id}/reviews Review a single milestone
MilestonesApi createMilestoneReviews POST /contracts/{contract_id}/milestones/many/reviews Review multiple milestones
MilestonesApi deleteMilestoneById DELETE /contracts/{contract_id}/milestones/{milestone_id} Delete a Milestone
MilestonesApi getMilestonesByContract GET /contracts/{contract_id}/milestones Retrieve Milestones by Contract
MilestonesApi getMilestonesByContractAndId GET /contracts/{contract_id}/milestones/{milestone_id} Retrieve a single milestone
OffCyclePaymentsApi createOffCyclePayment POST /contracts/{contract_id}/off-cycle-payments Add off-cycle payment
OffCyclePaymentsApi getOffCyclePaymentByContractAndId GET /contracts/{contract_id}/off-cycle-payments/{id} Retrieve a single off-cycle payment
OffCyclePaymentsApi getOffCyclePaymentsByContract GET /contracts/{contract_id}/off-cycle-payments List of off-cycle payments
OffboardingApi offboardingTrackerGet GET /offboarding/tracker Retrieve offboarding list
OffboardingApi offboardingTrackerHrisProfileOidGet GET /offboarding/tracker/hris_profile/{oid} Retrieve termination details
OffboardingApi offboardingTrackerIdGet GET /offboarding/tracker/{id} Retrieve termination details
OnboardingApi listOnboardingTracker GET /onboarding/tracker List onboarding employees
OnboardingApi onboardingTrackerHrisProfileOidGet GET /onboarding/tracker/hris_profile/{oid} Get onboarding details by onboarding hris profile oid
OnboardingApi onboardingTrackerIdGet GET /onboarding/tracker/{id} Get onboarding details by onboarding tracker ID
OrganizationStructureApi createOrgStructure POST /hris/organization_structures Create a new HRIS Organization Structure.
OrganizationStructureApi deleteOrgStructure DELETE /hris/organization_structures/{hrisOrgStr_id} Delete an Org Structure from the Organization
OrganizationStructureApi deleteOrgStructureByExternalId DELETE /hris/organization_structures/external/{external_id} Delete an Org Structure from the Organization by external ID
OrganizationStructureApi getAllOrgStructures GET /hris/organization_structures Fetch all Org Structures from the Organization.
OrganizationStructureApi getOrgStructure GET /hris/organization_structures/{hrisOrgStr_id} Fetch an Org Structure from the Organization
OrganizationStructureApi getOrgStructureByExternalId GET /hris/organization_structures/external/{external_id} Fetch an Org Structure from the Organization
OrganizationStructureApi updateOrgStructure PATCH /hris/organization_structures/{hrisOrgStr_id} Update an existing HRIS Org Structure
OrganizationStructureApi updateOrgStructureByExternalId PATCH /hris/organization_structures/external/{external_id} Update an existing HRIS Org Structure by external ID
OrganizationsApi createOrganizationRole POST /roles Create organization custom role.
OrganizationsApi getDepartments GET /departments Retrieve Departments
OrganizationsApi getLegalEntityList GET /legal-entities List of legal entities
OrganizationsApi getOrganizationRoles GET /roles Get the roles of the current organization.
OrganizationsApi getOrganizations GET /organizations Get Current Organization
OrganizationsApi getTeams GET /teams Get Team List
OrganizationsApi getWorkingLocations GET /working-locations Retrieve working locations
OrganizationsApi updateOrganizationRole PATCH /roles/{roleId} Update organization custom role
PartnerManagedApi addBankAccount POST /partner-managed/employees/{employee_id}/banks Add bank account
PartnerManagedApi addEmployeeAdditionalInformation POST /partner-managed/employees/{employee_id}/contracts/{contract_id}/additional-information Add additional information
PartnerManagedApi downloadHrVerificationLettersAndDocuments GET /partner-managed/employees/{employee_id}/contracts/{contract_id}/hr-documents/{document_id}/download Download HR verification letters and documents
PartnerManagedApi getBankAccountGuide GET /partner-managed/employees/{employee_id}/banks/guide Bank account form
PartnerManagedApi getEmployeeAgreementDownloadLink GET /partner-managed/employees/{employee_id}/contracts/{contract_id}/employee-agreement/download Download employee agreement PDF
PartnerManagedApi getEmployeeAgreementPreview GET /partner-managed/employees/{employee_id}/contracts/{contract_id}/employee-agreement Preview employee agreement
PartnerManagedApi getEmployeeComplianceDocumentTemplate GET /partner-managed/employees/{employee_id}/compliance-documents/{document_id}/templates/download Download employee compliance document template
PartnerManagedApi getEmployeeComplianceDocuments GET /partner-managed/employees/{employee_id}/compliance-documents List of employee compliance documents
PartnerManagedApi getEmployeePayslips GET /partner-managed/employees/{employee_id}/payslips Get list of payslips for an EOR employee
PartnerManagedApi getEmployeeTaxDocuments GET /partner-managed/employees/{employee_id}/tax-documents List of tax documents for an employee
PartnerManagedApi getHrVerificationLettersAndDocuments GET /partner-managed/employees/{employee_id}/contracts/{contract_id}/hr-documents List HR verification letters and documents
PartnerManagedApi getOfferLetterPreview GET /partner-managed/employees/{employee_id}/contracts/{contract_id}/offer-letter Preview job offer letter
PartnerManagedApi patchBankAccount PATCH /partner-managed/employees/{employee_id}/banks/{bank_id} Modify bank account for an EOR employee
PartnerManagedApi requestCustomVerificationLetter POST /partner-managed/employees/{employee_id}/contracts/{contract_id}/custom-verification-letter Request custom verification letter
PartnerManagedApi signEmployeeContract POST /partner-managed/employees/{employee_id}/contracts/{contract_id}/signatures Sign a contract
PartnerManagedApi uploadEmployeeComplianceDocument POST /partner-managed/employees/{employee_id}/compliance-documents/{document_id} Upload employee compliance document
PayoutsApi createBankTransferMethod POST /payouts/contractors/methods Create a bank transfer method
PayoutsApi getBankTransferRequirements GET /payouts/contractors/methods/bank_transfers/requirements Get bank transfer requirements
PayoutsApi getBankTransferSupportedRoutes GET /payouts/contractors/methods/bank_transfers/supported_routes Get bank transfer supported routes for contractor
PayoutsApi getPayoutMethods GET /payouts/contractors/methods Fetch all payout methods
PayoutsApi updateAutoWithdrawSetting POST /payouts/contractors/settings/auto_withdraw Update auto withdraw setting for contractor
PayoutsApi updateBankTransferMethod PUT /payouts/contractors/methods/{id} Update a bank transfer method
PayrollApi getPayStub GET /benefits/legal-entities/{id}/pay-stub Get pay stub from employees from organization integrated with external benefits vendor
PayrollApi getYearToDatePay GET /benefits/legal-entities/{id}/year-to-date-pay Get year to date payment for benefits 401k.
PaystubsApi getBenefitPaystubs GET /benefits/legal-entities/{legalEntityId}/paystubs Get paystubs from legal entity integrated with external benefits vendor
PeopleApi createDirectEmployee POST /people Create a direct employee
PeopleApi createDirectEmployeeOldTobeRemoved POST /hris/direct-employees-old-to-beremoved Create a new Hris direct employee
PeopleApi getPeople GET /people/me Get my current personal profile
PeopleApi getPeopleById GET /people/{hrisProfileOid} Retrieve a single person
PeopleApi getPeopleList GET /people List of people
PeopleApi getPeoplePersonalInformationByExternalId GET /people/external/{worker_id}/personal Get personal information by external id
PeopleApi getPeoplePersonalInformationById GET /people/{worker_id}/personal Get personal information by id
PeopleApi updatePeopleDepartment PUT /people/{id}/department Update department
PeopleApi updatePeoplePersonalInformationByExternalId PATCH /people/external/{worker_id}/personal Update personal information by external id
PeopleApi updatePeoplePersonalInformationById PATCH /people/{worker_id}/personal Update personal information
PeopleApi updatePeopleWorkingLocation PUT /people/{id}/working-location Update working location
PositionsApi applyChangesPositions POST /hris/positions/apply_changes Apply changes to positions.
PositionsApi getHrisPositions GET /hris/positions/profile/{hrisProfileId} Fetch HrisPositions from a HrisProfile
ReportsApi getDetailedPaymentsReport GET /reports/detailed-payments Detailed payments report
ScreeningsApi createManualVerificationScreening POST /screenings/manual-verification Create manual verification screening
ScreeningsApi createVeriffSession POST /veriff/session Create Veriff session
ScreeningsApi getVerificationMethod GET /screenings/verification-method Get verification method
TasksApi createContractPgoTak POST /contracts/{contract_id}/tasks Create a new task
TasksApi createTaskManyReview POST /contracts/{contract_id}/tasks/many/reviews Review multiple tasks
TasksApi createTaskReviewById POST /contracts/{contract_id}/tasks/{task_id}/reviews Review a single task
TasksApi deleteContractTaskById DELETE /contracts/{contract_id}/tasks/{task_id} Delete task
TasksApi getTasksByContract GET /contracts/{contract_id}/tasks List of tasks
TimeOffApi createTimeOff POST /time_offs Create time-off request
TimeOffApi deleteTimeOff DELETE /time_offs/{time_off_id} Delete time-off request
TimeOffApi getPoliciesForProfile GET /time_offs/profile/{hris_profile_id}/policies List policies
TimeOffApi getProfileEntitlements GET /time_offs/profile/{hris_profile_id}/entitlements Get Profile Entitlements
TimeOffApi getTimeOffsQuery GET /time_offs/profile/{hris_profile_id} List time-off requests
TimeOffApi getTimeOffsQueryForOrganization GET /time_offs List time-off requests for Organization
TimeOffApi updateTimeOff PATCH /time_offs/{time_off_id} Update time-off request
TimeTrackingRatesApi createShiftRate POST /time_tracking/shift_rates Create a New Shift Rate
TimeTrackingRatesApi deleteShiftRateExternalId DELETE /time_tracking/shift_rates/{external_id} Delete a ShiftRate by external ID
TimeTrackingRatesApi getShiftRate GET /time_tracking/shift_rates/{external_id} Retrieve a Shift Rate by External ID
TimeTrackingRatesApi getShiftRates GET /time_tracking/shift_rates Retrieve a Paginated List of Shift Rates
TimeTrackingRatesApi updateShiftRate PATCH /time_tracking/shift_rates/{external_id} Update a shift rate
TimeTrackingShiftsApi createShifts POST /time_tracking/shifts Create shifts
TimeTrackingShiftsApi deleteShiftExternalId DELETE /time_tracking/shifts/{external_id} Delete a Shift by External ID
TimeTrackingShiftsApi getShiftDetails GET /time_tracking/shifts/{external_id} Get shift details
TimeTrackingShiftsApi getShifts GET /time_tracking/shifts List of shifts
TimeTrackingShiftsApi updateShift PATCH /time_tracking/shifts/{external_id} Update a shift
TimesheetsApi createTimesheet POST /timesheets Create a timesheet entry
TimesheetsApi createTimesheetReview POST /timesheets/{id}/reviews Review a single timesheet
TimesheetsApi createTimesheetReviews POST /timesheets/many/reviews Review multiple timesheets
TimesheetsApi deleteTimesheetById DELETE /timesheets/{id} Delete a timesheet entry
TimesheetsApi getTimesheetById GET /timesheets/{id} Retrieve a single timesheet entry
TimesheetsApi getTimesheets GET /timesheets List of timesheets
TimesheetsApi getTimesheetsByContract GET /contracts/{contract_id}/timesheets List of timesheets by contract
TimesheetsApi updateTimesheetById PATCH /timesheets/{id} Update a timesheet entry
TokenApi createPublicToken POST /public-tokens Create a public token
WebhooksApi createWebhook POST /webhooks Create a webhook
WebhooksApi getAllWebhookEventTypes GET /webhooks/events/types List of webhook event types
WebhooksApi getAllWebhooks GET /webhooks List of webhooks
WebhooksApi webhookControllerDeleteById DELETE /webhooks/{id} Delete a webhook
WebhooksApi webhookControllerEditById PATCH /webhooks/{id} Edit a webhook
WebhooksApi webhookControllerGetById GET /webhooks/{id} Retrieve a single webhook
WorkerRelationsApi createOrUpdateChildRelationBetweenProfiles PUT /hris/worker_relations/profile/external/{hrisProfileExternalId}/child Create child worker relation with external Id
WorkerRelationsApi createOrUpdateParentRelationBetweenProfiles PUT /hris/worker_relations/profile/external/{hrisProfileExternalId}/parent Create a parent worker relation with external id
WorkerRelationsApi createWorkerRelation POST /hris/worker_relations/profile Create a worker relation
WorkerRelationsApi createWorkerRelationExternalId POST /hris/worker_relations/profile/external Create worker relation with external Ids
WorkerRelationsApi createWorkerRelationType POST /hris/worker_relations/types Create worker relation type
WorkerRelationsApi deleteWorkerRelation DELETE /hris/worker_relations/profile/{hrisProfileOid} Delete a worker relation
WorkerRelationsApi deleteWorkerRelationExternalId DELETE /hris/worker_relations/profile/external/{profileId} Delete a worker relation by external id
WorkerRelationsApi deleteWorkerRelationType DELETE /hris/worker_relations/types/{typeId} Delete a worker relation type
WorkerRelationsApi deleteWorkerRelationTypeExternalId DELETE /hris/worker_relations/types/external/{externalId} Delete a worker relation type by external id
WorkerRelationsApi getAllProfileWorkerRelations GET /hris/worker_relations/profile/{hrisProfileOid} List of worker relations
WorkerRelationsApi getAllProfileWorkerRelationsExternalId GET /hris/worker_relations/profile/external/{profileId} Fetch Worker Relations of a given HrisProfile by external id
WorkerRelationsApi getAllWorkerRelationTypes GET /hris/worker_relations/types Retrieve all worker relation types
WorkerRelationsApi updateWorkerRelationType PATCH /hris/worker_relations/types/{typeId} Update a worker relation type
WorkerRelationsApi updateWorkerRelationTypeExternalId PATCH /hris/worker_relations/types/external/{externalId} Update a worker relation type by external id
WorkerRelationsApi upsertChildWorkerRelations PUT /hris/worker_relations/profile/{hrisProfileOid}/child Create child worker relation
WorkerRelationsApi upsertChildWorkerRelationsExternalId PUT /hris/worker_relations/profile/external/{profileId}/child Create child worker relation with external Id
WorkerRelationsApi upsertParentWorkerRelations PUT /hris/worker_relations/profile/{hrisProfileOid}/parent Create a parent worker relation
WorkersApi createWorker POST /worker Create a new worker

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

deelToken

  • Type: HTTP Bearer Token authentication (JWT)

oauth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://auth.deel.com/authorize
  • Scopes:
    • accounting:read: View payments and invoices in your organization.
    • accounting:write: Create and edit payments and invoices.
    • candidates:read: View candidates in your organization.
    • candidates:write: Create, edit and delete candidates in your organization.
    • contracts:read: View contracts in your organization.
    • contracts:write: Create and amend contracts.
    • people:write: Write worker’s information such as profile, time-off and expense.
    • people:read: Read worker’s information such as profile, time-off and expenses.
    • profile:read: Read Profile information such as name, email, phone
    • Users:read: View information about people in Deel HR.
    • webhooks:read: View webhooks in your organization.
    • webhooks:write: Create and edit webhooks in your organization.
    • global-payroll:read: View global payroll information about your employees.
    • global-payroll:write: Write global payroll information about your employees.
    • adjustments:write: Create / update adjustments of your employee.
    • adjustments:read: View adjustments of your employee.
    • invoice-adjustments:read: View invoices of your workforce.
    • invoice-adjustments:write: Create, edit, review, and delete invoice adjustments.
    • milestones:read: View milestones of your contractors.
    • milestones:write: Create, edit, review, and delete milestones.
    • organizations:read: View basic information about your organizations, teams, legal entities and agreements.
    • organizations:write: Modify information in your organization. Create, edit, delete admin users or managers.
    • off-cycle-payments:read: View your off-cycle payments.
    • off-cycle-payments:write: Create, edit, review your off-cycle payments.
    • timesheets:read: View work submitted for time-based contracts.
    • timesheets:write: Create, edit, review, and delete timesheets.
    • tasks:read: View your pay-as-you-go tasks.
    • tasks:write: Create, edit, review and delete your pay-as-you-go tasks.
    • payslips:read: View employee payslips.
    • payslips:write: Create, edit, review and delete employee payslips.
    • public-token:write: Create, edit, review and delete public tokens.
    • profile:write: Write Profile information such as name, email, phone

public

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL:
  • Scopes:
    • contracts:read: View contracts in your organization.

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors 2

  •  
  •  

Languages