Changelog

Time Tracking Shifts → Create a shift for a contract: Endpoint is now available, which allows to record time a worker spent on a contract from an external time or workforce system so the hours reach approval and payroll without manual entry.

Time Tracking Shifts → List shifts in an organization: Endpoint is now available, which allows to list shifts recorded on an organization’s contracts for a period.

Time Tracking Shifts → Get a shift by ID: Endpoint is now available, which allows to retrieve a single shift by its ID and check its current approval state.

Time Tracking Shifts → Update a shift: Endpoint is now available, which allows to correct a shift recorded on a contract before its payroll period closes.

Time Tracking Shifts → Delete a shift: Endpoint is now available, which allows to remove a shift that should not have been recorded, before payroll closes its period.

Organizations → Remove admins from child organizations: Endpoint is now available, which allows to remove multiple admins from child organizations in one call.

Time Off → Get Profile Entitlements: Added country_data in the response that provides country-specific entitlement data, including Panama vacation cycle dates and earned vacation days.

Eor Contract → Update EOR Contract: Added dob to the request body that provides the employee’s date of birth.

Accounting → Get invoice by id: Added EOR_COMMISSION as a valid value for line_items[].type in the response.

Time Off → Retrieve policy validation templates: Added ALLOWED_WITH_INTERRUPTION as a valid value for overlap_request_type in the response; added interrupting_policy_type_codes to the response that lists policy type codes whose approved requests interrupt this policy; added WORK_SCHEDULE as a valid value for accrual_type in policy_allowances; added PRORATE_PUBLIC_HOLIDAYS as a valid value for accrual_prorate_types in policy_allowances.

Apps → Retrieve the listing of an app: Endpoint is now available, which allows to retrieve the App Store listing of an app, including its publication status, latest revision, and reviewer notes.

Organizations → Update a child organization bank account: Endpoint is now available, which allows to set a verified bank account as the default payment method for a child organization.

Organizations → Delete a child organization bank account: Endpoint is now available, which allows to remove a bank account from a child organization.

Organizations → Retrieve a child organization bank account: Endpoint is now available, which allows to retrieve the details of a child organization’s bank account, including its status, whether it is the default for debits, and whether it can be removed.

Organizations → List child organization bank accounts: Endpoint is now available, which allows to list the active bank accounts of a child organization with masked details and verification status.

Organizations → Create a child organization bank account: Endpoint is now available, which allows to add a US bank account (ACH direct debit) to a child organization and activate it via micro-deposit verification.

Organizations → Verify a child organization bank account: Endpoint is now available, which allows to verify a child organization bank account by confirming the two micro-deposit amounts.

Time Off → List time-off requests for Organization: Added CLIENT_INPUTS_FILE as a valid value for time_off_origin in the response.

Candidates → Add Candidate: Added team_id in the request that allows specifying the team for the candidate; when omitted or null, the default team is used.

Off Cycle → Add off-cycle payment: Added disable_withholding_tax to the request body that, when true, prevents the contract’s withholding tax from being applied to this off-cycle payment.

Time Off → Get Policies for Organization: Added WORK_SCHEDULE as a valid value for accrual_type in the response; added ALLOWED_WITH_INTERRUPTION as a valid value for overlap_request_type in the response; added interrupting_policy_type_codes in the response that lists the policy type codes whose approved requests interrupt requests of this policy.

Time Off → List policies: Added WORK_SCHEDULE as a valid value for accrual_type in the response; added ALLOWED_WITH_INTERRUPTION as a valid value for overlap_request_type in the response; added interrupting_policy_type_codes in the response that lists the policy type codes whose approved requests interrupt requests of this policy.

Apps → List App Store categories: Endpoint is now available, which allows to list App Store categories and their identifiers for use when configuring a listing.

Apps → List apps: Endpoint is now available, which allows to list the integration apps that belong to your organization.

Apps → Retrieve an app: Endpoint is now available, which allows to retrieve a single integration app that belongs to your organization.

Apps → Update an app: Endpoint is now available, which allows to update an integration app’s name, description, website, or redirect URLs.

Apps → Enable an app: Endpoint is now available, which allows to enable an integration app that belongs to your organization so it can obtain tokens again.

