ynab 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0abc6145b2851d23a9e7ba12e3482836aeeed054d7785c27a0d25eca6d66048
-  data.tar.gz: 0aac1965123555b8c71badcab23890cb7e8b09f369ecece7a534583f7554744e
+  metadata.gz: 176de7d09ec90d7defd49ae9ff687dc80c34d1c86b26c66fb6757f09061d745e
+  data.tar.gz: d6786245768c2075538fb946c6805ffd90ad550597a70d07aa2a263792b7a6d3
 SHA512:
-  metadata.gz: d43b5240894f6b7b342334d6e2d9c58b838808ff4892214921821991016ebc73aad421936b8d59313648e7052606fab3b0339635cdcac46de0306730c842de04
-  data.tar.gz: cc2931a5b5edcc82c9e7a203eff08cdb74b0e73945c9a276ec3d6e1eee53b9257362814c25e57db674c77ee181f082de6dada63a4c085a1cebd231e3d2db3ee1
+  metadata.gz: 4b63b0a402ad7952e3991685ae5f74179c9f41df73b6f43bdfb7d94575067cfff9110a352db98a9ce2523c98bb69925c3265a7309717f7ea2f7d567a9d1e5377
+  data.tar.gz: ce834fb610f9b0a44197d2b515dbad5af00ad895c30b0caa025f9f3a5b7afea754fb73bf3c2f9858cbad48a57c4f76c720d153ee6274195193fd08508d277065

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ynab (4.9.0)
+    ynab (5.0.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/docs/Account.md

@@ -22,4 +22,10 @@
 | **debt_minimum_payments** | **Hash<String, Integer>** |  | [optional] |
 | **debt_escrow_amounts** | **Hash<String, Integer>** |  | [optional] |
 | **deleted** | **Boolean** | Whether or not the account has been deleted.  Deleted accounts will only be included in delta requests. |  |
+| **balance_formatted** | **String** | The current available balance of the account formatted in the plan's currency format | [optional] |
+| **balance_currency** | **Float** | The current available balance of the account as a decimal currency amount | [optional] |
+| **cleared_balance_formatted** | **String** | The current cleared balance of the account formatted in the plan's currency format | [optional] |
+| **cleared_balance_currency** | **Float** | The current cleared balance of the account as a decimal currency amount | [optional] |
+| **uncleared_balance_formatted** | **String** | The current uncleared balance of the account formatted in the plan's currency format | [optional] |
+| **uncleared_balance_currency** | **Float** | The current uncleared balance of the account as a decimal currency amount | [optional] |
 

data/docs/AccountBase.md

@@ -0,0 +1,25 @@
+# YNAB::AccountBase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **type** | [**AccountType**](AccountType.md) |  |  |
+| **on_budget** | **Boolean** | Whether this account is \"on budget\" or not |  |
+| **closed** | **Boolean** | Whether this account is closed or not |  |
+| **note** | **String** |  | [optional] |
+| **balance** | **Integer** | The current available balance of the account in milliunits format |  |
+| **cleared_balance** | **Integer** | The current cleared balance of the account in milliunits format |  |
+| **uncleared_balance** | **Integer** | The current uncleared balance of the account in milliunits format |  |
+| **transfer_payee_id** | **String** | The payee id which should be used when transferring to this account |  |
+| **direct_import_linked** | **Boolean** | Whether or not the account is linked to a financial institution for automatic transaction import. | [optional] |
+| **direct_import_in_error** | **Boolean** | 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** | **Time** | A date/time specifying when the account was last reconciled. | [optional] |
+| **debt_original_balance** | **Integer** | This field is deprecated and will always be null. | [optional] |
+| **debt_interest_rates** | **Hash<String, Integer>** |  | [optional] |
+| **debt_minimum_payments** | **Hash<String, Integer>** |  | [optional] |
+| **debt_escrow_amounts** | **Hash<String, Integer>** |  | [optional] |
+| **deleted** | **Boolean** | Whether or not the account has been deleted.  Deleted accounts will only be included in delta requests. |  |
+

data/docs/Category.md

@@ -30,4 +30,18 @@
 | **goal_overall_left** | **Integer** | The amount of funding still needed to complete the goal within the current goal period. | [optional] |
 | **goal_snoozed_at** | **Time** | The date/time the goal was snoozed.  If the goal is not snoozed, this will be null. | [optional] |
 | **deleted** | **Boolean** | Whether or not the category has been deleted.  Deleted categories will only be included in delta requests. |  |
+| **balance_formatted** | **String** | Available balance of the category formatted in the plan's currency format | [optional] |
+| **balance_currency** | **Float** | Available balance of the category as a decimal currency amount | [optional] |
+| **activity_formatted** | **String** | Activity of the category formatted in the plan's currency format | [optional] |
+| **activity_currency** | **Float** | Activity of the category as a decimal currency amount | [optional] |
+| **budgeted_formatted** | **String** | Assigned (budgeted) amount of the category formatted in the plan's currency format | [optional] |
+| **budgeted_currency** | **Float** | Assigned (budgeted) amount of the category as a decimal currency amount | [optional] |
+| **goal_target_formatted** | **String** | The goal target amount formatted in the plan's currency format | [optional] |
+| **goal_target_currency** | **Float** | The goal target amount as a decimal currency amount | [optional] |
+| **goal_under_funded_formatted** | **String** | The goal underfunded amount formatted in the plan's currency format | [optional] |
+| **goal_under_funded_currency** | **Float** | The goal underfunded amount as a decimal currency amount | [optional] |
+| **goal_overall_funded_formatted** | **String** | The total amount funded towards the goal formatted in the plan's currency format | [optional] |
+| **goal_overall_funded_currency** | **Float** | The total amount funded towards the goal as a decimal currency amount | [optional] |
+| **goal_overall_left_formatted** | **String** | The amount of funding still needed to complete the goal formatted in the plan's currency format | [optional] |
+| **goal_overall_left_currency** | **Float** | The amount of funding still needed to complete the goal as a decimal currency amount | [optional] |
 

data/docs/CategoryBase.md

@@ -0,0 +1,33 @@
+# YNAB::CategoryBase
+
+## 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** | Assigned (budgeted) amount in milliunits format |  |
+| **activity** | **Integer** | Activity amount in milliunits format |  |
+| **balance** | **Integer** | Available 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_needs_whole_amount** | **Boolean** | Indicates the monthly rollover behavior for \"NEED\"-type goals. When \"true\", the goal will always ask for the target amount in the new month (\"Set Aside\"). When \"false\", previous month category funding is used (\"Refill\"). For other goal types, this field will be null. | [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** | DEPRECATED: No longer used.  Use `goal_target_date` instead. | [optional] |
+| **goal_target_date** | **Date** | The target date 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] |
+| **goal_snoozed_at** | **Time** | The date/time the goal was snoozed.  If the goal is not snoozed, this will be null. | [optional] |
+| **deleted** | **Boolean** | Whether or not the category has been deleted.  Deleted categories will only be included in delta requests. |  |
+

