YNAB SDK Python

https://github.com/ynab/ynab-sdk-python
Admin
This Python client library provides access to the YNAB API, allowing developers to interact with...
Tokens:92,222
Snippets:489
Trust Score:8.7
License:Apache-2.0
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Get user with Bearer authentication (Python)

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/UserApi.md

Use this example to call the get_user endpoint with Bearer token authentication. It configures the host and access token, then prints the UserResponse. The access token is read from the BEARER_TOKEN environment variable.

```python
import ynab
from ynab.models.user_response import UserResponse
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.UserApi(api_client)

    try:
        # Get user
        api_response = api_instance.get_user()
        print("The response of UserApi->get_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->get_user: %s\n" % e)
```

--------------------------------

### AccountBase usage example in Python

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/AccountBase.md

Shows how to create an AccountBase instance from a JSON string, print its JSON representation, convert it to a dictionary, and create a new instance from that dictionary. The example uses the ynab.models.account_base module.

```python
from ynab.models.account_base import AccountBase

# TODO update the JSON string below
json = "{}"
# create an instance of AccountBase from a JSON string
account_base_instance = AccountBase.from_json(json)
# print the JSON string representation of the object
print(AccountBase.to_json())

# convert the object into a dict
account_base_dict = account_base_instance.to_dict()
# create an instance of AccountBase from a dict
account_base_from_dict = AccountBase.from_dict(account_base_dict)
```

--------------------------------

### Account model usage example

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/Account.md

Shows how to create an Account instance from a JSON string, print its JSON representation, convert to a dict, and create an instance from a dict. The example uses the ynab.models.account module.

```python
from ynab.models.account import Account

# TODO update the JSON string below
json = "{}"
# create an instance of Account from a JSON string
account_instance = Account.from_json(json)
# print the JSON string representation of the object
print(Account.to_json())

# convert the object into a dict
account_dict = account_instance.to_dict()
# create an instance of Account from a dict
account_from_dict = Account.from_dict(account_dict)
```

--------------------------------

### Get a payee by ID using get_payee_by_id

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PayeesApi.md

Example for calling the get_payee_by_id endpoint with Bearer authentication. It configures the YNAB client with a host and access token, then retrieves a payee by plan_id and payee_id, printing the response or an exception.

```python
import ynab
from ynab.models.payee_response import PayeeResponse
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.PayeesApi(api_client)
    plan_id = 'plan_id_example' # str | The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
    payee_id = 'payee_id_example' # str | The id of the payee

    try:
        # Get a payee
        api_response = api_instance.get_payee_by_id(plan_id, payee_id)
        print("The response of PayeesApi->get_payee_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PayeesApi->get_payee_by_id: %s\n" % e)
```

--------------------------------

### Python example: Create and convert BudgetSettingsResponseData

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/BudgetSettingsResponseData.md

Shows how to import BudgetSettingsResponseData, create an instance from a JSON string using from_json, print its JSON representation, convert to a dict, and create a new instance from that dict using from_dict.

```python
from ynab.models.budget_settings_response_data import BudgetSettingsResponseData

# TODO update the JSON string below
json = "{}"
# create an instance of BudgetSettingsResponseData from a JSON string
budget_settings_response_data_instance = BudgetSettingsResponseData.from_json(json)
# print the JSON string representation of the object
print(BudgetSettingsResponseData.to_json())

# convert the object into a dict
budget_settings_response_data_dict = budget_settings_response_data_instance.to_dict()
# create an instance of BudgetSettingsResponseData from a dict
budget_settings_response_data_from_dict = BudgetSettingsResponseData.from_dict(budget_settings_response_data_dict)
```

--------------------------------

### PlanSettings JSON and dict conversion example

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PlanSettings.md

Shows how to create a PlanSettings instance from a JSON string, print its JSON representation, convert it to a dict, and create another instance from that dict. The JSON string is a placeholder that should be updated before use.

