v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Payroll tax return response message

Send the response message for the payroll tax return

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

Send the response message of the payroll tax return (loonaangifte) that was received from the Belastingdienst, to Loket. This is ONLY applicable for the limited group of parties that send and receive the payroll tax return themselves to the Belastingdienst. For the purposes of having those results visible in Loket the corresponding response message can be send to Loket via this endpoint.

What this endpoint does is the following:

  • It will receive the xml response message. For the schema (XSD) of this xml response message we refer to the documentation by the Belastingdienst itself
  • A set of input validations will be performed.
  • If those steps are successful the xml response message will placed in a designated directory. Where it will be picked up for final processing by a proces that runs about every 15 minutes
  • In other words; the result of this action will NOT be immediately visible
post/v2/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/sendresponsemessage

Path parameters

payrolltaxreturnIdstring uuid required

The unique identifier of the payroll tax return

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

responseMessageFilestring

base64 encoded xml file of the response message

Example request

{
  "responseMessageFile": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iSVNPLTg4NTktMSI/Pgo8UmVzcG9uc2VtZXNzYWdlIHZlcnNpb249IjIwMDYuMSI+Cgk8SWRlbnRpZmljYXRpb24+CgkJPE1lc3NhZ2VJZD5BLWVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWQ+CgkJPFJlZmVyc1RvTWVzc2FnZUlkPlZTUDAwMTAwMTE4MzcyMkwwNDAwMDAwMTIwMTIzNDwvUmVmZXJzVG9NZXNzYWdlSWQ+CgkJPE1lc3NhZ2VJZEJkPmVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWRCZD4KCQk8RGF0dW1UaWpkT250dmFuZ3N0PjIwMjAtMDEtMThUMTY6MDY6MzlaPC9EYXR1bVRpamRPbnR2YW5nc3Q+CgkJPFJlc3BvbnNlVHlwZT5hY2tub3dsZWRnZW1lbnQ8L1Jlc3BvbnNlVHlwZT4KCTwvSWRlbnRpZmljYXRpb24+CjwvUmVzcG9uc2VtZXNzYWdlPgo"
}

Response

OK