Pay Templates

This chapter describes all available Pay Templates, arranged by country. Since the inputs, when exposed via a Pay Item, configures a worker’s pay and benefits, these are detailed below along with significant details about algorithm.

Pay Templates and their Countries

Name

Description

Country

AE

Auto Enrolment (AE)

GB

AEO

Court AEO, court payee (England and Wales)

GB

AWE Sink

Track AWE for the next pay run

GB

AWE Source

AWE from previous pay runs

GB

Arrestment

Arrestment (Scotland) AEO

GB

CSA DEO

Deductions of Earnings, CSA

GB

CTAEO

Council tax attachment (CTAEO)

GB

DWP DEA

Direct Earnings Attachment, DWP

GB

GB Liability

GB Liability

GB

NIC

National Insurance (NI)

GB

PAYE

Pay As You Earn (PAYE)

GB

SL

Student/Postgrad Loan (SL/PGL)

GB

SMP

GB Statutory Maternity Pay (SMP)

GB

SPBP

GB Statutory Parental Bereavement Pay (SPBP)

GB

SPP

GB Statutory Paternity Pay (SPP)

GB

SSP

Statutory Sick Pay (SSP)

GB

Termination

GB Termination Payment

GB

% Bonus

% Bonus

Universal

Daily pay

Daily pay

Universal

Daily piece pay

Daily piece pay

Universal

Deduction

Deduction

Universal

Deduction (negative)

Deduction using negative values

Universal

Holiday

Holiday booking

Universal

Holiday %

Holiday %

Universal

Holiday scheme

Holiday scheme

Universal

Hourly pay

Hourly pay

Universal

Loan (amount)

Loan (amount)

Universal

OnDemand pay

On-demand pay requests

Universal

OnDemand scheme

On-demand schemes specification

Universal

Payment

Payment

Universal

Payment with offset

Payment with offset

Universal

Pension contribution

Pension contribution

Universal

Pension scheme

Pension scheme

Universal

Per unit

Per unit

Universal

Salary

Salary

Universal

Salary scheme

Salary schemes specification

Universal

Sickness scheme

Sickness scheme

Universal

Timesheet scheme

Timesheet scheme

Universal

Weekly pay

Weekly pay

Universal

Weekly piece pay

Weekly piece pay

Universal

Note that a full description for Pay Templates which have associated Pay Schemes involves both the Scheme and the Pay Template, this chapter simply links to the full description in these cases.

GB Pay Templates

AE and scheme

See GB AE.

AWE Source, AWE Sink

Average Weekly Earnings. Two separate PayTemplates work to calculate and maintain a worker’s average weekly earnings. Each worker’s AWE Source pay item specifies nothing and the AWE Sink specifies:

Gross pay

Gross pay.

NIC

National Insurance. Each worker’s pay item specifies:

NIC Taxable pay

Taxable pay: NIC Taxable pay.

PAYE

Pay As You Earn. Each worker’s pay item specifies:

Week1_month1

P6/P9 Week 1 month 1 indicator

Taxable pay

pay PAYE Taxable pay.

PBIK

Payroll Benefit In Kind.

Previous pay

pay: P6/P9 Total previous pay.

Previous tax

tax: P6/P9 Total previous tax.

Tax code

code: P6/P9 tax code

Effective date

date: Effective date of P6/P9

SL

Student loan and Postgraduate Loans. Each worker’s pay item specifies:

PGL

Postgraduate loan?

Earnings liable

Earnings liable

Plan type

Student loan plan type.

SL1 Start date

Student loan start date.

SL2 Stop date

Student loan stop date.

PGL1 start date

Postgraduate loan start date.

PGL2 stop date

Postgraduate loan stop date.

Note that the deductions for SL are automatically prioritised along with GB garnishes by GB Liability.

SMP, SPBP, SPP, SSP and schemes

See GB SMP, GB SPBP, GB SPP. and GB SSP scheme documentation.

GB Termination

Termination payments. Each worker’s pay item specifies:

Payment

Payment amount

Type

One of ‘standard’ or ‘sporting_testimonial’

See Income Tax and NI contributions: treatment of termination payments and New rules for taxation of termination payments.

