ynab 3.9.0 → 4.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +1 -0
- data/Gemfile.lock +3 -1
- data/README.md +47 -39
- data/Rakefile +1 -1
- data/docs/Account.md +3 -3
- data/docs/AccountsApi.md +12 -12
- data/docs/CategoriesApi.md +89 -25
- data/docs/Category.md +4 -3
- data/docs/CategoryGroupWithCategories.md +1 -1
- data/docs/ExistingCategory.md +12 -0
- data/docs/MoneyMovement.md +16 -0
- data/docs/MoneyMovementGroup.md +12 -0
- data/docs/MoneyMovementGroupsResponse.md +8 -0
- data/docs/MoneyMovementGroupsResponseData.md +9 -0
- data/docs/MoneyMovementsApi.md +89 -0
- data/docs/{BudgetSettingsResponse.md → MoneyMovementsResponse.md} +2 -2
- data/docs/MoneyMovementsResponseData.md +9 -0
- data/docs/MonthDetail.md +2 -2
- data/docs/MonthSummary.md +1 -1
- data/docs/MonthsApi.md +13 -13
- data/docs/NewCategory.md +12 -0
- data/docs/PatchCategoryGroupWrapper.md +8 -0
- data/docs/PatchCategoryWrapper.md +1 -1
- data/docs/PayeeLocationsApi.md +12 -12
- data/docs/PayeesApi.md +11 -11
- data/docs/{BudgetDetail.md → PlanDetail.md} +4 -4
- data/docs/PlanDetailResponse.md +8 -0
- data/docs/{BudgetDetailResponseData.md → PlanDetailResponseData.md} +2 -2
- data/docs/{BudgetSettings.md → PlanSettings.md} +1 -1
- data/docs/{BudgetDetailResponse.md → PlanSettingsResponse.md} +2 -2
- data/docs/PlanSettingsResponseData.md +8 -0
- data/docs/PlanSummary.md +15 -0
- data/docs/PlanSummaryResponse.md +8 -0
- data/docs/PlanSummaryResponseData.md +9 -0
- data/docs/PlansApi.md +68 -0
- data/docs/PostCategoryGroupWrapper.md +8 -0
- data/docs/PostCategoryWrapper.md +8 -0
- data/docs/SaveCategory.md +2 -1
- data/docs/SaveCategoryGroup.md +8 -0
- data/docs/SaveCategoryGroupResponse.md +8 -0
- data/docs/SaveCategoryGroupResponseData.md +9 -0
- data/docs/SaveMonthCategory.md +1 -1
- data/docs/ScheduledTransactionsApi.md +20 -20
- data/docs/TransactionsApi.md +48 -48
- data/docs/UserApi.md +2 -2
- data/examples/category-balance.rb +2 -2
- data/examples/create-multiple-transactions.rb +2 -2
- data/examples/create-transaction.rb +2 -2
- data/examples/{budget-list.rb → plan-list.rb} +6 -6
- data/examples/{budget-month.rb → plan-month.rb} +9 -10
- data/examples/update-category-budgeted.rb +2 -2
- data/examples/update-multiple-transactions.rb +3 -3
- data/lib/ynab/api/accounts_api.rb +33 -34
- data/lib/ynab/api/categories_api.rb +293 -66
- data/lib/ynab/api/deprecated_api.rb +11 -11
- data/lib/ynab/api/money_movements_api.rb +282 -0
- data/lib/ynab/api/months_api.rb +35 -36
- data/lib/ynab/api/payee_locations_api.rb +33 -34
- data/lib/ynab/api/payees_api.rb +31 -32
- data/lib/ynab/api/{budgets_api.rb → plans_api.rb} +54 -55
- data/lib/ynab/api/scheduled_transactions_api.rb +55 -56
- data/lib/ynab/api/transactions_api.rb +130 -131
- data/lib/ynab/api/user_api.rb +2 -3
- data/lib/ynab/api_client.rb +0 -2
- data/lib/ynab/api_model_base.rb +85 -0
- data/lib/ynab/models/account.rb +4 -81
- data/lib/ynab/models/account_response.rb +1 -75
- data/lib/ynab/models/account_response_data.rb +1 -75
- data/lib/ynab/models/accounts_response.rb +1 -75
- data/lib/ynab/models/accounts_response_data.rb +1 -75
- data/lib/ynab/models/bulk_response.rb +1 -75
- data/lib/ynab/models/bulk_response_data.rb +1 -75
- data/lib/ynab/models/bulk_response_data_bulk.rb +1 -75
- data/lib/ynab/models/bulk_transactions.rb +1 -75
- data/lib/ynab/models/categories_response.rb +1 -75
- data/lib/ynab/models/categories_response_data.rb +1 -75
- data/lib/ynab/models/category.rb +16 -79
- data/lib/ynab/models/category_group.rb +1 -75
- data/lib/ynab/models/category_group_with_categories.rb +2 -76
- data/lib/ynab/models/category_response.rb +1 -75
- data/lib/ynab/models/category_response_data.rb +1 -75
- data/lib/ynab/models/currency_format.rb +2 -76
- data/lib/ynab/models/date_format.rb +2 -76
- data/lib/ynab/models/error_detail.rb +1 -75
- data/lib/ynab/models/error_response.rb +1 -75
- data/lib/ynab/models/existing_category.rb +180 -0
- data/lib/ynab/models/existing_transaction.rb +1 -79
- data/lib/ynab/models/hybrid_transaction.rb +1 -85
- data/lib/ynab/models/hybrid_transactions_response.rb +1 -75
- data/lib/ynab/models/hybrid_transactions_response_data.rb +1 -75
- data/lib/ynab/models/money_movement.rb +223 -0
- data/lib/ynab/models/money_movement_group.rb +179 -0
- data/lib/ynab/models/{budget_summary_response.rb → money_movement_groups_response.rb} +4 -78
- data/lib/ynab/models/money_movement_groups_response_data.rb +149 -0
- data/lib/ynab/models/{budget_settings_response.rb → money_movements_response.rb} +4 -78
- data/lib/ynab/models/money_movements_response_data.rb +149 -0
- data/lib/ynab/models/month_detail.rb +3 -79
- data/lib/ynab/models/month_detail_response.rb +1 -75
- data/lib/ynab/models/month_detail_response_data.rb +1 -75
- data/lib/ynab/models/month_summaries_response.rb +1 -75
- data/lib/ynab/models/month_summaries_response_data.rb +1 -75
- data/lib/ynab/models/month_summary.rb +2 -76
- data/lib/ynab/models/new_category.rb +180 -0
- data/lib/ynab/models/new_transaction.rb +1 -79
- data/lib/ynab/models/patch_category_group_wrapper.rb +136 -0
- data/lib/ynab/models/patch_category_wrapper.rb +2 -76
- data/lib/ynab/models/patch_month_category_wrapper.rb +1 -75
- data/lib/ynab/models/patch_payee_wrapper.rb +1 -75
- data/lib/ynab/models/patch_transactions_wrapper.rb +1 -75
- data/lib/ynab/models/payee.rb +1 -75
- data/lib/ynab/models/payee_location.rb +1 -75
- data/lib/ynab/models/payee_location_response.rb +1 -75
- data/lib/ynab/models/payee_location_response_data.rb +1 -75
- data/lib/ynab/models/payee_locations_response.rb +1 -75
- data/lib/ynab/models/payee_locations_response_data.rb +1 -75
- data/lib/ynab/models/payee_response.rb +1 -75
- data/lib/ynab/models/payee_response_data.rb +1 -75
- data/lib/ynab/models/payees_response.rb +1 -75
- data/lib/ynab/models/payees_response_data.rb +1 -75
- data/lib/ynab/models/{budget_detail.rb → plan_detail.rb} +7 -83
- data/lib/ynab/models/plan_detail_response.rb +136 -0
- data/lib/ynab/models/{budget_detail_response_data.rb → plan_detail_response_data.rb} +4 -78
- data/lib/ynab/models/{budget_settings.rb → plan_settings.rb} +5 -79
- data/lib/ynab/models/{budget_detail_response.rb → plan_settings_response.rb} +4 -78
- data/lib/ynab/models/{budget_settings_response_data.rb → plan_settings_response_data.rb} +4 -78
- data/lib/ynab/models/{budget_summary.rb → plan_summary.rb} +7 -83
- data/lib/ynab/models/plan_summary_response.rb +136 -0
- data/lib/ynab/models/{budget_summary_response_data.rb → plan_summary_response_data.rb} +5 -79
- data/lib/ynab/models/post_account_wrapper.rb +1 -75
- data/lib/ynab/models/post_category_group_wrapper.rb +136 -0
- data/lib/ynab/models/post_category_wrapper.rb +136 -0
- data/lib/ynab/models/post_scheduled_transaction_wrapper.rb +1 -75
- data/lib/ynab/models/post_transactions_wrapper.rb +1 -75
- data/lib/ynab/models/put_scheduled_transaction_wrapper.rb +1 -75
- data/lib/ynab/models/put_transaction_wrapper.rb +1 -75
- data/lib/ynab/models/save_account.rb +1 -75
- data/lib/ynab/models/save_category.rb +18 -81
- data/lib/ynab/models/save_category_group.rb +148 -0
- data/lib/ynab/models/save_category_group_response.rb +136 -0
- data/lib/ynab/models/save_category_group_response_data.rb +147 -0
- data/lib/ynab/models/save_category_response.rb +1 -75
- data/lib/ynab/models/save_category_response_data.rb +1 -75
- data/lib/ynab/models/save_month_category.rb +2 -76
- data/lib/ynab/models/save_payee.rb +1 -75
- data/lib/ynab/models/save_payee_response.rb +1 -75
- data/lib/ynab/models/save_payee_response_data.rb +1 -75
- data/lib/ynab/models/save_scheduled_transaction.rb +1 -75
- data/lib/ynab/models/save_sub_transaction.rb +1 -75
- data/lib/ynab/models/save_transaction_with_id_or_import_id.rb +1 -79
- data/lib/ynab/models/save_transaction_with_optional_fields.rb +1 -75
- data/lib/ynab/models/save_transactions_response.rb +1 -75
- data/lib/ynab/models/save_transactions_response_data.rb +1 -75
- data/lib/ynab/models/scheduled_sub_transaction.rb +1 -75
- data/lib/ynab/models/scheduled_transaction_detail.rb +1 -80
- data/lib/ynab/models/scheduled_transaction_response.rb +1 -75
- data/lib/ynab/models/scheduled_transaction_response_data.rb +1 -75
- data/lib/ynab/models/scheduled_transaction_summary.rb +1 -75
- data/lib/ynab/models/scheduled_transactions_response.rb +1 -75
- data/lib/ynab/models/scheduled_transactions_response_data.rb +1 -75
- data/lib/ynab/models/sub_transaction.rb +1 -75
- data/lib/ynab/models/transaction_detail.rb +1 -85
- data/lib/ynab/models/transaction_response.rb +1 -75
- data/lib/ynab/models/transaction_response_data.rb +1 -75
- data/lib/ynab/models/transaction_summary.rb +1 -75
- data/lib/ynab/models/transactions_import_response.rb +1 -75
- data/lib/ynab/models/transactions_import_response_data.rb +1 -75
- data/lib/ynab/models/transactions_response.rb +1 -75
- data/lib/ynab/models/transactions_response_data.rb +1 -75
- data/lib/ynab/models/user.rb +1 -75
- data/lib/ynab/models/user_response.rb +1 -75
- data/lib/ynab/models/user_response_data.rb +1 -75
- data/lib/ynab/overrides/transactions_api.rb +6 -6
- data/lib/ynab/version.rb +1 -1
- data/lib/ynab.rb +28 -13
- data/open_api_spec.yaml +1155 -910
- data/spec/api/accounts_spec.rb +9 -9
- data/spec/api/categories_spec.rb +9 -9
- data/spec/api/months_spec.rb +7 -7
- data/spec/api/payee_locations_spec.rb +7 -7
- data/spec/api/payees_spec.rb +7 -7
- data/spec/api/{budgets_spec.rb → plans_spec.rb} +12 -12
- data/spec/api/scheduled_transactions_spec.rb +9 -9
- data/spec/api/transactions_spec.rb +27 -27
- data/spec/fixtures/vcr_cassettes/plans.yml +49 -0
- data/spec/fixtures/vcr_cassettes/plans_unauthorized.yml +49 -0
- data/templates/gem.mustache +3 -2
- data/templates/partial_model_generic.mustache +1 -1
- data/ynab.gemspec +1 -2
- metadata +62 -27
- data/docs/BudgetSettingsResponseData.md +0 -8
- data/docs/BudgetSummary.md +0 -15
- data/docs/BudgetSummaryResponse.md +0 -8
- data/docs/BudgetSummaryResponseData.md +0 -9
- data/docs/BudgetsApi.md +0 -68
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 22a62b958f408a681c3a96215a85f8645a98be22904c3be8f4ab6b3cf1a381b7
|
|
4
|
+
data.tar.gz: d36e3cb9fe1a1df2f1b362c570b194d4e885be50b9a8355c6867c2fe9a37d4b1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 353884a6f7e09f5ed7989cc4d2f975148cc164bd7476846f85ac5b59a1ae56e79ab60cf3713c6aa8737994d194164133358fe4ab42c8833dd9033a86335246ca
|
|
7
|
+
data.tar.gz: d8a23efb4ec3c2c7826f12a7ffd64220206d50a6376af1731e458366b366d15abfb5778635c66abd55b010d317b96ad293c860a6da47c3a183674f992590caac
|
data/Gemfile
CHANGED
data/Gemfile.lock
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
ynab (3.
|
|
4
|
+
ynab (3.9.0)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
8
8
|
remote: https://rubygems.org/
|
|
9
9
|
specs:
|
|
10
|
+
base64 (0.3.0)
|
|
10
11
|
diff-lcs (1.3)
|
|
11
12
|
ethon (0.16.0)
|
|
12
13
|
ffi (>= 1.15.0)
|
|
@@ -33,6 +34,7 @@ PLATFORMS
|
|
|
33
34
|
ruby
|
|
34
35
|
|
|
35
36
|
DEPENDENCIES
|
|
37
|
+
base64
|
|
36
38
|
rake (>= 12.3.3)
|
|
37
39
|
rspec (~> 3.6, >= 3.6.0)
|
|
38
40
|
vcr (>= 3.0.3)
|
data/README.md
CHANGED
|
@@ -29,11 +29,11 @@ require 'ynab'
|
|
|
29
29
|
access_token = ENV['YNAB_ACCESS_TOKEN']
|
|
30
30
|
ynab_api = YNAB::API.new(access_token)
|
|
31
31
|
|
|
32
|
-
|
|
33
|
-
|
|
32
|
+
plan_response = ynab_api.plans.get_plans
|
|
33
|
+
plans = plan_response.data.budgets
|
|
34
34
|
|
|
35
|
-
|
|
36
|
-
puts "
|
|
35
|
+
plans.each do |plan|
|
|
36
|
+
puts "Plan Name: #{plan.name}"
|
|
37
37
|
end
|
|
38
38
|
```
|
|
39
39
|
|
|
@@ -48,40 +48,48 @@ The following methods are available in this library.
|
|
|
48
48
|
| | Method | Description |
|
|
49
49
|
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
|
|
50
50
|
| **User** | [user.get_user()](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/UserApi.md#get_user) | Returns authenticated user information |
|
|
51
|
-
| **
|
|
52
|
-
| | [
|
|
53
|
-
| | [
|
|
54
|
-
| **Accounts** | [accounts.get_accounts(
|
|
55
|
-
| | [accounts.get_account_by_id(
|
|
56
|
-
|
|
|
57
|
-
|
|
|
58
|
-
| | [categories.
|
|
59
|
-
| | [categories.
|
|
60
|
-
| | [categories.
|
|
61
|
-
|
|
|
62
|
-
| | [
|
|
63
|
-
|
|
|
64
|
-
| | [
|
|
65
|
-
|
|
|
66
|
-
|
|
|
67
|
-
| | [
|
|
68
|
-
|
|
|
69
|
-
|
|
|
70
|
-
| | [
|
|
71
|
-
|
|
|
72
|
-
| | [
|
|
73
|
-
|
|
|
74
|
-
| | [
|
|
75
|
-
| | [
|
|
76
|
-
| | [
|
|
77
|
-
|
|
|
78
|
-
| | [transactions.
|
|
79
|
-
| | [transactions.
|
|
80
|
-
|
|
|
81
|
-
| | [
|
|
82
|
-
| | [
|
|
83
|
-
| | [
|
|
84
|
-
| | [
|
|
51
|
+
| **Plans** | [plans.get_plans()](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PlansApi.md#get_plans) | Returns plans list with summary information |
|
|
52
|
+
| | [plans.get_plan_by_id(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PlansApi.md#get_plan_by_id) | Returns a single plan with all related entities |
|
|
53
|
+
| | [plans.get_plan_settings_by_id(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PlansApi.md#get_plan_settings_by_id) | Returns settings for a plan |
|
|
54
|
+
| **Accounts** | [accounts.get_accounts(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/AccountsApi.md#get_accounts) | Returns all accounts |
|
|
55
|
+
| | [accounts.get_account_by_id(plan_id, account_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/AccountsApi.md#get_account_by_id) | Returns a single account |
|
|
56
|
+
| | [accounts.create_account(plan_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/AccountsApi.md#create_account) | Creates a new account |
|
|
57
|
+
| **Categories** | [categories.get_categories(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#get_categories) | Returns all categories grouped by category group |
|
|
58
|
+
| | [categories.get_category_by_id(plan_id, category_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#get_category_by_id) | Returns a single category |
|
|
59
|
+
| | [categories.get_month_category_by_id(plan_id, month, category_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#get_month_category_by_id) | Returns a single category for a specific plan month |
|
|
60
|
+
| | [categories.create_category(plan_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#create_category) | Creates a new category |
|
|
61
|
+
| | [categories.create_category_group(plan_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#create_category_group) | Creates a new category group |
|
|
62
|
+
| | [categories.update_category(plan_id, category_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#update_category) | Updates a category |
|
|
63
|
+
| | [categories.update_category_group(plan_id, category_group_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#update_category_group) | Updates a category group |
|
|
64
|
+
| | [categories.update_month_category(plan_id, month, category_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#update_month_category) | Updates a category for a specific month |
|
|
65
|
+
| **Payees** | [payees.get_payees(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#get_payees) | Returns all payees |
|
|
66
|
+
| | [payees.get_payee_by_id(plan_id, payee_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#get_payee_by_id) | Returns a single payee |
|
|
67
|
+
| | [payees.update_payee(plan_id, payee_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#update_payee) | Updates a payee |
|
|
68
|
+
| **Payee Locations** | [payee_locations.get_payee_locations(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_locations) | Returns all payee locations |
|
|
69
|
+
| | [payee_locations.get_payee_location_by_id(plan_id, payee_location_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_location_by_id) | Returns a single payee location |
|
|
70
|
+
| | [payee_locations.get_payee_locations_by_payee(plan_id, payee_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_locations_by_payee) | Returns all payee locations for the specified payee |
|
|
71
|
+
| **Months** | [months.get_plan_months(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MonthsApi.md#get_plan_months) | Returns all plan months |
|
|
72
|
+
| | [months.get_plan_month(plan_id, month)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MonthsApi.md#get_plan_month) | Returns a single plan month |
|
|
73
|
+
| **Money Movements** | [money_movements.get_money_movements(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MoneyMovementsApi.md#get_money_movements) | Returns all money movements |
|
|
74
|
+
| | [money_movements.get_money_movements_by_month(plan_id, month)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MoneyMovementsApi.md#get_money_movements_by_month) | Returns all money movements for a specific month |
|
|
75
|
+
| | [money_movements.get_money_movement_groups(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MoneyMovementsApi.md#get_money_movement_groups) | Returns all money movement groups |
|
|
76
|
+
| | [money_movements.get_money_movement_groups_by_month(plan_id, month)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MoneyMovementsApi.md#get_money_movement_groups_by_month) | Returns all money movement groups for a specific month|
|
|
77
|
+
| **Transactions** | [transactions.get_transactions(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions) | Returns plan transactions |
|
|
78
|
+
| | [transactions.get_transactions_by_account(plan_id, account_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions_by_account) | Returns all transactions for a specified account |
|
|
79
|
+
| | [transactions.get_transactions_by_category(plan_id, category_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions_by_category) | Returns all transactions for a specified category |
|
|
80
|
+
| | [transactions.get_transactions_by_payee(plan_id, payee_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions_by_payee) | Returns all transactions for a specified payee |
|
|
81
|
+
| | [transactions.get_transactions_by_month(plan_id, month)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions_by_month) | Returns all transactions for a specified month |
|
|
82
|
+
| | [transactions.get_transaction_by_id(plan_id, transaction_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transaction_by_id) | Returns a single transaction |
|
|
83
|
+
| | [transactions.create_transaction(plan_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#create_transaction) | Creates a single transaction or multiple transactions |
|
|
84
|
+
| | [transactions.update_transaction(plan_id, transaction_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#update_transaction) | Updates a single transaction |
|
|
85
|
+
| | [transactions.update_transactions(plan_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#update_transactions) | Updates multiple transactions |
|
|
86
|
+
| | [transactions.delete_transaction(plan_id, transaction_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#delete_transaction) | Deletes a single transaction |
|
|
87
|
+
| | [transactions.import_transactions(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#import_transactions) | Imports transactions |
|
|
88
|
+
| **Scheduled Transactions** | [scheduled_transactions.get_scheduled_transactions(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#get_scheduled_transactions) | Returns all scheduled transactions |
|
|
89
|
+
| | [scheduled_transactions.get_scheduled_transaction_by_id(plan_id, scheduled_transaction_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | Returns a single scheduled transaction |
|
|
90
|
+
| | [scheduled_transactions.create_scheduled_transaction(plan_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#create_scheduled_transaction) | Creates a single scheduled transaction |
|
|
91
|
+
| | [scheduled_transactions.update_scheduled_transaction(plan_id, scheduled_transaction_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#update_scheduled_transaction) | Updates a single scheduled transaction |
|
|
92
|
+
| | [scheduled_transactions.delete_scheduled_transaction(plan_id, scheduled_transaction_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#delete_scheduled_transaction) | Deletes a single scheduled transaction |
|
|
85
93
|
|
|
86
94
|
## Versioning
|
|
87
95
|
|
|
@@ -89,6 +97,6 @@ The version of this client is defined in the `ynab.gemspec` file and follows [se
|
|
|
89
97
|
|
|
90
98
|
## License
|
|
91
99
|
|
|
92
|
-
Copyright (c) 2024
|
|
100
|
+
Copyright (c) 2024 YNAB
|
|
93
101
|
|
|
94
102
|
Licensed under the Apache-2.0 license
|
data/Rakefile
CHANGED
data/docs/Account.md
CHANGED
|
@@ -7,17 +7,17 @@
|
|
|
7
7
|
| **id** | **String** | | |
|
|
8
8
|
| **name** | **String** | | |
|
|
9
9
|
| **type** | [**AccountType**](AccountType.md) | | |
|
|
10
|
-
| **on_budget** | **Boolean** | Whether this account is on budget or not | |
|
|
10
|
+
| **on_budget** | **Boolean** | Whether this account is \"on budget\" or not | |
|
|
11
11
|
| **closed** | **Boolean** | Whether this account is closed or not | |
|
|
12
12
|
| **note** | **String** | | [optional] |
|
|
13
|
-
| **balance** | **Integer** | The current balance of the account in milliunits format | |
|
|
13
|
+
| **balance** | **Integer** | The current available balance of the account in milliunits format | |
|
|
14
14
|
| **cleared_balance** | **Integer** | The current cleared balance of the account in milliunits format | |
|
|
15
15
|
| **uncleared_balance** | **Integer** | The current uncleared balance of the account in milliunits format | |
|
|
16
16
|
| **transfer_payee_id** | **String** | The payee id which should be used when transferring to this account | |
|
|
17
17
|
| **direct_import_linked** | **Boolean** | Whether or not the account is linked to a financial institution for automatic transaction import. | [optional] |
|
|
18
18
|
| **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] |
|
|
19
19
|
| **last_reconciled_at** | **Time** | A date/time specifying when the account was last reconciled. | [optional] |
|
|
20
|
-
| **debt_original_balance** | **Integer** |
|
|
20
|
+
| **debt_original_balance** | **Integer** | This field is deprecated and will always be null. | [optional] |
|
|
21
21
|
| **debt_interest_rates** | **Hash<String, Integer>** | | [optional] |
|
|
22
22
|
| **debt_minimum_payments** | **Hash<String, Integer>** | | [optional] |
|
|
23
23
|
| **debt_escrow_amounts** | **Hash<String, Integer>** | | [optional] |
|
data/docs/AccountsApi.md
CHANGED
|
@@ -4,16 +4,16 @@ All URIs are relative to *https://api.ynab.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**create_account**](AccountsApi.md#create_account) | **POST** /budgets/{
|
|
8
|
-
| [**get_account_by_id**](AccountsApi.md#get_account_by_id) | **GET** /budgets/{
|
|
9
|
-
| [**get_accounts**](AccountsApi.md#get_accounts) | **GET** /budgets/{
|
|
7
|
+
| [**create_account**](AccountsApi.md#create_account) | **POST** /budgets/{plan_id}/accounts | Create an account |
|
|
8
|
+
| [**get_account_by_id**](AccountsApi.md#get_account_by_id) | **GET** /budgets/{plan_id}/accounts/{account_id} | Get an account |
|
|
9
|
+
| [**get_accounts**](AccountsApi.md#get_accounts) | **GET** /budgets/{plan_id}/accounts | Get all accounts |
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
## create_account
|
|
13
13
|
|
|
14
|
-
> <AccountResponse> create_account(
|
|
14
|
+
> <AccountResponse> create_account(plan_id, data)
|
|
15
15
|
|
|
16
|
-
Create
|
|
16
|
+
Create an account
|
|
17
17
|
|
|
18
18
|
Creates a new account
|
|
19
19
|
|
|
@@ -21,7 +21,7 @@ Creates a new account
|
|
|
21
21
|
|
|
22
22
|
| Name | Type | Description | Notes |
|
|
23
23
|
| ---- | ---- | ----------- | ----- |
|
|
24
|
-
| **
|
|
24
|
+
| **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) | |
|
|
25
25
|
| **data** | [**PostAccountWrapper**](PostAccountWrapper.md) | The account to create. | |
|
|
26
26
|
|
|
27
27
|
### Return type
|
|
@@ -31,9 +31,9 @@ Creates a new account
|
|
|
31
31
|
|
|
32
32
|
## get_account_by_id
|
|
33
33
|
|
|
34
|
-
> <AccountResponse> get_account_by_id(
|
|
34
|
+
> <AccountResponse> get_account_by_id(plan_id, account_id)
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
Get an account
|
|
37
37
|
|
|
38
38
|
Returns a single account
|
|
39
39
|
|
|
@@ -41,7 +41,7 @@ Returns a single account
|
|
|
41
41
|
|
|
42
42
|
| Name | Type | Description | Notes |
|
|
43
43
|
| ---- | ---- | ----------- | ----- |
|
|
44
|
-
| **
|
|
44
|
+
| **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). | |
|
|
45
45
|
| **account_id** | **String** | The id of the account | |
|
|
46
46
|
|
|
47
47
|
### Return type
|
|
@@ -51,9 +51,9 @@ Returns a single account
|
|
|
51
51
|
|
|
52
52
|
## get_accounts
|
|
53
53
|
|
|
54
|
-
> <AccountsResponse> get_accounts(
|
|
54
|
+
> <AccountsResponse> get_accounts(plan_id, opts)
|
|
55
55
|
|
|
56
|
-
|
|
56
|
+
Get all accounts
|
|
57
57
|
|
|
58
58
|
Returns all accounts
|
|
59
59
|
|
|
@@ -61,7 +61,7 @@ Returns all accounts
|
|
|
61
61
|
|
|
62
62
|
| Name | Type | Description | Notes |
|
|
63
63
|
| ---- | ---- | ----------- | ----- |
|
|
64
|
-
| **
|
|
64
|
+
| **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). | |
|
|
65
65
|
| **last_knowledge_of_server** | **Integer** | The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. | [optional] |
|
|
66
66
|
|
|
67
67
|
### Return type
|
data/docs/CategoriesApi.md
CHANGED
|
@@ -4,26 +4,69 @@ All URIs are relative to *https://api.ynab.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
7
|
+
| [**create_category**](CategoriesApi.md#create_category) | **POST** /budgets/{plan_id}/categories | Create a category |
|
|
8
|
+
| [**create_category_group**](CategoriesApi.md#create_category_group) | **POST** /budgets/{plan_id}/category_groups | Create a category group |
|
|
9
|
+
| [**get_categories**](CategoriesApi.md#get_categories) | **GET** /budgets/{plan_id}/categories | Get all categories |
|
|
10
|
+
| [**get_category_by_id**](CategoriesApi.md#get_category_by_id) | **GET** /budgets/{plan_id}/categories/{category_id} | Get a category |
|
|
11
|
+
| [**get_month_category_by_id**](CategoriesApi.md#get_month_category_by_id) | **GET** /budgets/{plan_id}/months/{month}/categories/{category_id} | Get a category for a specific plan month |
|
|
12
|
+
| [**update_category**](CategoriesApi.md#update_category) | **PATCH** /budgets/{plan_id}/categories/{category_id} | Update a category |
|
|
13
|
+
| [**update_category_group**](CategoriesApi.md#update_category_group) | **PATCH** /budgets/{plan_id}/category_groups/{category_group_id} | Update a category group |
|
|
14
|
+
| [**update_month_category**](CategoriesApi.md#update_month_category) | **PATCH** /budgets/{plan_id}/months/{month}/categories/{category_id} | Update a category for a specific month |
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## create_category
|
|
18
|
+
|
|
19
|
+
> <SaveCategoryResponse> create_category(plan_id, data)
|
|
20
|
+
|
|
21
|
+
Create a category
|
|
22
|
+
|
|
23
|
+
Creates a new category
|
|
24
|
+
|
|
25
|
+
### Parameters
|
|
26
|
+
|
|
27
|
+
| Name | Type | Description | Notes |
|
|
28
|
+
| ---- | ---- | ----------- | ----- |
|
|
29
|
+
| **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) | |
|
|
30
|
+
| **data** | [**PostCategoryWrapper**](PostCategoryWrapper.md) | The category to create. | |
|
|
31
|
+
|
|
32
|
+
### Return type
|
|
33
|
+
|
|
34
|
+
[**SaveCategoryResponse**](SaveCategoryResponse.md)
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
## create_category_group
|
|
38
|
+
|
|
39
|
+
> <SaveCategoryGroupResponse> create_category_group(plan_id, data)
|
|
40
|
+
|
|
41
|
+
Create a category group
|
|
42
|
+
|
|
43
|
+
Creates a new category group
|
|
44
|
+
|
|
45
|
+
### Parameters
|
|
46
|
+
|
|
47
|
+
| Name | Type | Description | Notes |
|
|
48
|
+
| ---- | ---- | ----------- | ----- |
|
|
49
|
+
| **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) | |
|
|
50
|
+
| **data** | [**PostCategoryGroupWrapper**](PostCategoryGroupWrapper.md) | The category group to create. | |
|
|
51
|
+
|
|
52
|
+
### Return type
|
|
53
|
+
|
|
54
|
+
[**SaveCategoryGroupResponse**](SaveCategoryGroupResponse.md)
|
|
12
55
|
|
|
13
56
|
|
|
14
57
|
## get_categories
|
|
15
58
|
|
|
16
|
-
> <CategoriesResponse> get_categories(
|
|
59
|
+
> <CategoriesResponse> get_categories(plan_id, opts)
|
|
17
60
|
|
|
18
|
-
|
|
61
|
+
Get all categories
|
|
19
62
|
|
|
20
|
-
Returns all categories grouped by category group. Amounts (
|
|
63
|
+
Returns all categories grouped by category group. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
|
|
21
64
|
|
|
22
65
|
### Parameters
|
|
23
66
|
|
|
24
67
|
| Name | Type | Description | Notes |
|
|
25
68
|
| ---- | ---- | ----------- | ----- |
|
|
26
|
-
| **
|
|
69
|
+
| **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). | |
|
|
27
70
|
| **last_knowledge_of_server** | **Integer** | The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. | [optional] |
|
|
28
71
|
|
|
29
72
|
### Return type
|
|
@@ -33,17 +76,17 @@ Returns all categories grouped by category group. Amounts (budgeted, activity,
|
|
|
33
76
|
|
|
34
77
|
## get_category_by_id
|
|
35
78
|
|
|
36
|
-
> <CategoryResponse> get_category_by_id(
|
|
79
|
+
> <CategoryResponse> get_category_by_id(plan_id, category_id)
|
|
37
80
|
|
|
38
|
-
|
|
81
|
+
Get a category
|
|
39
82
|
|
|
40
|
-
Returns a single category. Amounts (
|
|
83
|
+
Returns a single category. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
|
|
41
84
|
|
|
42
85
|
### Parameters
|
|
43
86
|
|
|
44
87
|
| Name | Type | Description | Notes |
|
|
45
88
|
| ---- | ---- | ----------- | ----- |
|
|
46
|
-
| **
|
|
89
|
+
| **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). | |
|
|
47
90
|
| **category_id** | **String** | The id of the category | |
|
|
48
91
|
|
|
49
92
|
### Return type
|
|
@@ -53,18 +96,18 @@ Returns a single category. Amounts (budgeted, activity, balance, etc.) are spec
|
|
|
53
96
|
|
|
54
97
|
## get_month_category_by_id
|
|
55
98
|
|
|
56
|
-
> <CategoryResponse> get_month_category_by_id(
|
|
99
|
+
> <CategoryResponse> get_month_category_by_id(plan_id, month, category_id)
|
|
57
100
|
|
|
58
|
-
|
|
101
|
+
Get a category for a specific plan month
|
|
59
102
|
|
|
60
|
-
Returns a single category for a specific
|
|
103
|
+
Returns a single category for a specific plan month. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
|
|
61
104
|
|
|
62
105
|
### Parameters
|
|
63
106
|
|
|
64
107
|
| Name | Type | Description | Notes |
|
|
65
108
|
| ---- | ---- | ----------- | ----- |
|
|
66
|
-
| **
|
|
67
|
-
| **month** | **Date** | The
|
|
109
|
+
| **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). | |
|
|
110
|
+
| **month** | **Date** | The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | |
|
|
68
111
|
| **category_id** | **String** | The id of the category | |
|
|
69
112
|
|
|
70
113
|
### Return type
|
|
@@ -74,7 +117,7 @@ Returns a single category for a specific budget month. Amounts (budgeted, activ
|
|
|
74
117
|
|
|
75
118
|
## update_category
|
|
76
119
|
|
|
77
|
-
> <SaveCategoryResponse> update_category(
|
|
120
|
+
> <SaveCategoryResponse> update_category(plan_id, category_id, data)
|
|
78
121
|
|
|
79
122
|
Update a category
|
|
80
123
|
|
|
@@ -84,7 +127,7 @@ Update a category
|
|
|
84
127
|
|
|
85
128
|
| Name | Type | Description | Notes |
|
|
86
129
|
| ---- | ---- | ----------- | ----- |
|
|
87
|
-
| **
|
|
130
|
+
| **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). | |
|
|
88
131
|
| **category_id** | **String** | The id of the category | |
|
|
89
132
|
| **data** | [**PatchCategoryWrapper**](PatchCategoryWrapper.md) | The category to update | |
|
|
90
133
|
|
|
@@ -93,22 +136,43 @@ Update a category
|
|
|
93
136
|
[**SaveCategoryResponse**](SaveCategoryResponse.md)
|
|
94
137
|
|
|
95
138
|
|
|
139
|
+
## update_category_group
|
|
140
|
+
|
|
141
|
+
> <SaveCategoryGroupResponse> update_category_group(plan_id, category_group_id, data)
|
|
142
|
+
|
|
143
|
+
Update a category group
|
|
144
|
+
|
|
145
|
+
Update a category group
|
|
146
|
+
|
|
147
|
+
### Parameters
|
|
148
|
+
|
|
149
|
+
| Name | Type | Description | Notes |
|
|
150
|
+
| ---- | ---- | ----------- | ----- |
|
|
151
|
+
| **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). | |
|
|
152
|
+
| **category_group_id** | **String** | The id of the category group | |
|
|
153
|
+
| **data** | [**PatchCategoryGroupWrapper**](PatchCategoryGroupWrapper.md) | The category group to update | |
|
|
154
|
+
|
|
155
|
+
### Return type
|
|
156
|
+
|
|
157
|
+
[**SaveCategoryGroupResponse**](SaveCategoryGroupResponse.md)
|
|
158
|
+
|
|
159
|
+
|
|
96
160
|
## update_month_category
|
|
97
161
|
|
|
98
|
-
> <SaveCategoryResponse> update_month_category(
|
|
162
|
+
> <SaveCategoryResponse> update_month_category(plan_id, month, category_id, data)
|
|
99
163
|
|
|
100
164
|
Update a category for a specific month
|
|
101
165
|
|
|
102
|
-
Update a category for a specific month. Only `budgeted` amount can be updated.
|
|
166
|
+
Update a category for a specific month. Only `budgeted` (assigned) amount can be updated.
|
|
103
167
|
|
|
104
168
|
### Parameters
|
|
105
169
|
|
|
106
170
|
| Name | Type | Description | Notes |
|
|
107
171
|
| ---- | ---- | ----------- | ----- |
|
|
108
|
-
| **
|
|
109
|
-
| **month** | **Date** | The
|
|
172
|
+
| **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). | |
|
|
173
|
+
| **month** | **Date** | The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | |
|
|
110
174
|
| **category_id** | **String** | The id of the category | |
|
|
111
|
-
| **data** | [**PatchMonthCategoryWrapper**](PatchMonthCategoryWrapper.md) | The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored. | |
|
|
175
|
+
| **data** | [**PatchMonthCategoryWrapper**](PatchMonthCategoryWrapper.md) | The category to update. Only `budgeted` (assigned) amount can be updated and any other fields specified will be ignored. | |
|
|
112
176
|
|
|
113
177
|
### Return type
|
|
114
178
|
|
data/docs/Category.md
CHANGED
|
@@ -11,9 +11,9 @@
|
|
|
11
11
|
| **hidden** | **Boolean** | Whether or not the category is hidden | |
|
|
12
12
|
| **original_category_group_id** | **String** | DEPRECATED: No longer used. Value will always be null. | [optional] |
|
|
13
13
|
| **note** | **String** | | [optional] |
|
|
14
|
-
| **budgeted** | **Integer** |
|
|
14
|
+
| **budgeted** | **Integer** | Assigned (budgeted) amount in milliunits format | |
|
|
15
15
|
| **activity** | **Integer** | Activity amount in milliunits format | |
|
|
16
|
-
| **balance** | **Integer** |
|
|
16
|
+
| **balance** | **Integer** | Available balance in milliunits format | |
|
|
17
17
|
| **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] |
|
|
18
18
|
| **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] |
|
|
19
19
|
| **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] |
|
|
@@ -21,7 +21,8 @@
|
|
|
21
21
|
| **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] |
|
|
22
22
|
| **goal_creation_month** | **Date** | The month a goal was created | [optional] |
|
|
23
23
|
| **goal_target** | **Integer** | The goal target amount in milliunits | [optional] |
|
|
24
|
-
| **goal_target_month** | **Date** |
|
|
24
|
+
| **goal_target_month** | **Date** | DEPRECATED: No longer used. Use `goal_target_date` instead. | [optional] |
|
|
25
|
+
| **goal_target_date** | **Date** | The target date for the goal to be completed. Only some goal types specify this date. | [optional] |
|
|
25
26
|
| **goal_percentage_complete** | **Integer** | The percentage completion of the goal | [optional] |
|
|
26
27
|
| **goal_months_to_budget** | **Integer** | The number of months, including the current month, left in the current goal period. | [optional] |
|
|
27
28
|
| **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] |
|
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
| **name** | **String** | | |
|
|
9
9
|
| **hidden** | **Boolean** | Whether or not the category group is hidden | |
|
|
10
10
|
| **deleted** | **Boolean** | Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests. | |
|
|
11
|
-
| **categories** | [**Array<Category>**](Category.md) | Category group categories. Amounts (
|
|
11
|
+
| **categories** | [**Array<Category>**](Category.md) | Category group categories. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC). | |
|
|
12
12
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# YNAB::ExistingCategory
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | [optional] |
|
|
8
|
+
| **note** | **String** | | [optional] |
|
|
9
|
+
| **category_group_id** | **String** | | [optional] |
|
|
10
|
+
| **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] |
|
|
11
|
+
| **goal_target_date** | **Date** | The goal target date in ISO format (e.g. 2016-12-01). | [optional] |
|
|
12
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# YNAB::MoneyMovement
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **month** | **Date** | The month of the money movement in ISO format (e.g. 2024-01-01) | [optional] |
|
|
9
|
+
| **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] |
|
|
10
|
+
| **note** | **String** | | [optional] |
|
|
11
|
+
| **money_movement_group_id** | **String** | The id of the money movement group this movement belongs to | [optional] |
|
|
12
|
+
| **performed_by_user_id** | **String** | The id of the user who performed the money movement | [optional] |
|
|
13
|
+
| **from_category_id** | **String** | The id of the category the money was moved from | [optional] |
|
|
14
|
+
| **to_category_id** | **String** | The id of the category the money was moved to | [optional] |
|
|
15
|
+
| **amount** | **Integer** | The amount of the money movement in milliunits format | |
|
|
16
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# YNAB::MoneyMovementGroup
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **group_created_at** | **Time** | When the money movement group was created | |
|
|
9
|
+
| **month** | **Date** | The month of the money movement group in ISO format (e.g. 2024-01-01) | |
|
|
10
|
+
| **note** | **String** | | [optional] |
|
|
11
|
+
| **performed_by_user_id** | **String** | The id of the user who performed the money movement group | [optional] |
|
|
12
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# YNAB::MoneyMovementGroupsResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **money_movement_groups** | [**Array<MoneyMovementGroup>**](MoneyMovementGroup.md) | | |
|
|
8
|
+
| **server_knowledge** | **Integer** | The knowledge of the server | |
|
|
9
|
+
|