LOloket
Payroll run downloads

Get payroll run balance sheet

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"

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

Path parameters

payrollrunIdstring 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

Response

OK

totalSizeinteger

Total number of records, taking into account the given filter.

pageSizeinteger

Number of records in the response

totalPagesinteger

Number of pages available

currentPageinteger

Current page returned in the response

Example response

{
  "totalSize": 650,
  "pageSize": 250,
  "totalPages": 3,
  "currentPage": 2,
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "_embedded": [
    {
      "payrollComponent": {
        "key": 70,
        "description": "Wage",
        "balanceSheetSide": {
          "key": 1,
          "value": "Credit"
        }
      },
      "journalAllocation": [
        {
          "generalLedgerAccount": {
            "key": 1,
            "value": "Wages"
          },
          "costCenter": {
            "key": 1,
            "value": "Sales",
            "code": "SAL"
          },
          "costUnit": {
            "key": 1,
            "value": "International",
            "code": "INT"
          }
        }
      ],
      "value": 40457.01
    }
  ]
}

Changes

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