```python
from ynab.models.plan_settings import PlanSettings

# TODO update the JSON string below
json = "{}"
# create an instance of PlanSettings from a JSON string
plan_settings_instance = PlanSettings.from_json(json)
# print the JSON string representation of the object
print(PlanSettings.to_json())

# convert the object into a dict
plan_settings_dict = plan_settings_instance.to_dict()
# create an instance of PlanSettings from a dict
plan_settings_from_dict = PlanSettings.from_dict(plan_settings_dict)
```

--------------------------------

### Get all money movement groups with bearer authentication

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/MoneyMovementsApi.md

Example for calling get_money_movement_groups with a plan_id. It configures the YNAB client with a bearer token from the BEARER_TOKEN environment variable and prints the response. The plan_id can be 'last-used' or 'default' as documented.

```python
import ynab
from ynab.models.money_movement_groups_response import MoneyMovementGroupsResponse
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.MoneyMovementsApi(api_client)
    plan_id = 'plan_id_example' # str | The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).

    try:
        # Get all money movement groups
        api_response = api_instance.get_money_movement_groups(plan_id)
        print("The response of MoneyMovementsApi->get_money_movement_groups:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MoneyMovementsApi->get_money_movement_groups: %s\n" % e)
```

--------------------------------

### BudgetSettings JSON and dict conversion example

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/BudgetSettings.md

Shows how to create a BudgetSettings instance from a JSON string and convert it to a dict, then back to an instance. Includes printing the JSON string representation of the object.

```python
from ynab.models.budget_settings import BudgetSettings

# TODO update the JSON string below
json = "{}"
# create an instance of BudgetSettings from a JSON string
budget_settings_instance = BudgetSettings.from_json(json)
# print the JSON string representation of the object
print(BudgetSettings.to_json())

# convert the object into a dict
budget_settings_dict = budget_settings_instance.to_dict()
# create an instance of BudgetSettings from a dict
budget_settings_from_dict = BudgetSettings.from_dict(budget_settings_dict)
```

--------------------------------

### Get a plan with get_plan_by_id

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PlansApi.md

Example for calling the get_plan_by_id endpoint with Bearer authentication. It configures the client with a host and access token, then retrieves a plan by its ID, optionally using last_knowledge_of_server for incremental updates. The response is printed using pprint.

```python
import ynab
from ynab.models.plan_detail_response import PlanDetailResponse
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.PlansApi(api_client)
    plan_id = 'plan_id_example' # str | The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
    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:
        # Get a plan
        api_response = api_instance.get_plan_by_id(plan_id, last_knowledge_of_server=last_knowledge_of_server)
        print("The response of PlansApi->get_plan_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlansApi->get_plan_by_id: %s\n" % e)
```

--------------------------------

### PostPayee JSON and dict conversion example

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PostPayee.md

Shows how to create a PostPayee instance from a JSON string, print its JSON representation, convert it to a dict, and create an instance from a dict. The JSON string is a placeholder that should be updated with actual data.

```python
from ynab.models.post_payee import PostPayee

# TODO update the JSON string below
json = "{}"
# create an instance of PostPayee from a JSON string
post_payee_instance = PostPayee.from_json(json)
# print the JSON string representation of the object
print(PostPayee.to_json())

# convert the object into a dict
post_payee_dict = post_payee_instance.to_dict()
# create an instance of PostPayee from a dict
post_payee_from_dict = PostPayee.from_dict(post_payee_dict)
```

--------------------------------

### Get all payees with Bearer authentication

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PayeesApi.md

Example for calling PayeesApi.get_payees with Bearer authentication. It sets the API host, configures the bearer token from the BEARER_TOKEN environment variable, and prints the PayeesResponse. The plan_id parameter accepts 'last-used' or 'default' for special plan selection.

```python
import ynab
from ynab.models.payees_response import PayeesResponse
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.PayeesApi(api_client)
    plan_id = 'plan_id_example' # str | The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
    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:
        # Get all payees
        api_response = api_instance.get_payees(plan_id, last_knowledge_of_server=last_knowledge_of_server)
        print("The response of PayeesApi->get_payees:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PayeesApi->get_payees: %s\n" % e)
```

