All URIs are relative to https://api.youneedabudget.com/v1
| Method | HTTP request | Description |
|---|---|---|
| get_budget_by_id | GET /budgets/{budget_id} | Single budget |
| get_budget_settings_by_id | GET /budgets/{budget_id}/settings | Budget Settings |
| get_budgets | GET /budgets | List budgets |
BudgetDetailResponse get_budget_by_id(budget_id, last_knowledge_of_server=last_knowledge_of_server)
Single budget
Returns a single budget with all related entities. This resource is effectively a full budget export.
- Api Key Authentication (bearer):
from __future__ import print_function
import time
import ynab
from ynab.rest import ApiException
from pprint import pprint
configuration = ynab.Configuration()
# Configure API key authorization: bearer
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Defining host is optional and default to https://api.youneedabudget.com/v1
configuration.host = "https://api.youneedabudget.com/v1"
# Create an instance of the API class
api_instance = ynab.BudgetsApi(ynab.ApiClient(configuration))
budget_id = 'budget_id_example' # str | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
last_knowledge_of_server = 56 # int | The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
try:
# Single budget
api_response = api_instance.get_budget_by_id(budget_id, last_knowledge_of_server=last_knowledge_of_server)
pprint(api_response)
except ApiException as e:
print("Exception when calling BudgetsApi->get_budget_by_id: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| budget_id | str | The id of the budget ("last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | |
| last_knowledge_of_server | int | The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The requested budget | - |
| 404 | The specified budget was not found | - |
| 0 | An error occurred | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
BudgetSettingsResponse get_budget_settings_by_id(budget_id)
Budget Settings
Returns settings for a budget
- Api Key Authentication (bearer):
from __future__ import print_function
import time
import ynab
from ynab.rest import ApiException
from pprint import pprint
configuration = ynab.Configuration()
# Configure API key authorization: bearer
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Defining host is optional and default to https://api.youneedabudget.com/v1
configuration.host = "https://api.youneedabudget.com/v1"
# Create an instance of the API class
api_instance = ynab.BudgetsApi(ynab.ApiClient(configuration))
budget_id = 'budget_id_example' # str | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
try:
# Budget Settings
api_response = api_instance.get_budget_settings_by_id(budget_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling BudgetsApi->get_budget_settings_by_id: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| budget_id | str | The id of the budget ("last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The requested budget settings | - |
| 404 | The specified Budget was not found | - |
| 0 | An error occurred | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
BudgetSummaryResponse get_budgets(include_accounts=include_accounts)
List budgets
Returns budgets list with summary information
- Api Key Authentication (bearer):
from __future__ import print_function
import time
import ynab
from ynab.rest import ApiException
from pprint import pprint
configuration = ynab.Configuration()
# Configure API key authorization: bearer
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Defining host is optional and default to https://api.youneedabudget.com/v1
configuration.host = "https://api.youneedabudget.com/v1"
# Create an instance of the API class
api_instance = ynab.BudgetsApi(ynab.ApiClient(configuration))
include_accounts = True # bool | Whether to include the list of budget accounts (optional)
try:
# List budgets
api_response = api_instance.get_budgets(include_accounts=include_accounts)
pprint(api_response)
except ApiException as e:
print("Exception when calling BudgetsApi->get_budgets: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| include_accounts | bool | Whether to include the list of budget accounts | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The list of budgets | - |
| 404 | No budgets were found | - |
| 0 | An error occurred | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]