Analytics

Analytical categories and category groups (axes).

Bases: SyncAPIResource

Manage the company categories used to classify transactions and invoice lines.

list

list(
    *,
    cursor: str | None = None,
    limit: int | None = None,
    filter: FiltersInput | None = None,
    sort: str | None = None,
) -> SyncCursorPage[Category]

List categories.

Scope: categories:readonly. Reference: https://pennylane.readme.io/reference/getcategories

Parameters:

Name	Type	Description	Default
cursor	str | None	Pagination cursor from a previous page.	None
limit	int | None	Results per page (1-100, API default 20).	None
filter	FiltersInput | None	Conditions built with :mod:pennylane_sdk.filters.	None
sort	str | None	Sort field, prefixed with - for descending (default -id).	None

get

get(category_id: int) -> Category

Retrieve a category by its Pennylane identifier.

Scope: categories:readonly. Reference: https://pennylane.readme.io/reference/getcategory

create

create(
    *,
    label: str,
    category_group_id: int,
    direction: str | None = None,
    analytical_code: str | None = None,
) -> Category

Create a category.

Scope: categories:all. Reference: https://pennylane.readme.io/reference/postcategories

Parameters:

Name	Type	Description	Default
label	str	Category label.	required
category_group_id	int	Identifier of the category group this category belongs to.	required
direction	str | None	Only applicable for treasury categories. Defaults to "cash_out" if not provided ("cash_in" or "cash_out").	None
analytical_code	str | None	Analytical code for the category.	None

update

update(
    category_id: int,
    *,
    label: str | None = None,
    direction: str | None = None,
    analytical_code: str | None = None,
) -> Category

Update a category. Only the provided fields are modified.

Scope: categories:all. Reference: https://pennylane.readme.io/reference/updatecategory

Parameters:

Name	Type	Description	Default
label	str | None	Category label.	None
direction	str | None	Only applicable for treasury categories ("cash_in" or "cash_out").	None
analytical_code	str | None	Analytical code for the category.	None

Bases: SyncAPIResource

Manage the company category groups.

list

list(
    *, cursor: str | None = None, limit: int | None = None
) -> SyncCursorPage[CategoryGroup]

List category groups.

Scope: categories:readonly. Reference: https://pennylane.readme.io/reference/getcategorygroups

Parameters:

Name	Type	Description	Default
cursor	str | None	Pagination cursor from a previous page.	None
limit	int | None	Results per page (1-100, API default 20).	None

get

get(category_group_id: int) -> CategoryGroup

Retrieve a category group by its Pennylane identifier.

Scope: categories:readonly. Reference: https://pennylane.readme.io/reference/getcategorygroup

list_categories

list_categories(
    category_group_id: int,
    *,
    cursor: str | None = None,
    limit: int | None = None,
) -> SyncCursorPage[Category]

List the categories belonging to a category group.

Scope: categories:readonly. Reference: https://pennylane.readme.io/reference/getcategorygroupcategories

Parameters:

Name	Type	Description	Default
category_group_id	int	Identifier of the parent category group.	required
cursor	str | None	Pagination cursor from a previous page.	None
limit	int | None	Results per page (1-100, API default 20).	None