--------------------------------

### PlanSettingsResponse Model Usage Example in Python

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PlanSettingsResponse.md

Shows how to import PlanSettingsResponse, create an instance from a JSON string, print its JSON representation, convert to a dict, and create an instance from a dict. The JSON string is a placeholder and should be replaced with actual data.

```python
from ynab.models.plan_settings_response import PlanSettingsResponse

# TODO update the JSON string below
json = "{}"
# create an instance of PlanSettingsResponse from a JSON string
plan_settings_response_instance = PlanSettingsResponse.from_json(json)
# print the JSON string representation of the object
print(PlanSettingsResponse.to_json())

# convert the object into a dict
plan_settings_response_dict = plan_settings_response_instance.to_dict()
# create an instance of PlanSettingsResponse from a dict
plan_settings_response_from_dict = PlanSettingsResponse.from_dict(plan_settings_response_dict)
```

--------------------------------

### Python example: Using CurrencyFormat from_json, to_json, to_dict, from_dict

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/CurrencyFormat.md

Shows how to create a CurrencyFormat instance from a JSON string, print its JSON representation, convert it to a dict, and create a new instance from that dict. The JSON string is a placeholder that should be updated with actual data.

```python
from ynab.models.currency_format import CurrencyFormat

# TODO update the JSON string below
json = "{}"
# create an instance of CurrencyFormat from a JSON string
currency_format_instance = CurrencyFormat.from_json(json)
# print the JSON string representation of the object
print(CurrencyFormat.to_json())

# convert the object into a dict
currency_format_dict = currency_format_instance.to_dict()
# create an instance of CurrencyFormat from a dict
currency_format_from_dict = CurrencyFormat.from_dict(currency_format_dict)
```

--------------------------------

### Get money movement groups by month with Bearer authentication

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/MoneyMovementsApi.md

Example of calling the get_money_movement_groups_by_month endpoint with Bearer authentication. It configures the client with a host and access token, then retrieves money movement groups for a given plan and month, printing the response or an exception.

```python
import ynab
from ynab.models.money_movement_groups_response import MoneyMovementGroupsResponse
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.MoneyMovementsApi(api_client)
    plan_id = 'plan_id_example' # str | The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
    month = '2013-10-20' # date | The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))

    try:
        # Get money movement groups for a plan month
        api_response = api_instance.get_money_movement_groups_by_month(plan_id, month)
        print("The response of MoneyMovementsApi->get_money_movement_groups_by_month:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MoneyMovementsApi->get_money_movement_groups_by_month: %s\n" % e)
```

--------------------------------

### Python example: Using PutScheduledTransactionWrapper

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PutScheduledTransactionWrapper.md

Shows how to import PutScheduledTransactionWrapper, create an instance from a JSON string, print its JSON representation, convert to a dict, and create a new instance from that dict.

```python
from ynab.models.put_scheduled_transaction_wrapper import PutScheduledTransactionWrapper

# TODO update the JSON string below
json = "{}"
# create an instance of PutScheduledTransactionWrapper from a JSON string
put_scheduled_transaction_wrapper_instance = PutScheduledTransactionWrapper.from_json(json)
# print the JSON string representation of the object
print(PutScheduledTransactionWrapper.to_json())

# convert the object into a dict
put_scheduled_transaction_wrapper_dict = put_scheduled_transaction_wrapper_instance.to_dict()
# create an instance of PutScheduledTransactionWrapper from a dict
put_scheduled_transaction_wrapper_from_dict = PutScheduledTransactionWrapper.from_dict(put_scheduled_transaction_wrapper_dict)
```

--------------------------------

### Get plan settings with PlansApi.get_plan_settings_by_id

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PlansApi.md

Example of calling the get_plan_settings_by_id endpoint using the YNAB Python SDK. It configures the client with a bearer token from the BEARER_TOKEN environment variable, creates a PlansApi instance, and prints the PlanSettingsResponse. The plan_id can be a specific id, "last-used", or "default".

