Create GP Employment
Get employee creation form schema
Returns the form schema (field definitions and validation rules) needed to create an employee under a specific employment context.
The schema describes required and optional fields, their types, validation constraints, and allowed values for the given context.
Context Types:
- GP Employment: Provide entity to get the schema for a Global Payroll employee creation.
get/v1/employees/dynamic-details/schema
Query parameters
employmentType'GLOBAL_PAYROLL' required
Type of employment context
Example:GLOBAL_PAYROLL
Type of employment. Required for all contexts.
entitystring
Legal entity name. Required for GP employment context. When provided, the schema returned is for creating a GP employee under this entity.
Response
Form schema retrieved successfully
Example response
{
"legalDetails": {
"required": true,
"fields": [
{
"key": "field1",
"label": "Field 1",
"type": "TEXT",
"required": true
},
{
"key": "field2",
"label": "Field 2",
"type": "NUMBER",
"required": false
},
{
"key": "field3",
"label": "Field 3",
"type": "DATE",
"required": true,
"minDate": "2025-01-01",
"maxDate": "2025-12-31"
},
{
"key": "field4",
"label": "Field 4",
"type": "SELECT",
"required": true,
"options": [
"option1",
"option2"
],
"multiSelect": false
},
{
"key": "field5",
"label": "Field 5",
"type": "OBJECT",
"required": false,
"fields": [
{
"key": "field5a",
"label": "Field 5a",
"type": "TEXT",
"required": true
},
{
"key": "field5b",
"label": "Field 5b",
"type": "NUMBER",
"required": false
}
]
},
{
"key": "field6",
"label": "Field 6",
"type": "ARRAY",
"required": true,
"minItems": 1,
"maxItems": 3,
"item": {
"key": "field6a",
"label": "Field 6a",
"type": "TEXT",
"required": true
}
}
]
},
"customFields": {
"required": true,
"fields": [
{
"key": "field1",
"label": "Field 1",
"type": "TEXT",
"required": true
},
{
"key": "field2",
"label": "Field 2",
"type": "NUMBER",
"required": false
},
{
"key": "field3",
"label": "Field 3",
"type": "DATE",
"required": true,
"minDate": "2025-01-01",
"maxDate": "2025-12-31"
},
{
"key": "field4",
"label": "Field 4",
"type": "SELECT",
"required": true,
"options": [
"option1",
"option2"
],
"multiSelect": false
},
{
"key": "field5",
"label": "Field 5",
"type": "OBJECT",
"required": false,
"fields": [
{
"key": "field5a",
"label": "Field 5a",
"type": "TEXT",
"required": true
},
{
"key": "field5b",
"label": "Field 5b",
"type": "NUMBER",
"required": false
}
]
},
{
"key": "field6",
"label": "Field 6",
"type": "ARRAY",
"required": true,
"minItems": 1,
"maxItems": 3,
"item": {
"key": "field6a",
"label": "Field 6a",
"type": "TEXT",
"required": true
}
}
]
}
}