Employers
Introduction
The Protime API supports the catalog of employers.
Note
If you are looking for the history of employers linked to people, this can be found in the People’s historical fields section.
Tip
Check the Swagger page for more technical information on the endpoints.
Properties
Property | Type | Description |
---|---|---|
id |
integer | Unique identifier for the employer. |
name.default |
string | Default name of the employer. |
name.translations |
string | A list of translated names for supported languages. |
externalCode |
string | External code for the employer. |
address |
string | Street address of the employer. |
town |
string | Town or city of the employer. |
postalCode |
string | Postal code of the employer. |
bankAccount |
string | Bank account number of the employer. |
companyRegistrationNumber |
string | Company registration number. |
External references
It’s possible to use custom external references. More information can be found on the External references page
Endpoints
Below you can find the supported endpoints for this data collection.
GET an employer by reference
You can retrieve an employer by the internal ID or an external reference using the GET call.
GET https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/employers/{employerReference}
GET a list of employers
You can retrieve a list of employers.
GET https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/employers