sales-tax

node-sales-tax

International sales tax calculator for Node (offline, except for VAT number validation). Tax rates are kept up-to-date.

You may use it to calculate VAT rates for countries in the European Union (VAT MOSS), GST in Canada, or get VAT for countries such as China, or even Hong Kong (which has no VAT).

Who uses it?

Crisp

👋 You use sales-tax and you want to be listed there? Contact me!

How to install?

Include sales-tax in your package.json dependencies.

Alternatively, you can run npm install sales-tax --save.

How to use?

This module may be used to acquire the billable VAT percentage for a given customer. You may also use it directly to process the total amount including VAT you should bill; and even to validate a customer's VAT number.

:red_circle: Important: in order to fetch the sales tax for a customer, you need to know their country (and sometimes state). The country (sometimes state) must be passed to all module methods, formatted as ISO ALPHA-2 (eg. France is FR, United States is US).

:arrow_right: Import the module

Import the module in your code:

var SalesTax = require("sales-tax");

:white_check_mark: Check if a country has sales tax

Prototype: SalesTax.hasSalesTax(countryCode<string>)<boolean>

Check some countries for sales tax (returns true or false):

var franceHasSalesTax = SalesTax.hasSalesTax("FR")  // franceHasSalesTax === true
var brazilHasSalesTax = SalesTax.hasSalesTax("BR")  // brazilHasSalesTax === true
var hongKongHasSalesTax = SalesTax.hasSalesTax("HK")  // hongKongHasSalesTax === false

:white_check_mark: Check if a state has sales tax (in a country)

Prototype: SalesTax.hasStateSalesTax(countryCode<string>, stateCode<string>)<boolean>

Check some states for sales tax (returns true or false):

var canadaQuebecHasSalesTax = SalesTax.hasSalesTax("CA", "QC")  // canadaQuebecHasSalesTax === true
var unitedStatesCaliforniaHasSalesTax = SalesTax.hasSalesTax("US", "CA")  // unitedStatesCaliforniaHasSalesTax === true
var canadaYukonHasSalesTax = SalesTax.hasSalesTax("CA", "YT")  // canadaYukonHasSalesTax === false
var unitedStatesDelawareHasSalesTax = SalesTax.hasSalesTax("US", "DE")  // unitedStatesDelawareHasSalesTax === false

:white_check_mark: Get the sales tax for a customer

Prototype: SalesTax.getSalesTax(countryCode<string>, stateCode<string?>, taxNumber<string?>)<Promise<object>>

:fr: Given a French customer VAT number (eg. here SAS CLEVER CLOUD with VAT number FR 87524172699):

SalesTax.getSalesTax("FR", null, "87524172699")
  .then((tax) => {
    // This customer is VAT-exempt (as it is a business)
    /* tax ===
      {
        type   : "vat",
        rate   : 0.00,
        exempt : true
      }
     */
  });

Note: Clever-Cloud is a real living business from France, check their website there.

:latvia: Given a Latvian customer without any VAT number (eg. a physical person):

SalesTax.getSalesTax("LV")
  .then((tax) => {
    // This customer has to pay 21% VAT (as it is a physical person)
    /* tax ===
      {
        type   : "vat",
        rate   : 0.21,
        exempt : false
      }
     */
  });

:hong_kong: Given an Hong Kong-based customer (eg. a physical person):

SalesTax.getSalesTax("HK")
  .then((tax) => {
    // Hong Kong has no VAT
    /* tax ===
      {
        type   : "none",
        rate   : 0.00,
        exempt : true
      }
     */
  });

:es: Given a Spanish customer who provided an invalid VAT number (eg. a rogue individual):

SalesTax.getSalesTax("ES", null, "12345523")
  .then((tax) => {
    // This customer has to pay 21% VAT (VAT number could not be authenticated against the European Commission API)
    /* tax ===
      {
        type   : "vat",
        rate   : 0.21,
        exempt : false
      }
     */
  });

:white_check_mark: Process the price including sales tax for a customer

Prototype: SalesTax.getAmountWithSalesTax(countryCode<string>, stateCode<string?>, amount<number?>, taxNumber<string?>)<Promise<object>>

:estonia: Given an Estonian customer without any VAT number, buying for 100.00€ of goods (eg. a physical person):

SalesTax.getAmountWithSalesTax("EE", null, 100.00)
  .then((amountWithTax) => {
    // This customer has to pay 20% VAT
    /* amountWithTax ===
      {
        type   : "vat",
        rate   : 0.20,
        exempt : false,
        price  : 100.00,
        total  : 120.00
      }
     */
  });

:white_check_mark: Validate tax number for a customer

Prototype: SalesTax.validateTaxNumber(countryCode<string>, taxNumber<string?>)<Promise<boolean>>

:fr: Given a French customer VAT number (eg. here SAS CLEVER CLOUD with VAT number FR 87524172699):

SalesTax.validateTaxNumber("FR", "87524172699")
  .then((isValid) => {
    // isValid === true
  });

:latvia: Given a Latvian customer without any VAT number (eg. a physical person):

SalesTax.validateTaxNumber("LV")
  .then((isValid) => {
    // isValid === false
  });

:es: Given a Spanish customer who provided an invalid VAT number (eg. a rogue individual):

SalesTax.validateTaxNumber("ES", "12345523")
  .then((isValid) => {
    // isValid === false
  });

:white_check_mark: Check if a customer is tax-exempt

Prototype: SalesTax.isTaxExempt(countryCode<string>, taxNumber<string?>)<Promise<boolean>>

:fr: Given a French customer VAT number (eg. here SAS CLEVER CLOUD with VAT number FR 87524172699):

SalesTax.isTaxExempt("FR", "87524172699")
  .then((isTaxExempt) => {
    // isTaxExempt === true
  });

:morocco: Given a Morocco-based customer:

SalesTax.isTaxExempt("MA")
  .then((isTaxExempt) => {
    // isTaxExempt === false
  });

:hong_kong: Given an Hong Kong-based customer:

SalesTax.isTaxExempt("HK")
  .then((isTaxExempt) => {
    // isTaxExempt === true
  });

:white_check_mark: Disable / enable tax number validation

Prototype: SalesTax.toggleEnabledTaxNumberValidation(enabled<boolean>)<undefined>

Disable tax number validation (disable hitting against external APIs and consider all tax numbers as valid):

SalesTax.toggleEnabledTaxNumberValidation(false)

Enable tax number validation (enabled by default — use only if you disabled it previously):

SalesTax.toggleEnabledTaxNumberValidation(true)

Where is the offline tax data is pulled from?

The offline tax data is pulled from VAT, GST and sales tax rates — ey.com.

It is kept up-to-date with the year-by-year tax changes worldwide.

Some countries have multiple sales tax, eg. Brazil. In those cases, the returned sales tax is the one on services. Indeed, I consider most users of this module use it for their SaaS business — in other words, service businesses.

How are tax numbers validated?

For now, this module only supports tax number (VAT number) validation for European countries.

:eu: European countries

European VAT numbers are validated against the official ec.europa.eu API, which return whether a given VAT number exists or not. This helps you ensure a customer-provided VAT number is valid (ie. you don't have to bill VAT for this customer).

You can manually check a VAT number on VIES VAT number validation.