Changelog

Ats → Get an interview transcript: Endpoint is now available, which allows to retrieve the transcript of an interview as a paginated, ordered list of speaker segments.

Legal Entities → Submit EDD request answers for a legal entity: Endpoint is now available, which allows to answer the open enhanced due diligence (EDD) request of a legal entity by submitting answers for each question in the EDD form.

It Products → List products in the catalog: Added category query parameter that filters results by product category.

Ats Applications → Retrieve a list of ATS applications: Added position_number to the current_application_interview_plan_stage.interview_plan_stage response field that indicates the ordinal position of the stage in the job pipeline; raised the limit query parameter maximum from 100 to 500.

Ats Offers → Retrieve a list of ATS offers: Added application object and sent_at field to the response that identify the offer’s candidate and job without a second lookup and record when the offer was sent to the candidate.

Webhooks → Retrieve a single webhook: Added include_child_orgs to the response that indicates whether the webhook will also receive events from child organizations.

Ats Jobs → Retrieve a list of ATS jobs: Added optional job_ids query parameter that allows resolving specific jobs by UUID, and added PAUSED as a new allowed value to the status filter parameter and response field.

Webhooks → Update a webhook: Added url, name, events, and description fields to the request body, allowing callers to update additional webhook subscription properties.

Eor → Get amendment data points configuration by country: Added new allowed values to the item enum in the response: END_DATE, CURRENCY, TIME_OFF_TYPE, FIXED_ALLOWANCES, PROBATION_PERIOD, SENIORITY_ID, WORK_HOURS_PER_WEEK, EMPLOYMENT_STATE, EMPLOYMENT_TYPE, EMPLOYEE_NATIONALITY, NOTICE_PERIOD_DURING_PROBATION, NOTICE_PERIOD_AFTER_PROBATION, NOTICE_PERIOD_TYPE, WORK_SCHEDULE, SENIORITY_DATE, JOB_CATEGORY, and JOB_CODE.

Custom Fields Contracts → List all custom fields: Added hyperlink as a new allowed value for the type.name field in the response, enabling custom fields of hyperlink type.

Custom Fields Contracts → Get custom fields from contracts: Added hyperlink as a new allowed value for the type.name field in the response, enabling custom fields of hyperlink type.

Custom Fields Contracts → Retrieve custom fields for a contract: Added hyperlink as a new allowed value for the type field in the response.

Custom Fields People → List all people custom fields: Added hyperlink as a new allowed value for the type.name field and peo, hris_direct_contractor, and person_without_contract as new allowed values for the settings.worker_types field in the response.

Custom Fields People → Retrieve custom fields for a worker: Added hyperlink as a new allowed value for the type field in the response.

Legal Entities → Submit KYB information for a legal entity: Added null as an explicit allowed value for meta_type in the response documents array, documenting that it is null for non-Proof of Authority documents.

Legal Entities → Retrieve the KYB state of a legal entity: Added null as an explicit allowed value in the meta_type enum of documents response items, reflecting that this field is null for non-Proof of Authority documents.

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

People → Create a person without a contract: Added address field to the request body that allows specifying the home address of the person being hired.

Immigration → Get case timeline: Added AGENT_ADD_RFE_DEADLINE as a new allowed value for the type field of actions.

Legal Entities → Upload a document for an EDD request of a legal entity: Endpoint is now available, which allows to upload a document for a DOCUMENT_UPLOAD question of an open EDD request and obtain an opaque handle to reference in an EDD answer.

Legal Entities → Submit KYB information for a legal entity: Endpoint is now available, which allows to submit Know Your Business (KYB) verification information, company documents, and declared persons of significant control for a legal entity.

Immigration → Get case timeline: Endpoint is now available, which allows to retrieve the processes, steps and client or employee actions of a case.

Immigration → List case visa application quotes: Endpoint is now available, which allows to retrieve the visa application quote Deel proposed on an eligibility check case, with all its fees.

Immigration → List case invoices: Endpoint is now available, which allows to retrieve the invoices issued to the organization for a case, including payment status, amount, currency, and due date.

Immigration → Approve a visa application quote: Endpoint is now available, which allows to approve a visa application quote for an eligibility check case.

Ats → List interviews: Added SLOT_REQUEST_SENT and SLOTS_SUBMITTED to the status_enum response field and status filter parameter allowed values.

Legal Entities → Retrieve the KYB state of a legal entity: Added edd to the response that provides the open enhanced due diligence (EDD) request, including its status and questions, while the entity is under EDD review.

Eor → Reject an EOR quote: Added COMPLIANCE_RESTRICTIONS to the allowed values of reason in the request body.

Accounting → Get invoice by id: Added adjustment_id and pricing_fx_rate fields to line_items in the response.

Time Off → List time-off requests for Organization: Added AUTO_BANK_HOLIDAY to the allowed values of time_off_origin in the response, representing a bank holiday request that the system books for the worker.

Time Tracking Shifts → List of shifts: Changed time_amount minimum validation in the response from exclusive (must be greater than 0) to inclusive (value of 0 is now allowed).

Time Tracking Shifts → Create shifts: Changed time_amount and total_payable_hours minimum validation in the correction shift summary from exclusive (must be greater than 0) to inclusive (value of 0 is now allowed), enabling correction shifts to fully zero out the hours of the original shift.

Payouts → Update a bank transfer method: Added version in the response that provides the version identifier for the bank transfer method.

Global Payroll → Create a Global Payroll worker: Endpoint is now available, which allows to create a Global Payroll worker and their contract in a single call.