data/docs/ExistingCategory.md

@@ -7,6 +7,7 @@
 | **name** | **String** |  | [optional] |
 | **note** | **String** |  | [optional] |
 | **category_group_id** | **String** |  | [optional] |
-| **goal_target** | **Integer** | The goal target amount in milliunits format.  If value is specified and goal has not already been configured for category, a monthly 'Needed for Spending' goal will be created for the category with this target amount. | [optional] |
+| **goal_target** | **Integer** | The goal target amount in milliunits format.  If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount.  If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories. | [optional] |
 | **goal_target_date** | **Date** | The goal target date in ISO format (e.g. 2016-12-01). | [optional] |
+| **goal_needs_whole_amount** | **Boolean** | Whether the goal requires the full target amount each period. Only supported for 'NEED' goals. When true, the goal is configured as 'Set aside another...'. When false, the goal is configured as 'Refill up to...'. | [optional] |
 

data/docs/HybridTransaction.md

@@ -23,6 +23,8 @@
 | **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. |  |
+| **amount_formatted** | **String** | The transaction amount formatted in the plan's currency format | [optional] |
+| **amount_currency** | **Float** | The transaction amount as a decimal currency amount | [optional] |
 | **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** |  |  |

data/docs/MoneyMovement.md

@@ -13,4 +13,6 @@
 | **from_category_id** | **String** | The id of the category the money was moved from | [optional] |
 | **to_category_id** | **String** | The id of the category the money was moved to | [optional] |
 | **amount** | **Integer** | The amount of the money movement in milliunits format |  |
