region

Documentation

Index

• func All() map[Code]Region
• func Register(region Region)
• type Code
  • func Codes() []Code
• type Region
  • func For(code Code) Region

Functions

func All

func All() map[Code]Region

All provides a map of all the codes to regions.

func Register

func Register(region Region)

Register adds a new region to the shared global list of regions.

Types

type Code

type Code string

Code defines the code used to identify a region.

const (
	ES Code = "ES" // Spain
	NL Code = "NL" // Netherlands
	GB Code = "GB" // Great Britain (not Northern Ireland)
)

Defined region codes.

func Codes

func Codes() []Code

Codes provides a list of region codes contained in the collection of registered regions.

type Region

type Region interface {
	// Taxes provides a region's tax definition
	Taxes() *tax.Region

	// Currency provides the regions default currency definition.
	Currency() *currency.Def

	// Code provides this region's official code.
	Code() Code

	// Validate determines the type of GOBL document provided and attempts
	// to check the contents for errors.
	Validate(obj interface{}) error
}

Region represents the methods we expect to be available from a region.

func For

func For(code Code) Region

For returns the region definition for the document or nil if the region code is invalid or has not been registered.