The following will be automatically calculated:

  • Non-taxable pay

  • Taxable pay

  • Employers Class 1A NI contributions

GB Attachment of Earnings (Garnishes)

The supported attachments are listed below, along with the supporting GB Liability, which provides arbitration functionality to ensure they are paid in the correct order.

The attachment notice will specify whether the amount involved is weekly or monthly. Enter the value as provided, paiyroll® will pro-rate as needed. Note:

  • A weekly notice value is required for weekly schedules (w1, w2, w4).

  • A monthly notice value is required for monthly schedules (m1, m3, m6 and m12).

Note

GB attachments require calculations which need to account for Custom pay runs or OnDemand schemes pay runs. During the Scheduled pay run at the end of a pay period, any attachments must be recalculated. At this point, any previous Custom or OnDemand requests could result in negative pay.

To avoid the need to manage such arrears, workers with attachments should have their Custom or OnDemand requests limited either at the scheme level, or at the approval stage. Otherwise, any arrears must be handled in the normal manner.

AEO

England, Wales and Northern Ireland court orders. Each worker’s pay item specifies:

Debt

Initial balance.

Earnings

Earnings subject to garnishment.

Reference

A reference for this order.

Payee

The payee for this order.

Priority

Is this a priority order?

Start

The start date for the order.

Arrestment

Scottish court orders. Each worker’s pay item specifies:

Debt

Initial balance.

Earnings

Earnings subject to garnishment.

Reference

A reference for this order.

Payee

The payee for this order.

Start

The start date for the order.

CSA DEO

Child Support orders. Each worker’s pay item specifies:

Repayment

Amount of each payment.

Earnings

Earnings subject to garnishment.

Reference

A reference for this order.

Payee

The payee for this order.

Date

The start date for the order.

CTAEO

Council tax orders. Each worker’s pay item specifies:

Debt

Initial balance.

Earnings

Earnings subject to garnishment.

Reference

A reference for this order.

Payee

The payee for this order.

Start

The start date for the order.

DWP DEA

Deprtment of Work and Pensions orders. Each worker’s pay item specifies:

Higher rate

Higher rate repayment.

Fixed rate

Fixed rate repayment.

Debt

Initial balance.

Unpaid

Initial unpaid deductions.

Earnings

Earnings subject to garnishment.

Reference

A reference for this order.

Start

The start date for the order.

GB Liability

The attachments listed above must be applied in a specific order; this is managed by GB Liability. Note that the deductions for SL are also included in the prioritisation. Each worker’s pay item specifies:

Earnings

Earnings subject to garnishment.

Deductions

Total of garnish deductions.

Universal Pay Templates

Universal Pay Templates can be adapted for use in any country. Typically, the adapating Pay Definition will need to arrange the outputs to connect to the busses relevant to the usage, including any statutory requirements that may imply.

For example, the output of the Universal Salary will typically need to be subject to income tax while also contributing to net pay.

% Bonus

A percentage-based bonus. Each worker’s pay item specifies:

Eligible pay

Basis.

%

Percentage multiplier.

Deduction

A deduction. Each worker’s pay item specifies:

Value

Amount to be removed.

Deduction (negative)

A deduction, specified as a negative. Each worker’s pay item specifies:

Negative value

Amount to be added.

Holiday and scheme

See Universal Holiday.

Holiday %

Some less regular working arrangements provide compensatation in lieu of holiday using a percentage payment. Each worker’s pay item specifies:

Basis pay

Basis.

Multiplier

Multiplier.

Display as

A descriptive string used for reporting purposes.

Loan (amount)

A loan. Each worker’s pay item specifies:

OnDemand pay and scheme

See Universal OnDemand pay.

Payment

A lump sum payment. Each worker’s pay item specifies:

Base Payment

Amount to be added.

Payment with offset

A lump sum payment with an offset amount. Each worker’s pay item specifies:

Payment

Basis.

Offset

Amount taken away.

Pension contribution and scheme

See Universal Pension contribution.

Per unit

Pay per unit. Each worker’s pay item specifies:

Base

Basis.

Units

Multiplier.

Display as

A descriptive string used for reporting purposes.

Salary and scheme

See Universal Salary.

Timesheets and schemes

Timesheets provide for time-based reporting of pay, by attendance and by piece.