aeat.domain.transactions._enums module

Closed enumerations for the transaction catalogue.

Defines the closed discriminators on aeat.domain.transactions.Transaction and related history records.

class TransactionDirection(*values)[source]

Bases: StrEnum

Supported transaction directions.

Variables:

  • INCOMING – Money credited to the autónomo’s account.

  • OUTGOING – Money debited from the autónomo’s account.

  • INTERNAL_TRANSFER – Movement between two of the autónomo’s own accounts; never tax-relevant on its own.

INCOMING
OUTGOING
INTERNAL_TRANSFER
class BusinessClassification(*values)[source]

Bases: StrEnum

Supported business-classification states.

The three classified outcomes are BUSINESS, PERSONAL, and MIXED. The remaining members each capture a distinct pipeline or review disposition so a downstream consumer can answer “did the pipeline look at this, and what did it decide?” without ambiguous catch-all values.

Variables:

  • BUSINESS – Certain business expense or income.

  • PERSONAL – Certain personal expense or income.

  • MIXED – Partially business, partially personal; requires a business_pct companion in [0, 1].

  • NOT_YET_PROCESSED – Pipeline has not yet evaluated this transaction; the default state on import.

  • PROCESSED_UNCLASSIFIED – Classifier ran but could not decide.

  • SKIPPED_BY_RULE – A rule explicitly skipped this transaction.

  • FAILED_VALIDATION – Classifier output failed validation; the pipeline preserves the prior decision.

  • REVIEWED_EXCLUDED – The operator reviewed this transaction and deliberately excluded it from filing. A final disposition distinct from NOT_YET_PROCESSED (never looked at) and from a classified outcome (business/personal/mixed): the operator asserted “I saw this, it is not filing-relevant, stop surfacing it.” Excluded from every tax aggregation and dropped from the review queue; the row stays visible in the ledger with review status excluded.

BUSINESS
PERSONAL
MIXED
NOT_YET_PROCESSED
PROCESSED_UNCLASSIFIED
SKIPPED_BY_RULE
FAILED_VALIDATION
REVIEWED_EXCLUDED
class TransactionLifecycleState(*values)[source]

Bases: StrEnum

Supported lifecycle states for one ledger transaction row.

Variables:

  • ACTIVE – The row participates in every default list, every tax aggregation, and every readiness check. The only state in which update_manual_transaction accepts a mutation.

  • ARCHIVED – Operator chose to remove the row from default attention without deleting it. Reversible.

  • STASHED – Operator parked the row pending classification or review. Reversible.

  • SPLIT – The row is the parent of an N-way split; its amount has been redistributed into N child rows that now carry the active balance. The parent is preserved for audit lineage. A SPLIT row is invisible to default lists, tax aggregations, and readiness checks; only the merge_transactions action can transition a SPLIT parent back to ARCHIVED (never to ACTIVE).

ACTIVE
ARCHIVED
STASHED
SPLIT
class SplitRole(*values)[source]

Bases: StrEnum

Role of a transaction within a split-lineage relationship.

Variables:

  • PARENT – The original row whose amount was redistributed. Carries the canonical split_group_id and the full tuple of child ids in sibling_transaction_ids.

  • CHILD – One of the N derived rows produced by a split. Sums of every CHILD amount under one split_group_id equal the PARENT amount exactly. Carries the parent id plus every other child id in sibling_transaction_ids.

  • MERGED – A new row produced by re-merging a complete cohort of CHILD rows. The PARENT transitions to ARCHIVED; the CHILD rows transition to ARCHIVED; the MERGED row carries a fresh content-addressed id and the merged-cohort ids in sibling_transaction_ids.

PARENT
CHILD
MERGED
CLASSIFIED_STATES: frozenset[BusinessClassification]

Frozen set of BusinessClassification values that count as classified outcomes for downstream rollups.

is_classified(state)[source]

Return True when the pipeline has produced a classified outcome.

Parameters:

state (BusinessClassification) – A BusinessClassification value.

Return type:

bool

Returns:

True iff state is one of BusinessClassification.BUSINESS, BusinessClassification.PERSONAL, or BusinessClassification.MIXED.