Global Payroll → Retrieve the Global Payroll worker creation schema: Endpoint is now available, which allows to retrieve the fields accepted by the Global Payroll worker creation endpoint, including required status, permitted values, and validation rules.

Organizations → Add admins to child organizations: Endpoint is now available, which allows to add multiple admins to child organizations in one call.

Global Payroll → Get payroll activation readiness for a legal entity: Endpoint is now available, which allows to check whether a legal entity has reached payroll activation readiness.

Global Payroll → Update end date for a contract: Endpoint is now available, which allows to update the end date of a Global Payroll contract, making it fixed-term when an end date is set or open-ended when null, effective from a specified date.

Ats Applications → Retrieve ATS application: Added EXPIRED to the offer_status_enum response field that indicates an offer has expired.

Eor Contract → Create an EOR contract: Added job_code and job_category to the response that provide the country-specific occupation code and the job category assigned to the role.

Legal Entities → List of legal entities: Added status field to each item in the response that provides the mapped legal entity lifecycle status.

People → Retrieve a single person: Added person_status and lifecycle_status to the response that provide the person profile status and work lifecycle stage respectively; also added middle_name and other new response fields.

Organizations → Create child organization: Added optional parent_admin_emails and child_admins arrays to the request, allowing callers to specify parent organization admins and child organization admins when creating a child organization.

Onboarding → Get onboarding details by employee HRIS profile ID: Added banner, actions, contracts, and app_experience fields to the response, and expanded profile, stepper, contract, progress, checklist, and hris_profile with additional sub-fields.

Onboarding → Get onboarding details by onboarding tracker ID: Added banner, actions, contracts, and app_experience to the response, and extended profile, stepper, contract, progress, checklist, and hris_profile with additional sub-fields.

Onboarding → List onboarding employees: Added lifecycleStatuses, waitingOnParties, card, weekFromDate, and weekToDate query parameters for filtering; added profile, overview, contracts, pending_steps, invitation_sent, and can_send_invitation to each response item; and expanded contract, progress, hris_profile, and app_experience with additional sub-fields.

Eor Offboarding → Retrieve Offboarding Request: Added new values to the reason field in the request_data response, including WORKER_TYPE_CHANGE, DISSATISFIED_WITH_DEEL_SERVICE, DISSATISFIED_WITH_DEEL_PRICING, DISSATISFIED_WITH_DEEL_PRODUCT, DEEL_COLLECTIONS, and additional employee departure reason codes.

Time Off → Create time-off request: Added custom_field_values to the request and response that allows submitting and retrieving answers to custom fields declared by the time-off policy.

Time Off → Validate time-off request: Added custom_field_values to the request and custom_fields and custom_field_validation_results to the response to support submitting and validating custom field answers declared by the time-off policy.

Time Off → List time-off requests for Organization: Added Bereaved partner's paternity leave, Carer's leave, Neonatal care leave, Parental bereavement leave, and Shared parental leave as accepted values for the policy_type_names filter parameter.

Time Off → List policies: Added has_custom_fields, is_requiring_custom_fields, and custom_fields to the response, and expanded the policy_type_name query parameter with additional allowed values.

Time Off → Process time-off requests from an external HRIS: Added new accepted values to policy_type in the request: Bereaved partner's paternity leave, Carer's leave, Neonatal care leave, Parental bereavement leave, Shared parental leave, and Work Location.

Time Off → Get Profile Entitlements: Added five new values to the policy_type_name filter: Bereaved partner's paternity leave, Carer's leave, Neonatal care leave, Parental bereavement leave, and Shared parental leave.

Time Off → List time-off requests: Added Bereaved partner's paternity leave, Carer's leave, Neonatal care leave, Parental bereavement leave, and Shared parental leave as accepted values for the policy_type_names filter parameter.

Time Off → Get Policies for Organization: Added five UK family leave types to the policy_type filter: Bereaved partner's paternity leave, Carer's leave, Neonatal care leave, Parental bereavement leave, and Shared parental leave.

Ats Locations → Retrieve a list of ATS locations: Added include_archived query parameter to include archived locations in the response, and added archived_at response field indicating when a location was archived.

Ats Tags → List tags: Added include_archived query parameter to include archived tags in the response, and added archived_at field to the response that indicates when a tag was archived.

Ats Departments → Retrieve a list of ATS departments: Added include_archived query parameter to include archived departments in the response, and added archived_at response field indicating when a department was archived.

Ats Reasons → Retrieve paginated list of ATS Rejection/Archivation reasons: Added include_archived query parameter to include archived reasons in the response, and added archived_at response field indicating when a reason was archived.

Ats → Retrieve a list of ATS teams: Added include_archived query parameter to include archived teams in the response, and added archived_at response field indicating when a team was archived.

Users → List users: Added jobProfile field in the response that provides the worker’s active job profile from job architecture, and departmentCustomFields field that provides org-structure custom fields for the department node.

Users → Retrieve a single User: Added jobProfile field in the response that provides the worker’s active job profile from job architecture, and departmentCustomFields field that provides org-structure custom fields for the department node.

Payments → Create and pay a payment statement: Added new fields to beneficiary_details in the response (address, bsb_code, bank_code, ifsc_code, branch_code, account_type, bank_address, routing_number, intermediary_bank, ach_routing_number, wire_routing_number) that provide additional bank routing details for various payment rails.

Payments → Retrieve a payment statement: Added new fields to beneficiary_details in the response, including address, bsb_code, bank_code, ifsc_code, branch_code, account_type, bank_address, routing_number, ach_routing_number, wire_routing_number, and intermediary_bank.

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.

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.

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.

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.

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.

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.

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.