Apps → Disable an app: Endpoint is now available, which allows to disable an integration app that belongs to your organization so it can no longer obtain tokens, revoking all consents and tokens issued to it.

Time Tracking Shifts → Update multiple shifts: Endpoint is now available, which allows to update multiple shifts of a single Global Payroll contract in bulk.

Immigration → Get the worker onboarding case: Endpoint is now available, which allows to retrieve the newest onboarding immigration case of the worker behind the token.

Immigration → Get a case: Endpoint is now available, which allows to retrieve a single immigration case by its unique identifier.

Immigration → List immigration cases: Endpoint is now available, which allows to list immigration cases the token can see, newest first.

Immigration → Upload documents for a document request: Endpoint is now available, which allows to upload files for a pending compliance document request.

Immigration → Get the case document request: Endpoint is now available, which allows to retrieve the compliance document request for an immigration case, including the document details and status.

Immigration → Get a document: Endpoint is now available, which allows to retrieve an immigration document, follow its review status, or download it.

Adjustments → Retrieve an adjustment: Added deel_review in the response that provides the latest Deel review outcome for an EOR adjustment, including review status, reason, and reviewer details.

Ats Jobs → Retrieve a list of ATS jobs: Added hiring_member_role_ids as a query parameter that narrows hiring_member_hou_ids results to jobs where those people hold specific roles.

Immigration → List visa types: Added sponsorship, visa_category, and estimated_timeline response fields that indicate who can sponsor the visa, its category (work permit or business visa), and the estimated processing time.

Eor Amendments → Submit contract amendment for review: Added SOLVE_LEGAL and LEGAL_JIRA_REOPENED as valid values for legal_context.status in the response.

Onboarding → List onboarding employees: Added owner to each checklist step in the response indicating who acts on the step (the client, the worker, or Deel), and is_current to each contract indicating whether the contract is the focus of the overview.

Onboarding → Get onboarding details by employee HRIS profile ID: Added owner in the response that indicates who acts on each checklist step.

Onboarding → Get onboarding details by onboarding tracker ID: Added owner in the response that indicates who acts on each checklist step.

It Orders → Retrieve an IT order: Added delivery_estimate in the response that provides the estimated delivery date range for items still pending delivery.

Time Off → Get Policies for Organization: Added hourly_entitlement_amount, hourly_accrual_based_on, hourly_accrual_mode, and max_accrual_per_tracking_period in the response that expose hourly accrual settings for each policy allowance; added Strike as a valid value for the policy_type query parameter.

Time Off → List policies: Added hourly_entitlement_amount, hourly_accrual_based_on, hourly_accrual_mode, and max_accrual_per_tracking_period in the response that provide hourly accrual settings for each policy allowance.

Time Off → Get Profile Entitlements: Added Strike as a valid value for policy_type_name in the request.

Time Off → Process time-off requests from an external HRIS: Added Strike as a valid value for policy_type in the request.

Time Off → List time-off requests for Organization: Added Strike as a valid value for policy_type_names in the request.

Time Off → List time-off requests: Added Strike as a valid value for policy_type_names in the request.

Api Tokens → Retrieve an API token: Endpoint is now available, which allows to retrieve an API token by its identifier, without exposing its secret value.

Api Tokens → Invalidate an API token: Endpoint is now available, which allows to invalidate an API token that should no longer be used.

Api Tokens → List API tokens: Endpoint is now available, which allows to list your organization’s tokens and your own personal tokens, newest first, without their secret values.

Ats → Retrieve the ATS activity timeline: Added CANDIDATE_FOLLOW_UP_REMINDER as a valid value for category in the response and the categories query parameter, and added CANDIDATE_FOLLOW_UP_REMINDER_CREATED, CANDIDATE_FOLLOW_UP_REMINDER_UPDATED, CANDIDATE_FOLLOW_UP_REMINDER_COMPLETED, and CANDIDATE_FOLLOW_UP_REMINDER_DELETED as valid values for operation_type in the response.

Eor → Get amendment data points configuration by country: Added HOURLY_RATE as a valid value for item in the response.

