--- title: "Create an employer" method: POST path: "/v2/providers/{providerId}/employers" tags: ["Employer"] --- # Create an employer `POST /v2/providers/{providerId}/employers` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/{providerId}/employers` - Auth: none required __Activity name :__ PostEmployerByProviderId Create an employee for the provider (administratiekantoor) identified by the given providerId. Please take note of the following; a newly created Employer is not immediately accessible for the user. As this would require adding the Employer to a specific Loket team (which is a separate activity). Even after adding the Employer to a team, it may take a few minutes before the Employer is accessible for the user because of caching. __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL. __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. ## Path parameters - `providerId` string, uuid, required ## Headers - `Authorization` string, required - `Accept` string, required ## Request body - Employer - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `employerNumber` integer: The employer number is used in various overviews and exports to identify a specific employer in Loket (please note: this is not the identifier used in the REST API). - `companyName` string: Name of the company - `chamberOfCommerceNumber` string, nullable: Chamber of commerce number. In Dutch "Kamer van koophandel" number - `employerLogo` string, url, nullable: The location of the logo of the employer. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output. - `providerLogo` string, url, nullable: This logo is displayed in the interface of loket.nl. if null no deviating logo is present and the normal provider logo should be used (aquire the URL to the logo via ../v2/providers) - `sbi` Sbi, nullable: The 'Standard Industrial Classifications (Dutch SBI 2008, NACE and ISIC)' as defined bij the Dutch chamber of commerce - `key` integer: The key of the SBI code. Possible values can be aquired via the metadata endpoint - `value` string: Description of the SBI code - `sbiCode` string: Possible values are the values from the Dutch SBI 2008 - `legalForm` LegalForm, nullable - `key` integer: The key of the legal form. Possible values can be aquired via the metadata endpoint - `value` string: Description of the legal form. Possible values are the legel forms supported by Dutch law - `branch` Branch, nullable - `key` integer: The key of the branch. Possible values can be aquired via the metadata endpoint - `value` string: Description of the branch. Branch is only available in Dutch - `providerSettings` ProviderSettings - `administrationNumber` string, nullable: A free field that is most commonly used to store the Debtors Number the provider uses for the employer. This field is used as a key field in some of the existing SOAP webservices. - `groupCode` integer, nullable: The groupcode is used for grouping employers. It is used for filtering output and processes (only include employers in group 40 in this report). This field does not support 0 as a value. If 0 is send it will be stored as NULL. - `parentEmployerForConsolidatedOverviews` integer, nullable: This field is used to link employers in order to generate reports containing the information of all the linked employers. By applying this method, infinite amount of employers can be linked. - `sendEmailWhenSalarySlipIsAvailable` boolean: Indicates whether an e-mail should be sent to an employee if a salary slip becomes available in the employee portal (loket.nl's "werknemer.loket") - `contact` Contact2, nullable - `name` string, nullable: Name of the contact of the employer - `phoneNumber` string, nullable: The general phone number of the employer - `function` string, nullable: The job title/function of the contact of the employer - `contactInformation` ContactInformation3, nullable - `emailAddress` string, email, nullable: The email address of the employer - `faxNumber` string, nullable: The fax number of the employer - `phoneNumber` string, nullable: The telephone number of the employer - `website` string, url, nullable: The website of the employer - `address` Address - `street` string: Streetname of the address - `city` string: City of the address - `houseNumber` integer: House number of the address - `houseNumberAddition` string, nullable: An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. - `furtherIndication` object, nullable - `key` integer: The key of the further indication. Possible values can be aquired via the metadata endpoint - `value` string: The description of the further indication, the possible values are "WW" and "AB" - `postalCode` string: The postal code of the address - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired via the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `province` object, nullable: A Dutch province - `key` integer, nullable: The key for the province. Possible values can be aquired via the metadata endpoint - `value` string, nullable: The name of the province. Only the Dutch provices are supported and not translated - `deviatingPostalAddress` DeviatingPostalAddress, nullable - `street` string, nullable: Streetname of the address - `city` string: City of the address - `houseNumber` integer, nullable: House number of the address - `houseNumberAddition` string, nullable: An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. - `furtherIndication` object, nullable - `key` integer: The key of the further indication. Possible values can be aquired by the metadata endpoint - `value` string: The description of the further indication, the possible values are "WW" and "AB" - `postalCode` string, nullable: The postal code of the address, only nullable if country is not The Netherlands (NL). - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired by the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `poBox` integer, nullable: Post office box ## Response `201` Created - object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour. - `version` Version - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available - `resourceVersion` string, date: The resource version of the object in the response - `messages` object[] - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages) - `description` string: Describes the message - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity - `code` integer: Identifying code for the message - `properties` string[]: An array that can contain additional information - `content` Employer - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `employerNumber` integer: The employer number is used in various overviews and exports to identify a specific employer in Loket (please note: this is not the identifier used in the REST API). - `companyName` string: Name of the company - `chamberOfCommerceNumber` string, nullable: Chamber of commerce number. In Dutch "Kamer van koophandel" number - `employerLogo` string, url, nullable: The location of the logo of the employer. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output. - `providerLogo` string, url, nullable: This logo is displayed in the interface of loket.nl. if null no deviating logo is present and the normal provider logo should be used (aquire the URL to the logo via ../v2/providers) - `sbi` Sbi, nullable: The 'Standard Industrial Classifications (Dutch SBI 2008, NACE and ISIC)' as defined bij the Dutch chamber of commerce - `key` integer: The key of the SBI code. Possible values can be aquired via the metadata endpoint - `value` string: Description of the SBI code - `sbiCode` string: Possible values are the values from the Dutch SBI 2008 - `legalForm` LegalForm, nullable - `key` integer: The key of the legal form. Possible values can be aquired via the metadata endpoint - `value` string: Description of the legal form. Possible values are the legel forms supported by Dutch law - `branch` Branch, nullable - `key` integer: The key of the branch. Possible values can be aquired via the metadata endpoint - `value` string: Description of the branch. Branch is only available in Dutch - `providerSettings` ProviderSettings - `administrationNumber` string, nullable: A free field that is most commonly used to store the Debtors Number the provider uses for the employer. This field is used as a key field in some of the existing SOAP webservices. - `groupCode` integer, nullable: The groupcode is used for grouping employers. It is used for filtering output and processes (only include employers in group 40 in this report). This field does not support 0 as a value. If 0 is send it will be stored as NULL. - `parentEmployerForConsolidatedOverviews` integer, nullable: This field is used to link employers in order to generate reports containing the information of all the linked employers. By applying this method, infinite amount of employers can be linked. - `sendEmailWhenSalarySlipIsAvailable` boolean: Indicates whether an e-mail should be sent to an employee if a salary slip becomes available in the employee portal (loket.nl's "werknemer.loket") - `contact` Contact2, nullable - `name` string, nullable: Name of the contact of the employer - `phoneNumber` string, nullable: The general phone number of the employer - `function` string, nullable: The job title/function of the contact of the employer - `contactInformation` ContactInformation3, nullable - `emailAddress` string, email, nullable: The email address of the employer - `faxNumber` string, nullable: The fax number of the employer - `phoneNumber` string, nullable: The telephone number of the employer - `website` string, url, nullable: The website of the employer - `address` Address - `street` string: Streetname of the address - `city` string: City of the address - `houseNumber` integer: House number of the address - `houseNumberAddition` string, nullable: An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. - `furtherIndication` object, nullable - `key` integer: The key of the further indication. Possible values can be aquired via the metadata endpoint - `value` string: The description of the further indication, the possible values are "WW" and "AB" - `postalCode` string: The postal code of the address - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired via the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `province` object, nullable: A Dutch province - `key` integer, nullable: The key for the province. Possible values can be aquired via the metadata endpoint - `value` string, nullable: The name of the province. Only the Dutch provices are supported and not translated - `deviatingPostalAddress` DeviatingPostalAddress, nullable - `street` string, nullable: Streetname of the address - `city` string: City of the address - `houseNumber` integer, nullable: House number of the address - `houseNumberAddition` string, nullable: An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. - `furtherIndication` object, nullable - `key` integer: The key of the further indication. Possible values can be aquired by the metadata endpoint - `value` string: The description of the further indication, the possible values are "WW" and "AB" - `postalCode` string, nullable: The postal code of the address, only nullable if country is not The Netherlands (NL). - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired by the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `poBox` integer, nullable: Post office box ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)