Persons
Query Parameters
Only persons whose data has changed since this date are included in the results. The returned elements only contain information from systems in which changes have occurred; they do not contain complete person data. This enables us to produce faster results. If you feel that this should change, please provide us with feedback.
Response
OK
Unique identifier. Matches the ID of the person in the VEDA Horizon (Base) API
- Payroll Expert - LPTITL
- Platform - Personal information > General (Formerly title)
80"Dr."
- Payroll Expert - LPVNAM
- Platform - Personal information > General
80"Max"
- Payroll Expert includes the middle name in the firstName field. If present, this field is always empty.
- Platform - Personal information > General
80"Moritz"
- Payroll Expert - LPNAME (Formerly name)
- Platform - Personal information > General
80"Mustermann"
- Payroll Expert - LPGNAM
- Platform - Personal information > General
80"Musterfamilie"
- Payroll Expert - LPVSWO (Formerly namePrefix)
- Platform - Personal information > General (Formerly namePrefix)
80"zum"
- Payroll Expert - LPNMZU (Formerly nameAffix)
- Platform - Personal information > General (Formerly nameAffix)
80"Baron"
E.g. additions like senior, junior, or suffixed academic titles like M.Sc., M.A., abbreviations of religious orders like SJ, or abbreviations of public offices like MP
- Platform - Personal information > General (Formerly titlePostPositioned)
80"junior"
Gender according to birth certificate or passport
- Payroll Expert - LPGENU
- Platform - Personal information > General
MALE, FEMALE, INTERSEX, UNSPECIFIED "FEMALE"
- Payroll Expert - LPGBDT
- Platform - Personal information > General
"2023-06-14"
- Payroll Expert - LPSTAA
- Platform - Personal information > General
2"DE"
- Payroll Expert
- Platform - Personal information > Personal contact information
- StreetAddress
- PostOfficeBox
- Platform - Personal information > Compensation-relevant information
The standard business email address
- Platform - Business information > Business contact details
254|^.+@.+$"Max.Mustermann@example.com"
Name of the place where the person can usually be reached and can receive visitors or mail, for example.
- Payroll Expert - LPBEOR (Formerly placeOfEmployment)
33Account status of the person.
- Platform - Administration > Basics > Users
ACTIVE, INACTIVE Start of first employment with the organisation
- Platform - Business information > General (Formerly enterpriseEntryDate)
"1999-02-31"
End or planned end of last employment with the organization
- Payroll Expert - LPADDT (Formerly terminationDate)
- Platform - Business information > General (Formerly leavingDate)
"2050-12-24"
Identifier of the reason for exit
- Payroll Expert - LPATGR (Formerly terminationReasonId)
2Effective date of termination. Depending on the reason for termination, either the date of receipt of the termination or the date on which the termination was declared.
- Payroll Expert - LPKUDT (Formerly terminationCommunicatedDate)
- Platform - Business information > General
"2099-12-31"
- Platform - Business information > General
20"56"
- Platform - Business information > General (Formerly employmentTitleDisplayName)
400"Integrations Team Lead"
The legal entity the person is primarily associated with. They are similar to groups, but you can only have one.
- Payroll Expert - LPWERK (Formerly branchId)
Grouping (ha!) of a person. A person can be member of multiple groups of the same and different types.
Person id of the disciplinary manager. Further information about the manager (as person) can be retrieved using this id
- Platform - Business information > General
The person's ID number. Used for identification at time-recording or similar terminals.
- Time Expert
Information about the person's employment(s). While most employees have a single employment, multiple concurrent employments are possible. Common scenarios include:
- Employees in multiple roles across different subsidiaries
- Employees on parental leave who maintain a part-time position during this period Only employment records that exist in Payroll Expert, and for which matching person mappings are configured in VEDA Horizon, will be returned. Any additional employments or mappings will be ignored.
Custom fields of the person. Before any custom fields can be returned, you need to configure the API to include the fields you need. This can be done in the Platform under Administration > Basics > External applications > Second icon in the action column.
(⚠️ Deprecated - Please use employments.id instead. It includes more information in addition to the ids) Maintained field for backwards compatibility.
Contract ids are used to identify individuals in the payroll system. One person can have multiple payroll contracts, e.g. if they have multiple jobs or roles in the organization. This list may contain values that are not available in Payroll. If this is the case, please correct the person mappings in VEDA Horizon. In the past, payroll contracts were identified using a combination of the company and employee number. Currently, the ids are in the form 'companyId-employeeNumber'. You can use this information if you already have it, but it may not be stable in the future.