payReferencePeriod
| Synopsis | The pay reference period that this set of contributions is for. |
| Where used | /contributions request |
Each /contributions request must contain information for the pay reference period that follows the last one. You can confirm the next pay reference period that contributions are expected for by requesting the /accounts/{accountId} information and examining the nextPayReferencePeriod field.
The nextPayReferencePeriod is intended for initial and ongoing validation that the payroll and pension cycles are in sync: your payroll software should be able to calculate its pay reference periods independently.
The account’s prpFrequency indicates how your application should calculate the dates of the pay reference periods that you use when submitting contributions to us. The possible combinations of prpFrequency and payrollFrequency are:
prpFrequency |
payrollFrequency |
Example pay reference periods |
|---|---|---|
Weekly |
Weekly |
1st to 7th, 8th to 14th, 15th to 21st |
Fortnightly |
Fortnightly |
1st to 14th, 15th to 28th, 29th to 11th |
Four Weekly |
Four Weekly |
1st to 28th, 29th to 25th, 26th to 25th |
Monthly |
Monthly |
1st to 31st, 1st to 28th, 1st to 31st |
Weekly |
Monthly |
1st to 7th, 8th to 14th, 15th to 21st |
We have more information in our What’s a pay reference period (PRP)? article on The People’s Pension web site, and The Pensions Regulator provides further guidance for calculating the relevant pay reference period.
Accounts with prpFrequency of Weekly and payrollFrequency of Monthly have been converted from one of our legacy products. Contributions should be submitted on a weekly basis, but we collect the weekly contributions together. See payrollFrequency for more details.
| Data type | Date Range: an object with 'start' and 'end' properties. |
| Constraints/format | 'start' and 'end': |
| Example | ... |
| Related errors |
H/C01 – Start date has not been provided H/C02 – Start date is formatted incorrectly H/C03 – Start date is not for the expected period H/D01 – End date has not been provided H/D02 – End date is formatted incorrectly H/D03 – End date is not for the expected period H/P02 – Duration does not match a valid prpFrequency H/P03 – Start date precedes start of automatic enrolment H/P04 – Start date more than 3 months after staging date |
| See also |