Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ docs/_build/
# PyBuilder
target/

#Ipython Notebook
# Ipython Notebook
.ipynb_checkpoints
70 changes: 50 additions & 20 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,6 @@ docs/AccountType.md
docs/AccountsApi.md
docs/AccountsResponse.md
docs/AccountsResponseData.md
docs/BudgetDetail.md
docs/BudgetDetailResponse.md
docs/BudgetDetailResponseData.md
docs/BudgetSettings.md
docs/BudgetSettingsResponse.md
docs/BudgetSettingsResponseData.md
docs/BudgetSummary.md
docs/BudgetSummaryResponse.md
docs/BudgetSummaryResponseData.md
docs/BudgetsApi.md
docs/BulkResponse.md
docs/BulkResponseData.md
docs/BulkResponseDataBulk.md
Expand All @@ -32,18 +22,28 @@ docs/CurrencyFormat.md
docs/DateFormat.md
docs/ErrorDetail.md
docs/ErrorResponse.md
docs/ExistingCategory.md
docs/ExistingTransaction.md
docs/HybridTransaction.md
docs/HybridTransactionsResponse.md
docs/HybridTransactionsResponseData.md
docs/MoneyMovement.md
docs/MoneyMovementGroup.md
docs/MoneyMovementGroupsResponse.md
docs/MoneyMovementGroupsResponseData.md
docs/MoneyMovementsApi.md
docs/MoneyMovementsResponse.md
docs/MoneyMovementsResponseData.md
docs/MonthDetail.md
docs/MonthDetailResponse.md
docs/MonthDetailResponseData.md
docs/MonthSummariesResponse.md
docs/MonthSummariesResponseData.md
docs/MonthSummary.md
docs/MonthsApi.md
docs/NewCategory.md
docs/NewTransaction.md
docs/PatchCategoryGroupWrapper.md
docs/PatchCategoryWrapper.md
docs/PatchMonthCategoryWrapper.md
docs/PatchPayeeWrapper.md
Expand All @@ -60,13 +60,28 @@ docs/PayeeResponseData.md
docs/PayeesApi.md
docs/PayeesResponse.md
docs/PayeesResponseData.md
docs/PlanDetail.md
docs/PlanDetailResponse.md
docs/PlanDetailResponseData.md
docs/PlanSettings.md
docs/PlanSettingsResponse.md
docs/PlanSettingsResponseData.md
docs/PlanSummary.md
docs/PlanSummaryResponse.md
docs/PlanSummaryResponseData.md
docs/PlansApi.md
docs/PostAccountWrapper.md
docs/PostCategoryGroupWrapper.md
docs/PostCategoryWrapper.md
docs/PostScheduledTransactionWrapper.md
docs/PostTransactionsWrapper.md
docs/PutScheduledTransactionWrapper.md
docs/PutTransactionWrapper.md
docs/SaveAccount.md
docs/SaveCategory.md
docs/SaveCategoryGroup.md
docs/SaveCategoryGroupResponse.md
docs/SaveCategoryGroupResponseData.md
docs/SaveCategoryResponse.md
docs/SaveCategoryResponseData.md
docs/SaveMonthCategory.md
Expand Down Expand Up @@ -112,11 +127,12 @@ tox.ini
ynab/__init__.py
ynab/api/__init__.py
ynab/api/accounts_api.py
ynab/api/budgets_api.py
ynab/api/categories_api.py
ynab/api/money_movements_api.py
ynab/api/months_api.py
ynab/api/payee_locations_api.py
ynab/api/payees_api.py
ynab/api/plans_api.py
ynab/api/scheduled_transactions_api.py
ynab/api/transactions_api.py
ynab/api/user_api.py
Expand All @@ -131,15 +147,6 @@ ynab/models/account_response_data.py
ynab/models/account_type.py
ynab/models/accounts_response.py
ynab/models/accounts_response_data.py
ynab/models/budget_detail.py
ynab/models/budget_detail_response.py
ynab/models/budget_detail_response_data.py
ynab/models/budget_settings.py
ynab/models/budget_settings_response.py
ynab/models/budget_settings_response_data.py
ynab/models/budget_summary.py
ynab/models/budget_summary_response.py
ynab/models/budget_summary_response_data.py
ynab/models/bulk_response.py
ynab/models/bulk_response_data.py
ynab/models/bulk_response_data_bulk.py
Expand All @@ -155,17 +162,26 @@ ynab/models/currency_format.py
ynab/models/date_format.py
ynab/models/error_detail.py
ynab/models/error_response.py
ynab/models/existing_category.py
ynab/models/existing_transaction.py
ynab/models/hybrid_transaction.py
ynab/models/hybrid_transactions_response.py
ynab/models/hybrid_transactions_response_data.py
ynab/models/money_movement.py
ynab/models/money_movement_group.py
ynab/models/money_movement_groups_response.py
ynab/models/money_movement_groups_response_data.py
ynab/models/money_movements_response.py
ynab/models/money_movements_response_data.py
ynab/models/month_detail.py
ynab/models/month_detail_response.py
ynab/models/month_detail_response_data.py
ynab/models/month_summaries_response.py
ynab/models/month_summaries_response_data.py
ynab/models/month_summary.py
ynab/models/new_category.py
ynab/models/new_transaction.py
ynab/models/patch_category_group_wrapper.py
ynab/models/patch_category_wrapper.py
ynab/models/patch_month_category_wrapper.py
ynab/models/patch_payee_wrapper.py
Expand All @@ -180,13 +196,27 @@ ynab/models/payee_response.py
ynab/models/payee_response_data.py
ynab/models/payees_response.py
ynab/models/payees_response_data.py
ynab/models/plan_detail.py
ynab/models/plan_detail_response.py
ynab/models/plan_detail_response_data.py
ynab/models/plan_settings.py
ynab/models/plan_settings_response.py
ynab/models/plan_settings_response_data.py
ynab/models/plan_summary.py
ynab/models/plan_summary_response.py
ynab/models/plan_summary_response_data.py
ynab/models/post_account_wrapper.py
ynab/models/post_category_group_wrapper.py
ynab/models/post_category_wrapper.py
ynab/models/post_scheduled_transaction_wrapper.py
ynab/models/post_transactions_wrapper.py
ynab/models/put_scheduled_transaction_wrapper.py
ynab/models/put_transaction_wrapper.py
ynab/models/save_account.py
ynab/models/save_category.py
ynab/models/save_category_group.py
ynab/models/save_category_group_response.py
ynab/models/save_category_group_response_data.py
ynab/models/save_category_response.py
ynab/models/save_category_response_data.py
ynab/models/save_month_category.py
Expand Down
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.14.0
7.20.0
2 changes: 1 addition & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Setup

