wtfs.models.report

Module Contents

Classes

Report	The base class for the reports.
ReportBoxes	A report containing all boxes from the municipalities of normal scan
ReportBoxesAndForms	A report containing all boxes, tax forms and single documents.
ReportFormsByMunicipality	A report containing all tax forms of a single municipality.
ReportFormsAllMunicipalities	A report containing all tax forms of all municipalities.
ReportBoxesAndFormsByDelivery	A report containing all boxes, tax forms and single documents of a

Functions

sum(→ Any)
zero(→ Any)

wtfs.models.report.sum(table: object, attribute: str) → Any

wtfs.models.report.zero(attribute: str) → Any

class wtfs.models.report.Report(session: sqlalchemy.orm.Session, start: datetime.date | None = None, end: datetime.date | None = None, type: str | None = None, municipality_id: UUID | None = None)

The base class for the reports.

Aggregates the columns_dispatch on the dispatch date and columns_return on the return date.

Allows to filter by date range and scan job type.

municipality_name() → str | None

columns_dispatch() → list[str]

columns_return() → list[str]

columns() → list[str]

query() → Query[Any]

total() → Query[tuple[int, ...]]

class wtfs.models.report.ReportBoxes(session: sqlalchemy.orm.Session, start: datetime.date | None = None, end: datetime.date | None = None)

Bases: Report

A report containing all boxes from the municipalities of normal scan jobs.

columns_dispatch() → list[str]

class wtfs.models.report.ReportBoxesAndForms(session: sqlalchemy.orm.Session, start: datetime.date | None = None, end: datetime.date | None = None, type: str | None = None, municipality_id: UUID | None = None)

Bases: Report

A report containing all boxes, tax forms and single documents.

columns_dispatch() → list[str]

class wtfs.models.report.ReportFormsByMunicipality(session: sqlalchemy.orm.Session, start: datetime.date | None = None, end: datetime.date | None = None, type: str | None = None, municipality_id: UUID | None = None)

Bases: Report

A report containing all tax forms of a single municipality.

columns_dispatch() → list[str]

class wtfs.models.report.ReportFormsAllMunicipalities(session: sqlalchemy.orm.Session, start: datetime.date | None = None, end: datetime.date | None = None, type: str | None = None, municipality_id: UUID | None = None)

Bases: ReportFormsByMunicipality

A report containing all tax forms of all municipalities.

municipality_name() → str

class wtfs.models.report.ReportBoxesAndFormsByDelivery(session: sqlalchemy.orm.Session, start: datetime.date, end: datetime.date, type: str, municipality_id: uuid.UUID)

A report containing all boxes, tax forms and single documents of a single municipality by delivery.

property municipality: onegov.wtfs.models.municipality.Municipality

columns() → list[str]

query() → Query[Any]

total() → Query[tuple[int, ...]]