Interface CountryDocumentBundle

Bundle of all specs for a country, plus convenience defaults.

Each src/countries/<cc>/index.ts exports one of these.

interface CountryDocumentBundle {
    country: CountryCode;
    defaultPersonal?: DocumentTypeCode;
    defaultTax?: DocumentTypeCode;
    personal: readonly DocumentSpec<DocumentTypeCode>[];
    tax: readonly DocumentSpec<DocumentTypeCode>[];
}

Index

Properties

country defaultPersonal? defaultTax? personal tax

Properties

`Readonly`country

country: CountryCode

`Optional` `Readonly`defaultPersonal

defaultPersonal?: DocumentTypeCode

Default personal document type to surface in UI when none is selected. Optional — VAT-only EU bundles (LU, MT, CY, IS) have no personal spec.

`Optional` `Readonly`defaultTax

defaultTax?: DocumentTypeCode

Default tax document type. Optional for symmetry with defaultPersonal.

`Readonly`personal

personal: readonly DocumentSpec<DocumentTypeCode>[]

All personal-scope specs for this country.

`Readonly`tax

tax: readonly DocumentSpec<DocumentTypeCode>[]

All tax-scope specs.