cadrumo.domain.calculations.registry.renta_codes_catalogue module

Typed projections for the cross-cutting Renta residency catalogues.

class FiscalResidencyDefinition(token, description, tax_regime, requires_country, is_default)[source]

Bases: object

One registry-declared fiscal-residency token and its semantics.

Parameters:
token: FiscalResidency
description: str
tax_regime: str
requires_country: bool
is_default: bool
class FiscalResidencyCatalogue(definitions, default_token)[source]

Bases: object

Typed projection of the dated fiscal-residency vocabulary.

Parameters:
definitions: tuple[FiscalResidencyDefinition, ...]
default_token: FiscalResidency
property all_residencies: frozenset[FiscalResidency]

Return every residency token declared by this catalogue.

property choices: tuple[FiscalResidency, ...]

Return declared residency tokens in authored choice order.

require(value)[source]

Project one token only when the selected fact declares it.

Return type:

FiscalResidency

Parameters:

value (object)

definition(value)[source]

Return the declaration for a required residency token.

Return type:

FiscalResidencyDefinition

Parameters:

value (object)

resolve_fiscal_residency_catalogue(*, effective_date=None, authority=None)[source]

Resolve the dated fiscal-residency vocabulary through fact 0122.

Return type:

FiscalResidencyCatalogue

Parameters:
require_fiscal_residency(value, *, effective_date=None, authority=None)[source]

Project one registry-governed fiscal-residency token.

Return type:

FiscalResidency

Parameters:
fiscal_residency_choices(*, effective_date=None, authority=None)[source]

Return fiscal-residency choices in authored order.

Return type:

tuple[FiscalResidency, ...]

Parameters:
default_fiscal_residency(*, effective_date=None, authority=None)[source]

Return the registry-declared default residency token.

Return type:

FiscalResidency

Parameters:
fiscal_residency_requires_country(value, *, effective_date=None, authority=None)[source]

Return the registry-declared country requirement for one token.

Return type:

bool

Parameters:
ue_eea_country_codes(*, effective_date=None, authority=None)[source]

Return the selected EU/EEA country-code entity set from fact 0123.

Return type:

frozenset[str]

Parameters:
is_ue_eea_country_code(country_code, *, effective_date=None, authority=None)[source]

Return whether a country token is in the selected EU/EEA entity set.

Return type:

bool

Parameters: