ynab 1.31.0 → 2.0.0

data/docs/CategoriesApi.md

@@ -0,0 +1,94 @@
+# YNAB::CategoriesApi
+
+All URIs are relative to *https://api.ynab.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_categories**](CategoriesApi.md#get_categories) | **GET** /budgets/{budget_id}/categories | List categories |
+| [**get_category_by_id**](CategoriesApi.md#get_category_by_id) | **GET** /budgets/{budget_id}/categories/{category_id} | Single category |
+| [**get_month_category_by_id**](CategoriesApi.md#get_month_category_by_id) | **GET** /budgets/{budget_id}/months/{month}/categories/{category_id} | Single category for a specific budget month |
+| [**update_month_category**](CategoriesApi.md#update_month_category) | **PATCH** /budgets/{budget_id}/months/{month}/categories/{category_id} | Update a category for a specific month |
+
+
+## get_categories
+
+> <CategoriesResponse> get_categories(budget_id, opts)
+
+List categories
+
+Returns all categories grouped by category group.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **last_knowledge_of_server** | **Integer** | The starting server knowledge.  If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included. | [optional] |
+
+### Return type
+
+[**CategoriesResponse**](CategoriesResponse.md)
+
+
+## get_category_by_id
+
+> <CategoryResponse> get_category_by_id(budget_id, category_id)
+
+Single category
+
+Returns a single category.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **category_id** | **String** | The id of the category |  |
+
+### Return type
+
+[**CategoryResponse**](CategoryResponse.md)
+
+
+## get_month_category_by_id
+
+> <CategoryResponse> get_month_category_by_id(budget_id, month, category_id)
+
+Single category for a specific budget month
+
+Returns a single category for a specific budget month.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **month** | **Date** | The budget month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC)) |  |
+| **category_id** | **String** | The id of the category |  |
+
+### Return type
+
+[**CategoryResponse**](CategoryResponse.md)
+
+
+## update_month_category
+
+> <SaveCategoryResponse> update_month_category(budget_id, month, category_id, data)
+
+Update a category for a specific month
+
+Update a category for a specific month.  Only `budgeted` amount can be updated.
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **month** | **Date** | The budget month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC)) |  |
+| **category_id** | **String** | The id of the category |  |
+| **data** | [**PatchMonthCategoryWrapper**](PatchMonthCategoryWrapper.md) | The category to update.  Only &#x60;budgeted&#x60; amount can be updated and any other fields specified will be ignored. |  |
+
+### Return type
+
+[**SaveCategoryResponse**](SaveCategoryResponse.md)
+

data/docs/CategoriesResponse.md

@@ -0,0 +1,8 @@
+# YNAB::CategoriesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**CategoriesResponseData**](CategoriesResponseData.md) |  |  |
+

data/docs/CategoriesResponseData.md

@@ -0,0 +1,9 @@
+# YNAB::CategoriesResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category_groups** | [**Array<CategoryGroupWithCategories>**](CategoryGroupWithCategories.md) |  |  |
+| **server_knowledge** | **Integer** | The knowledge of the server |  |
+

data/docs/Category.md

@@ -0,0 +1,30 @@
+# YNAB::Category
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **category_group_id** | **String** |  |  |
+| **category_group_name** | **String** |  | [optional] |
+| **name** | **String** |  |  |
+| **hidden** | **Boolean** | Whether or not the category is hidden |  |
+| **original_category_group_id** | **String** | DEPRECATED: No longer used.  Value will always be null. | [optional] |
+| **note** | **String** |  | [optional] |
+| **budgeted** | **Integer** | Budgeted amount in milliunits format |  |
+| **activity** | **Integer** | Activity amount in milliunits format |  |
+| **balance** | **Integer** | Balance in milliunits format |  |
+| **goal_type** | **String** | The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending') | [optional] |
+| **goal_day** | **Integer** | A day offset modifier for the goal's due date. When goal_cadence is 2 (Weekly), this value specifies which day of the week the goal is due (0 = Sunday, 6 = Saturday). Otherwise, this value specifies which day of the month the goal is due (1 = 1st, 31 = 31st, null = Last day of Month). | [optional] |
+| **goal_cadence** | **Integer** | The goal cadence. Value in range 0-14. There are two subsets of these values which behave differently. For values 0, 1, 2, and 13, the goal's due date repeats every goal_cadence * goal_cadence_frequency, where 0 = None, 1 = Monthly, 2 = Weekly, and 13 = Yearly. For example, goal_cadence 1 with goal_cadence_frequency 2 means the goal is due every other month. For values 3-12 and 14, goal_cadence_frequency is ignored and the goal's due date repeats every goal_cadence, where 3 = Every 2 Months, 4 = Every 3 Months, ..., 12 = Every 11 Months, and 14 = Every 2 Years. | [optional] |
+| **goal_cadence_frequency** | **Integer** | The goal cadence frequency. When goal_cadence is 0, 1, 2, or 13, a goal's due date repeats every goal_cadence * goal_cadence_frequency. For example, goal_cadence 1 with goal_cadence_frequency 2 means the goal is due every other month.  When goal_cadence is 3-12 or 14, goal_cadence_frequency is ignored. | [optional] |
+| **goal_creation_month** | **Date** | The month a goal was created | [optional] |
+| **goal_target** | **Integer** | The goal target amount in milliunits | [optional] |
+| **goal_target_month** | **Date** | The original target month for the goal to be completed.  Only some goal types specify this date. | [optional] |
+| **goal_percentage_complete** | **Integer** | The percentage completion of the goal | [optional] |
+| **goal_months_to_budget** | **Integer** | The number of months, including the current month, left in the current goal period. | [optional] |
+| **goal_under_funded** | **Integer** | The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period. This amount will generally correspond to the 'Underfunded' amount in the web and mobile clients except when viewing a category with a Needed for Spending Goal in a future month.  The web and mobile clients will ignore any funding from a prior goal period when viewing category with a Needed for Spending Goal in a future month. | [optional] |
+| **goal_overall_funded** | **Integer** | The total amount funded towards the goal within the current goal period. | [optional] |
+| **goal_overall_left** | **Integer** | The amount of funding still needed to complete the goal within the current goal period. | [optional] |
+| **deleted** | **Boolean** | Whether or not the category has been deleted.  Deleted categories will only be included in delta requests. |  |
+

data/docs/CategoryGroup.md

@@ -0,0 +1,11 @@
+# YNAB::CategoryGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **hidden** | **Boolean** | Whether or not the category group is hidden |  |
+| **deleted** | **Boolean** | Whether or not the category group has been deleted.  Deleted category groups will only be included in delta requests. |  |
+

data/docs/CategoryGroupWithCategories.md

@@ -0,0 +1,12 @@
+# YNAB::CategoryGroupWithCategories
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **hidden** | **Boolean** | Whether or not the category group is hidden |  |
+| **deleted** | **Boolean** | Whether or not the category group has been deleted.  Deleted category groups will only be included in delta requests. |  |
+| **categories** | [**Array<Category>**](Category.md) | Category group categories.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). |  |
+

data/docs/CategoryGroupWithCategoriesAllOf.md

@@ -0,0 +1,8 @@
+# YNAB::CategoryGroupWithCategoriesAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **categories** | [**Array<Category>**](Category.md) | Category group categories.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). |  |
+

data/docs/CategoryGroupsWrapper.md

@@ -0,0 +1,9 @@
+# YNAB::CategoryGroupsWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category_groups** | [**Array<CategoryGroupWithCategories>**](CategoryGroupWithCategories.md) |  | 
+**server_knowledge** | **Integer** | The knowledge of the server | 
+
+

data/docs/CategoryResponse.md

@@ -0,0 +1,8 @@
+# YNAB::CategoryResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**CategoryResponseData**](CategoryResponseData.md) |  |  |
+

data/docs/CategoryResponseData.md

@@ -0,0 +1,8 @@
+# YNAB::CategoryResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category** | [**Category**](Category.md) |  |  |
+

data/docs/CategoryWrapper.md

@@ -0,0 +1,9 @@
+# YNAB::CategoryWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | [**Category**](Category.md) |  | 
+**server_knowledge** | **Integer** | The knowledge of the server | 
+
+

data/docs/CurrencyFormat.md

@@ -0,0 +1,15 @@
+# YNAB::CurrencyFormat
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **iso_code** | **String** |  |  |
+| **example_format** | **String** |  |  |
+| **decimal_digits** | **Integer** |  |  |
+| **decimal_separator** | **String** |  |  |
+| **symbol_first** | **Boolean** |  |  |
+| **group_separator** | **String** |  |  |
+| **currency_symbol** | **String** |  |  |
+| **display_symbol** | **Boolean** |  |  |
+

data/docs/DateFormat.md

@@ -0,0 +1,8 @@
+# YNAB::DateFormat
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **format** | **String** |  |  |
+

data/docs/DeprecatedApi.md

@@ -0,0 +1,28 @@
+# YNAB::DeprecatedApi
+
+All URIs are relative to *https://api.ynab.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**bulk_create_transactions**](DeprecatedApi.md#bulk_create_transactions) | **POST** /budgets/{budget_id}/transactions/bulk | Bulk create transactions |
+
+
+## bulk_create_transactions
+
+> <BulkResponse> bulk_create_transactions(budget_id, transactions)
+
+Bulk create transactions
+
+Creates multiple transactions.  Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions.
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **transactions** | [**BulkTransactions**](BulkTransactions.md) | The list of transactions to create |  |
+
+### Return type
+
+[**BulkResponse**](BulkResponse.md)
+

