LOloket
Wage

Create an wage for an employment

Activity name : <a href="https://developer.loket.nl/Activities/PostWageByEmploymentId" target="_blank">PostWageByEmploymentId</a><br><br>Create a new wage record for the given employment<br><br>Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST Wage URL.<br><br> <br>The possible options for payGrade are scoped by a payScale. To obtain the pay grades for a pay scale a metadata call has to be performed with the following format ../wages/metadata/payscale/{key}. Where {key} is the key of the payScale (obtained via the first metadata call) for which the pay grades are to be returned.<br><br>Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL and performing a GET action.<br>

post/v2/providers/employers/employees/employments/{employmentId}/wages

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}/wages
  • Auth
    none required

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

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)

startDatestring date

The start date for the information in the record.

A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. Note It is possible to have no wage record.

endDatestring date nullable

The end date for the information in the record.

grossWagenumber double nullable

The gross wage for the employee

isGrossWageFullTimeboolean

Indicates whether the given grossWage is either a full-time wage or a part-time wage. Full-time wage is the default value (isGrossWageFulltime = true) and Loket recommends to use this option. A full-time wage takes into account the part-time percentage of an employment. While a part-time wage does not. E.g. A full-time wage of 2400 euro’s is registered. The employments works 20 out of 40 hours (40 fours is a full-time shift) thus having a 20/40 = 50% part-time percentage. The part-time hours (deviatingHoursPerWeek) are accessible through the endpoint for working hours of an employement. In the wage calculation Loket will divide the grossWage component by 50% resulting in a grossWage of 1200 euro’s. In the case of a part-time wage the part-time percentage will be ignored.

netWagenumber double nullable

Net wage for the employment

employerCostsnumber double nullable

The cost for the employer for this employee.

applyPayGradeboolean nullable

Apply pay grade indicates that after submitting the record the server will replace the value of grossWage with the value represented by the selected payGrade. A pay grade contains time based values, the value that is active on the start date of the record will be selected.

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "startDate": "1995-05-21",
  "payrollPeriodType": {
    "key": 1,
    "value": "Maand"
  },
  "grossWage": 2300,
  "grossWageType": {
    "key": 2,
    "value": "hourly"
  },
  "isGrossWageFullTime": true,
  "netWage": 2400,
  "netWageType": {
    "key": 1,
    "value": "hourly"
  },
  "employerCosts": 3500,
  "employerCostsType": {
    "key": 1,
    "value": "hourly"
  },
  "payScale": {
    "key": 1,
    "value": "Glastuinbouw maand, Loongebouw A"
  },
  "payGrade": {
    "key": 1,
    "value": "Schaal B1, 15 jaar"
  },
  "applyPayGrade": true
}

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",
    "startDate": "1995-05-21",
    "payrollPeriodType": {
      "key": 1,
      "value": "Maand"
    },
    "grossWage": 2300,
    "grossWageType": {
      "key": 2,
      "value": "hourly"
    },
    "isGrossWageFullTime": true,
    "netWage": 2400,
    "netWageType": {
      "key": 1,
      "value": "hourly"
    },
    "employerCosts": 3500,
    "employerCostsType": {
      "key": 1,
      "value": "hourly"
    },
    "payScale": {
      "key": 1,
      "value": "Glastuinbouw maand, Loongebouw A"
    },
    "payGrade": {
      "key": 1,
      "value": "Schaal B1, 15 jaar"
    },
    "applyPayGrade": true
  }
}

Changes

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