---
title: "Get journal results for a payroll administration"
method: GET
path: "/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns/cumulativeresults"
tags: ["Journal run cumulative results"]
---

# Get journal results for a payroll administration

`GET /v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns/cumulativeresults`

## Request

- Base URL: `https://api.loket.nl`
- URL: `https://api.loket.nl/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns/cumulativeresults`
- Auth: none required

__Activity name :__ <a href="https://developer.loket.nl/Activities/GetCumulativeJournalRunResultsByPayrollAdministrationId" target="_blank">GetCumulativeJournalRunResultsByPayrollAdministrationId</a>

Returns the journal run results for the the payroll administration for the given start- and end period.

## Path parameters

- `payrollAdministrationId` string, uuid, required

## Query parameters

- `startPeriod` integer, required
- `endPeriod` integer, required
- `consolidate` 'BasedOnLedgerAccountConfiguration' | 'Always' | 'Never'

## Headers

- `Authorization` string, required
- `Accept` string, required

## Response `200`

OK

- object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.
  - `totalSize` integer: Total number of records, taking into account the given filter.
  - `pageSize` integer: Number of records in the response
  - `totalPages` integer: Number of pages available
  - `currentPage` integer: Current page returned in the response
  - `version` Version
    - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available
    - `resourceVersion` string, date: The resource version of the object in the response
  - `messages` object[]
    - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages)
    - `description` string: Describes the message
    - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity
    - `code` integer: Identifying code for the message
    - `properties` string[]: An array that can contain additional information
  - `_embedded` JournalRunCumulativeResults[]
    - `payrollPeriodStart` number: The first payroll period in the dataset which contains journal results.
    - `payrollPeriodEnd` number: The last payroll period in the dataset which contains journal results.
    - `generalLedgerAccount` object: General ledger account number and description `generalLedgerAccount` is a metadata field within the payroll administration context. Possible values can be managed by the user.
      - `key` integer: Database id (unique per administration).
      - `code` string: The general ledger accounting number (grootboekrekeningnummer)
      - `description` string: Description for the general ledger accounting number.
    - `costCenter` object, nullable: The cost center on which the data for this entry will be booked for the ledger. `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
      - `key` integer
      - `code` string
      - `description` string
    - `costUnit` object, nullable: The cost unit on which the data for this entry will be booked for the ledger. `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
      - `key` integer
      - `code` string
      - `description` string
    - `payrollComponent` object, nullable: A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment. `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
      - `key` integer: The number for the payroll component. This number has meaning to payroll professionals using Loket who often know it by heart.
      - `description` string: The description of the payroll component
    - `debetAmount` number: The debet amount for the ledger entry.
    - `creditAmount` number: The credit amount for the ledger entry.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)