--- title: "Process Information about a payroll on administration level" method: GET path: "/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview" tags: ["Payroll administration process overview"] --- # Process Information about a payroll on administration level `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 __Activity name :__ GetPayrollProcessOverviewByPayrollAdministrationId 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`. ## Path parameters - `payrollAdministrationId` string, uuid, required ## Query parameters - `payrollPeriodIdStart` integer, required - `payrollPeriodIdEnd` integer ## 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` PayrollProcessOverview[] - `payrollPeriod` object - `year` integer: The year of the payroll period - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) - `payrollPeriodId` integer: The year and period of the payroll period - `periodStartDate` string, date: The first day of the period to which the payroll period data applies - `periodEndDate` string, date: The last day of the period to which the payroll period data applies - `payrollTaxReturnPeriod` object - `year` integer: The year of the payroll tax return period - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 13]) - `payrollTaxReturnPeriodId` integer: The year and period of the payroll tax return period - `periodStartDate` string, date: The first day of the period to which the payroll tax return period data applies - `periodEndDate` string, date: The last day of the period to which the payroll tax return period data applies - `lastPayrollPeriodId` integer: The year and period identifying the last payroll period that is part of the payroll tax return period. - `payroll` object: Status and possible actions of the payroll process - `payrollStatus` object: Status of the payroll process in the period. Possible statuses are: - 0 Invalid - 1 Not started - 2 Queued - 3 Waiting for approval - 4 Incorrect and there is an approved preceding payrollrun - 5 Incorrect - 6 Approved - 7 No results - 8 No results and there is an approved preceding payrollrun - `key` integer - `value` string - `payrollStatusAdditionalInfo` object: Additional information on the the status of the payroll process in the period. - `key` string - `value` string - `payrollPossibleActions` object: Possible actions for the payroll process in the period. Possible actions are: - 0 None (no action possible) - 1 Ready to proces - 2 Start - 3 Restart - `key` integer - `value` string - `payrollPossibleActionsAdditionalInfo` object: Additional information on the possible action of the payroll process in the period. - `key` string - `value` string - `typeOfInitiationLastPayrollRun` 'regular' | 'withoutEmploymentData': Indicates whether the run is completed with or withour employments. - `journal` object: Status and possible actions of the journal process - `journalStatus` object: Status of the journal process in the period. Possible statuses are: - 0 Invalid - 1 Queued - 2 Exporting - 3 Incorrect - 4 Incorrect and preceding journalrun - 5 No results - 6 No results and preceding journalrun - 7 Last export failed - 8 Journal ready - 9 Export failed - 10 Not started - 11 Exported - `key` integer - `value` string - `journalStatusAdditionalInfo` object: Additional information on the the status of the payroll process in the period. - `key` string - `value` string - `journalPossibleActions` object: Possible actions for the journal process in the period. Possible actions are: - 0 None (no action possible) - 1 Start - 2 Export - `key` integer - `value` string - `journalPossibleActionsAdditionalInfo` object: Additional information on the possible action of the journal process in the period. - `key` string - `value` string - `payrollTaxReturn` object: Status and possible actions of the payroll taxReturn process - `payrollTaxReturnStatus` object: Status of the payroll taxreturn process in the period. Possible statuses are: - 0 Invalid - 1 Not started - 2 Queued - 3 Waiting for approval - 5 Incorrect - 6 Approved - 9 Approved and sent - 10 Not available - 11 Cancelled - 12 Deleted - 13 Blank - `key` integer - `value` string - `payrollTaxReturnStatusAdditionalInfo` object: Additional information on the status of the payroll tax return process in the period. - `key` string - `value` string - `payrollTaxReturnPossibleActions` object: Possible actions for the payroll tax return process in the period. Possible actions are: - 0 None (no action possible) - 1 Ready to proces - 2 Start - `key` integer - `value` string - `payrollTaxReturnPossibleActionsAdditionalInfo` object: Additional information on the possible action of the payroll tax return process in the period. - `key` string - `value` string - `initiateIdealPayment` object: Indicates whether the payroll tax can be payed by means of IDEAL. Possible values: - Ideal Payment is possible (key = 0) - Ideal Payment not possible for total amount (<=0 of >=50.000) (key = 1) - Ideal Payment not possible from a "G-rekening" (key = 2) - Ideal Payment not possible there is a pending payment (key = 3) - Ideal Payment not possible the payment has already been processed and accepted (key = 4) - `key` integer - `value` string - `pensionDeclaration` object[] - `pensionDeclarationStatus` object: Status of the pensiondeclaration process in the period. Possible statuses are: - 0 Invalid - 1 Not started - 2 Queued - 3 Waiting for approval - 5 Incorrect - 6 Approved - 9 Approved and sent - 10 Not available - 11 Cancelled - 12 Deleted - 13 Blank - `key` integer - `value` string - `pensionDeclarationStatusAdditionalInfo` object: Additional information on the status of the pensiondeclaration process in the period. - `key` string - `value` string - `pensionDeclarationPossibleActions` object: Possible actions for the pensiondeclaration process in the period. Possible actions are: - 0 None (no action possible) - 1 Ready to proces - 2 Start - `key` integer - `value` string - `pensionDeclarationPossibleActionsAdditionalInfo` object: Additional information on the possible action of the pensiondeclaration process in the period. - `key` string - `value` string - `pensionDeclarationAdministratorType` 'UPA' | 'APG': The type of Pension declaration - `pensionDeclarationExternalParty` object: External party (externe partij) - `key` integer - `value` string - `pawwDeclaration` object: Status and possible actions of the pawwDeclaration process - `pawwDeclarationStatus` object: Status of the pawwDeclaration process in the period. Possible statuses are: - 0 Invalid - 1 Not started - 2 Queued - 3 Waiting for approval - 5 Incorrect - 6 Approved - 9 Approved and sent - 10 Not available - 11 Cancelled - 12 Deleted - 13 Blank - `key` integer - `value` string - `pawwDeclarationStatusAdditionalInfo` object: Additional information on the status of the pawwDeclaration process in the period. - `key` string - `value` string - `pawwDeclarationPossibleActions` object: Possible actions for the pawwDeclaration process in the period. Possible actions are: - 0 None (no action possible) - 1 Ready to proces - 2 Start - `key` integer - `value` string - `pawwDeclarationPossibleActionsAdditionalInfo` object: Additional information on the possible action of the pawwDeclaration process in the period. - `key` string - `value` string - `pensionAdministratorType` 'UPA' | 'APG': The type of Pension declaration ## 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)