aeat.domain.calculations.registry._schema_references module

Registry reference, source, and temporal coordinate schema models.

class RegistrySnapshotRef(**data)[source]

Bases: RegistryModel

Typed coordinates that identify a registry snapshot.

Parameters:

  • modelo (ModeloId)

  • revision_id (RevisionId)

  • modelo_year (int)

  • period (str)

modelo: ModeloId
revision_id: RevisionId
modelo_year: int
period: str
class PeriodSelector(**data)[source]

Bases: RegistryModel

Parameters:
years: tuple[int, ...]
year_from: int | None
year_to: int | None
periods: tuple[str, ...]
includes_year(year)[source]

Return whether the selector covers a filing year.

Return type:

bool

Parameters:

year (int)

class TemporalApplicability(**data)[source]

Bases: RegistryModel

Parameters:

  • date_axis (Literal['filing_period', 'devengo_date', 'transaction_date', 'invoice_date', 'submission_date'])

  • valid_from (date)

  • valid_to (date | None)

  • period_selector (PeriodSelector | None)

date_axis: DateAxis
valid_from: date
valid_to: date | None
period_selector: PeriodSelector | None
class LegalReference(**data)[source]

Bases: RegistryModel

Legal-authority citation row carried by registry definitions.

Parameters:

  • id (LegalRefId)

  • evidence_tier (Literal['legal_authority'])

  • authority (Literal['boe', 'aeat', 'eu', 'autonomous_community', 'other'])

  • kind (Literal['ley', 'real_decreto', 'real_decreto_legislativo', 'real_decreto_ley', 'orden', 'reglamento', 'acuerdo_internacional', 'directiva', 'manual', 'instruction'])

  • corpus_ref (str)

  • document_id (str)

  • article (str | None)

  • section (str | None)

  • permalink (str)

  • published_at (date | None)

  • effective_from (date)

  • effective_to (date | None)

  • consolidated_as_of (date | None)

  • review_status (Literal['reviewed'])

  • reviewed_at (date)

  • reviewed_by (str)

  • notes (str | None)

  • required_text (tuple[str, ...])

id: LegalRefId
evidence_tier: Literal['legal_authority']
authority: Literal['boe', 'aeat', 'eu', 'autonomous_community', 'other']
kind: Literal['ley', 'real_decreto', 'real_decreto_legislativo', 'real_decreto_ley', 'orden', 'reglamento', 'acuerdo_internacional', 'directiva', 'manual', 'instruction']
corpus_ref: str
document_id: str
article: str | None
section: str | None
published_at: date | None
effective_from: date
effective_to: date | None
consolidated_as_of: date | None
review_status: ReviewStatus
reviewed_at: date
reviewed_by: str
notes: str | None
required_text: tuple[str, ...]
class SourceReference(**data)[source]

Bases: RegistryModel

Official-source evidence row with bundled-corpus integrity metadata.

Parameters:

  • id (SourceRefId)

  • evidence_tier (Literal['legal_authority', 'official_source_guidance', 'executable_parity_evidence', 'layout_authority'])

  • authority (Literal['aeat', 'boe', 'eu', 'autonomous_community', 'other'])

  • kind (Literal['record_design', 'manual_pdf', 'instructions', 'xsd', 'dictionary', 'form_spec', 'suppression_notice'])

  • corpus_path (str)

  • sha256 (str)

  • bytes (int)

  • retrieved_at (date)

  • published_at (date | None)

  • applies_from (date | None)

  • applies_to (date | None)

  • source_url (str)

  • review_status (Literal['reviewed'])

id: SourceRefId
evidence_tier: EvidenceTier
authority: Literal['aeat', 'boe', 'eu', 'autonomous_community', 'other']
kind: Literal['record_design', 'manual_pdf', 'instructions', 'xsd', 'dictionary', 'form_spec', 'suppression_notice']
corpus_path: str
sha256: str
bytes: int
retrieved_at: date
published_at: date | None
applies_from: date | None
applies_to: date | None
source_url: str
review_status: ReviewStatus
class LegalParameter(**data)[source]

Bases: RegistryModel

Versioned legal parameter value cited by registry formulas.

Parameters:

  • id (str)

  • evidence_tier (Literal['legal_authority'])

  • value (str)

  • unit (str)

  • applies_to (str)

  • legal_refs (Annotated[tuple[LegalRefId, ...], FieldInfo(annotation=NoneType, required=True, metadata=[MinLen(min_length=1)])])

  • review_status (Literal['reviewed'])

  • reviewed_at (date | None)

  • reviewed_by (str | None)

  • notes (str | None)

id: str
evidence_tier: Literal['legal_authority']
value: str
unit: str
applies_to: str
legal_refs: LegalRefs
review_status: ReviewStatus
reviewed_at: date | None
reviewed_by: str | None
notes: str | None