latestOpenAPI 3.0.1Proprietary2026-08-1844131294.9 KB

59cd6443fdbf

Create GP Employment

Create a GP (Global Payroll) employee

Creates, onboards a Global Payroll employee in a single call.

Handles the full onboarding flow including personal details, contact information, employment terms, compensation, and compliance setup.

post/v1/employees/gp-employments

Request body

Example request

{
  "personal": {
    "firstName": "Foo",
    "lastName": "Bar",
    "fullLegalName": "Foo Bar",
    "dateOfBirth": "2000-10-11",
    "gender": "MALE",
    "maritalStatus": "SINGLE",
    "religion": "Sikh"
  },
  "contact": {
    "personalEmail": "foo.bar@personal.com",
    "personalPhoneNumber": "+41791234567"
  },
  "employment": {
    "employeeCode": "EMP-12345",
    "entity": "Tech Corp Singapore Pte Ltd",
    "workEmail": "foo.bar@company.com",
    "startDate": "2023-01-15",
    "term": "PERMANENT",
    "designation": "Software Engineer",
    "department": "Engineering",
    "reportsTo": "jane.smith@company.com"
  },
  "compensation": {
    "baseSalary": {
      "startDate": "2025-01-01",
      "endDate": "2025-12-31"
    },
    "additionalPays": [
      {
        "startDate": "2025-01-01",
        "endDate": "2025-12-31"
      }
    ]
  },
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apartment 4B",
    "streetName": "Main Street",
    "city": "Zurich",
    "subdivision": "Zurich",
    "country": "CHE",
    "postalCode": "8001"
  }
}

Response

GP employee created successfully

idstring uuid required

Unique identifier for the employee

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}