Skip to navigation

Added

  • Eor → Get additional information: Endpoint is now available, which allows to retrieve the additional information saved on an EOR worker’s employee agreement.

Changed

  • Time Tracking → Update a Shift Rate: Added guarantee that external_id, name, created_at, and updated_at are always present in the response.

  • Time Tracking → Create a New Shift Rate: Added created_at and updated_at fields in the response that provide timestamps for when the shift rate was created and last updated.

  • Time Tracking → Retrieve a Shift Rate by External ID: Added created_at and updated_at fields to the response.

  • Time Tracking Shifts → Create raw time tracking shifts: Added optional payroll_cycle_ref to the request body shift items and added summary, shift_type, payroll_cycle_ref, and shift_reference_id fields to the response.

  • Time Tracking Shifts → List of shifts: Added shift_reference_id, summary.time_unit, and summary.time_amount optional fields to the response, and added the contract_id optional query parameter for filtering by contract IDs.

  • Time Tracking Shifts → Update a shift: Added meta, shift_type, and shift_reference_id fields to the response.

  • Time Tracking Shifts → Create shifts: Added meta field to the response that provides shift start, end, break details, and approval date information.

  • Time Tracking Shifts → Get Shift details: Added time_unit and time_amount fields to the summary object in the response, and added shift_reference_id field to the response.

  • Contracts → Retrieve a single contract: Added division field in the response that indicates the division the worker belongs to, sourced from the active job information of a Global Payroll contract (null for other contract types or when no division is set). Added non_compete_clause and non_solicitation_clause fields in the response that indicate the respective clause states on the active EOR statement of work.

Added

  • Legal Entities → Upload a KYB document for a legal entity: Endpoint is now available, which allows to upload a KYB document (company document, Proof of Authority, or identity document) for a legal entity and returns an opaque handle for use in a KYB submission.

Changed

  • Adjustments → Update an adjustment: Added odp_only and date_of_adjustment fields to the request body; odp_only restricts EOR contract adjustments to on-demand payroll, and date_of_adjustment sets the adjustment date in ISO-8601 format.

  • Time Off → Update time-off request: Added custom_field_values to the request and response bodies to support submitting and retrieving answers to custom fields declared by the time-off policy.

  • Time Off → List time-off requests: Added custom_field_values in the response that provides answers to the custom fields declared by the time-off request policy.

  • Time Off → Get Policies for Organization: Added has_custom_fields, is_requiring_custom_fields, and custom_fields fields to the response, indicating whether the policy uses custom fields and providing the policy’s custom field definitions.

Added

  • Legal Entities → Retrieve the KYB state of a legal entity: Endpoint is now available, which allows to retrieve the Know Your Business (KYB) verification state of a legal entity, including its status, outstanding requirements, company documents, and declared persons of significant control.

  • Ats → Retrieve a list of ATS hires: Endpoint is now available, which allows to retrieve ATS application to HRIS profile mappings, including hire status and HRIS profile identifiers, with cursor-based pagination.

Changed

  • Ats Applications → Retrieve a list of ATS applications: Added country_code and city fields in the response that provide the candidate’s country code (ISO 3166-1 alpha-2) and city.

  • Ats Candidates → Create ATS Candidate: Added optional country_code and city fields to the request body and response, allowing callers to set and read the candidate’s location.

  • Ats → Retrieve an ATS candidate: Added country_code and city fields to the response that indicate the ISO 3166-1 alpha-2 country and city the candidate currently lives in.

  • Ats → Update ATS Candidate: Added country_code and city fields to the request body and response that allow callers to set and read the candidate’s location.

  • Ats Applications → Retrieve ATS application: Added city and country_code fields to the candidate object in the response.

  • Ats → Retrieve ATS Application form: Added should_show_location_country_field, should_show_location_city_field, is_location_country_field_required, and is_location_city_field_required fields to the response, along with is_phone_number_required and is_linkedin_profile_url_required as guaranteed response fields.

Added

  • It Orders → Approve an IT order: Endpoint is now available, which allows to approve an IT order that is awaiting approval, moving it to approved status, creating assignments for approved items, and starting fulfilment.

  • It Orders → Reject an IT order: Endpoint is now available, which allows to decline an IT order that is awaiting approval, moving it to a DECLINED status.

  • Organizations → Create a deal registration: Endpoint is now available, which allows to register a prospective end client against a partner organization, protecting the partner’s claim on that client for a fixed period.

