Update an employer
Updates an existing employer, identified by its internal ID or an external reference.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
PUT
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/employers/{employerReference}
Headers: Authorization: Bearer {token}, User-Agent: {agent}
Scope: connector-protimeapi-employers.write
URL parameters
| Parameter | Description |
|---|---|
{employerReference} |
The internal ID or external reference of the employer. |
Body properties
| Field | Type | Required | Writable | Description |
|---|---|---|---|---|
name.default |
string | Yes | Yes | Default name of the employer. |
name.translations |
object | No | Yes | Translated names, keyed by ISO language code (for example nl, fr). |
externalCode |
string | No | Yes | External code for the employer. Maximum 50 characters. |
address |
string | No | Yes | Street address of the employer. Maximum 200 characters. |
town |
string | No | Yes | Town or city of the employer. Maximum 100 characters. |
postalCode |
string | No | Yes | Postal code of the employer. Maximum 20 characters. |
bankAccount |
string | No | Yes | Bank account number of the employer. Maximum 50 characters. |
companyRegistrationNumber |
string | No | Yes | Company registration number. Maximum 50 characters. |
External references
The endpoint resolves {employerReference} through the externalReferences query parameter. See the external references page for details.
| Collection | Predefined | Custom |
|---|---|---|
employers |
Not available | Supported |
Error responses
| Status | Condition |
|---|---|
400 |
Invalid external reference specification, or validation failed (missing name.default, invalid translation key, value too long) |
401 |
Missing or invalid access token, or insufficient scope |
404 |
Employer with the given ID or external reference not found |
Success response
200 OK. The response body is empty.
Examples
Update an employer by internal ID
PUT
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/employers/312
{
"name": {
"default": "Protime NV"
},
"address": "Wayenborgstraat 14",
"town": "Mechelen",
"postalCode": "2800"
}Update an employer by custom external reference
PUT
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/employers/EMP-01?externalReferences=(employers,customEmployerCode)
{
"name": {
"default": "Protime NV"
},
"bankAccount": "BE68539007547034"
}