Updated: Create global payroll contract API

New Optional Parameter: invite_employee_to_app
A new field has been introduced to allow automatic onboarding invitations for employees.

Endpoint: POST /rest/v2/contracts/gp

API reference: Create a contract

Details
When invite_employee_to_app is set to true, and if the employee app is enabled for the account, the invited employee will receive an email invitation to join the platform.
This feature streamlines the onboarding process by ensuring employees are proactively included in the Deel ecosystem.

Example

curl --request POST \
    --url \
    https://api.letsdeel.com/v2/rest/contracts/gp --header 'accept: application/json' \
    --header 'authorization: Bearer {API_TOKEN}' \
    --header 'content-type: application/json' \
    --data '
        {
            "data": {
                "client": {
                    "legal_entity": {
                        "id": "00000000-0000-0000-0000-000000000000"
                    },
                    "team": {
                        "id": "00000000-0000-0000-0000-000000000000"
                    }
                },
                "employee": {
                    "first_name": "Jane",
                    "last_name": "Doe",
                    "email": "[email protected]",
                    "address": {
                        "street": "Deel Street 500",
                        "city": "Denver",
                        "zip": "44000",
                        "country": "US"
                    },
                    "work_email": "[email protected]",
                    "nationality": "US",
                    "employee_number": "100"
                },
                "job_title": "Designer",
                "employment": {
                    "type": "Full-time",
                    "start_date": "2023-01-01",
                    "holidays": {
                        "allowance": 25,
                        "start_date": "2023-01-01"
                    }
                },
                "compensation_details": {
                    "scale": "YEAR",
                    "salary": 50000,
                    "currency": "GBP"
                },
                "invite_employee_to_app": true
            }
        }
    '