PayrollProcessOverviewByPayrollAdministrationId |
Process Information about a payroll on administration level__Activity name :__ GetPayrollProcessOverviewByPayrollAdministrationIdGet 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 `../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 `../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/defaults`.
Catalogus: LoketNlRest
Schema: PayrollAdministrationProcessOverview
Dit is een alleen-lezen tabelfunctie. De Loket.nl REST API biedt mogelijk geen ondersteuning voor het wijzigen van de data of het Invantive UniversalSQL-stuurprogramma voor Loket.nl REST ondersteunt dit niet. In het laatste geval gebruikt u de tabel NativePlatformScalarRequests om gegevens te uploaden naar de Loket.nl REST-API.
Parameters van Tabelfunctie
De volgende parameters kunnen worden gebruikt om het gedrag van de tabelfunctie PayrollProcessOverviewByPayrollAdministrationId in te stellen. Voor verplichte parameters moet altijd een waarde worden opgegeven, maar optionele parameters hoeven in het algemeen geen waarde te hebben en de uitvoering zal standaard een vooraf bepaald gedrag vertonen. Waarden kunnen worden gespecificeerd op basis van positie en naam. In beide gevallen worden alle niet-gespecificeerde parameters geëvalueerd aan de hand van hun standaardwaarden.
Waardespecificatie op positie gebeurt door alle waarden van de eerste tot de laatste benodigde waarde op te sommen. Bijvoorbeeld: een `select * uit tabel(waarde1, waarde2, waarde3)` op een tabel met vier parameters zal de standaardwaarde voor de vierde parameter gebruiken en de opgegeven waarden voor de eerste drie.
Waardespecificatie op naam gebeurt door alle waarden die een waarde vereisen op te sommen. Bijvoorbeeld met `selecteer * uit tabel(naam1 => waarde1, naam3 => waarde3)` op dezelfde tabel zullen de standaardwaarden voor de tweede en vierde parameter worden gebruikt en de opgegeven waarden voor de eerste en derde.
Naam |
Datatype |
Verplicht |
Standaardwaarde |
Documentatie |
---|---|---|---|---|
payrollAdministrationId |
guid |
☑ |
|
The unique identifier of an administration |
payrollPeriodIdEnd |
int32 |
☐ |
|
The unique identifier of the last payroll period to return |
payrollPeriodIdStart |
int32 |
☑ |
|
The unique identifier of the first payroll period to return |
Kolommen van Tabelfunctie
De kolommen van de tabelfunctie PayrollProcessOverviewByPayrollAdministrationId worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype.
Naam |
Datatype |
Label |
Verplicht |
Documentatie |
---|---|---|---|---|
journal_journalPossibleActions_journalPossibleActionsAdditionalInfo_key |
string |
|
☐ |
|
journal_journalPossibleActions_journalPossibleActionsAdditionalInfo_value |
string |
|
☐ |
|
journal_journalPossibleActions_key |
int32 |
|
☐ |
|
journal_journalPossibleActions_value |
string |
|
☐ |
|
journal_journalStatus_journalStatusAdditionalInfo_key |
string |
|
☐ |
|
journal_journalStatus_journalStatusAdditionalInfo_value |
string |
|
☐ |
|
journal_journalStatus_key |
int32 |
|
☐ |
|
journal_journalStatus_value |
string |
|
☐ |
|
pawwDeclaration_pawwDeclarationPossibleActions_key |
int32 |
|
☐ |
|
pawwDeclaration_pawwDeclarationPossibleActions_pawwDeclarationPossibleActionsAdditionalInfo_key |
string |
|
☐ |
|
pawwDeclaration_pawwDeclarationPossibleActions_pawwDeclarationPossibleActionsAdditionalInfo_value |
string |
|
☐ |
|
pawwDeclaration_pawwDeclarationPossibleActions_value |
string |
|
☐ |
|
pawwDeclaration_pawwDeclarationStatus_key |
int32 |
|
☐ |
|
pawwDeclaration_pawwDeclarationStatus_pawwDeclarationStatusAdditionalInfo_key |
string |
|
☐ |
|
pawwDeclaration_pawwDeclarationStatus_pawwDeclarationStatusAdditionalInfo_value |
string |
|
☐ |
|
pawwDeclaration_pawwDeclarationStatus_value |
string |
|
☐ |
|
pawwDeclaration_pensionAdministratorType |
string |
|
☐ |
The type of Pension declaration |
payroll_payrollPossibleActions_key |
int32 |
|
☐ |
|
payroll_payrollPossibleActions_payrollPossibleActionsAdditionalInfo_key |
string |
|
☐ |
|
payroll_payrollPossibleActions_payrollPossibleActionsAdditionalInfo_value |
string |
|
☐ |
|
payroll_payrollPossibleActions_value |
string |
|
☐ |
|
payroll_payrollStatus_key |
int32 |
|
☐ |
|
payroll_payrollStatus_payrollStatusAdditionalInfo_key |
string |
|
☐ |
|
payroll_payrollStatus_payrollStatusAdditionalInfo_value |
string |
|
☐ |
|
payroll_payrollStatus_value |
string |
|
☐ |
|
payroll_typeOfInitiationLastPayrollRun |
string |
|
☐ |
Indicates whether the run is completed with or withour employments. |
payrollPeriod_payrollPeriodId |
int32 |
|
☐ |
The year and period of the payroll period |
payrollPeriod_periodEndDate |
datetime |
Einddatum Loonperiode |
☐ |
The last day of the period to which the payroll period data applies |
payrollPeriod_periodNumber |
int32 |
Nummer Verloningsperiode |
☐ |
The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) |
payrollPeriod_periodStartDate |
datetime |
Startdatum Verloningsperiode |
☐ |
The first day of the period to which the payroll period data applies |
payrollPeriod_year |
int32 |
Loonverwerking Jaarperiode |
☐ |
The year of the payroll period |
payrollTaxReturn_initiateIdealPayment_key |
int32 |
|
☐ |
|
payrollTaxReturn_initiateIdealPayment_value |
string |
|
☐ |
|
payrollTaxReturn_payrollTaxReturnPossibleActions_key |
int32 |
|
☐ |
|
payrollTaxReturn_payrollTaxReturnPossibleActions_payrollTaxReturnPossibleActionsAdditionalInfo_key |
string |
|
☐ |
|
payrollTaxReturn_payrollTaxReturnPossibleActions_payrollTaxReturnPossibleActionsAdditionalInfo_value |
string |
|
☐ |
|
payrollTaxReturn_payrollTaxReturnPossibleActions_value |
string |
|
☐ |
|
payrollTaxReturn_payrollTaxReturnStatus_key |
int32 |
|
☐ |
|
payrollTaxReturn_payrollTaxReturnStatus_payrollTaxReturnStatusAdditionalInfo_key |
string |
|
☐ |
|
payrollTaxReturn_payrollTaxReturnStatus_payrollTaxReturnStatusAdditionalInfo_value |
string |
|
☐ |
|
payrollTaxReturn_payrollTaxReturnStatus_value |
string |
|
☐ |
|
payrollTaxReturnPeriod_lastPayrollPeriodId |
int32 |
|
☐ |
The year and period identifying the last payroll period that is part of the payroll tax return period. |
payrollTaxReturnPeriod_payrollTaxReturnPeriodId |
int32 |
|
☐ |
The year and period of the payroll tax return period |
payrollTaxReturnPeriod_periodEndDate |
datetime |
|
☐ |
The last day of the period to which the payroll tax return period data applies |
payrollTaxReturnPeriod_periodNumber |
int32 |
|
☐ |
The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 13]) |
payrollTaxReturnPeriod_periodStartDate |
datetime |
|
☐ |
The first day of the period to which the payroll tax return period data applies |
payrollTaxReturnPeriod_year |
int32 |
|
☐ |
The year of the payroll tax return period |
pensionDeclaration_pensionAdministratorType |
string |
|
☐ |
The type of Pension declaration |
pensionDeclaration_pensionDeclarationPossibleActions_key |
int32 |
|
☐ |
|
pensionDeclaration_pensionDeclarationPossibleActions_pensionDeclarationPossibleActionsAdditionalInfo_key |
string |
|
☐ |
|
pensionDeclaration_pensionDeclarationPossibleActions_pensionDeclarationPossibleActionsAdditionalInfo_value |
string |
|
☐ |
|
pensionDeclaration_pensionDeclarationPossibleActions_value |
string |
|
☐ |
|
pensionDeclaration_pensionDeclarationStatus_key |
int32 |
|
☐ |
|
pensionDeclaration_pensionDeclarationStatus_pensionDeclarationStatusAdditionalInfo_key |
string |
|
☐ |
|
pensionDeclaration_pensionDeclarationStatus_pensionDeclarationStatusAdditionalInfo_value |
string |
|
☐ |
|
pensionDeclaration_pensionDeclarationStatus_value |
string |
|
☐ |
|
10-06-2024 18:51 Versie 24.1.3-BETA+4689