Eor Amendments → Validate amendment data points: Added scope and job_title as declared fields in the request body data object.

People → Create a direct employee: Added invitation in the request that controls whether to send an invitation email to the new hire.

Onboarding → List onboarding employees: Added banners to the response (data[].overview) that lists all banners for the onboarding; added HS_OBLIGATIONS_PENDING as a valid value for overview.banner.key; added SET_UP_HEALTH_SAFETY as a valid value for overview.banner.action.

Onboarding → Get onboarding details by employee HRIS profile ID: Added banners array in the response that lists all pending banners for the worker; added HS_OBLIGATIONS_PENDING as a valid value for banner.key; added SET_UP_HEALTH_SAFETY as a valid value for banner.action.

Onboarding → Get onboarding details by onboarding tracker ID: Added banners array in the response that lists all client-action banners; added HS_OBLIGATIONS_PENDING as a valid value for banner.key and SET_UP_HEALTH_SAFETY as a valid value for banner.action.

It Assets → List IT assets: Added USED_AS_SPARE_PART as a valid value for status in the response.

Time Off → Get Policies for Organization: Added Work away from office as a valid value for policy_type in the request.

Time Off → List policies: Added Work away from office as a valid value for policy_type_name in the request.

Time Off → Get Profile Entitlements: Added Work away from office as a valid value for policy_type_name in the request.

Time Off → Process time-off requests from an external HRIS: Added Work away from office as a valid value for policy_type in the request.

Time Off → List time-off requests for Organization: Added Work away from office as a valid value for policy_type_names in the request.

Time Off → List time-off requests: Added Work away from office as a valid value for policy_type_names in the request.

Invoice Adjustments → Retrieve invoice adjustment by ID: Added new as a valid value for status in the response, and gp_client_agreement as a valid value for contract.type in the response.

Invoice Adjustments → List invoice adjustments: Added download_url to the response attachment object that provides a time-limited URL to download the attachment; added new as a valid value for status in the response and statuses query parameter; added gp_client_agreement as a valid value for contract.type in the response.

Apps → Enable an app: Endpoint is now available, which allows to enable an integration app so it can obtain tokens again.

Apps → List apps: Endpoint is now available, which allows to list the integration apps that belong to your organization.

Apps → Retrieve an app: Endpoint is now available, which allows to retrieve a single integration app that belongs to your organization.

Apps → Update an app: Endpoint is now available, which allows to update the name, description, website, or redirect URLs of an integration app.

Apps → Disable an app: Endpoint is now available, which allows to disable an integration app so it can no longer obtain tokens.

Immigration → Create an immigration case for a contract: Endpoint is now available, which allows to open an eligibility check or right to work check for the worker of a contract.

Accounting → Retrieve a payment breakdown: Added new valid values for contract_type in the response: hris_direct_contractor, office_solutions, usp_service_fee, ic_contract_fees, mobility_subscription_service_fee, intercompany, deel_card_fee, entity_management, crypto_payout, deel_ai_workforce, deel_talent_fee, deel_hris, deel_compensation, contractor_subscription_fee, integration_services_fee, bundle_commitment_fee, wallet_chargeback_recovery_funding_statement, deel_workforce_planning_fee, fee_merge, and payroll_merge.

Forms → Fetch multiple EOR Contract forms: Added CustomDropdown and PresetDropdown as valid values for type in the response.

Equity Tokens → List equity grants with tax events: Increased the maximum allowed value of limit to 200.

It Products → Retrieve a product’s catalog details: Added bundle in the response that identifies which addon type each available addon is, used to submit it in contract_setting.addons[] on POST /rest/it/orders.

It Products → Retrieve a product’s prices for a delivery country: Added bundle in the response that identifies which addon bundle each available addon belongs to, for use as bundle in contract_setting.addons[] on POST /rest/it/orders.

Ats → Retrieve suggested ATS email templates: Added DEFAULT_INTERVIEW_LOCATION_UPDATED_CANDIDATE as a valid value for type in the response.

Ats Email Templates → Retrieve a list of published ATS email templates: Added DEFAULT_INTERVIEW_LOCATION_UPDATED_CANDIDATE as a valid value for type in the request and response.

