LOloket
Payroll administration process overview

Process Information about a payroll on administration level

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

Get an overview of the status and possible actions for the specified period, including the preceding and subsequent period. The overview contains information about: payroll runs, payroll tax return and pension. Metadata : Possible options for the query string parameters can be acquired (GET) via the /metadata endpoint. The URI for this endpoint is ../v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/metadata.

Defaults : Default values for the query string parameters can be acquired via the /defaults endpoint. The URI for this endpoint is ../v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/defaults.

get/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview

Request

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

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

Query parameters

payrollPeriodIdStartinteger required

The unique identifier of the first payroll period to return

payrollPeriodIdEndinteger

The unique identifier of the last payroll period to return

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": [
    {
      "payrollPeriod": {
        "year": 2020,
        "periodNumber": 4,
        "payrollPeriodId": 202004,
        "periodStartDate": "2020-04-01",
        "periodEndDate": "2020-06-30"
      },
      "payrollTaxReturnPeriod": {
        "year": 2020,
        "periodNumber": 4,
        "payrollTaxReturnPeriodId": 202001,
        "periodStartDate": "2020-04-01",
        "periodEndDate": "2020-06-30",
        "lastPayrollPeriodId": 202004
      },
      "payroll": {
        "payrollStatus": {
          "key": 2,
          "value": "Queued",
          "payrollStatusAdditionalInfo": {
            "key": "2.1",
            "value": "The period has a payrollrun queued."
          }
        },
        "payrollPossibleActions": {
          "value": "None",
          "payrollPossibleActionsAdditionalInfo": {
            "key": "0.7",
            "value": "The period has a payrollrun queued."
          }
        }
      },
      "journal": {
        "journalStatus": {
          "key": 2,
          "value": "Queued",
          "journalStatusAdditionalInfo": {
            "key": "2.1",
            "value": "The period has a journalrun ready for export"
          }
        },
        "journalPossibleActions": {
          "value": "None",
          "journalPossibleActionsAdditionalInfo": {
            "key": "0.7",
            "value": "The period has a journalrun queued."
          }
        }
      },
      "payrollTaxReturn": {
        "payrollTaxReturnStatus": {
          "key": 6,
          "value": "Done",
          "payrollTaxReturnStatusAdditionalInfo": {
            "key": "2",
            "value": "The period has a payrolltaxrun queued."
          }
        },
        "payrollTaxReturnPossibleActions": {
          "key": 2,
          "value": "Start",
          "payrollTaxReturnPossibleActionsAdditionalInfo": {
            "key": "0.13",
            "value": "There is a queued payrolltaxreturn."
          }
        },
        "initiateIdealPayment": {
          "value": "Ideal Payment is possible"
        }
      },
      "pensionDeclaration": [
        {
          "pensionDeclarationStatus": {
            "key": 6,
            "value": "Done",
            "pensionDeclarationStatusAdditionalInfo": {
              "key": "2",
              "value": "The period has a pensiondeclaration queued."
            }
          },
          "pensionDeclarationPossibleActions": {
            "key": 2,
            "value": "Start",
            "pensionDeclarationPossibleActionsAdditionalInfo": {
              "key": "UPAC014",
              "value": "There is a queued pensiondeclaration."
            }
          },
          "pensionDeclarationExternalParty": {
            "key": 13,
            "value": "PFZW (UPA)"
          }
        }
      ],
      "pawwDeclaration": {
        "pawwDeclarationStatus": {
          "key": 6,
          "value": "Done",
          "pawwDeclarationStatusAdditionalInfo": {
            "key": "2",
            "value": "The period has a pawwDeclaration queued."
          }
        },
        "pawwDeclarationPossibleActions": {
          "key": 2,
          "value": "Start",
          "pawwDeclarationPossibleActionsAdditionalInfo": {
            "key": "UPAC014",
            "value": "There is a queued pawwDeclaration."
          }
        }
      }
    }
  ]
}

Changes

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