common

Documentation

Overview

Package common provides re-usable regime related structures and data.

Index

• Constants
• func ComputeLuhnCheckDigit(number string) string
• func NormalizeTaxIdentity(tID *tax.Identity) error

Constants

const (
	TaxCategoryST  cbc.Code = "ST"  // Sales Tax
	TaxCategoryVAT cbc.Code = "VAT" // Value Added Tax
	TaxCategoryGST cbc.Code = "GST" // Goods and Services Tax
)

Standard tax categories that may be shared between countries.

const (
	TaxRateExempt       cbc.Key = "exempt"
	TaxRateZero         cbc.Key = "zero"
	TaxRateStandard     cbc.Key = "standard"
	TaxRateIntermediate cbc.Key = "intermediate"
	TaxRateReduced      cbc.Key = "reduced"
	TaxRateSuperReduced cbc.Key = "super-reduced"
	TaxRateSpecial      cbc.Key = "special"
)

Most commonly used keys. Local regions may add their own rate keys.

const (
	TagSimplified    cbc.Key = "simplified"
	TagReverseCharge cbc.Key = "reverse-charge"
	TagCustomerRates cbc.Key = "customer-rates"
	TagSelfBilled    cbc.Key = "self-billed"
	TagPartial       cbc.Key = "partial"
)

Standard tax tags

const (
	IdentityTypeDUNS cbc.Code = "DUNS" // Dun & Bradstreet - Data Universal Numbering System
)

Common Identity Type Codes that are not country specific.

const (
	InboxKeyPEPPOL cbc.Key = "peppol-id"
)

Common inbox keys

Functions

func ComputeLuhnCheckDigit

func ComputeLuhnCheckDigit(number string) string

ComputeLuhnCheckDigit expects as argument a number string excluding the check digit. The returned integer should be checked against the check digit by the caller. Luhn Algorithm definition: https://en.wikipedia.org/wiki/Luhn_algorithm

func NormalizeTaxIdentity

func NormalizeTaxIdentity(tID *tax.Identity) error

NormalizeTaxIdentity removes any whitespace or separation characters and ensures all letters are uppercase.