```python
import ynab
from ynab.models.plan_settings_response import PlanSettingsResponse
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.PlansApi(api_client)
    plan_id = 'plan_id_example' # str | The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).

    try:
        # Get plan settings
        api_response = api_instance.get_plan_settings_by_id(plan_id)
        print("The response of PlansApi->get_plan_settings_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlansApi->get_plan_settings_by_id: %s\n" % e)
```

--------------------------------

### Create BudgetSettingsResponse from JSON and dict

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/BudgetSettingsResponse.md

Shows how to import BudgetSettingsResponse, create an instance from a JSON string using BudgetSettingsResponse.from_json(), print the JSON string representation with BudgetSettingsResponse.to_json(), convert to a dict with to_dict(), and create an instance from a dict with from_dict(). The example uses a placeholder JSON string '{}'.

```python
from ynab.models.budget_settings_response import BudgetSettingsResponse

# TODO update the JSON string below
json = "{}"
# create an instance of BudgetSettingsResponse from a JSON string
budget_settings_response_instance = BudgetSettingsResponse.from_json(json)
# print the JSON string representation of the object
print(BudgetSettingsResponse.to_json())

# convert the object into a dict
budget_settings_response_dict = budget_settings_response_instance.to_dict()
# create an instance of BudgetSettingsResponse from a dict
budget_settings_response_from_dict = BudgetSettingsResponse.from_dict(budget_settings_response_dict)
```

--------------------------------

### Get payee locations by payee with Bearer Authentication in Python

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PayeeLocationsApi.md

Example using the YNAB Python SDK to call the get_payee_locations_by_payee endpoint with Bearer token authentication. The host defaults to https://api.ynab.com/v1. The function returns a PayeeLocationsResponse; a 200 status indicates success, and a 404 indicates no locations were found.

```python
import ynab
from ynab.models.payee_locations_response import PayeeLocationsResponse
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.PayeeLocationsApi(api_client)
    plan_id = 'plan_id_example' # str | The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
    payee_id = 'payee_id_example' # str | id of payee

    try:
        # Get all locations for a payee
        api_response = api_instance.get_payee_locations_by_payee(plan_id, payee_id)
        print("The response of PayeeLocationsApi->get_payee_locations_by_payee:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PayeeLocationsApi->get_payee_locations_by_payee: %s\n" % e)
```

--------------------------------

### GET /plans

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PlansApi.md

Get all plans.

```APIDOC
## GET /plans

### Description
Get all plans.

### Method
GET

### Endpoint
/plans

### Response
#### Success Response (200)
- **PlansResponse** - The list of plans

### Authorization
Bearer authentication required.

### HTTP Request Headers
- **Content-Type**: Not defined
- **Accept**: application/json
```

--------------------------------

### Example: Create TransactionSummary from JSON and dict

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/TransactionSummary.md

Shows how to instantiate a TransactionSummary from a JSON string, print its JSON representation, and convert it to a dictionary. Also demonstrates creating an instance from a dict using TransactionSummary.from_dict().

```python
from ynab.models.transaction_summary import TransactionSummary

# TODO update the JSON string below
json = "{}"
# create an instance of TransactionSummary from a JSON string
transaction_summary_instance = TransactionSummary.from_json(json)
# print the JSON string representation of the object
print(TransactionSummary.to_json())

# convert the object into a dict
transaction_summary_dict = transaction_summary_instance.to_dict()
# create an instance of TransactionSummary from a dict
transaction_summary_from_dict = TransactionSummary.from_dict(transaction_summary_dict)
```

--------------------------------

### PlanDetail usage example

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PlanDetail.md

Shows how to create a PlanDetail instance from a JSON string, print its JSON representation, and convert it to and from a dict.

```python
from ynab.models.plan_detail import PlanDetail

# TODO update the JSON string below
json = "{}"
# create an instance of PlanDetail from a JSON string
plan_detail_instance = PlanDetail.from_json(json)
# print the JSON string representation of the object
print(PlanDetail.to_json())

# convert the object into a dict
plan_detail_dict = plan_detail_instance.to_dict()
# create an instance of PlanDetail from a dict
plan_detail_from_dict = PlanDetail.from_dict(plan_detail_dict)
```

