Create an employer
Creates a new employer.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
POST
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/employers
Headers: Authorization: Bearer {token}, User-Agent: {agent}
Scope: connector-protimeapi-employers.write
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
This endpoint does not accept the externalReferences query parameter. Register a custom external reference for the created employer with the external references endpoints.
Error responses
| Status | Condition |
|---|---|
400 |
Validation failed (missing name.default, invalid translation key, value too long) |
401 |
Missing or invalid access token, or insufficient scope |
Success response
201 Created with a Location header pointing to the new employer. The response body is empty.
Examples
Create an employer
POST
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/employers
{
"name": {
"default": "Protime NV"
},
"externalCode": "EMP-01",
"address": "Wayenborgstraat 14",
"town": "Mechelen",
"postalCode": "2800",
"companyRegistrationNumber": "BE0123456789"
}