+| **amount_formatted** | **String** | The money movement amount formatted in the plan's currency format | [optional] |
+| **amount_currency** | **Float** | The money movement amount as a decimal currency amount | [optional] |
 

data/docs/MoneyMovementBase.md

@@ -0,0 +1,16 @@
+# YNAB::MoneyMovementBase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **month** | **Date** | The month of the money movement in ISO format (e.g. 2024-01-01) | [optional] |
+| **moved_at** | **Time** | The date/time the money movement was processed on the server in ISO format (e.g. 2024-01-01T12:00:00Z) | [optional] |
+| **note** | **String** |  | [optional] |
+| **money_movement_group_id** | **String** | The id of the money movement group this movement belongs to | [optional] |
+| **performed_by_user_id** | **String** | The id of the user who performed the money movement | [optional] |
+| **from_category_id** | **String** | The id of the category the money was moved from | [optional] |
+| **to_category_id** | **String** | The id of the category the money was moved to | [optional] |
+| **amount** | **Integer** | The amount of the money movement in milliunits format |  |
+

data/docs/MonthDetail.md

@@ -12,5 +12,13 @@
 | **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. |  |
+| **income_formatted** | **String** | The total income formatted in the plan's currency format | [optional] |
+| **income_currency** | **Float** | The total income as a decimal currency amount | [optional] |
+| **budgeted_formatted** | **String** | The total amount assigned formatted in the plan's currency format | [optional] |
+| **budgeted_currency** | **Float** | The total amount assigned as a decimal currency amount | [optional] |
+| **activity_formatted** | **String** | The total activity amount formatted in the plan's currency format | [optional] |
+| **activity_currency** | **Float** | The total activity amount as a decimal currency amount | [optional] |
+| **to_be_budgeted_formatted** | **String** | The available amount for 'Ready to Assign' formatted in the plan's currency format | [optional] |
+| **to_be_budgeted_currency** | **Float** | The available amount for 'Ready to Assign' as a decimal currency amount | [optional] |
 | **categories** | [**Array<Category>**](Category.md) | The plan month categories.  Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. |  |
 

data/docs/MonthDetailBase.md

@@ -0,0 +1,16 @@
+# YNAB::MonthDetailBase
+
+## 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 assigned (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<CategoryBase>**](CategoryBase.md) | The plan month categories.  Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. |  |
+

data/docs/MonthSummary.md

@@ -12,4 +12,12 @@
 | **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. |  |
+| **income_formatted** | **String** | The total income formatted in the plan's currency format | [optional] |
+| **income_currency** | **Float** | The total income as a decimal currency amount | [optional] |
+| **budgeted_formatted** | **String** | The total amount assigned formatted in the plan's currency format | [optional] |
+| **budgeted_currency** | **Float** | The total amount assigned as a decimal currency amount | [optional] |
+| **activity_formatted** | **String** | The total activity amount formatted in the plan's currency format | [optional] |
+| **activity_currency** | **Float** | The total activity amount as a decimal currency amount | [optional] |
+| **to_be_budgeted_formatted** | **String** | The available amount for 'Ready to Assign' formatted in the plan's currency format | [optional] |
+| **to_be_budgeted_currency** | **Float** | The available amount for 'Ready to Assign' as a decimal currency amount | [optional] |
 

data/docs/MonthSummaryBase.md

@@ -0,0 +1,15 @@
+# YNAB::MonthSummaryBase
+
+## 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 assigned (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/NewCategory.md

@@ -7,6 +7,7 @@
 | **name** | **String** |  | [optional] |
 | **note** | **String** |  | [optional] |
 | **category_group_id** | **String** |  | [optional] |
-| **goal_target** | **Integer** | The goal target amount in milliunits format.  If value is specified and goal has not already been configured for category, a monthly 'Needed for Spending' goal will be created for the category with this target amount. | [optional] |
+| **goal_target** | **Integer** | The goal target amount in milliunits format.  If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount.  If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories. | [optional] |
 | **goal_target_date** | **Date** | The goal target date in ISO format (e.g. 2016-12-01). | [optional] |
+| **goal_needs_whole_amount** | **Boolean** | Whether the goal requires the full target amount each period. Only supported for 'NEED' goals. When true, the goal is configured as 'Set aside another...'. When false, the goal is configured as 'Refill up to...'. | [optional] |
 

