latestOpenAPI 3.0.1Proprietary2026-08-1844131294.9 KB

59cd6443fdbf

Approver Management3

Create GP Employment3

Customer Departments3

Customer Entities1

Customer Users4

Customers2

Dev Support2

Employee Address Details1

Employee Bank Details1

Employee Compensation Details3

Employee Contact Details1

Employee Education Details1

Employee Employment Details2

Employee Personal Details1

expenses2

JWKS Controller1

List Employees4

Magic Links3

OAuth1

Partner Token1

Time Offs2

Timesheet2

Create GP Employment

Submit dynamic data for employee creation

Submits dynamic field values (as required by the schema returned from GET /v1/employees/schema) for a GP employment record.

Use this endpoint after getting the schema to know which fields are required, and after creating the basic employment record. The submitted values populate the dynamic sections: legal details and custom fields.

patch/v1/employees/{employeeId}/dynamic-details

Path parameters

employeeIdstring uuid required

Unique identifier for the employee

Request body

legalDetailsobject

Flat key-value map of legal detail field values as defined by the schema. Keys correspond to key fields returned in legalDetails.fields from GET /v1/employees/schema.

customFieldsobject

Flat key-value map of custom field values as defined by the schema. Keys correspond to key fields returned in customFields.fields from GET /v1/employees/schema.

Example request

{
  "legalDetails": {
    "nationalId": "S1234567A",
    "taxId": "123456789"
  },
  "customFields": {
    "costCenter": "CC-001",
    "projectCode": "PROJ-42"
  }
}

Response

Dynamic data submitted successfully