GuidesRecipesAPI ReferenceChangelog
Changelog

Changed

  • EORCreate an EOR contract amendment: Added requested_by field in the response that tells the name of the person who requested the amendment. Retained numeric fields such as value and amount as strings to preserve decimal precision.
  • EORList all amendments for an EOR contract: Added new response objects: fixed_adjustments and variable_compensation.
  • EORConfirm an existing contract amendment: Added new response objects: fixed_adjustments and variable_compensation.
  • ImmigrationCreate an immigration case: Modified request body so that employee_details is now a required object. Marked few attributes of this object to be always required, namely employee_details.citizenships and employee_details.residence. Following attributes are only required if contract_id is not included, namely employee_details.first_name, employee_details.last_name and employee_details.email.
  • ImmigrationRetrieve onboarding right-to-work case for a worker: Added a new optional query param contract_id that allows filtering the worker's onboarding case by a specific contract. If the worker has multiple contracts and this parameter is omitted, the response may reflect onboarding case for any associated contract. Also added a new response object property contract with property id to indicate which contract was used.

Added

  • IC invoicing taxesGet IC invoicing taxes: Endpoint is now available, which enables retrieving invoicing tax settings for an independent contractor contract. This endpoint returns the configured VAT and withholding tax percentages for the specified contract, which can be used when displaying or calculating taxes on invoices.
  • IC invoicing taxesCreate IC invoicing tax: Endpoint is now available, which enables creating an invoicing tax for an independent contractor contract. This endpoint allows setting a tax type (VAT or withholding tax) and percentage that will be applied to future invoices.
  • IC invoicing taxesUpdate IC invoicing tax: Endpoint is now available, which enables updating an existing invoicing tax for an independent contractor contract. This endpoint allows modifying the tax percentage for VAT or withholding tax to adjust how taxes are applied to invoices.
  • IC invoicing taxesDelete IC invoicing tax: Endpoint is now available, which enables removing an invoicing tax from an independent contractor contract. This action is irreversible and ensures the specified tax will no longer be applied to future invoices.

Changed

Added

  • Time Tracking TimesheetsGenerate timesheet upload url: Endpoint is now available, which enables generating a pre-signed upload URL for timesheet files. This endpoint receives timesheet file metadata (contract_id, file_name, start_date, end_date) and returns a secure upload URL that can be used to upload the timesheet file to storage.
  • Time Tracking TimesheetsRetrieve a timesheet: Endpoint is now available, which enables retrieving a timesheet by its ID, including its submission, review, and processing status. When the extend=file_data query parameter is provided, the response also includes file-related details such as the file name and download URL.
  • Time Tracking TimesheetsReview a submitted timesheet: Endpoint is now available, which enables reviewing a successfully submitted timesheet. Only timesheets with PENDING_REVIEW status can be reviewed, and all associated hours will be approved or rejected at once based on the review decision.
  • Immigration --> Get business visa eligibility and requirements: Endpoint is now available, to check business visa eligibility and requirements to apply for it.

Changed

  • Contractors -> Create a new contract: Added a new request body property scope_of_work_id that allows passing a scope of work when creating a contract.
  • Immigration -> Create an immigration case: Added support for creating BUSINESS_VISA cases through the public API.

Changed

  • HiringCreate a contract: Added a new optional request field name inside work_location property for Global Payroll (GP) contract creation. The name of the entity work location address to map to the contract. It specifies the employee's entity work location name. This field is required when is_wfh is false in work_location

Added

Changed

  • PeopleUpdate organization structure: Added new optional field effective_date optional request body.
  • ContractorsCreate a new contract: Updated request body with BEFORE_CYCLE_END and AFTER_MONTH as new monthly payment due type options, allowing invoices to be due a specified number of days (payment_due_days) before the cycle end or after the end of the month in which the cycle ends.

Added

  • ATSRetrieve a list of ATS employment types: New endpoint available that allows users to retrieve a list of employment types available in ATS for syncing and validation workflows.
  • ATSRetrieve a list of ATS departments: New endpoint available that allows users to retrieve a list of all departments in the Applicant Tracking System
  • ATSRetrieve a list of ATS locations: New endpoint available that allows users to retrieve a list of ATS locations for jobs.
  • ATS -> Create ATS Job - Endpoint is now available, this endpoint allows the creation of a new job within the ATS system. The user must provide all required fields, and the job will be created with the specified details.

Changed

  • Time OffList time-off requests for Organization: Added a new query parameter time_off_ids that allows retrieving a batch of time offs by the provided ids.
  • Time OffList time-off requests: Added a new query parameter time_off_ids that allows retrieving a batch of time offs by the provided ids.
  • ATSRetrieve paginated list of ATS Candidates: Added the updated_after query param which can be used to fetch candidates that were updated after a certain date.
  • ContractsList of contracts: Added the external_id_absent query param which can be used to filter contracts based on whether external ID is present or not.

Changed

  • PeopleGet my current personal profile: Added a new response property hris_organization_user_id that uniquely identifies user in Engage products.
  • PeopleList of people: Added a new response property hris_organization_user_id that uniquely identifies user in Engage products.
  • HiringCreate a contract: Added a new optional request field property work_location for Global Payroll (GP) contract creation that specifies the employee's work location. This field is required for US legal entities.
  • ContractsList Contract Amendments: Added a new fields to response rate , scale , and currency_code.

Removed

  • Background ChecksList of background check options: This endpoint had no active consumers, and has now been permanently removed. No action required, requests to this endpoint will now return 404.
  • Background ChecksCreate background check: This endpoint had no active consumers, and has now been permanently removed. No action required, requests to this endpoint will now return 404.

Deprecated

  • Background ChecksList background checks by contract: This endpoint is now officially deprecated. It will continue to function for the next 6 months before permanent removal. Clients using this endpoint should migrate to the recommended alternative before the sunset date.

Added