--------------------------------

### GET /plans/{plan_id}/accounts

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/AccountsApi.md

Get all accounts for a plan.

```APIDOC
## GET /plans/{plan_id}/accounts

### Description
Get all accounts.

### Method
GET

### Endpoint
/plans/{plan_id}/accounts

### Parameters
#### Path Parameters
- **plan_id** (str) - Required - The id of the plan ("last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)

### Response
#### Success Response (200)
- **AccountResponse** - The list of accounts.

#### Response Example
```json
{
  "data": []
}
```

### Error Handling
- **404** - The plan was not found.
```

--------------------------------

### SavePayee JSON and dict conversion example

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/SavePayee.md

Shows how to create a SavePayee instance from a JSON string, print its JSON representation, convert it to a dict, and create an instance from that dict. The JSON string is a placeholder that should be updated before use.

```python
from ynab.models.save_payee import SavePayee

# TODO update the JSON string below
json = "{}"
# create an instance of SavePayee from a JSON string
save_payee_instance = SavePayee.from_json(json)
# print the JSON string representation of the object
print(SavePayee.to_json())

# convert the object into a dict
save_payee_dict = save_payee_instance.to_dict()
# create an instance of SavePayee from a dict
save_payee_from_dict = SavePayee.from_dict(save_payee_dict)
```

--------------------------------

### GET /plans/{plan_id}/accounts/{account_id}

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/AccountsApi.md

Get an account by its ID.

```APIDOC
## GET /plans/{plan_id}/accounts/{account_id}

### Description
Get an account.

### Method
GET

### Endpoint
/plans/{plan_id}/accounts/{account_id}

### Parameters
#### Path Parameters
- **plan_id** (str) - Required - The id of the plan ("last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
- **account_id** (str) - Required - The id of the account.

### Response
#### Success Response (200)
- **AccountResponse** - The account details.

#### Response Example
```json
{
  "data": {}
}
```

### Error Handling
- **404** - The account was not found.
```

--------------------------------

### BudgetSummary usage example

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/BudgetSummary.md

Shows how to create a BudgetSummary instance from a JSON string or a dictionary, and how to print its JSON representation. The JSON string is a placeholder that should be updated with actual data.

```python
from ynab.models.budget_summary import BudgetSummary

# TODO update the JSON string below
json = "{}"
# create an instance of BudgetSummary from a JSON string
budget_summary_instance = BudgetSummary.from_json(json)
# print the JSON string representation of the object
print(BudgetSummary.to_json())

# convert the object into a dict
budget_summary_dict = budget_summary_instance.to_dict()
# create an instance of BudgetSummary from a dict
budget_summary_from_dict = BudgetSummary.from_dict(budget_summary_dict)
```

--------------------------------

### GET /plans/{plan_id}/settings

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PlansApi.md

Get plan settings for a specific plan.

```APIDOC
## GET /plans/{plan_id}/settings

### Description
Get plan settings for a specific plan.

### Method
GET

### Endpoint
/plans/{plan_id}/settings

### Parameters
#### Path Parameters
- **plan_id** (str) - Required - The id of the plan.

### Response
#### Success Response (200)
- **PlanSettingsResponse** - The plan settings

### Authorization
Bearer authentication required.

### HTTP Request Headers
- **Content-Type**: Not defined
- **Accept**: application/json
```

--------------------------------

### Python example: update_month_category with Bearer authentication

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/CategoriesApi.md

Use this example to call the update_month_category endpoint with Bearer token authentication. The example sets the API host and access token from the BEARER_TOKEN environment variable, then creates a CategoriesApi instance and calls update_month_category with the required parameters. The response is printed using pprint, and any exception is caught and printed.

