LOloket
Employer

Create an employer

Activity name : <a href="https://developer.loket.nl/Activities/PostEmployerByProviderId" target="_blank">PostEmployerByProviderId</a>

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.

post/v2/providers/{providerId}/employers

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/{providerId}/employers
  • Auth
    none required

Path parameters

providerIdstring uuid required

The unique identifier of a provider

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

employerNumberinteger

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).

companyNamestring

Name of the company

chamberOfCommerceNumberstring nullable

Chamber of commerce number. In Dutch "Kamer van koophandel" number

employerLogostring 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.

providerLogostring 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)

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "employerNumber": 20720,
  "companyName": "Voorbeeld B.V.",
  "chamberOfCommerceNumber": "18124676",
  "employerLogo": "https://api.loket.nl/v2/v2/providers/employers/{guid}/logo/{version}",
  "providerLogo": "https://api.loket.nl/v2/v2/providers/employers/{guid}/deviatingproviderlogo",
  "sbi": {
    "key": 12,
    "value": "Agriculture, Forestry and Fishing",
    "sbiCode": "0116"
  },
  "legalForm": {
    "key": 1,
    "value": "B.V."
  },
  "branch": {
    "key": 2,
    "value": "Landbouw en jacht"
  },
  "providerSettings": {
    "administrationNumber": "SR2",
    "groupCode": 40,
    "parentEmployerForConsolidatedOverviews": 9933,
    "sendEmailWhenSalarySlipIsAvailable": true
  },
  "contact": {
    "name": "Henk de Vries",
    "phoneNumber": "013-12345678",
    "function": "Manager"
  },
  "contactInformation": {
    "emailAddress": "info@voorbeeldbv.nl",
    "faxNumber": "(088) 31 11149",
    "phoneNumber": "(088) 31 11150",
    "website": "www.voorbeeldbv.nl"
  },
  "address": {
    "street": "Voordijk",
    "city": "Leiden",
    "houseNumber": 12,
    "houseNumberAddition": "D",
    "furtherIndication": {
      "key": 1,
      "value": "WW"
    },
    "postalCode": "1234AA",
    "location": "Fourth floor or building C",
    "country": {
      "key": 1,
      "value": "Netherlands",
      "isoCode": "NL"
    },
    "province": {
      "key": 1,
      "value": "Noord-Holland"
    }
  },
  "deviatingPostalAddress": {
    "street": "Voordijk",
    "city": "Leiden",
    "houseNumber": 12,
    "houseNumberAddition": "D",
    "furtherIndication": {
      "key": 1,
      "value": "WW"
    },
    "postalCode": "1234 AA",
    "location": "Fourth floor or building C",
    "country": {
      "key": 1,
      "value": "Netherlands",
      "isoCode": "NL"
    },
    "poBox": 5000
  }
}

Response

Created

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "employerNumber": 20720,
    "companyName": "Voorbeeld B.V.",
    "chamberOfCommerceNumber": "18124676",
    "employerLogo": "https://api.loket.nl/v2/v2/providers/employers/{guid}/logo/{version}",
    "providerLogo": "https://api.loket.nl/v2/v2/providers/employers/{guid}/deviatingproviderlogo",
    "sbi": {
      "key": 12,
      "value": "Agriculture, Forestry and Fishing",
      "sbiCode": "0116"
    },
    "legalForm": {
      "key": 1,
      "value": "B.V."
    },
    "branch": {
      "key": 2,
      "value": "Landbouw en jacht"
    },
    "providerSettings": {
      "administrationNumber": "SR2",
      "groupCode": 40,
      "parentEmployerForConsolidatedOverviews": 9933,
      "sendEmailWhenSalarySlipIsAvailable": true
    },
    "contact": {
      "name": "Henk de Vries",
      "phoneNumber": "013-12345678",
      "function": "Manager"
    },
    "contactInformation": {
      "emailAddress": "info@voorbeeldbv.nl",
      "faxNumber": "(088) 31 11149",
      "phoneNumber": "(088) 31 11150",
      "website": "www.voorbeeldbv.nl"
    },
    "address": {
      "street": "Voordijk",
      "city": "Leiden",
      "houseNumber": 12,
      "houseNumberAddition": "D",
      "furtherIndication": {
        "key": 1,
        "value": "WW"
      },
      "postalCode": "1234AA",
      "location": "Fourth floor or building C",
      "country": {
        "key": 1,
        "value": "Netherlands",
        "isoCode": "NL"
      },
      "province": {
        "key": 1,
        "value": "Noord-Holland"
      }
    },
    "deviatingPostalAddress": {
      "street": "Voordijk",
      "city": "Leiden",
      "houseNumber": 12,
      "houseNumberAddition": "D",
      "furtherIndication": {
        "key": 1,
        "value": "WW"
      },
      "postalCode": "1234 AA",
      "location": "Fourth floor or building C",
      "country": {
        "key": 1,
        "value": "Netherlands",
        "isoCode": "NL"
      },
      "poBox": 5000
    }
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.