https://github.com/teamwork/vat

VAT matching and validation in Go
https://github.com/teamwork/vat

Last synced: 3 days ago
JSON representation

VAT matching and validation in Go

• Host: GitHub
• URL: https://github.com/teamwork/vat
• Owner: Teamwork
• License: mit
• Created: 2016-08-01T18:53:43.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-15T06:28:01.000Z (7 months ago)
• Last Synced: 2024-04-18T12:58:07.529Z (7 months ago)
• Language: Go
• Size: 24.4 KB
• Stars: 3
• Watchers: 11
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Package vat

===

![Build](https://github.com/Teamwork/vat/actions/workflows/build.yml/badge.svg)

[![Go Report Card](https://goreportcard.com/badge/github.com/teamwork/vat/v3)](https://goreportcard.com/report/github.com/teamwork/vat/v3)

[![GoDoc](https://godoc.org/github.com/teamwork/vat/v3?status.svg)](https://godoc.org/github.com/teamwork/vat/v3)

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/teamwork/vat/master/LICENSE)

Package for validating VAT numbers & retrieving VAT rates (

from [ibericode/vat-rates](https://github.com/ibericode/vat-rates)) in Go.

Based on https://github.com/dannyvankooten/vat

## Installation

Use go get.

``` 

go get github.com/teamwork/vat

```

Then import the package into your own code.

```

import "github.com/teamwork/vat"

```

## Usage

### Validating VAT numbers

VAT numbers can be validated by format, existence or both.

EU VAT numbers are looked up using the [VIES VAT validation API](http://ec.europa.eu/taxation_customs/vies/).

UK VAT numbers are looked up

using [UK GOV VAT validation API](https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-registered-companies-api/1.0)

.

```go

package main

import "github.com/teamwork/vat"

func main() {

	// These validation functions return an error if the VAT number is invalid. If no error, then it is valid.

	// Validate number by format + existence

	err := vat.Validate("NL123456789B01")

	// Validate number format

	err := vat.ValidateFormat("NL123456789B01")

	// Validate number existence

	err := vat.ValidateExists("NL123456789B01")

}

```

### Retrieving VAT rates

> This package relies on a [community maintained repository of vat rates](https://github.com/ibericode/vat-rates). We

> invite you to toggle notifications for that repository and contribute changes to VAT rates in your country once they

> are announced.

To get VAT rate periods for a country, first get a CountryRates struct using the country's ISO-3166-1-alpha2 code.

You can get the rate that is currently in effect using the `GetRate` function.

```go

package main

import (

	"fmt"

	"github.com/teamwork/vat"

)

func main() {

	c, err := vat.GetCountryRates("IE")

	r, err := c.GetRate("standard")

	fmt.Printf("Standard VAT rate for IE is %.2f", r)

	// Output: Standard VAT rate for IE is 23.00

}

```

## License

MIT licensed. See the LICENSE file for details.