LOloket
Journal run

Send the journal run

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

Send a journal run to a journal application. Use the defaults and metadata to acquire the journal application settings. The defaults endpoint contains values for all required fields.

There are two metadata endpoints:

  • /journalruns/{journalrunId}/send/metadata

  • /journalruns/{journalrunId}/send/metadata/accountId/{accountId}

post/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/send

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/send
  • Auth
    none required

Path parameters

journalrunIdstring uuid required

The unique identifier of the payroll run

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

datestring date

Date

journalNumberinteger nullable
periodinteger nullable

the period to which the journal should be added.

financialYearinteger nullable
descriptionstring nullable
userstring nullable
journalCodestring nullable
includeCostCenterboolean nullable

Indicates whether cost centers are included in the journal.

includeCostUnitboolean nullable

Indicates whether cost units are included in the journal.

accountKeystring nullable
deviatingJournalSeriesstring nullable
linkCostCenterToGroupstring uuid nullable

The Group to which the CostCenter will be linked.

linkCostUnitToGroupstring uuid nullable

The Group to which the CostUnit will be linked.

suspenseAccountstring nullable

The "number" for the suspense account (is a string)

Example request

{
  "date": "2022-01-01",
  "journalNumber": 2,
  "period": 2,
  "financialYear": 2023,
  "description": "Opmerking 1",
  "administration": {
    "id": 223,
    "value": "Administration A"
  },
  "subAdministration": {
    "Id": 223,
    "Name": "Administration A"
  },
  "user": "User1",
  "journalCode": "2",
  "includeCostCenter": true,
  "account": {
    "id": 2,
    "value": "Account Jan"
  },
  "accountKey": "User1",
  "deviatingJournalSeries": "Afwijking1",
  "linkCostCenterToGroup": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "linkCostUnitToGroup": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "suspenseAccount": "SAL-4000"
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "date": "2022-01-01",
    "journalNumber": 2,
    "period": 2,
    "financialYear": 2023,
    "description": "Opmerking 1",
    "administration": {
      "id": 223,
      "value": "Administration A"
    },
    "subAdministration": {
      "Id": 223,
      "Name": "Administration A"
    },
    "user": "User1",
    "journalCode": "2",
    "includeCostCenter": true,
    "account": {
      "id": 2,
      "value": "Account Jan"
    },
    "accountKey": "User1",
    "deviatingJournalSeries": "Afwijking1",
    "linkCostCenterToGroup": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "linkCostUnitToGroup": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "suspenseAccount": "SAL-4000"
  }
}

Changes

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