Journal configuration

Edit the details of a journal configuration

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

Edit the details of a journal configuration record

Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.

put/v2/providers/employers/payrolladministrations/journalConfigurations/{journalConfigurationId}

Request

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

Path parameters

journalConfigurationIdstring uuid required

The unique identifier of a journal configuration

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)

automaticallyInitiateJournalRunboolean

Indicates whether a journal run is automaticly started when a payroll run is approved

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "journalProfile": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "key": 2,
    "description": "General ledger supermarkets"
  },
  "startPeriod": {
    "year": 2017,
    "periodNumber": 1,
    "periodStartDate": "2018-01-01",
    "periodEndDate": "2018-01-31"
  },
  "endPeriod": {
    "year": 2017,
    "periodNumber": 1,
    "periodStartDate": "2018-01-01",
    "periodEndDate": "2018-01-31"
  }
}

Response

OK

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",
    "journalProfile": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "key": 2,
      "description": "General ledger supermarkets"
    },
    "startPeriod": {
      "year": 2017,
      "periodNumber": 1,
      "periodStartDate": "2018-01-01",
      "periodEndDate": "2018-01-31"
    },
    "endPeriod": {
      "year": 2017,
      "periodNumber": 1,
      "periodStartDate": "2018-01-01",
      "periodEndDate": "2018-01-31"
    }
  }
}

Changes

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