Period ready for payroll

Send an email to inform the salary administrator

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

Send an email to inform that the period is ready for payrolling.

post/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/periodreadyforpayroll

Request

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

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

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

payrollPeriodIdinteger

The id for this specific payroll period.

emailAddressPeriodReadyForPayrollstring[]

The email address(es) of the recipient(s)

userCommentstring nullable

A personal message from the sender.

Example request

{
  "payrollPeriodId": 202101,
  "emailAddressPeriodReadyForPayroll": [
    "email@kantoor.nl",
    "email2@kantoor.nl"
  ],
  "userComment": "All mutations are done."
}

Response

Accepted

contentobject

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "BrokenBusinessRule",
      "description": "Invalid value for <field>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ]
}

Changes

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