LOloket
Generate document

Generate documents for selected employments

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

Metadata: Available templates can be acquired(GET) at Employer level(/v2/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).

Generate documents for a selection of employments and store it in the employment dossier. Via Qwoater. (One document is generated and stored for each selected employment)

post/v2/providers/employers/{employerId}/documenttemplates/{documentId}/generatedocuments

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/{employerId}/documenttemplates/{documentId}/generatedocuments
  • Auth
    none required

Path parameters

employerIdstring uuid required

The unique identifier of the employer

documentIdstring required

The unique identifier of the template

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

descriptionstring

The description defined by the submitter. Qwoater: Docfield 33 Omschrijving

yearinteger nullable

The year the document relates to. Qwoater: Docfield 86 Jaar

attributestring nullable

The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk

dateOfAlertstring date nullable

The date at which document will alerted for cancellation. Qwoater: AlertDate

filenamestring

The name of the file. Qwoater: Filename

templateEmployerIdstring uuid

The unique identifier of the employer to which the template belongs (GUID/UUID).

referenceDatestring date

This date will be used to select date depending data such as department and function.

sendEmailNotificationboolean nullable

Indicate whether to send an email to the employees.

employmentIdsstring[]

Example request

{
  "description": "Copy of id card",
  "year": 2017,
  "attribute": "VSP004",
  "dateOfAlert": "2018-05-08",
  "filename": "BowlsJohn.pdf",
  "templateEmployerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "referenceDate": "2020-05-08",
  "sendEmailNotification": true,
  "employmentIds": [
    "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
  ]
}

Response

OK. The process of generating documents has started.

Changes

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