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>.
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>.
X-Correlation-IdCorrelation id
Attempts to look up a single given employee › Responses
OK
idThe id of the employee
employeeNoEmployee number
firstNameThe employee's first name
surnameThe employee's surname
postalCodeThe employee's postal code
isDeletedWhether the employee has been marked for deletion
ticketHolderCodeThe employee's ticket holder code
Companies are where employees are hired
Employment type. Examples include Employee, Part time, Temp
dateOfBirthWhen the employee was born
ssnThe employee's social security number
addressLineThe employee's postal address
A personnel ticket product
abstainFromTicketWhether a ticket should be created
hireStartDateWhen the employee was hired
payTypePay type - see the codes in the API documentation
hireEndDateWhen the employee left the company
hireEndCauseWhy the employee left the company
disabilityGradeThe employee's degree of disability. Default 0.
employmentPercentageEmployment percentage
employmentPercentageDateDate for registered employment percentage
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
leaveFromDateWhen the employee starts a leave
noteAny additional information
lastUpdateWhen the imported employee was last updated
sourceLastUpdateThe source for the last update
The employee's family members
The employee's ticket rights
createdAtThe date of creation.
createdByThe source for the first creation
The registered categories on this employee
The status of yearly fees for the current and the next year
The status of disability proofs for the current and the next year
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.
sendTicketToPrivateAddressUnused
jobDescriptionUnused
disabilityFromDateUnused
disabilityProofRegisteredDeprecated. Use disability proofs.
disabilityProofRegisteredDateUnused
paidPercentageDateDate for last change to paidPercentage
isOnWaitPayUnused
waitPayDateUnused
isFeePaidDeprecated. Use yearlyFees