Changed

  • Clearance Requests → Create a clearance request for an asset: Added SKIPPED_QUOTE to the allowed values of request_items[].status in the response.

  • Clearance Requests → Cancel a clearance request: Added SKIPPED_QUOTE to the allowed values of request_items[].status in the response.

  • Clearance Requests → Retrieve a clearance request: Added SKIPPED_QUOTE to the allowed values of request_items[].status in the response.

  • Clearance Requests → Approve or reject quotes on a clearance request: Added SKIPPED_QUOTE to the allowed values of request_items[].status in the response.

  • Adjustments → Create a new adjustment: Added application/json as a supported request content type; added optional odp_only and submitter_profile_id fields to the request, and added odp_only to the response.

  • Adjustments → Retrieve an adjustment: Added odp_only in the response that indicates whether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle.

  • Contractor Amendments → Update contract: Added support for Global Payroll contracts, including new request fields such as effective_date, type_of_edit, base_compensation_type, and variable_compensations, and a new Global Payroll response variant.

  • Accounting → Retrieve payment receipts: Added sepa_debit, bacs_debit, and wallet_balance as new allowed values for payment_method.type in the response.

  • Off Cycle → Add off-cycle payment: Added payment_due_date to the request body that specifies the due date of the resulting one-off invoice in ISO-8601 format (YYYY-MM-DD).

  • People → List of People: Added lifecycle_status to the response and as a filter (lifecycle_statuses) and sort option, indicating where each person sits in the work lifecycle.

  • Contracts → List work statement payment policies: Added null as an explicit allowed value in the end_week_parity enum field in the response.

  • Organization Tasks → List organization tasks: Added EXPENSES_TO_CLARIFY and APPROVE_CHILD_ORG_CONTRACT_EDIT as new allowed values for the category query parameter filter.

  • Onboarding → List onboarding employees: Added worker, country, and start_date to each response item, and added progress.steps, progress.waiting_on, and progress.lifecycle_status to the progress object; added new allowed values to the progressStatuses query parameter filter.

  • Immigration → List of immigration cases: Added TERMINATION_REVERSED and CONVERTED_TO_VISA_APPLICATION as new allowed values for closure.reason in the response.

Added

  • Ats → Upload an ATS attachment file: Endpoint is now available, which allows to upload a file and attach it to an ATS candidate, offer, or job activity.

  • Contracts → Submit Global Payroll amendment signature: Endpoint is now available, which allows to sign a pending Global Payroll amendment on the client’s behalf, applying the change.

  • ATS → Add note to a candidate: Endpoint is now available, which allows to add a note to a candidate, keeping the note visible across all of that candidate’s applications.

Added

Added

  • It Seats → Retrieve the IT seat subscription: Endpoint is now available, which allows to retrieve the organization’s IT seat subscription details, including paid, assigned, available, and pending approval seats, monthly seat price, and subscription term and status.

  • It Seats → Unassign workers from IT seats: Endpoint is now available, which allows to release the IT seats of up to 100 workers in a single all-or-nothing call, freeing the seats for other workers.

  • It Seats → List IT seats: Endpoint is now available, which allows to list the IT seats of an organization for auditing which worker holds which seat and reconciling seat usage, with filtering by seat status and HRIS profile.

  • It Seats → Assign workers to IT seats: Endpoint is now available, which allows to assign up to 100 workers to an IT seat subscription in a single all-or-nothing call, with optional automatic seat purchasing when the subscription has insufficient free seats.

  • IT Policies → List users assigned to an IT policy: Endpoint is now available, which allows to list the workers assigned to one of your organization’s IT hardware policies.

Changed

  • IT Products → List products in the catalog: Added categories, operating_systems, keyboard_layouts, brands, it_policy_ids, and is_marketplace query parameters to filter products by category, operating system, keyboard layout, manufacturer, IT policy, and marketplace sourcing.

Changed

  • Ats → List interviews: Added application_ids and interview_plan_stage_ids filter parameters, LATEST_MEETING_FIRST sort option, and new response fields including cancelled_at, has_happened, interview_plan_stage, and interview feedback fields submitted_at and overall_recommendation.

Added

  • Global Payroll → Retrieve HRIS worker bank accounts: Endpoint is now available, which allows to retrieve the active bank account details of an HRIS worker for payment disbursement during payroll processing.

Added

