Deel: Get a payroll migration import
Deel globalPayroll.getPayrollMigrationImport: arguments, response, policy and SDK examples.
← Global payroll operations · Get started
Operation deel.globalpayroll_getpayrollmigrationimport_v2026_09_15
Provider route: GET /gp/legal-entities/{legal_entity_id}/payroll-migration-imports/{import_id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["globalPayroll"]["getPayrollMigrationImport"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.globalPayroll.getPayrollMigrationImport(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.global_payroll.get_payroll_migration_import(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.legal_entity_id | string | Required within parent | Format: uuid |
path.import_id | string | Required within parent | Format: uuid |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get a payroll migration import — 200 response body |
Referenced models: Get a payroll migration import — 200 response body
Schemas
Section titled “Schemas”Get a payroll migration import — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a payroll migration import — 200 response body — data The payroll migration import. |
Referenced models: Get a payroll migration import — 200 response body — data
Get a payroll migration import — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The payroll migration import. |
created_at | string | Required within parent | When the import was created. Format: date-time |
files | array | Required within parent | The files attached to the import. |
files[] | Model | Each item | Expand Get a payroll migration import — 200 response body — data files item |
import_id | string | Required within parent | The unique identifier of the payroll migration import. Format: uuid |
legal_entity_id | string | Required within parent | The legal entity the import belongs to. Format: uuid |
status | Model | Required within parent | Expand Get a payroll migration import — 200 response body — data status The state of the import. IN_PROGRESS holds files that have not been submitted, and is what attaching files leaves behind - including on an import that had already been submitted, which reopens it. SUBMITTED once handed to Deel for review. DRAFT is an import started with no files yet, which only happens in the Deel web app. |
submitted_at | JSON | Required within parent | |
submitted_at (anyOf 1) | string | Alternative | When the import was submitted for review, or null when it is not SUBMITTED. Format: date-time |
submitted_at (anyOf 2) | null | Alternative | When the import was submitted for review, or null when it is not SUBMITTED. Format: date-time |
type | string | Required within parent | What kind of ingestion this is. Year-to-date payroll history is the only kind today. Known values: YTD_HISTORICAL_INGESTION |
updated_at | string | Required within parent | When the import last changed. Format: date-time |
Referenced models: Get a payroll migration import — 200 response body — data files item, Get a payroll migration import — 200 response body — data status
Get a payroll migration import — 200 response body — data files item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_id | string | Required within parent | The identifier of the file in the Deel file service. |
file_name | JSON | Required within parent | |
file_name (anyOf 1) | string | Alternative | The name displayed for the file in Deel, when one is known. |
file_name (anyOf 2) | null | Alternative | The name displayed for the file in Deel, when one is known. |
file_size | JSON | Required within parent | |
file_size (anyOf 1) | JSON | Alternative | |
file_size (anyOf 1) (anyOf 1) | integer | Alternative | The size of the file in bytes, when one is known. Maximum: 10485760 Minimum: 1 |
file_size (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
file_size (anyOf 2) | null | Alternative | The size of the file in bytes, when one is known. Maximum: 10485760 Minimum: 1 |
mime_type | JSON | Required within parent | |
mime_type (anyOf 1) | string | Alternative | The media type of the file, when one is known. |
mime_type (anyOf 2) | null | Alternative | The media type of the file, when one is known. |
source | string | Required within parent | Which surface the file arrived through: EXTERNAL for this API, INTERNAL for the Deel web app. An import can hold both when a client and a partner have each added files to it. Known values: INTERNAL, EXTERNAL |
uploaded_at | string | Required within parent | When the file was uploaded to the Deel file service. Format: date-time |
Get a payroll migration import — 200 response body — data status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The state of the import. IN_PROGRESS holds files that have not been submitted, and is what attaching files leaves behind - including on an import that had already been submitted, which reopens it. SUBMITTED once handed to Deel for review. DRAFT is an import started with no files yet, which only happens in the Deel web app. Known values: DRAFT, IN_PROGRESS, SUBMITTED |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.globalpayroll_getpayrollmigrationimport_v2026_09_15. Catalog operation: globalpayroll_getpayrollmigrationimport_v2026_09_15. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["global-payroll:read"]
Pinned headers: {"X-Version": "2026-09-15"}