Have ideas to improve npm?Join in the discussion! »

    validate-vat-ts
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published

    Validate European VAT number

    Build Status

    Downloads

    The original validate-vat lib was written in CoffeeScript and did not update for many years. This rewrites it in TypeScript. This lib is basically calling web service provided by VIES (at http://ec.europa.eu/taxation_customs/vies/checkVatService.wsdl) for VAT number validation. It can only be used in node env, if you want to call the VIES service from browser, you probably need proxy it through your server.

    What is a VAT number?

    A value added tax identification number or VAT identification number (VATIN) is an identifier used in many countries, including the countries of the European Union, for value added tax purposes.

    Get started

    npm install validate-vat-ts

    In your code

    import validateVat, {ViesValidationResponse} from 'validate-vat-ts';
     
    const consumer = async () => {
      try {
        const validationInfo: ViesValidationResponse = await validateVat(CountryCodes.Germany, "12323");
      } catch (e) {
        console.log(e);
      }
    }

    For more usages, please refer to the test file.

    Returns

    when valid

    {
      countryCode: 'xx',
      vatNumber: 'xxxxxxxxx',
      requestDate: '2013-11-22+01:00',
      valid: true,
      name: 'company name',
      address: 'company address'
    }

    when invalid

    {
      countryCode: 'xx',
      vatNumber: 'xxxxxxxxxx',
      requestDate: '2013-11-22+01:00',
      valid: false,
      name: '---',
      address: '---'
    }

    Exceptions

    The function will throw three types errors.

    • ViesServerError

      This is when the VIES server returns some error code. The error message is whatever the faultstring returned from VIES server. You could probably find out all the possible error messages from thetest file

    • ViesClientError

      This is when the client side failed to talk to the VIES server.

    • Error

      Happens in other unexpected situations

    License

    The MIT License (MIT)

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i validate-vat-ts

    DownloadsWeekly Downloads

    882

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    19.2 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar