# Deel Global Payroll API

**Canonical:** https://apis.io/apis/deel-com/deel-com-globalpayroll-api/  
**Provider:** Deel — https://apis.io/providers/deel-com/  
**Base URL:** https://api.letsdeel.com/rest/v2  
**Documentation:** https://developer.deel.com/api/introduction

Deel Global Payroll API is one of 121 APIs that [Deel](https://apis.io/providers/deel-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 5 JSON Schema definitions. Tagged areas include Global Payroll. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, a JSON-LD context, an API reference, and 5 JSON Schemas.

The globalPayroll API from Deel — 17 operation(s) for globalpayroll.

## Operations (19)

| Method | Path | Summary |
|---|---|---|
| POST | `/gp/contracts/{contract_id}/banks` | Add bank account |
| GET | `/gp/contracts/{contract_id}/banks` | Retrieve bank accounts |
| POST | `/gp/legal-entities/{legal_entity_id}/payroll-migration-imports` | Add payroll migration files to a legal entity |
| GET | `/gp/legal-entities/{legal_entity_id}/payroll-migration-imports` | List payroll migration imports for a legal entity |
| POST | `/gp/workers` | Create a Global Payroll worker |
| GET | `/gp/workers/{id}/payslips/{payslip_id}/download` | Download a GP worker payslip |
| GET | `/gp/legal-entities/{legal_entity_id}/payroll-migration-imports/{import_id}` | Get a payroll migration import |
| GET | `/contracts/{contract_id}/additional-info` | Get additional info for a contract |
| GET | `/payroll-activations` | Get payroll activation readiness for a legal entity |
| GET | `/payroll-groups` | List payroll groups for a legal entity |
| GET | `/forms/gp/worker-additional-fields/{country_code}` | Retrieve additional information fields for GP workers by country |
| GET | `/gp/contracts/{contract_id}/banks/guide` | Retrieve bank guide |
| GET | `/hris/workers/{worker_id}/banks` | Retrieve HRIS worker bank accounts |
| GET | `/gp/workers/creation-schema` | Retrieve the Global Payroll worker creation schema |
| PATCH | `/gp/contracts/{contract_id}/banks/settings` | Set salary split |
| POST | `/gp/legal-entities/{legal_entity_id}/payroll-migration-imports/{import_id}/submit` | Submit a payroll migration import for review |
| PATCH | `/gp/contracts/{contract_id}/banks/{bank_id}` | Update bank account |
| PATCH | `/gp/contracts/{contract_id}/employment-type` | Update employment type for a contract |
| PATCH | `/gp/contracts/{contract_id}/end-date` | Update end date for a contract |

## Machine-readable artifacts (38)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/openapi/deel-com-globalpayroll-api-openapi.yml
- **Documentation** — https://developer.deel.com/api/introduction
- **GettingStarted** — https://developer.deel.com/api/quickstart
- **Authentication** — https://developer.deel.com/api/authentication
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/json-schema/deel-contract-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/json-schema/deel-person-schema.json
- **JSONLD** — https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/json-ld/deel-com-context.jsonld
- **Documentation** — https://developer.deel.com/api/employer-of-record/introduction
- **Documentation** — https://developer.deel.com/api/employer-of-record/employment-cost-calculator
- **Documentation** — https://developer.deel.com/api/employer-of-record/hiring
- **Documentation** — https://developer.deel.com/api/employer-of-record/accept-quote
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/json-schema/deel-eor-contract-schema.json
- **Documentation** — https://developer.deel.com/api/contractors/introduction
- **Documentation** — https://developer.deel.com/api/contractors/invoice-adjustments
- **Documentation** — https://developer.deel.com/api/contractors/timesheets
- **Documentation** — https://developer.deel.com/api/global-payroll/introduction
- **Documentation** — https://developer.deel.com/api/global-payroll/time-tracking
- **Documentation** — https://developer.deel.com/api/global-payroll/adjustments
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/json-schema/deel-payroll-event-schema.json
- **Documentation** — https://developer.deel.com/api/hris/introduction
- **Documentation** — https://developer.deel.com/api/scim-api/overview
- **Documentation** — https://developer.deel.com/api/hris-common-use-cases/sync-deel-users-to-identity-providers
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/json-schema/deel-time-off-schema.json
- **Documentation** — https://developer.deel.com/api/ats-guides/introduction
- **Documentation** — https://developer.deel.com/api/ats-guides/getting-started
- **Documentation** — https://developer.deel.com/api/ats-guides/manage-jobs
- **Documentation** — https://developer.deel.com/api/ats-guides/manage-candidates-and-applications
- **Documentation** — https://developer.deel.com/api/ats-guides/webhooks
- **Documentation** — https://developer.deel.com/api/webhooks/introduction
- **Documentation** — https://developer.deel.com/api/webhooks/quickstart
- **Documentation** — https://developer.deel.com/api/webhooks/events
- **Documentation** — https://developer.deel.com/api/webhooks/simulations
- **Documentation** — https://developer.deel.com/api/platform/screenings
- **Documentation** — https://developer.deel.com/api/platform/immigration
- **Documentation** — https://developer.deel.com/api/deel-it/getting-started/introduction
- **Documentation** — https://developer.deel.com/
- **APIReference** — https://developer.deel.com/reference
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/asyncapi/deel-webhooks-asyncapi.yaml

## Other Deel APIs (12)

- [Deel Adjustments API](https://apis.io/apis/deel-com/deel-com-adjustments-api/)
- [Deel Candidates API](https://apis.io/apis/deel-com/deel-com-candidates-api/)
- [Deel Contracts API](https://apis.io/apis/deel-com/deel-com-contracts-api/)
- [Deel IT API](https://apis.io/apis/deel-com/deel-com-deel-it-api/)
- [Deel Global Payroll API](https://apis.io/apis/deel-com/deel-com-global-payroll-api/)
- [Deel GP Hiring API](https://apis.io/apis/deel-com/deel-com-gp-hiring-api/)
- [Deel Immigration API](https://apis.io/apis/deel-com/deel-com-immigration-api/)
- [Deel Lookups API](https://apis.io/apis/deel-com/deel-com-lookups-api/)
- [Deel Managers API](https://apis.io/apis/deel-com/deel-com-managers-api/)
- [Deel Milestones API](https://apis.io/apis/deel-com/deel-com-milestones-api/)
- [Deel Organizations API](https://apis.io/apis/deel-com/deel-com-organizations-api/)
- [Deel Payslips API](https://apis.io/apis/deel-com/deel-com-payslips-api/)

## Tags

Global Payroll

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/deel-com/deel-com-globalpayroll-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/deel-com/.
