Skip to content
View payetools's full-sized avatar

Achievements

Achievement: Quickdraw

Achievements

Achievement: Quickdraw

Block or report payetools

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Please don't include any personal information such as legal names or email addresses. Maximum 100 characters, markdown supported. This note will be visible to only you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
payetools/README.md

Payetools

Cross-platform Open-Source Library for UK payroll

Payetools is the first library of its kind to bring open-source capabilities to UK payroll processing via a robust, cross-platform framework written in C#.

Payetools contains support for calculating the following:

  • UK Income Tax (all jurisdictions)
  • National Insurance
  • Student Loans
  • Pensions using Qualifying Earnings and Pensionable Pay earnings bases (under both Relief at Source and Net Pay Arrangement tax treatments)
  • Compliance with National Minimum/Living Wage regulations

See the Program.cs of the example project for step-by-step instructions on getting your first pay run output.

The code passes HMRC tests for income tax, National Insurance, student loans and National Minimum Wage.

Separately, Payetools has developed libraries for HMRC RTI and DPS services that sit on top of the core Payetools open-source libraries published here. The Payetools.Hmrc libraries enable the publishing of FPS and EPS submissions to HMRC and the retrieval of notifications (e.g., tax code changes, student loan starts/stops, etc.) from HMRC's Data Provisioning Service (DPS). Payetools.Hmrc is available as a commercial offering - please contact info [at] payetools.com for further information.

Commercial support for the Payetools open-source libraries is also available - please contact info [at] payetools.com for further information.

Releases

Releases are made via nuget - search for payetools to see all libraries for this repo or follow this link. Packages are built with compatibility with .NET 8.0 and 9.0.

Release notes can be found in releases.md.

Reference Data

Payetools relies on static reference data to drive tax, NI, etc., calculations (the machine-readable equivalent of HMRC's Rates and thresholds for employers page. A version of this data set for testing can be found at https://uk-rates-and-thresholds-data.netlify.app/index.json. (2022-2023, 2023-2024 and 2024-2025 reference data sets are currently published.)

Documentation

API documentation is available at https://payetools.dev/api/Payetools.html. (This is a work in progress.)

Contributing

Please contact payetools via dev [at] payetools.com if you are interested in contributing to the project.

License

This project is licensed under the MIT License.

Pinned Loading

  1. Payetools Payetools Public

    Cross-platform UK payroll library written in C#

    C# 11