tax-kalculator

Calculate take-home pay

First create an instance of Calculator, passing in the values as per the following example:

val calculator = Calculator(
    taxCode = "1250L",     // Required
    wages = 20000.0,       // Required
    payPeriod = YEARLY,    // Required
    isPensionAge = false,  // Optional (Default: false)
    howManyAWeek = null,   // Optional (Default: null)
    taxYear = 2020         // Optional (Default: Current Tax Year)
)

The default values are working in Android (and other JVM) but currently do not seem to be present in iOS, so pass in the default values for now.

Run calculations by calling run():

val response = calculator.run()

This will returns an object of type CalculatorResponse. This class is broken up into weekly, four_weekly, monthly and yearly. Each of these members is of type CalculatorResponsePayPeriod and the members of this class are what will return the values (relative to their PayPeriod) needed for the app, they are:

• taxToPay: Double -> This will capped at a maximum of 50% of their wages
• maxTaxAmountExceeded: Boolean -> This will always be false unless taxToPay is adjusted for 50%
• employeesNI: Double
• employersNI: Double
• wages: Double
• taxBreakdown: List<BandBreakdown>
• taxFree: Double
• totalDeductions: Double
• takeHome: Double

For tax breakdown this is the amount of tax per tax band which has two members, percentage: Double and amount: Double.

Validation

To validate a tax code:

val isValid = TaxCodeValidator.isValidTaxCode("1250L") // TaxCodeValidationResponse(true)
val isValid = TaxCodeValidator.isValidTaxCode("OO9999") // TaxCodeValidationResponse(false, ValidationError.WrongTaxCodePrefix)
val isValid = TaxCodeValidator.isValidTaxCode("9999R") // TaxCodeValidationResponse(false, ValidationError.WrongTaxCodeSuffix)
val isValid = TaxCodeValidator.isValidTaxCode("HELLO") // TaxCodeValidationResponse(false, ValidationError.WrongTaxCodeNumber)
val isValid = TaxCodeValidator.isValidTaxCode("110") // TaxCodeValidationResponse(false, ValidationError.Other)

To validate wages:

val isValidWages = WageValidator.isValidWages(1000) // true
val isAboveMinimumWages = WageValidator.isAboveMinimumWages(0.0) // false
val isBelowMaximumWages = WageValidator.isBelowMaximumWages(120000.0) // true

To validate hours worked per week:

val isValidHoursPerWeek = HoursDaysValidator.isValidHoursPerWeek(20) // true
val isAboveMinimumHoursPerWeek = HoursDaysValidator.isAboveMinimumHoursPerWeek(1.0) // true
val isBelowMaximumHoursPerWeek = HoursDaysValidator.isBelowMaximumHoursPerWeek(170.0) // false
val isValidHoursPerDay = HoursDaysValidator.isValidHoursPerDay(20) // true
val isAboveMinimumHoursPerDay = HoursDaysValidator.isAboveMinimumHoursPerDay(1.0) // true
val isBelowMaximumHoursPerDay = HoursDaysValidator.isBelowMaximumHoursPerDay(25.0) // false

Development

To run unit tests and checks:

./gradlew check

To update the README badges:

./gradlew cleanBuildTestCoverage

Download

iOS

Swift Package Manager

• From version 0.12.0 onwards, the use of Swift Package Manager is required.
• Note: Because this operates as a closed source, binary dependency, Swift PM will only work with tagged releases and not branches.

https://github.com/hmrc/tax-kalculator

Carthage

• For all versions below 0.12.0, the use of Carthage is required.
• Each release tag includes a Carthage binary dependency specification. To use the Carthage binary:

• In the same directory as your Cartfile, add a directory.

 $ mkdir Carthage-Binaries

• Add a JSON file that holds your Carthage binary specifications.

 $ touch Carthage-Binaries/TaxKalculator.json

• Point to the latest release in your JSON file.

    {
      "0.3.7": "https://github.com/hmrc/tax-kalculator/releases/download/0.3.7/TaxKalculator.framework.zip"
    }

• List the dependency in your Cartfile

    ...
    binary "Carthage-Binaries/TaxKalculator.json" == 0.3.7
    ...

• Update your Carthage dependencies as per your requirements.

Simulator Architectures:

• Most Carthage users will include a Carthage copy-frameworks build step that removes unwanted architectures for distribution builds.
• If you don't use Carthage and just download and link the framework in your project, it'll be necessary to strip unwanted architectures in a build step. You may want to implement something like this.

Android or JVM

Add the Github Package repository to your top-level build.gradle, along with a Github username and access token (no permissions required).

repositories {
    maven {
        url = "https://maven.pkg.github.com/hmrc/tax-kalculator"
        credentials {
            username = System.getenv("GITHUB_USER_NAME")
            password = System.getenv("GITHUB_TOKEN")
        }
    }
}

Add the dependency in the build.gradle of the module:

dependencies {
    implementation "uk.gov.hmrc:tax-kalculator-jvm:x.y.z"
}

Release process

The CI tool has been set up to trigger a build and publish to GitHub packages when a tag is created on a build.

Recommended flow:

• Raise PR
• Approved PR
• Merge
• Wait for Bitrise to build and test
• Tag for release
• Apps update to new version

License

This code is open source software licensed under the Apache 2.0 License.