Ats → Delete an email draft to a candidate: Endpoint is now available, which allows to delete an unsent email draft addressed to a candidate.

Ats → List available slots for an interview: Endpoint is now available, which allows to list the available time slots when all interviewers of an interview are free, so a time can be proposed to the candidate before booking.

Ats → Create a stage move for an application: Endpoint is now available, which allows to advance or move back a candidate between the lead and active stages of a job’s interview plan.

Ats → List email drafts to a candidate as they would be sent: Endpoint is now available, which allows to list email drafts to a candidate as they would be sent.

Ats → Set the hiring team role of a person on a job: Endpoint is now available, which allows to add a person to a job’s hiring team, change their role, or remove them.

Ats → Create an email draft to a candidate: Endpoint is now available, which allows to save an email to a candidate as a draft without sending it, returning it rendered as it would be sent.

Ats → Set the time of an interview: Endpoint is now available, which allows to book an interview at a confirmed time or move an already booked interview to a new time.

Ats → List the private note of a job: Endpoint is now available, which allows to read the private note of a job.

Ats → Send an email draft to a candidate: Endpoint is now available, which allows to send an email draft to a candidate.

Ats → List the offer letter templates of the organization: Endpoint is now available, which allows to list the offer letter templates the organization can attach to an offer.

Ats → List the active approval options for offers: Endpoint is now available, which allows to list the approval policies or approval rules an offer can go through.

Ats → Create an offer for an application in the offer stage: Endpoint is now available, which allows to create an offer for a candidate once their application has reached the offer stage and route it to internal approval when applicable.

Ats → Validate offer terms for an application: Endpoint is now available, which allows to validate proposed offer terms against hiring rules before creating an offer.

Ats → Add content to the private note of a job: Endpoint is now available, which allows to add content to the private note of a job.

Ats → Retrieve the organization’s offer settings: Endpoint is now available, which allows to retrieve the organization’s offer settings, including whether offer approval is required and the default approval rule.

Organizations → Submit terms and conditions acceptance: Endpoint is now available, which allows to accept Deel’s terms and conditions for the organization, including legal agreements and the platform terms of service.

Organizations → Retrieve terms and conditions acceptance: Endpoint is now available, which allows to retrieve the terms and conditions acceptance status for the organization, including legal agreements and platform terms of service.

Global Payroll → Retrieve contract creation schema: Endpoint is now available, which allows to retrieve the list of fields required to create a Global Payroll contract, including field types, required status, permitted values, and validation constraints.

Organization Structure → Update an existing HRIS Org Structure: Added explicit properties id, name, children, and externalId to team items in the teams request field, defining the accepted structure for creating, updating, and deleting teams.

Invoice Adjustments → Create an invoice adjustment: Added new as a valid value for status in the response.

Immigration → Create an immigration case: Added new valid values for purpose in the travel_information request body, including EXT_BUS_MEET_NO_WORK, EXT_BUS_DELIVER_SERVICE, CONF_WORKSHOP_PAID, TECH_SUPERVISION, MARITIME_CREW, and 13 others.

Time Tracking Shifts → Get Shift details: Lowered the minimum value of time_amount to 0.

Gp Hiring → Create a Global Payroll (GP) contract: Added payroll_group_id in the request that specifies the payroll group the employee will be assigned to.

Contractor Hiring → Create contract signature: contract_template_id now accepts null.

Talent → List candidates: Endpoint is now available, which allows to list candidates submitted to Deel Talent job requests of the organization, with their pipeline status and talent partner.

Logs → List request logs: Endpoint is now available, which allows to retrieve the public API request logs made by the organization, including gateway-rejected calls, with filters for request ID, route, path, method, and status.

Logs → List token activity: Endpoint is now available, which allows to list token activity showing calls, errors, last use, and a per-day breakdown per token within the organization.

Logs → Retrieve a request log: Endpoint is now available, which allows to retrieve a single API request log by its x-request-id, including the gateway outcome explanation and troubleshooting hint.

Logs → Retrieve request logs summary: Endpoint is now available, which allows to retrieve request counts per status class, the number of rate-limited requests, p50/p95 latency, and the number of active tokens for a time window of up to 15 days.