Changed

  • Ats → List feedbacks for an application: Added application_activity_id and scheduled_interview_id to each feedback item in the response.

  • Ats Offers → Retrieve a list of ATS offers: Added job_ids and offer_status query parameters that allow filtering offers by job IDs and offer status.

  • Ats Applications → Retrieve a list of ATS applications: Added reached_interview_plan_stage_ids, moved_to_current_stage_before, archivation_reason_ids, and include query parameters for filtering, and added hired_at, archivation_reason_id, stage_history, and updated_at fields to each application in the response.

  • Ats Applications → Retrieve ATS application: Added hired_at, archivation_reason, and stage timeline fields entered_at, exited_at, is_current, moved_by_hris_organization_user_id, and position_number to the response.

  • People → List of People: Added lineTwo to address objects in the response and middle_name to the employee record.

Added

  • ATS → Update ATS Application: Endpoint is now available, which allows to update the source (source_slug) of an ATS application.

  • It Agreements → Assign agreement to a new worker: Endpoint is now available, which allows to reassign a rental agreement to a new worker via store-and-reuse, so a leaver’s rented device can be passed to a new joiner without returning it to Deel.

  • Clearance Requests → Create a clearance request for an asset: Endpoint is now available, which allows to create a clearance request for a customer-owned IT asset, initiating the recovery, resale, or certified data erasure process.

  • Clearance Requests → Approve or reject quotes on a clearance request: Endpoint is now available, which allows to approve or reject quoted items on a clearance request, moving accepted items to collection and cancelling the request when all items are rejected.

  • It Policies → List users assigned to an IT policy: Endpoint is now available, which allows to list the workers assigned to an IT hardware policy, enabling integrations to resolve policy membership without filtering client-side.

  • IT Orders → Create an IT order: Endpoint is now available, which allows to create a pre-approved IT equipment order for a worker and deliver it to the specified address.

  • It Products → List products in the catalog: Endpoint is now available, which allows to browse the Deel IT catalog to see which devices are available for purchase or rent, filtered by country, category, acquisition type, operating system, and keyboard layout.

  • It Products → Retrieve a product’s catalog details: Endpoint is now available, which allows to retrieve catalog data for a single product including variants, images, hardware specifications, and available addons.

  • Global Payroll → Retrieve bank accounts: Endpoint is now available, which allows to retrieve bank accounts configured for a specific contract, including funds distribution details for salary split across multiple accounts.

  • Global Payroll → Set salary split: Endpoint is now available, which allows to set the salary split across an employee’s bank accounts for a Global Payroll contract.

  • Global Payroll → Add bank account: Endpoint is now available, which allows to add a bank account for a specific GP contract.

  • Global Payroll → Retrieve bank guide: Endpoint is now available, which allows to retrieve the bank account form fields and validation rules for a specific GP contract, indicating which fields are required for a given country.

  • Global Payroll → Update bank account: Endpoint is now available, which allows to update bank account details for a specific Global Payroll contract, managing each contract’s bank account and salary split independently.

  • IT Policies → Assign workers to an IT hardware policy: Endpoint is now available, which allows to assign up to 100 workers, identified by their HRIS profile ids, to an IT hardware policy in a single all-or-nothing call.

Changed

  • Assets → List IT assets: Added public_id to the response items and to assigned_warehouse objects, and added COMPACT_DESKTOP to the product.category enum.

  • Orders → Retrieve an IT order: Added public_id field to the response that provides the public identifier of the order; added COMPACT_DESKTOP to the allowed values for order_items[].product.category.

  • ATS → List feedbacks for an application: Added DISMISSED and REVOKED to the allowed values for status; added revoked_at, dismissed_at, dismissal_reason, and revocation_reason_enum fields to the response.

Added

  • Ats → Upload ATS Candidate CV: Endpoint is now available, which allows to upload a CV file for an existing candidate.

  • Ats → Update ATS Candidate: Endpoint is now available, which allows to update an existing candidate’s details and origin source in the ATS.

  • Clearance Requests → List clearance requests: Endpoint is now available, which allows to list the clearance requests their organization raised and identify those awaiting a decision.

Added

  • Global Payroll → Get additional info for a contract: Endpoint is now available, which allows to retrieve the country-specific additional-information fields submitted by a worker for a contract, such as local identifiers, demographic data, and emergency contacts.

  • Global Payroll → Submit a payroll migration import for review: Endpoint is now available, which allows to submit a payroll migration import for review, handing its files to the Deel Payroll Implementation Manager working on the legal entity.

  • Global Payroll → Add payroll migration files to a legal entity: Endpoint is now available, which allows to attach year-to-date payroll files to a legal entity’s payroll migration import over the API.