Skip to content

Latest commit

 

History

History
253 lines (174 loc) · 8.57 KB

BudgetsApi.md

File metadata and controls

253 lines (174 loc) · 8.57 KB

ynab.BudgetsApi

All URIs are relative to https://api.ynab.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

get_budget_by_id

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.

Example

  • Bearer Authentication (bearer):
import ynab
from ynab.models.budget_detail_response import BudgetDetailResponse
from ynab.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ynab.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = ynab.Configuration(
    host = "https://api.ynab.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearer
configuration = ynab.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ynab.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ynab.BudgetsApi(api_client)
    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.ynab.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)
        print("The response of BudgetsApi->get_budget_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BudgetsApi->get_budget_by_id: %s\n" % e)

Parameters

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.ynab.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]

Return type

BudgetDetailResponse

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

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]

get_budget_settings_by_id

BudgetSettingsResponse get_budget_settings_by_id(budget_id)

Budget Settings

Returns settings for a budget

Example

  • Bearer Authentication (bearer):
import ynab
from ynab.models.budget_settings_response import BudgetSettingsResponse
from ynab.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ynab.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = ynab.Configuration(
    host = "https://api.ynab.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearer
configuration = ynab.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ynab.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ynab.BudgetsApi(api_client)
    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.ynab.com/#oauth-default-budget).

    try:
        # Budget Settings
        api_response = api_instance.get_budget_settings_by_id(budget_id)
        print("The response of BudgetsApi->get_budget_settings_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BudgetsApi->get_budget_settings_by_id: %s\n" % e)

Parameters

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.ynab.com/#oauth-default-budget).

Return type

BudgetSettingsResponse

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

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]

get_budgets

BudgetSummaryResponse get_budgets(include_accounts=include_accounts)

List budgets

Returns budgets list with summary information

Example

  • Bearer Authentication (bearer):
import ynab
from ynab.models.budget_summary_response import BudgetSummaryResponse
from ynab.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ynab.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = ynab.Configuration(
    host = "https://api.ynab.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearer
configuration = ynab.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ynab.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ynab.BudgetsApi(api_client)
    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)
        print("The response of BudgetsApi->get_budgets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BudgetsApi->get_budgets: %s\n" % e)

Parameters

Name Type Description Notes
include_accounts bool Whether to include the list of budget accounts [optional]

Return type

BudgetSummaryResponse

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

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]