- Install Poetry: `pip install poetry`
- Install Poetry: `pipx install poetry`
- Install dependencies: `poetry install`
- Install [OpenAPI Generator](https://openapi-generator.tech/) (on macOS: `brew install openapi-generator`)
- Run tests: `poetry run pytest`
Expand Down
79 changes: 43 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,61 +41,68 @@ configuration = ynab.Configuration(
)

with ynab.ApiClient(configuration) as api_client:
budgets_api = ynab.BudgetsApi(api_client)
budgets_response = budgets_api.get_budgets()
budgets = budgets_response.data.budgets
plans_api = ynab.PlansApi(api_client)
plans_response = plans_api.get_plans()
plans = plans_response.data.budgets

for budget in budgets:
print(budget.name)
for plan in plans:
print(plan.name)
```

## Methods

Class | Method | Description
------------ | ------------- | -------------
**UserApi** | [**get_user**](docs/UserApi.md#get_user) | User info
**AccountsApi** | [**create_account**](docs/AccountsApi.md#create_account) | Create a new account
  | [**get_account_by_id**](docs/AccountsApi.md#get_account_by_id) | Single account
  | [**get_accounts**](docs/AccountsApi.md#get_accounts) | Account list
**BudgetsApi** | [**get_budget_by_id**](docs/BudgetsApi.md#get_budget_by_id) | Single budget
  | [**get_budget_settings_by_id**](docs/BudgetsApi.md#get_budget_settings_by_id) | Budget Settings
  | [**get_budgets**](docs/BudgetsApi.md#get_budgets) | List budgets
**CategoriesApi** | [**get_categories**](docs/CategoriesApi.md#get_categories) | List categories
  | [**get_category_by_id**](docs/CategoriesApi.md#get_category_by_id) | Single category
  | [**get_month_category_by_id**](docs/CategoriesApi.md#get_month_category_by_id) | Single category for a specific budget month
**UserApi** | [**get_user**](docs/UserApi.md#get_user) | Get user
**AccountsApi** | [**create_account**](docs/AccountsApi.md#create_account) | Create an account
  | [**get_account_by_id**](docs/AccountsApi.md#get_account_by_id) | Get an account
  | [**get_accounts**](docs/AccountsApi.md#get_accounts) | Get all accounts
**BudgetsApi** | [**get_plan_by_id**](docs/BudgetsApi.md#get_plan_by_id) | Get a plan
  | [**get_plan_settings_by_id**](docs/BudgetsApi.md#get_plan_settings_by_id) | Get plan settings
  | [**get_plans**](docs/BudgetsApi.md#get_plans) | Get all plans
**CategoriesApi** | [**create_category**](docs/CategoriesApi.md#create_category) | Create a category
  | [**create_category_group**](docs/CategoriesApi.md#create_category_group) | Create a category group
  | [**get_categories**](docs/CategoriesApi.md#get_categories) | Get all categories
  | [**get_category_by_id**](docs/CategoriesApi.md#get_category_by_id) | Get a category
  | [**get_month_category_by_id**](docs/CategoriesApi.md#get_month_category_by_id) | Get a category for a specific plan month
  | [**update_category**](docs/CategoriesApi.md#update_category) | Update a category
  | [**update_category_group**](docs/CategoriesApi.md#update_category_group) | Update a category group
  | [**update_month_category**](docs/CategoriesApi.md#update_month_category) | Update a category for a specific month
**MonthsApi** | [**get_budget_month**](docs/MonthsApi.md#get_budget_month) | Single budget month
  | [**get_budget_months**](docs/MonthsApi.md#get_budget_months) | List budget months
**PayeeLocationsApi** | [**get_payee_location_by_id**](docs/PayeeLocationsApi.md#get_payee_location_by_id) | Single payee location
  | [**get_payee_locations**](docs/PayeeLocationsApi.md#get_payee_locations) | List payee locations
  | [**get_payee_locations_by_payee**](docs/PayeeLocationsApi.md#get_payee_locations_by_payee) | List locations for a payee
**PayeesApi** | [**get_payee_by_id**](docs/PayeesApi.md#get_payee_by_id) | Single payee
  | [**get_payees**](docs/PayeesApi.md#get_payees) | List payees
**MonthsApi** | [**get_plan_month**](docs/MonthsApi.md#get_plan_month) | Get a plan month
  | [**get_plan_months**](docs/MonthsApi.md#get_plan_months) | Get all plan months
**PayeeLocationsApi** | [**get_payee_location_by_id**](docs/PayeeLocationsApi.md#get_payee_location_by_id) | Get a payee location
  | [**get_payee_locations**](docs/PayeeLocationsApi.md#get_payee_locations) | Get all payee locations
  | [**get_payee_locations_by_payee**](docs/PayeeLocationsApi.md#get_payee_locations_by_payee) | Get all locations for a payee
**PayeesApi** | [**get_payee_by_id**](docs/PayeesApi.md#get_payee_by_id) | Get a payee
  | [**get_payees**](docs/PayeesApi.md#get_payees) | Get all payees
  | [**update_payee**](docs/PayeesApi.md#update_payee) | Update a payee
**ScheduledTransactionsApi** | [**create_scheduled_transaction**](docs/ScheduledTransactionsApi.md#create_scheduled_transaction) | Create a single scheduled transaction
  | [**get_scheduled_transaction_by_id**](docs/ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | Single scheduled transaction
  | [**get_scheduled_transactions**](docs/ScheduledTransactionsApi.md#get_scheduled_transactions) | List scheduled transactions
  | [**update_scheduled_transaction**](docs/ScheduledTransactionsApi.md#update_scheduled_transaction) | Update an existing scheduled transactions
  | [**delete_scheduled_transaction**](docs/ScheduledTransactionsApi.md#delete_scheduled_transaction) | Delete an existing scheduled transaction
**MoneyMovementsApi** | [**get_money_movement_groups**](docs/MoneyMovementsApi.md#get_money_movement_groups) | Get all money movement groups
  | [**get_money_movement_groups_by_month**](docs/MoneyMovementsApi.md#get_money_movement_groups_by_month) | Get money movement groups for a plan month
  | [**get_money_movements**](docs/MoneyMovementsApi.md#get_money_movements) | Get all money movements
  | [**get_money_movements_by_month**](docs/MoneyMovementsApi.md#get_money_movements_by_month) | Get money movements for a plan month
**TransactionsApi** | [**create_transaction**](docs/TransactionsApi.md#create_transaction) | Create a single transaction or multiple transactions
  | [**delete_transaction**](docs/TransactionsApi.md#delete_transaction) | Deletes an existing transaction
  | [**get_transaction_by_id**](docs/TransactionsApi.md#get_transaction_by_id) | Single transaction
  | [**get_transactions**](docs/TransactionsApi.md#get_transactions) | List transactions
  | [**get_transactions_by_account**](docs/TransactionsApi.md#get_transactions_by_account) | List account transactions
  | [**get_transactions_by_category**](docs/TransactionsApi.md#get_transactions_by_category) | List category transactions, excluding any pending transactions
  | [**get_transactions_by_month**](docs/TransactionsApi.md#get_transactions_by_month) | List transactions in month, excluding any pending transactions
  | [**get_transactions_by_payee**](docs/TransactionsApi.md#get_transactions_by_payee) | List payee transactions, excluding any pending transactions
  | [**delete_transaction**](docs/TransactionsApi.md#delete_transaction) | Delete a transaction
  | [**get_transaction_by_id**](docs/TransactionsApi.md#get_transaction_by_id) | Get a transaction
  | [**get_transactions**](docs/TransactionsApi.md#get_transactions) | Get all transactions
  | [**get_transactions_by_account**](docs/TransactionsApi.md#get_transactions_by_account) | Get all account transactions
  | [**get_transactions_by_category**](docs/TransactionsApi.md#get_transactions_by_category) | Get all category transactions
  | [**get_transactions_by_month**](docs/TransactionsApi.md#get_transactions_by_month) | Get all plan month transactions
  | [**get_transactions_by_payee**](docs/TransactionsApi.md#get_transactions_by_payee) | Get all payee transactions
  | [**import_transactions**](docs/TransactionsApi.md#import_transactions) | Import transactions
  | [**update_transaction**](docs/TransactionsApi.md#update_transaction) | Updates an existing transaction
  | [**update_transaction**](docs/TransactionsApi.md#update_transaction) | Update a transaction
  | [**update_transactions**](docs/TransactionsApi.md#update_transactions) | Update multiple transactions
**ScheduledTransactionsApi** | [**create_scheduled_transaction**](docs/ScheduledTransactionsApi.md#create_scheduled_transaction) | Create a scheduled transaction
  | [**delete_scheduled_transaction**](docs/ScheduledTransactionsApi.md#delete_scheduled_transaction) | Delete a scheduled transaction
  | [**get_scheduled_transaction_by_id**](docs/ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | Get a scheduled transaction
  | [**get_scheduled_transactions**](docs/ScheduledTransactionsApi.md#get_scheduled_transactions) | Get all scheduled transactions
  | [**update_scheduled_transaction**](docs/ScheduledTransactionsApi.md#update_scheduled_transaction) | Update a scheduled transaction

## Versioning

The version of this client is defined in the `pyproject.toml` file and follows [semantic versioning](https://semver.org/). The version of this client is maintained independently and does not align with the the version of YNAB API itself (which is defined in the [OpenAPI spec](https://api.ynab.com/papi/open_api_spec.yaml)). To determine which spec version of the YNAB API was used when generating this client you can refer to the "description" field in the `pyproject.toml` file.

## License

Copyright (c) 2025 You Need A Budget, LLC
Copyright (c) 2025 YNAB

Licensed under the Apache-2.0 license
10 changes: 5 additions & 5 deletions docs/Account.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | |
**id** | **UUID** | |
**name** | **str** | |
**type** | [**AccountType**](AccountType.md) | |
**on_budget** | **bool** | Whether this account is on budget or not |
**on_budget** | **bool** | Whether this account is \"on budget\" or not |
**closed** | **bool** | Whether this account is closed or not |
**note** | **str** | | [optional]
**balance** | **int** | The current balance of the account in milliunits format |
**balance** | **int** | The current available balance of the account in milliunits format |
**cleared_balance** | **int** | The current cleared balance of the account in milliunits format |
**uncleared_balance** | **int** | The current uncleared balance of the account in milliunits format |
**transfer_payee_id** | **str** | The payee id which should be used when transferring to this account |
**transfer_payee_id** | **UUID** | The payee id which should be used when transferring to this account |
**direct_import_linked** | **bool** | Whether or not the account is linked to a financial institution for automatic transaction import. | [optional]
**direct_import_in_error** | **bool** | If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true. | [optional]
**last_reconciled_at** | **datetime** | A date/time specifying when the account was last reconciled. | [optional]
**debt_original_balance** | **int** | The original debt/loan account balance, specified in milliunits format. | [optional]
**debt_original_balance** | **int** | This field is deprecated and will always be null. | [optional]
**debt_interest_rates** | **Dict[str, int]** | | [optional]
**debt_minimum_payments** | **Dict[str, int]** | | [optional]
**debt_escrow_amounts** | **Dict[str, int]** | | [optional]
Expand Down
Loading