data/docs/PayeesApi.md

@@ -4,11 +4,32 @@ All URIs are relative to *https://api.ynab.com/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**create_payee**](PayeesApi.md#create_payee) | **POST** /plans/{plan_id}/payees | Create a payee |
 | [**get_payee_by_id**](PayeesApi.md#get_payee_by_id) | **GET** /plans/{plan_id}/payees/{payee_id} | Get a payee |
 | [**get_payees**](PayeesApi.md#get_payees) | **GET** /plans/{plan_id}/payees | Get all payees |
 | [**update_payee**](PayeesApi.md#update_payee) | **PATCH** /plans/{plan_id}/payees/{payee_id} | Update a payee |
 
 
+## create_payee
+
+> <SavePayeeResponse> create_payee(plan_id, data)
+
+Create a payee
+
+Creates a new payee
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
+| **data** | [**PostPayeeWrapper**](PostPayeeWrapper.md) | The payee to create |  |
+
+### Return type
+
+[**SavePayeeResponse**](SavePayeeResponse.md)
+
+
 ## get_payee_by_id
 
 > <PayeeResponse> get_payee_by_id(plan_id, payee_id)

data/docs/PlanDetail.md

@@ -11,14 +11,14 @@
 | **last_month** | **Date** | The latest plan month | [optional] |
 | **date_format** | [**DateFormat**](DateFormat.md) |  | [optional] |
 | **currency_format** | [**CurrencyFormat**](CurrencyFormat.md) |  | [optional] |
-| **accounts** | [**Array<Account>**](Account.md) |  | [optional] |
+| **accounts** | [**Array<AccountBase>**](AccountBase.md) |  | [optional] |
 | **payees** | [**Array<Payee>**](Payee.md) |  | [optional] |
 | **payee_locations** | [**Array<PayeeLocation>**](PayeeLocation.md) |  | [optional] |
 | **category_groups** | [**Array<CategoryGroup>**](CategoryGroup.md) |  | [optional] |
-| **categories** | [**Array<Category>**](Category.md) |  | [optional] |
-| **months** | [**Array<MonthDetail>**](MonthDetail.md) |  | [optional] |
-| **transactions** | [**Array<TransactionSummary>**](TransactionSummary.md) |  | [optional] |
-| **subtransactions** | [**Array<SubTransaction>**](SubTransaction.md) |  | [optional] |
-| **scheduled_transactions** | [**Array<ScheduledTransactionSummary>**](ScheduledTransactionSummary.md) |  | [optional] |
-| **scheduled_subtransactions** | [**Array<ScheduledSubTransaction>**](ScheduledSubTransaction.md) |  | [optional] |
+| **categories** | [**Array<CategoryBase>**](CategoryBase.md) |  | [optional] |
+| **months** | [**Array<MonthDetailBase>**](MonthDetailBase.md) |  | [optional] |
+| **transactions** | [**Array<TransactionSummaryBase>**](TransactionSummaryBase.md) |  | [optional] |
+| **subtransactions** | [**Array<SubTransactionBase>**](SubTransactionBase.md) |  | [optional] |
+| **scheduled_transactions** | [**Array<ScheduledTransactionSummaryBase>**](ScheduledTransactionSummaryBase.md) |  | [optional] |
+| **scheduled_subtransactions** | [**Array<ScheduledSubTransactionBase>**](ScheduledSubTransactionBase.md) |  | [optional] |
 

data/docs/PostPayee.md

@@ -0,0 +1,8 @@
+# YNAB::PostPayee
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the payee. |  |
+

data/docs/PostPayeeWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::PostPayeeWrapper
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payee** | [**PostPayee**](PostPayee.md) |  |  |
+

data/docs/SaveAccount.md

@@ -5,6 +5,6 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the account |  |
-| **type** | [**AccountType**](AccountType.md) |  |  |
+| **type** | [**SaveAccountType**](SaveAccountType.md) |  |  |
 | **balance** | **Integer** | The current balance of the account in milliunits format |  |
 

data/docs/SaveAccountType.md

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

data/docs/SaveCategory.md

@@ -7,6 +7,7 @@
 | **name** | **String** |  | [optional] |
 | **note** | **String** |  | [optional] |
 | **category_group_id** | **String** |  | [optional] |
-| **goal_target** | **Integer** | The goal target amount in milliunits format.  If value is specified and goal has not already been configured for category, a monthly 'Needed for Spending' goal will be created for the category with this target amount. | [optional] |
+| **goal_target** | **Integer** | The goal target amount in milliunits format.  If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount.  If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories. | [optional] |
 | **goal_target_date** | **Date** | The goal target date in ISO format (e.g. 2016-12-01). | [optional] |
+| **goal_needs_whole_amount** | **Boolean** | Whether the goal requires the full target amount each period. Only supported for 'NEED' goals. When true, the goal is configured as 'Set aside another...'. When false, the goal is configured as 'Refill up to...'. | [optional] |
 

data/docs/SavePayee.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | The name of the payee. The name must be a maximum of 500 characters. | [optional] |
+| **name** | **String** | The name of the payee. | [optional] |
 

data/docs/ScheduledSubTransaction.md

@@ -14,4 +14,6 @@
 | **category_name** | **String** |  | [optional] |
 | **transfer_account_id** | **String** | If a transfer, the account_id which the scheduled subtransaction transfers to | [optional] |
 | **deleted** | **Boolean** | Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests. |  |
+| **amount_formatted** | **String** | The scheduled subtransaction amount formatted in the plan's currency format | [optional] |
+| **amount_currency** | **Float** | The scheduled subtransaction amount as a decimal currency amount | [optional] |
 

data/docs/ScheduledSubTransactionBase.md

@@ -0,0 +1,17 @@
+# YNAB::ScheduledSubTransactionBase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **scheduled_transaction_id** | **String** |  |  |
+| **amount** | **Integer** | The scheduled subtransaction amount in milliunits format |  |
+| **memo** | **String** |  | [optional] |
+| **payee_id** | **String** |  | [optional] |
+| **payee_name** | **String** |  | [optional] |
+| **category_id** | **String** |  | [optional] |
+| **category_name** | **String** |  | [optional] |
+| **transfer_account_id** | **String** | If a transfer, the account_id which the scheduled subtransaction transfers to | [optional] |
+| **deleted** | **Boolean** | Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests. |  |
+

data/docs/ScheduledTransactionDetail.md

@@ -17,6 +17,8 @@
 | **category_id** | **String** |  | [optional] |
 | **transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to | [optional] |
 | **deleted** | **Boolean** | Whether or not the scheduled transaction has been deleted.  Deleted scheduled transactions will only be included in delta requests. |  |
+| **amount_formatted** | **String** | The scheduled transaction amount formatted in the plan's currency format | [optional] |
+| **amount_currency** | **Float** | The scheduled transaction amount as a decimal currency amount | [optional] |
 | **account_name** | **String** |  |  |
 | **payee_name** | **String** |  | [optional] |
 | **category_name** | **String** | The name of the category.  If a split scheduled transaction, this will be 'Split'. | [optional] |

data/docs/ScheduledTransactionSummary.md

@@ -17,4 +17,6 @@
 | **category_id** | **String** |  | [optional] |
 | **transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to | [optional] |
 | **deleted** | **Boolean** | Whether or not the scheduled transaction has been deleted.  Deleted scheduled transactions will only be included in delta requests. |  |
+| **amount_formatted** | **String** | The scheduled transaction amount formatted in the plan's currency format | [optional] |
+| **amount_currency** | **Float** | The scheduled transaction amount as a decimal currency amount | [optional] |
 

data/docs/ScheduledTransactionSummaryBase.md

@@ -0,0 +1,20 @@
+# YNAB::ScheduledTransactionSummaryBase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **date_first** | **Date** | The first date for which the Scheduled Transaction was scheduled. |  |
+| **date_next** | **Date** | The next date for which the Scheduled Transaction is scheduled. |  |
+| **frequency** | **String** |  |  |
+| **amount** | **Integer** | The scheduled transaction amount in milliunits format |  |
+| **memo** | **String** |  | [optional] |
+| **flag_color** | [**TransactionFlagColor**](TransactionFlagColor.md) |  | [optional] |
+| **flag_name** | **String** | The customized name of a transaction flag | [optional] |
+| **account_id** | **String** |  |  |
+| **payee_id** | **String** |  | [optional] |
+| **category_id** | **String** |  | [optional] |
+| **transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to | [optional] |
+| **deleted** | **Boolean** | Whether or not the scheduled transaction has been deleted.  Deleted scheduled transactions will only be included in delta requests. |  |
+

data/docs/SubTransaction.md

@@ -15,4 +15,6 @@
 | **transfer_account_id** | **String** | If a transfer, the account_id which the subtransaction transfers to | [optional] |
 | **transfer_transaction_id** | **String** | If a transfer, the id of transaction on the other side of the transfer | [optional] |
 | **deleted** | **Boolean** | Whether or not the subtransaction has been deleted.  Deleted subtransactions will only be included in delta requests. |  |
+| **amount_formatted** | **String** | The subtransaction amount formatted in the plan's currency format | [optional] |
+| **amount_currency** | **Float** | The subtransaction amount as a decimal currency amount | [optional] |
 

data/docs/SubTransactionBase.md

@@ -0,0 +1,18 @@
+# YNAB::SubTransactionBase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **transaction_id** | **String** |  |  |
+| **amount** | **Integer** | The subtransaction amount in milliunits format |  |
+| **memo** | **String** |  | [optional] |
+| **payee_id** | **String** |  | [optional] |
+| **payee_name** | **String** |  | [optional] |
+| **category_id** | **String** |  | [optional] |
+| **category_name** | **String** |  | [optional] |
+| **transfer_account_id** | **String** | If a transfer, the account_id which the subtransaction transfers to | [optional] |
+| **transfer_transaction_id** | **String** | If a transfer, the id of transaction on the other side of the transfer | [optional] |
+| **deleted** | **Boolean** | Whether or not the subtransaction has been deleted.  Deleted subtransactions will only be included in delta requests. |  |
+

data/docs/TransactionDetail.md

@@ -23,6 +23,8 @@
 | **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. |  |
+| **amount_formatted** | **String** | The transaction amount formatted in the plan's currency format | [optional] |
+| **amount_currency** | **Float** | The transaction amount as a decimal currency amount | [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/TransactionSummary.md

@@ -23,4 +23,6 @@
 | **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. |  |
+| **amount_formatted** | **String** | The transaction amount formatted in the plan's currency format | [optional] |
+| **amount_currency** | **Float** | The transaction amount as a decimal currency amount | [optional] |
 

data/docs/TransactionSummaryBase.md

@@ -0,0 +1,26 @@
+# YNAB::TransactionSummaryBase
+
+## 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** | [**TransactionClearedStatus**](TransactionClearedStatus.md) |  |  |
+| **approved** | **Boolean** | Whether or not the transaction is approved |  |
+| **flag_color** | [**TransactionFlagColor**](TransactionFlagColor.md) |  | [optional] |
+| **flag_name** | **String** | The customized name of a 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. |  |
+

data/lib/ynab/api/payees_api.rb

@@ -15,6 +15,80 @@ module YNAB
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Create a payee
+    # Creates a new payee
+    # @param plan_id [String] 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).
+    # @param data [PostPayeeWrapper] The payee to create
+    # @param [Hash] opts the optional parameters
+    # @return [SavePayeeResponse]
+    def create_payee(plan_id, data, opts = {})
+      data, _status_code, _headers = create_payee_with_http_info(plan_id, data, opts)
+      data
+    end
+
+    # Create a payee
+    # Creates a new payee
+    # @param plan_id [String] 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).
+    # @param data [PostPayeeWrapper] The payee to create
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SavePayeeResponse, Integer, Hash)>] SavePayeeResponse data, response status code and response headers
+    def create_payee_with_http_info(plan_id, data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayeesApi.create_payee ...'
+      end
+      # verify the required parameter 'plan_id' is set
+      if @api_client.config.client_side_validation && plan_id.nil?
+        fail ArgumentError, "Missing the required parameter 'plan_id' when calling PayeesApi.create_payee"
+      end
+      # verify the required parameter 'data' is set
+      if @api_client.config.client_side_validation && data.nil?
+        fail ArgumentError, "Missing the required parameter 'data' when calling PayeesApi.create_payee"
+      end
+      # resource path
+      local_var_path = '/plans/{plan_id}/payees'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SavePayeeResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"PayeesApi.create_payee",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayeesApi#create_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a payee
     # Returns a single payee
     # @param plan_id [String] The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).