data/docs/ErrorDetail.md

@@ -0,0 +1,10 @@
+# YNAB::ErrorDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **detail** | **String** |  |  |
+

data/docs/ErrorResponse.md

@@ -0,0 +1,8 @@
+# YNAB::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ErrorDetail**](ErrorDetail.md) |  |  |
+

data/docs/HybridTransaction.md

@@ -0,0 +1,30 @@
+# YNAB::HybridTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **date** | **Date** | The transaction date in ISO format (e.g. 2016-12-01) |  |
+| **amount** | **Integer** | The transaction amount in milliunits format |  |
+| **memo** | **String** |  | [optional] |
+| **cleared** | **String** | The cleared status of the transaction |  |
+| **approved** | **Boolean** | Whether or not the transaction is approved |  |
+| **flag_color** | **String** | The transaction flag | [optional] |
+| **account_id** | **String** |  |  |
+| **payee_id** | **String** |  | [optional] |
+| **category_id** | **String** |  | [optional] |
+| **transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional] |
+| **transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] |
+| **matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional] |
+| **import_id** | **String** | If the transaction was imported, this field is a unique (by account) import identifier.  If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'.  For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'.  If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. | [optional] |
+| **import_payee_name** | **String** | If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules | [optional] |
+| **import_payee_name_original** | **String** | If the transaction was imported, the original payee name as it appeared on the statement | [optional] |
+| **debt_transaction_type** | **String** | If the transaction is a debt/loan account transaction, the type of transaction | [optional] |
+| **deleted** | **Boolean** | Whether or not the transaction has been deleted.  Deleted transactions will only be included in delta requests. |  |
+| **type** | **String** | Whether the hybrid transaction represents a regular transaction or a subtransaction |  |
+| **parent_transaction_id** | **String** | For subtransaction types, this is the id of the parent transaction.  For transaction types, this id will be always be null. | [optional] |
+| **account_name** | **String** |  |  |
+| **payee_name** | **String** |  | [optional] |
+| **category_name** | **String** | The name of the category.  If a split transaction, this will be 'Split'. | [optional] |
+

data/docs/HybridTransactionAllOf.md

@@ -0,0 +1,12 @@
+# YNAB::HybridTransactionAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Whether the hybrid transaction represents a regular transaction or a subtransaction |  |
+| **parent_transaction_id** | **String** | For subtransaction types, this is the id of the parent transaction.  For transaction types, this id will be always be null. | [optional] |
+| **account_name** | **String** |  |  |
+| **payee_name** | **String** |  | [optional] |
+| **category_name** | **String** | The name of the category.  If a split transaction, this will be 'Split'. | [optional] |
+

data/docs/HybridTransactionsResponse.md

@@ -0,0 +1,8 @@
+# YNAB::HybridTransactionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**HybridTransactionsResponseData**](HybridTransactionsResponseData.md) |  |  |
+

data/docs/HybridTransactionsResponseData.md

@@ -0,0 +1,9 @@
+# YNAB::HybridTransactionsResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transactions** | [**Array<HybridTransaction>**](HybridTransaction.md) |  |  |
+| **server_knowledge** | **Integer** | The knowledge of the server | [optional] |
+

data/docs/HybridTransactionsWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::HybridTransactionsWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transactions** | [**Array<HybridTransaction>**](HybridTransaction.md) |  | 
+
+

data/docs/LoanAccountPeriodicValue.md

@@ -0,0 +1,7 @@
+# YNAB::LoanAccountPeriodicValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/MonthDetail.md

@@ -0,0 +1,16 @@
+# YNAB::MonthDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **month** | **Date** |  |  |
+| **note** | **String** |  | [optional] |
+| **income** | **Integer** | The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month |  |
+| **budgeted** | **Integer** | The total amount budgeted in the month |  |
+| **activity** | **Integer** | The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign' |  |
+| **to_be_budgeted** | **Integer** | The available amount for 'Ready to Assign' |  |
+| **age_of_money** | **Integer** | The Age of Money as of the month | [optional] |
+| **deleted** | **Boolean** | Whether or not the month has been deleted.  Deleted months will only be included in delta requests. |  |
+| **categories** | [**Array<Category>**](Category.md) | The budget month categories.  Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. |  |
+

data/docs/MonthDetailAllOf.md

@@ -0,0 +1,8 @@
+# YNAB::MonthDetailAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **categories** | [**Array<Category>**](Category.md) | The budget month categories.  Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. |  |
+

data/docs/MonthDetailResponse.md

