Categories
upbankapi.models.Tag
#
Bases: ModelBase
Representation of a Tag.
id: str
class-attribute
#
The label of the tag, which also acts as the tags unique identifier.
transactions(account=None, *, status=None, since=None, until=None, category=None, limit=None, page_size=DEFAULT_PAGE_SIZE)
#
Retrieves transactions for a specific account or all accounts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
account |
Union[str, Account]
|
An account/id to fetch transactions from.
If |
None
|
status |
TransactionStatus
|
The transaction status for which to return records. |
None
|
since |
datetime
|
The start |
None
|
until |
datetime
|
The end |
None
|
category |
Union[str, PartialCategory]
|
The category/id identifier for which to filter transactions. Raises exception for invalid category. |
None
|
limit |
int
|
The maximum number of records to return. |
None
|
page_size |
int
|
The number of records to return in each page. (max appears to be 100) |
DEFAULT_PAGE_SIZE
|
Returns:
| Type | Description |
|---|---|
PaginatedList[Transaction]
|
A paginated list of the transactions. |
upbankapi.models.PartialCategory
#
Bases: ModelBase
Representation of a PartialCategory.
id: str
class-attribute
#
The unique identifier for this category.
This is a human-readable but URL-safe value.
category()
#
Returns the full category information for a partial category.
transactions(account=None, *, status=None, since=None, until=None, tag=None, limit=None, page_size=DEFAULT_PAGE_SIZE)
#
Retrieves transactions for a specific account or all accounts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
account |
Union[str, Account]
|
An account/id to fetch transactions from.
If |
None
|
status |
TransactionStatus
|
The transaction status for which to return records. |
None
|
since |
datetime
|
The start |
None
|
until |
datetime
|
The end |
None
|
tag |
Union[str, Tag]
|
A transaction tag/id to filter for which to return records. Returns empty if tag does not exist. |
None
|
limit |
int
|
The maximum number of records to return. |
None
|
page_size |
int
|
The number of records to return in each page. (max appears to be 100) |
DEFAULT_PAGE_SIZE
|
Returns:
| Type | Description |
|---|---|
PaginatedList[Transaction]
|
A paginated list of the transactions. |
upbankapi.models.PartialCategoryParent
#
Bases: PartialCategory
Representation of a PartialCategoryParent.
This is used when an API response includes a partial category and a partial parent.
parent: Optional[PartialCategory] = None
class-attribute
#
The parent category of this category, if it exists.
upbankapi.models.Category
#
Bases: PartialCategoryParent
Representation of a Category.