```python
import ynab
from ynab.models.patch_month_category_wrapper import PatchMonthCategoryWrapper
from ynab.models.save_category_response import SaveCategoryResponse
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.CategoriesApi(api_client)
    plan_id = 'plan_id_example' # str | The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
    month = '2013-10-20' # date | The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
    category_id = 'category_id_example' # str | The id of the category
    data = ynab.PatchMonthCategoryWrapper() # PatchMonthCategoryWrapper | The category to update.  Only `budgeted` (assigned) amount can be updated and any other fields specified will be ignored.

    try:
        # Update a category for a specific month
        api_response = api_instance.update_month_category(plan_id, month, category_id, data)
        print("The response of CategoriesApi->update_month_category:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CategoriesApi->update_month_category: %s\n" % e)
```

--------------------------------

### PlanSummaryResponseData from_json and from_dict example

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PlanSummaryResponseData.md

Shows how to create a PlanSummaryResponseData instance from a JSON string, print its JSON representation, convert it to a dictionary, and create an instance from that dictionary. The JSON string is a placeholder that should be updated with actual data.

```python
from ynab.models.plan_summary_response_data import PlanSummaryResponseData

# TODO update the JSON string below
json = "{}"
# create an instance of PlanSummaryResponseData from a JSON string
plan_summary_response_data_instance = PlanSummaryResponseData.from_json(json)
# print the JSON string representation of the object
print(PlanSummaryResponseData.to_json())

# convert the object into a dict
plan_summary_response_data_dict = plan_summary_response_data_instance.to_dict()
# create an instance of PlanSummaryResponseData from a dict
plan_summary_response_data_from_dict = PlanSummaryResponseData.from_dict(plan_summary_response_data_dict)
```

--------------------------------

### Install ynab package using pip

Source: https://github.com/ynab/ynab-sdk-python/blob/main/README.md

Install the YNAB API Python client library using pip. This is the first step before importing the package in your Python code.

```sh
pip install ynab
```

--------------------------------

### PlanDetailResponse usage example in Python

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PlanDetailResponse.md

Shows how to import PlanDetailResponse, create an instance from a JSON string using from_json, print its JSON representation with to_json, convert to a dict with to_dict, and create a new instance from a dict with from_dict. The JSON string is a placeholder that should be updated.

```python
from ynab.models.plan_detail_response import PlanDetailResponse

# TODO update the JSON string below
json = "{}"
# create an instance of PlanDetailResponse from a JSON string
plan_detail_response_instance = PlanDetailResponse.from_json(json)
# print the JSON string representation of the object
print(PlanDetailResponse.to_json())

# convert the object into a dict
plan_detail_response_dict = plan_detail_response_instance.to_dict()
# create an instance of PlanDetailResponse from a dict
plan_detail_response_from_dict = PlanDetailResponse.from_dict(plan_detail_response_dict)
```

--------------------------------

### PostAccountWrapper usage example in Python

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PostAccountWrapper.md

Shows how to import PostAccountWrapper, create an instance from a JSON string, print its JSON representation, and convert to/from a dict.

```python
from ynab.models.post_account_wrapper import PostAccountWrapper

# TODO update the JSON string below
json = "{}"
# create an instance of PostAccountWrapper from a JSON string
post_account_wrapper_instance = PostAccountWrapper.from_json(json)
# print the JSON string representation of the object
print(PostAccountWrapper.to_json())

# convert the object into a dict
post_account_wrapper_dict = post_account_wrapper_instance.to_dict()
# create an instance of PostAccountWrapper from a dict
post_account_wrapper_from_dict = PostAccountWrapper.from_dict(post_account_wrapper_dict)
```

--------------------------------

### Python example: create_category_group with bearer authentication

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/CategoriesApi.md

Example showing how to call CategoriesApi.create_category_group. It configures a YNAB client with a bearer token and creates a category group. The response is printed, and exceptions are caught.

```python
import ynab
from ynab.models.post_category_group_wrapper import PostCategoryGroupWrapper
from ynab.models.save_category_group_response import SaveCategoryGroupResponse
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.CategoriesApi(api_client)
    plan_id = 'plan_id_example' # str | The id of the plan (\"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan)
    data = ynab.PostCategoryGroupWrapper() # PostCategoryGroupWrapper | The category group to create.

    try:
        # Create a category group
        api_response = api_instance.create_category_group(plan_id, data)
        print("The response of CategoriesApi->create_category_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CategoriesApi->create_category_group: %s\n" % e)
```

