models.entity

Represents the person, real or artifial engaging in financial Transactions.

Module Contents

Classes

Entity

Represents the Reporting Entity.

class models.entity.Entity

Bases: python_accounting.models.Recyclable

Represents the Reporting Entity.

__mapper_args__

id: sqlalchemy.orm.Mapped[int]

The primary key of the Entity database record.

Type:

(int)

name: sqlalchemy.orm.Mapped[str]

The Name of the Entity.

Type:

(str)

multi_currency: sqlalchemy.orm.Mapped[bool]

Determines if the Entity can have Transactions in currencies other than its base Currency. Defaults to False.

Type:

(bool, optional)

mid_year_balances: sqlalchemy.orm.Mapped[bool]

Determines if the Entity can have Opening Balances withing the current Reporting Period. Defaults to False.

Type:

(bool, optional)

year_start: sqlalchemy.orm.Mapped[int]

The month at which the Entity’s Reporting Periods begin, expressed as a number between 1 and 12. Defaults to 1 (January).

Type:

(int, optional)

locale: sqlalchemy.orm.Mapped[str]

The language format to be used to represent amounts. Defaults to en_GB.

Type:

(str)

currency_id: sqlalchemy.orm.Mapped[int]

The id of the Reporting Currency of the Entity.

Type:

(int, optional)

reporting_period_id: sqlalchemy.orm.Mapped[int]

The id of the current Reporting Period of the Entity.

Type:

(int, optional)

currency: sqlalchemy.orm.Mapped[Currency]

The Reporting Currency of the Entity.

Type:

(Currency)

reporting_period: sqlalchemy.orm.Mapped[python_accounting.models.ReportingPeriod]

The current Reporting Period of the Entity.

Type:

(ReportingPeriod)

users: sqlalchemy.orm.Mapped[List[User]]

A list of Users that belong to the Entity.

Type:

(list of User)

__repr__() → str