common

Documentation

Overview

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

Index

• Constants
• Variables
• func ComputeLuhnCheckDigit(number string) string
• func InvoiceScenarios() *tax.ScenarioSet
• func InvoiceTags() []*cbc.KeyDefinition
• func InvoiceTagsWith(tags []*cbc.KeyDefinition) []*cbc.KeyDefinition
• func NormalizeTaxIdentity(tID *tax.Identity, altCodes ...l10n.Code) error

Constants

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

Variables

var (
	// TaxCodeBadCharsRegexp is used to remove any characters that are not valid in a tax code.
	TaxCodeBadCharsRegexp = regexp.MustCompile(`[^A-Z0-9]+`)
)

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 InvoiceScenarios

func InvoiceScenarios() *tax.ScenarioSet

InvoiceScenarios provides a standard set of scenarios to either be extended or overridden by the regime.

func InvoiceTags

func InvoiceTags() []*cbc.KeyDefinition

InvoiceTags returns a list of common invoice tag key definitions.

func InvoiceTagsWith

func InvoiceTagsWith(tags []*cbc.KeyDefinition) []*cbc.KeyDefinition

InvoiceTagsWith appends the list of provided key definitions to the base list of tags and returns a new array.

func NormalizeTaxIdentity

func NormalizeTaxIdentity(tID *tax.Identity, altCodes ...l10n.Code) error

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