--------------------------------

### ScheduledTransactionSummaryBase usage example

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/ScheduledTransactionSummaryBase.md

Shows how to create a ScheduledTransactionSummaryBase instance from a JSON string, print its JSON representation, convert to a dict, and create a new instance from that dict. The example uses the ynab.models.scheduled_transaction_summary_base module.

```python
from ynab.models.scheduled_transaction_summary_base import ScheduledTransactionSummaryBase

# TODO update the JSON string below
json = "{}"
# create an instance of ScheduledTransactionSummaryBase from a JSON string
scheduled_transaction_summary_base_instance = ScheduledTransactionSummaryBase.from_json(json)
# print the JSON string representation of the object
print(ScheduledTransactionSummaryBase.to_json())

# convert the object into a dict
scheduled_transaction_summary_base_dict = scheduled_transaction_summary_base_instance.to_dict()
# create an instance of ScheduledTransactionSummaryBase from a dict
scheduled_transaction_summary_base_from_dict = ScheduledTransactionSummaryBase.from_dict(scheduled_transaction_summary_base_dict)
```

--------------------------------

### Python example: Create MoneyMovement from JSON and dict

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/MoneyMovement.md

Shows how to import MoneyMovement, create an instance from a JSON string, print its JSON representation, convert to a dict, and create an instance from that dict. The JSON string is a placeholder that should be updated.

```python
from ynab.models.money_movement import MoneyMovement

# TODO update the JSON string below
json = "{}"
# create an instance of MoneyMovement from a JSON string
money_movement_instance = MoneyMovement.from_json(json)
# print the JSON string representation of the object
print(MoneyMovement.to_json())

# convert the object into a dict
money_movement_dict = money_movement_instance.to_dict()
# create an instance of MoneyMovement from a dict
money_movement_from_dict = MoneyMovement.from_dict(money_movement_dict)
```

--------------------------------

### SaveMonthCategory usage example in Python

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/SaveMonthCategory.md

Shows how to create a SaveMonthCategory instance from a JSON string, print its JSON representation, convert it to a dict, and create an instance from a dict. The example uses the ynab.models.save_month_category module.

```python
from ynab.models.save_month_category import SaveMonthCategory

# TODO update the JSON string below
json = "{}"
# create an instance of SaveMonthCategory from a JSON string
save_month_category_instance = SaveMonthCategory.from_json(json)
# print the JSON string representation of the object
print(SaveMonthCategory.to_json())

# convert the object into a dict
save_month_category_dict = save_month_category_instance.to_dict()
# create an instance of SaveMonthCategory from a dict
save_month_category_from_dict = SaveMonthCategory.from_dict(save_month_category_dict)
```

--------------------------------

### PlanSummaryResponse usage example in Python

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PlanSummaryResponse.md

Shows how to import PlanSummaryResponse, create an instance from a JSON string, print its JSON representation, convert to a dict, and create an instance from a dict. The JSON string is a placeholder that should be updated with actual data.

```python
from ynab.models.plan_summary_response import PlanSummaryResponse

# TODO update the JSON string below
json = "{}"
# create an instance of PlanSummaryResponse from a JSON string
plan_summary_response_instance = PlanSummaryResponse.from_json(json)
# print the JSON string representation of the object
print(PlanSummaryResponse.to_json())

# convert the object into a dict
plan_summary_response_dict = plan_summary_response_instance.to_dict()
# create an instance of PlanSummaryResponse from a dict
plan_summary_response_from_dict = PlanSummaryResponse.from_dict(plan_summary_response_dict)
```

--------------------------------

### CategoryBase JSON and dict conversion example

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/CategoryBase.md

Use this snippet to create a CategoryBase instance from a JSON string and convert it to a dict and back. The example prints the JSON representation and demonstrates round-trip conversion.

