---
title: "Get payroll run balance sheet"
method: GET
path: "/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/BalanceSheet"
tags: ["Payroll run downloads"]
---

# Get payroll run balance sheet

`GET /v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/BalanceSheet`

## Request

- Base URL: `https://api.loket.nl`
- URL: `https://api.loket.nl/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/BalanceSheet`
- Auth: none required

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

This endpoint returns per payroll components, marked as relevant for the general ledge (balance sheet), the sum of the values.

If for the given payroll period of the payroll run a "journal profile" is configured the endpoint also returns the ledger account and costcenter/costunit linked to the given payroll component in the "journal profile"

## Path parameters

- `payrollrunId` string, uuid, required

## 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` BalanceSheet[]
    - `payrollComponent` object: 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 many of them by heart.
      - `description` string: The description of the payroll component
      - `balanceSheetSide` object
        - `key` integer: Indicates on what side (debit or credit) the value should go
        - `value` string: The description of the side of the balance sheet
    - `journalAllocation` object[]: If configured in the software (by configuring a "journal profile") this array returns all the combinations of `generalLedgerAccount`, `costCenter` and `costUnit` configures for the given component. The hour or factor based allocation is ignored in this endpoint.
      - `generalLedgerAccount` object
        - `key` integer: The key of the general ledger account
        - `generalLedgerAccountnumber` string: The account number for the general ledger account
        - `value` string: The description of the general ledger account
      - `costCenter` object
        - `key` integer: The key of the cost center
        - `value` string: The description of the cost center
        - `code` string, nullable: The code of the cost center
      - `costUnit` object
        - `key` integer: The key of the cost unit
        - `value` string: The description of the cost unit
        - `code` string, nullable: The code of the cost unit
    - `value` number: The sum of all the values for the payrollcomponent in the specific payroll run. Payroll period, employment and normal/tarif payslip are not taken into account and simply summed up.

## 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)