@@ -0,0 +1,8 @@
+# YNAB::MonthDetailResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**MonthDetailResponseData**](MonthDetailResponseData.md) |  |  |
+

data/docs/MonthDetailResponseData.md

@@ -0,0 +1,8 @@
+# YNAB::MonthDetailResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **month** | [**MonthDetail**](MonthDetail.md) |  |  |
+

data/docs/MonthDetailWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::MonthDetailWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**month** | [**MonthDetail**](MonthDetail.md) |  | 
+
+

data/docs/MonthSummariesResponse.md

@@ -0,0 +1,8 @@
+# YNAB::MonthSummariesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**MonthSummariesResponseData**](MonthSummariesResponseData.md) |  |  |
+

data/docs/MonthSummariesResponseData.md

@@ -0,0 +1,9 @@
+# YNAB::MonthSummariesResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **months** | [**Array<MonthSummary>**](MonthSummary.md) |  |  |
+| **server_knowledge** | **Integer** | The knowledge of the server |  |
+

data/docs/MonthSummariesWrapper.md

@@ -0,0 +1,9 @@
+# YNAB::MonthSummariesWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**months** | [**Array<MonthSummary>**](MonthSummary.md) |  | 
+**server_knowledge** | **Integer** | The knowledge of the server | 
+
+

data/docs/MonthSummary.md

@@ -0,0 +1,15 @@
+# YNAB::MonthSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **month** | **Date** |  |  |
+| **note** | **String** |  | [optional] |
+| **income** | **Integer** | The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month |  |
+| **budgeted** | **Integer** | The total amount budgeted in the month |  |
+| **activity** | **Integer** | The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign' |  |
+| **to_be_budgeted** | **Integer** | The available amount for 'Ready to Assign' |  |
+| **age_of_money** | **Integer** | The Age of Money as of the month | [optional] |
+| **deleted** | **Boolean** | Whether or not the month has been deleted.  Deleted months will only be included in delta requests. |  |
+

data/docs/MonthsApi.md

@@ -0,0 +1,49 @@
+# YNAB::MonthsApi
+
+All URIs are relative to *https://api.ynab.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_budget_month**](MonthsApi.md#get_budget_month) | **GET** /budgets/{budget_id}/months/{month} | Single budget month |
+| [**get_budget_months**](MonthsApi.md#get_budget_months) | **GET** /budgets/{budget_id}/months | List budget months |
+
+
+## get_budget_month
+
+> <MonthDetailResponse> get_budget_month(budget_id, month)
+
+Single budget month
+
+Returns a single budget month
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **month** | **Date** | The budget month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC)) |  |
+
+### Return type
+
+[**MonthDetailResponse**](MonthDetailResponse.md)
+
+
+## get_budget_months
+
+> <MonthSummariesResponse> get_budget_months(budget_id, opts)
+
+List budget months
+
+Returns all budget months
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **last_knowledge_of_server** | **Integer** | The starting server knowledge.  If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included. | [optional] |
+
+### Return type
+
+[**MonthSummariesResponse**](MonthSummariesResponse.md)
+

data/docs/PatchMonthCategoryWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::PatchMonthCategoryWrapper
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category** | [**SaveMonthCategory**](SaveMonthCategory.md) |  |  |
+

data/docs/PatchTransactionsWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::PatchTransactionsWrapper
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transactions** | [**Array<SaveTransactionWithId>**](SaveTransactionWithId.md) |  |  |
+

data/docs/Payee.md

@@ -0,0 +1,11 @@
+# YNAB::Payee
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **transfer_account_id** | **String** | If a transfer payee, the `account_id` to which this payee transfers to | [optional] |
+| **deleted** | **Boolean** | Whether or not the payee has been deleted.  Deleted payees will only be included in delta requests. |  |
+

data/docs/PayeeLocation.md

@@ -0,0 +1,12 @@
+# YNAB::PayeeLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **payee_id** | **String** |  |  |
+| **latitude** | **String** |  |  |
+| **longitude** | **String** |  |  |
+| **deleted** | **Boolean** | Whether or not the payee location has been deleted.  Deleted payee locations will only be included in delta requests. |  |
+

data/docs/PayeeLocationResponse.md

@@ -0,0 +1,8 @@
+# YNAB::PayeeLocationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**PayeeLocationResponseData**](PayeeLocationResponseData.md) |  |  |
+

data/docs/PayeeLocationResponseData.md

@@ -0,0 +1,8 @@
+# YNAB::PayeeLocationResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payee_location** | [**PayeeLocation**](PayeeLocation.md) |  |  |
+

data/docs/PayeeLocationWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::PayeeLocationWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payee_location** | [**PayeeLocation**](PayeeLocation.md) |  | 
+
+