Welcome to the Python Noko Client’s documentation!
The python-freckle-client is a simple client for the Noko (formerly Freckle) API. It supports
two different clients with different levels of flexibility and support to interact with the Noko API v2.
Noko Clients
There are two versions of the client available:
FreckleClientV2
NokoClient
The FreckleClientV2 provides a quick and easy way to interact with NOKO, primarily to fetch JSON from it. The NokoClient
is built on top of the FreckleClientV2 request handling and offers individual methods for different interactions with
parameter type flexibility and validation before the Noko API is even hit.
Minimum Requirements
The FreckleClientV2 is available in versions v0.5.0 and up. The NokoClient is only available from version v1.0.0.
Notable requirements for v1.0.0:
Python 3.10
Pydantic v2
Get Started
Client Documentation
- Noko Entries
- Noko Tags
- Noko Projects
NokoClientNokoClient.access_tokenNokoClient.archive_projects()NokoClient.archive_single_project()NokoClient.create_project()NokoClient.delete_projects()NokoClient.delete_single_project()NokoClient.edit_project()NokoClient.get_all_entries_for_project()NokoClient.get_expenses_for_project()NokoClient.get_single_project()NokoClient.list_projects()NokoClient.merge_project_into_this_project()NokoClient.unarchive_projects()NokoClient.unarchive_single_project()
- Noko Project Groups
NokoClientNokoClient.access_tokenNokoClient.add_projects_to_group()NokoClient.create_project_group()NokoClient.delete_project_group()NokoClient.edit_project_group()NokoClient.get_all_entries_for_project_in_project_group()NokoClient.get_all_projects_in_project_group()NokoClient.get_single_project_group()NokoClient.list_project_groups()NokoClient.remove_all_projects_from_group()NokoClient.remove_projects_from_group()
- Noko Invoices
NokoClientNokoClient.access_tokenNokoClient.add_entries_to_invoice()NokoClient.add_expenses_to_invoice()NokoClient.add_taxes_to_invoice()NokoClient.create_invoice()NokoClient.delete_invoice()NokoClient.edit_invoice()NokoClient.get_invoice_entries()NokoClient.get_invoice_expenses()NokoClient.get_single_invoice()NokoClient.list_invoices()NokoClient.mark_invoice_as_paid()NokoClient.mark_invoice_as_unpaid()NokoClient.remove_all_entries_from_invoice()NokoClient.remove_all_expenses_from_invoice()NokoClient.remove_all_taxes_from_invoice()NokoClient.remove_entries_from_invoice()NokoClient.remove_expenses_from_invoice()NokoClient.remove_taxes_from_invoice()
- Noko Expenses
- Noko Users
NokoClientNokoClient.access_tokenNokoClient.create_user()NokoClient.deactivate_user()NokoClient.delete_user()NokoClient.edit_user()NokoClient.get_single_user()NokoClient.get_user_entries()NokoClient.get_user_expenses()NokoClient.give_user_access_to_projects()NokoClient.list_users()NokoClient.reactivate_user()NokoClient.revoke_user_access_to_all_projects()NokoClient.revoke_user_access_to_projects()
- Noko Teams
NokoClientNokoClient.access_tokenNokoClient.add_users_to_team()NokoClient.create_team()NokoClient.delete_team()NokoClient.edit_team()NokoClient.get_entries_for_users_in_team()NokoClient.get_single_team()NokoClient.get_users_in_team()NokoClient.list_teams()NokoClient.remove_all_users_from_team()NokoClient.remove_users_from_team()