Personal information

Introduction

The Protime API allows you to retrieve personal data from the people collection.

Properties

Property Type Description
id integer Internal unique identifier for the person.
periodClosingDate string Date of the period closing, used to lock the calendar.
hourlyRateCurrencyDefinition.id integer Internal unique identifier for the hourly rate currency.
advanceCurrencyDefinition.id integer Internal unique identifier for the advance currency.
lastName string Last name of the person.
firstName string First name of the person.
initials string Initials of the person.
telephone string Telephone number.
mobile string Mobile phone number.
email string Email address.
address string Street address with the number.
postalCode string Postal code.
town string Town or city.
countryIsoCode string ISO code of the country.
nationalityIsoCode string ISO code of the nationality.
sex string Sex of the person (Unknown, Female, Male, Other).
maritalStatus string Marital status (Unknown, Single, Married, Widow, Widower, Divorced, LivingTogether).
birthDate string Birth date of the person (YYYY-MM-DD).
placeOfBirth string Place of birth.
drivingLicense string Driving license number.
registerNumber string Register number.
passportNumber string Passport number.
socialSecurityNumber string Social security number.
bankAccount string Bank account number.
inServiceDate string Date when the person entered service (YYYY-MM-DD).
outOfServiceDate string Date when the person stopped service (YYYY-MM-DD). To infinity if empty.
wtdStartDate string WTD start date (YYYY-MM-DD).
employeeNumber string Employee number.
payGroup string Pay group of the person.
hourlyRate number Hourly rate.
maxAdvance number Maximum advance allowed.
terminalGroup.id integer Internal unique identifier for the terminal group the person is linked to.
badgeNumber string Badge number of the person. Needs to be unique.
pinCode integer PIN code.
terminalLanguageISOCode string ISO code of the terminal language for this person.

External references

It’s possible to use predefined external references and custom external references. More information can be found on the External References Page

For a list of predefined external references, see the external reference options section.

Example to request personal information with a badge number:
GET https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people/8526?externalReferences=(people,@badge-number)
Example to request personal information with an employee number:
GET https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people/8526?externalReferences=(people,@employee-number)

Endpoints

Below you can find the supported endpoints for this data collection.

GET a person by reference

You can retrieve personal data by the internal ID or an external reference by using the GET call.

GET https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people/{PersonReference}

GET a list of people

GET https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people

Delta

It’s possible to retrieve changes on personal information with the delta. Check the Delta page how to use this.

Example for personal information with a delta:
GET https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people?delta

Webhooks

It’s possible to retrieve change-events with webhooks. Check the Webhooks page for more general and critical information on how to use this feature.

Example for creating a webhook for personal information:
POST https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks

{
    "destinationUrl": "https://www.fictional-customer.com/protime/people",
    "collectionName": "people"
}