```python
from ynab.models.category_base import CategoryBase

# TODO update the JSON string below
json = "{}"
# create an instance of CategoryBase from a JSON string
category_base_instance = CategoryBase.from_json(json)
# print the JSON string representation of the object
print(CategoryBase.to_json())

# convert the object into a dict
category_base_dict = category_base_instance.to_dict()
# create an instance of CategoryBase from a dict
category_base_from_dict = CategoryBase.from_dict(category_base_dict)
```

--------------------------------

### PayeeLocationsResponseData usage example

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/PayeeLocationsResponseData.md

Shows how to import the model, create an instance from a JSON string, print its JSON representation, and convert to/from a dictionary.

```python
from ynab.models.payee_locations_response_data import PayeeLocationsResponseData

# TODO update the JSON string below
json = "{}"
# create an instance of PayeeLocationsResponseData from a JSON string
payee_locations_response_data_instance = PayeeLocationsResponseData.from_json(json)
# print the JSON string representation of the object
print(PayeeLocationsResponseData.to_json())

# convert the object into a dict
payee_locations_response_data_dict = payee_locations_response_data_instance.to_dict()
# create an instance of PayeeLocationsResponseData from a dict
payee_locations_response_data_from_dict = PayeeLocationsResponseData.from_dict(payee_locations_response_data_dict)
```

--------------------------------

### BudgetDetailResponseData usage example in Python

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/BudgetDetailResponseData.md

Shows how to create a BudgetDetailResponseData instance from a JSON string, print its JSON representation, convert to a dict, and create an instance from a dict. The JSON string is a placeholder that should be updated.

```python
from ynab.models.budget_detail_response_data import BudgetDetailResponseData

# TODO update the JSON string below
json = "{}"
# create an instance of BudgetDetailResponseData from a JSON string
budget_detail_response_data_instance = BudgetDetailResponseData.from_json(json)
# print the JSON string representation of the object
print(BudgetDetailResponseData.to_json())

# convert the object into a dict
budget_detail_response_data_dict = budget_detail_response_data_instance.to_dict()
# create an instance of BudgetDetailResponseData from a dict
budget_detail_response_data_from_dict = BudgetDetailResponseData.from_dict(budget_detail_response_data_dict)
```

--------------------------------

### BudgetSummaryResponseData from_json and to_dict example

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/BudgetSummaryResponseData.md

Shows how to create a BudgetSummaryResponseData instance from a JSON string, print its JSON representation, convert it to a dictionary, and create an instance from that dictionary. The JSON string is a placeholder that should be updated with actual data.

```python
from ynab.models.budget_summary_response_data import BudgetSummaryResponseData

# TODO update the JSON string below
json = "{}"
# create an instance of BudgetSummaryResponseData from a JSON string
budget_summary_response_data_instance = BudgetSummaryResponseData.from_json(json)
# print the JSON string representation of the object
print(BudgetSummaryResponseData.to_json())

# convert the object into a dict
budget_summary_response_data_dict = budget_summary_response_data_instance.to_dict()
# create an instance of BudgetSummaryResponseData from a dict
budget_summary_response_data_from_dict = BudgetSummaryResponseData.from_dict(budget_summary_response_data_dict)
```

--------------------------------

### Python example for get_transaction_by_id with Bearer authentication

Source: https://github.com/ynab/ynab-sdk-python/blob/main/docs/TransactionsApi.md

Shows how to call get_transaction_by_id using the ynab SDK. Requires a Bearer token set as the BEARER_TOKEN environment variable. The example prints the response or an exception message.

```python
import ynab
from ynab.models.transaction_response import TransactionResponse
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.TransactionsApi(api_client)
    plan_id = 'plan_id_example' # str | The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
    transaction_id = 'transaction_id_example' # str | The id of the transaction

    try:
        # Get a transaction
        api_response = api_instance.get_transaction_by_id(plan_id, transaction_id)
        print("The response of TransactionsApi->get_transaction_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransactionsApi->get_transaction_by_id: %s\n" % e)
```
Tokens:
Raw