/uk-ireland-stampduty-calculator

Stamp duty calculator for countries/regions in the British Isles

Primary LanguageJavaScript

uk-ireland-stampduty-calculator

Calculates stamp duty based on current rules v1.2.0 upward reflects England and NI changes introduced July 2020. Handles regional/country variation for commercial and residential property, and includes options for first time buyers, homeowners and investors.

install

npm install uk-ireland-stampduty-calculator

usage

const {
  propertyTypes, countries, buyerTypes, calculate,
} = require('uk-ireland-stampduty-calculator');

const propertyValue = 2500000;
const propertyType = propertyTypes.RESIDENTIAL;
const country = countries.ENGLAND;
const buyerType = buyerTypes.MOVING_HOUSE;

const stampDuty = calculate(
  propertyValue, propertyType, country, buyerType,
);

console.log(stampDuty);

will log...

{ 
  "propertyValue": 2500000,
  "propertyType": "residential",
  "country": "england",
  "buyerType": "first",
  "summaryBands":[
     {
       "start": 0,
       "end": 125000,
       "bandLimit": 925000,
       "bandAmount": 125000,
       "adjustedRate": 0,
       "taxAdded": 0
     },
     {
       "start": 125000,
       "end": 250000,
       "bandLimit": 250000,
       "bandAmount": 125000,
       "adjustedRate": 2,
       "taxAdded": 2500
     },
     {
       "start": 250000,
       "end": 925000,
       "bandLimit": 925000,
       "bandAmount": 675000,
       "adjustedRate": 5,
       "taxAdded": 33750
     },
     {
       "start": 925000,
       "end": 1500000,
       "bandLimit": 1500000,
       "bandAmount": 575000,
       "adjustedRate": 10,
       "taxAdded": 57500
     },
     {
       "start": 1500000,
       "end": 2500000,
       "bandLimit": "+++",
       "bandAmount": 1000000,
       "adjustedRate": 12,
       "taxAdded": 120000
     }
  ],
  "tax": 213750,
  "ok": "ok",
  "comment": "properties over 500000 do not attract first time buyer relief",
  "taxName": { "long": "stamp duty land tax", "short": "SDLT" }
}

Note: numbers and messages in the above extract are subject to change but JSON structure should be correct

parameters values
propertyValue int
propertyType propertyTypes.RESIDENTIAL
propertyTypes.COMMERCIAL
country countries.ENGLAND (same for Northern Ireland)
countries.SCOTLAND
countries.WALES
countries.IRELAND
buyerType buyerTypes.FIRST_TIME
buyerTypes.MOVING_HOUSE
buyerTypes.INVESTOR

Used in:

prop-calc-react

example React implementation

example React repo

License ISC

Copyright 2019 Richard Milton

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.