cadrumo.domain.calculations.registry.prorrata_register_catalogue module

Typed projections of the registry-owned prorrata-register vocabularies.

class ProrrataRegisterRegimeDefinition(token, description, legal_ref, apportions)[source]

Bases: object

One registry-declared register regime and its applicability metadata.

Parameters:
token: ProrrataRegisterRegime
description: str
legal_ref: str
apportions: bool
class ProrrataTransitionDefinition(token, description, legal_ref)[source]

Bases: object

One registry-declared special-prorrata transition kind.

Parameters:
token: ProrrataEspecialTransitionKind
description: str
legal_ref: str
class ProrrataProvenanceDefinition(token, description, legal_ref, authorisation_required, election_allowed)[source]

Bases: object

One registry-declared art. 105 provisional provenance.

Parameters:
token: ProrrataProvisionalProvenance
description: str
legal_ref: str
authorisation_required: bool
election_allowed: bool
class SectorDiferenciadoLetraDefinition(token, description, legal_ref)[source]

Bases: object

One registry-declared LIVA art. 9.1.c sector letter.

Parameters:
token: SectorDiferenciadoLetra
description: str
legal_ref: str
class ProrrataRegisterCatalogue(regimes, transition_kinds, provenances, sector_letters)[source]

Bases: object

Complete typed projection of the dated 0116 register vocabulary.

Parameters:
regimes: tuple[ProrrataRegisterRegimeDefinition, ...]
transition_kinds: tuple[ProrrataTransitionDefinition, ...]
provenances: tuple[ProrrataProvenanceDefinition, ...]
sector_letters: tuple[SectorDiferenciadoLetraDefinition, ...]
property all_regimes: frozenset[ProrrataRegisterRegime]

Return every register regime declared by the registry.

property apportioning_regimes: tuple[ProrrataRegisterRegime, ...]

Return registry regimes that apportion deductible amounts.

property non_apportioning_regimes: tuple[ProrrataRegisterRegime, ...]

Return registry regimes that do not apportion deductible amounts.

property all_transition_kinds: frozenset[ProrrataEspecialTransitionKind]

Return every special-prorrata transition declared by the registry.

property all_provenances: frozenset[ProrrataProvisionalProvenance]

Return every provisional provenance declared by the registry.

property all_sector_letters: frozenset[SectorDiferenciadoLetra]

Return every differentiated-sector letter declared by the registry.

property referenced_provenances: frozenset[ProrrataProvisionalProvenance]

Return provenances that require an authorisation reference.

property electable_provenances: tuple[ProrrataProvisionalProvenance, ...]

Return provenances that the operator may elect.

require_regime(value)[source]

Validate and return one registry-declared register regime.

Return type:

ProrrataRegisterRegime

Parameters:

value (object)

require_transition(value)[source]

Validate and return one registry-declared transition kind.

Return type:

ProrrataEspecialTransitionKind

Parameters:

value (object)

require_provenance(value)[source]

Validate and return one registry-declared provisional provenance.

Return type:

ProrrataProvisionalProvenance

Parameters:

value (object)

require_sector_letter(value)[source]

Validate and return one registry-declared differentiated-sector letter.

Return type:

SectorDiferenciadoLetra

Parameters:

value (object)

property general_regime: ProrrataRegisterRegime

Return the first, general regime in registry order.

property especial_regime: ProrrataRegisterRegime

Return the second, special regime in registry order.

property no_prorrata_regime: ProrrataRegisterRegime

Return the sole non-apportioning regime declared by the registry.

property opcion_transition: ProrrataEspecialTransitionKind

Return the first special-prorrata transition in registry order.

property revocacion_transition: ProrrataEspecialTransitionKind

Return the second special-prorrata transition in registry order.

property aeat_autorizada_provenance: ProrrataProvisionalProvenance

Return the AEAT-authorised provenance in registry order.

property inicio_actividad_provenance: ProrrataProvisionalProvenance

Return the activity-start provenance in registry order.

property carried_prior_definitiva_provenance: ProrrataProvisionalProvenance

Return the carried prior definitive provenance in registry order.

property provenance_precedence: tuple[ProrrataProvisionalProvenance, ...]

Return provisional provenances in their registry precedence order.

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

Resolve all register vocabularies through the dated 0116 mapping fact.

Return type:

ProrrataRegisterCatalogue

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

Return the registry-declared general-prorrata regime token.

Return type:

ProrrataRegisterRegime

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

Return the registry-declared special-prorrata regime token.

Return type:

ProrrataRegisterRegime

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

Return the registry-declared no-prorrata regime token.

Return type:

ProrrataRegisterRegime

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

Return the registry-declared special-prorrata option transition token.

Return type:

ProrrataEspecialTransitionKind

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

Return the registry-declared special-prorrata revocation token.

Return type:

ProrrataEspecialTransitionKind

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

Return the registry-declared AEAT-authorised provenance token.

Return type:

ProrrataProvisionalProvenance

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

Return the registry-declared start-of-activity provenance token.

Return type:

ProrrataProvisionalProvenance

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

Return the registry-declared carried-prior-definitive provenance token.

Return type:

ProrrataProvisionalProvenance

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

Return the registry-authored provisional-provenance precedence ladder.

Return type:

tuple[ProrrataProvisionalProvenance, ...]

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

Return registry provenances that require an operator-held reference.

Return type:

frozenset[ProrrataProvisionalProvenance]

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

Return the registry-authored provenances that may be elected.

Return type:

tuple[ProrrataProvisionalProvenance, ...]

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

Return differentiated-sector letters in registry-authored order.

Return type:

tuple[SectorDiferenciadoLetra, ...]

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

Return whether a registry-declared regime applies a percentage.

Return type:

bool

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

Validate one value against the dated prorrata register vocabulary.

Return type:

ProrrataRegisterRegime

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

Validate one value against the dated prorrata transition vocabulary.

Return type:

ProrrataEspecialTransitionKind

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

Validate one value against the dated prorrata provenance vocabulary.

Return type:

ProrrataProvisionalProvenance

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

Validate one value against the dated differentiated-sector vocabulary.

Return type:

SectorDiferenciadoLetra

Parameters: