Employee
API for fetching employees in the personnel ticket system. An employee is the main entity of the pbsys system. They are hired by a Company and work at a WorkPlace. Employees are created from ImportedEmployee
Find employees
query Parameters
employeeNocompanyIddateOfBirthssnincludeFamilyMembersincludeTicketRightspageperPageHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find employees › Responses
OK
All items for this page
totalItemsTotal items which could be returned
totalPagesTotal number of pages
Attempts to look up a single given employee
path Parameters
idquery Parameters
includeFamilyMembersincludeTicketRightsHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Attempts to look up a single given employee › Responses
OK
idThe id of the employee
surnameThe employee's surname
firstNameThe employee's first name
isDeletedWhether the employee has been marked for deletion
employeeNoEmployee number
postalCodeThe employee's postal code
ticketHolderCodeThe employee's ticket holder code
ssnThe employee's social security number
noteAny additional information
Companies are where employees are hired
payTypePay type - see the codes in the API documentation
createdAtThe date of creation.
createdByThe source for the first creation
The registered categories on this employee
lastUpdateWhen the imported employee was last updated
The status of yearly fees for the current and the next year
addressLineThe employee's postal address
dateOfBirthWhen the employee was born
hireEndDateWhen the employee left the company
hireEndCauseWhy the employee left the company
The employee's ticket rights
The employee's family members
hireStartDateWhen the employee was hired
leaveFromDateWhen the employee starts a leave
customerNumberThe employees customer number in ESS. Note this profile is owned by JBD and is the profile connected to the ticket right. A 'null'-value here may indicate that the ticket right is not yet synced to ESS.
Employment type. Examples include Employee, Part time, Temp
paidPercentageThe pay level. This is calculated based on the employment percentage and the type of employment. Typically holds the same value as employment percentage, unless special circumstances apply
disabilityGradeThe employee's degree of disability. Default 0.
The status of disability proofs for the current and the next year
A personnel ticket product
sourceLastUpdateThe source for the last update
abstainFromTicketWhether a ticket should be created
employmentPercentageEmployment percentage
employmentPercentageDateDate for registered employment percentage
isFeePaidDeprecated. Use yearlyFees
isOnWaitPayUnused
waitPayDateUnused
jobDescriptionUnused
disabilityFromDateUnused
paidPercentageDateDate for last change to paidPercentage
disabilityProofRegisteredDeprecated. Use disability proofs.
sendTicketToPrivateAddressUnused
disabilityProofRegisteredDateUnused