ynab 1.4.0 → 1.5.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 +5 -5
- data/Gemfile.lock +2 -2
- data/README.md +37 -27
- data/Rakefile +0 -6
- data/config.json +1 -1
- data/docs/Account.md +1 -0
- data/docs/AccountsApi.md +3 -3
- data/docs/BudgetsApi.md +4 -4
- data/docs/CategoriesApi.md +45 -4
- data/docs/HybridTransaction.md +2 -1
- data/docs/MonthDetail.md +1 -1
- data/docs/MonthsApi.md +3 -3
- data/docs/PayeeLocationsApi.md +4 -4
- data/docs/PayeesApi.md +3 -3
- data/docs/SaveMonthCategory.md +8 -0
- data/docs/SaveMonthCategoryWrapper.md +8 -0
- data/docs/SaveTransaction.md +2 -2
- data/docs/SaveTransactionsResponse.md +8 -0
- data/docs/SaveTransactionsResponseData.md +11 -0
- data/docs/SaveTransactionsWrapper.md +9 -0
- data/docs/ScheduledTransactionsApi.md +3 -3
- data/docs/TransactionDetail.md +2 -1
- data/docs/TransactionSummary.md +2 -1
- data/docs/TransactionsApi.md +25 -25
- data/docs/UserApi.md +1 -1
- data/examples/create-multiple-transactions.rb +44 -0
- data/examples/update-category-budgeted.rb +23 -0
- data/lib/ynab.rb +5 -0
- data/lib/ynab/api/accounts_api.rb +6 -6
- data/lib/ynab/api/budgets_api.rb +8 -8
- data/lib/ynab/api/categories_api.rb +142 -8
- data/lib/ynab/api/months_api.rb +6 -6
- data/lib/ynab/api/payee_locations_api.rb +8 -8
- data/lib/ynab/api/payees_api.rb +6 -6
- data/lib/ynab/api/scheduled_transactions_api.rb +6 -6
- data/lib/ynab/api/transactions_api.rb +54 -54
- data/lib/ynab/api/user_api.rb +2 -2
- data/lib/ynab/models/account.rb +16 -1
- data/lib/ynab/models/hybrid_transaction.rb +17 -1
- data/lib/ynab/models/month_detail.rb +1 -1
- data/lib/ynab/models/save_month_category.rb +189 -0
- data/lib/ynab/models/save_month_category_wrapper.rb +188 -0
- data/lib/ynab/models/save_transaction.rb +2 -2
- data/lib/ynab/models/save_transactions_response.rb +188 -0
- data/lib/ynab/models/save_transactions_response_data.rb +225 -0
- data/lib/ynab/models/save_transactions_wrapper.rb +194 -0
- data/lib/ynab/models/transaction_detail.rb +17 -1
- data/lib/ynab/models/transaction_summary.rb +17 -1
- data/lib/ynab/version.rb +1 -1
- data/pkg/ynab-1.4.0.gem +0 -0
- data/spec-v1-swagger.json +413 -245
- data/spec/api/categories_spec.rb +14 -2
- data/spec/api/transactions_spec.rb +31 -0
- data/spec/fixtures/vcr_cassettes/category.yml +1 -1
- data/spec/fixtures/vcr_cassettes/multiple_transactions.yml +46 -0
- data/spec/fixtures/vcr_cassettes/patch_month_category.yml +46 -0
- metadata +20 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 4b166573dcd75e698d3f7267aaae6c2f059df2548cfe1e40966c45a42d4acbca
|
|
4
|
+
data.tar.gz: 76367dc36941d01aa034d733f38f219f68f94df529e8df20c9dfafacad49ecc0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ffc1e4b9eebd5dae1d5aebca1f84bfcf96b21b40175d9897c2b40d868ffa7d90a56d39fcde15b25fffb1dbe3aafdb2790fa102c281d17f7098b4a75671efe38a
|
|
7
|
+
data.tar.gz: 0c1ce24d903f9926b0d5b069d589ad2c317572150fcd4d49f14891aaa538f90f4cbb312118f5d511a8b141ad88eb18f0cb2560c3a3ef0b8c184cc222f8733bce
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -46,39 +46,49 @@ See the [examples folder](https://github.com/ynab/ynab-sdk-ruby/tree/master/exam
|
|
|
46
46
|
|
|
47
47
|
The following methods are available in this library.
|
|
48
48
|
|
|
49
|
-
|
|
|
50
|
-
|
|
51
|
-
| **User**
|
|
52
|
-
| **Budgets** | [budgets.get_budgets()](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/BudgetsApi.md#get_budgets)
|
|
53
|
-
|
|
|
54
|
-
|
|
|
55
|
-
| **Accounts** | [accounts.get_accounts(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/AccountsApi.md#get_accounts)
|
|
56
|
-
|
|
|
57
|
-
| **Categories** | [categories.get_categories(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#get_categories)
|
|
58
|
-
|
|
|
59
|
-
| **Payees** | [payees.get_payees(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#get_payees)
|
|
60
|
-
|
|
|
61
|
-
| **Payee Locations** | [payee_locations.get_payee_locations(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_locations)
|
|
62
|
-
|
|
|
63
|
-
|
|
|
64
|
-
| **Months** | [months.get_budget_months(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MonthsApi.md#get_budget_months)
|
|
65
|
-
|
|
|
66
|
-
|
|
|
67
|
-
|
|
|
68
|
-
|
|
|
69
|
-
|
|
|
70
|
-
|
|
|
71
|
-
|
|
|
72
|
-
|
|
|
73
|
-
|
|
|
74
|
-
|
|
|
49
|
+
| | Method | Description | |
|
|
50
|
+
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|---|
|
|
51
|
+
| **User** | [user.get_user()](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/UserApi.md#get_user) | Returns authenticated user information | |
|
|
52
|
+
| **Budgets** | [budgets.get_budgets()](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/BudgetsApi.md#get_budgets) | Returns budgets list with summary information | |
|
|
53
|
+
| | [budgets.get_budget_by_id(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/BudgetsApi.md#get_budget_by_id) | Returns a single budget with all related entities | |
|
|
54
|
+
| | [budgets.get_budget_settings_by_id(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/BudgetsApi.md#get_budget_settings_by_id) | Returns settings for a budget | |
|
|
55
|
+
| **Accounts** | [accounts.get_accounts(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/AccountsApi.md#get_accounts) | Returns all accounts | |
|
|
56
|
+
| | [accounts.get_account_by_id(budget_id, account_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/AccountsApi.md#get_account_by_id) | Returns a single account | |
|
|
57
|
+
| **Categories** | [categories.get_categories(budget_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(budget_id, category_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#get_category_by_id) | Returns a single category | |
|
|
59
|
+
| **Payees** | [payees.get_payees(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#get_payees) | Returns all payees | |
|
|
60
|
+
| | [payees.get_payee_by_id(budget_id, payee_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#get_payee_by_id) | Returns single payee | |
|
|
61
|
+
| **Payee Locations** | [payee_locations.get_payee_locations(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_locations) | Returns all payee locations | |
|
|
62
|
+
| | [payee_locations.get_payee_location_by_id(budget_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 | |
|
|
63
|
+
| | [payee_locations.get_payee_locations_by_payee(budget_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 | |
|
|
64
|
+
| **Months** | [months.get_budget_months(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MonthsApi.md#get_budget_months) | Returns all budget months | |
|
|
65
|
+
| | [months.get_budget_month(budget_id, month)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MonthsApi.md#get_budget_month) | Returns a single budget month | |
|
|
66
|
+
| | [months.get_month_category_by_id(budget_id, month, category_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MonthsApi.md#get_month_category_by_id) | Returns a single category for a specific budget month | |
|
|
67
|
+
| | [months.update_month_category(budget_id, month, category_id, month_category)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MonthsApi.md#update_month_category) | Update an existing month category | |
|
|
68
|
+
| **Transactions** | [transactions.get_transactions(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions) | Returns budget transactions | |
|
|
69
|
+
| | [transactions.get_transactions_by_account(budget_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 | |
|
|
70
|
+
| | [transactions.get_transactions_by_category(budget_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 | |
|
|
71
|
+
| | [transactions.get_transaction_by_id(budget_id, transaction_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transaction_by_id) | Returns a single transaction | |
|
|
72
|
+
| | [transactions.update_transaction(budget_id, id, transaction)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#update_transaction) | Updates a transaction | |
|
|
73
|
+
| | [transactions.create_transaction(budget_id, save_transactions)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#create_transaction) | Creates one or multiple transactions | |
|
|
74
|
+
| | [transactions.bulk_create_transactions(budget_id, transactions)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#bulk_create_transactions) | Creates multiple transactions | |
|
|
75
|
+
| **Scheduled Transactions** | [scheduled_transactions.get_scheduled_transactions(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#get_scheduled_transactions) | Returns all scheduled transactions | |
|
|
76
|
+
| | [scheduled_transactions.get_scheduled_transaction_by_id(budget_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 | |
|
|
77
|
+
|
|
78
|
+
|
|
75
79
|
|
|
76
80
|
## Development
|
|
77
81
|
|
|
78
82
|
- Install dependencies: `bundle`
|
|
79
83
|
- Generate latest client based on swagger spec: `rake generate`
|
|
80
84
|
- Run tests: `rake spec` or `rspec`
|
|
81
|
-
|
|
85
|
+
|
|
86
|
+
## Releasing
|
|
87
|
+
|
|
88
|
+
- Generate latest with `rake generate`
|
|
89
|
+
- Commit all changes
|
|
90
|
+
- Bump `gemVersion` in config.json
|
|
91
|
+
- Run `rake publish` to publish to RubyGems
|
|
82
92
|
|
|
83
93
|
## License
|
|
84
94
|
|
data/Rakefile
CHANGED
|
@@ -17,12 +17,6 @@ task :generate do
|
|
|
17
17
|
spec_filename = 'spec-v1-swagger.json'
|
|
18
18
|
sh "rm #{spec_filename} && wget https://api.youneedabudget.com/papi/#{spec_filename}"
|
|
19
19
|
|
|
20
|
-
# Replace nullable types defined as i.e. ["string", "null"] in the spec to simply "string" as the generator does not understand the nullable format.
|
|
21
|
-
# Examples:
|
|
22
|
-
# ["string", "null"] => "string"
|
|
23
|
-
# ["number", "null"] => "number"
|
|
24
|
-
sh %Q[sed -E -i '' 's/\\\[\\"(string|number|integer|array|boolean)\\"\\, \\"null\\"\\\]/"\\1"/g' #{spec_filename}]
|
|
25
|
-
|
|
26
20
|
# Use Docker to codegen ruby based on the swagger spec
|
|
27
21
|
sh "docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli generate"\
|
|
28
22
|
" -i /local/spec-v1-swagger.json"\
|
data/config.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"gemName": "ynab",
|
|
3
3
|
"moduleName": "YNAB",
|
|
4
|
-
"gemVersion": "1.
|
|
4
|
+
"gemVersion": "1.5.0",
|
|
5
5
|
"gemDescription": "Ruby gem wrapper for the YNAB API. Read the documentation at https://api.youneedabudget.com",
|
|
6
6
|
"gemHomepage": "https://github.com/ynab/ynab-sdk-ruby",
|
|
7
7
|
"gemLicense": "Apache-2.0",
|
data/docs/Account.md
CHANGED
|
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**balance** | **Integer** | The current balance of the account in milliunits format |
|
|
13
13
|
**cleared_balance** | **Integer** | The current cleared balance of the account in milliunits format |
|
|
14
14
|
**uncleared_balance** | **Integer** | The current uncleared balance of the account in milliunits format |
|
|
15
|
+
**transfer_payee_id** | **String** | The payee id which should be used when transferring to this account |
|
|
15
16
|
**deleted** | **BOOLEAN** | Whether or not the account has been deleted. Deleted accounts will only be included in delta requests. |
|
|
16
17
|
|
|
17
18
|
|
data/docs/AccountsApi.md
CHANGED
|
@@ -19,8 +19,8 @@ Returns a single account
|
|
|
19
19
|
|
|
20
20
|
Name | Type | Description | Notes
|
|
21
21
|
------------- | ------------- | ------------- | -------------
|
|
22
|
-
**budget_id** | [**String**](.md)| The
|
|
23
|
-
**account_id** | [**String**](.md)| The
|
|
22
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
23
|
+
**account_id** | [**String**](.md)| The id of the account |
|
|
24
24
|
|
|
25
25
|
### Return type
|
|
26
26
|
|
|
@@ -37,7 +37,7 @@ Returns all accounts
|
|
|
37
37
|
|
|
38
38
|
Name | Type | Description | Notes
|
|
39
39
|
------------- | ------------- | ------------- | -------------
|
|
40
|
-
**budget_id** | [**String**](.md)| The
|
|
40
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
41
41
|
|
|
42
42
|
### Return type
|
|
43
43
|
|
data/docs/BudgetsApi.md
CHANGED
|
@@ -20,7 +20,7 @@ Returns a single budget with all related entities. This resource is effectively
|
|
|
20
20
|
|
|
21
21
|
Name | Type | Description | Notes
|
|
22
22
|
------------- | ------------- | ------------- | -------------
|
|
23
|
-
**budget_id** | [**String**](.md)| The
|
|
23
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
24
24
|
**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]
|
|
25
25
|
|
|
26
26
|
### Return type
|
|
@@ -32,13 +32,13 @@ Name | Type | Description | Notes
|
|
|
32
32
|
|
|
33
33
|
Budget Settings
|
|
34
34
|
|
|
35
|
-
Returns settings for a budget
|
|
35
|
+
Returns settings for a budget
|
|
36
36
|
|
|
37
37
|
### Parameters
|
|
38
38
|
|
|
39
39
|
Name | Type | Description | Notes
|
|
40
40
|
------------- | ------------- | ------------- | -------------
|
|
41
|
-
**budget_id** | [**String**](.md)| The
|
|
41
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
42
42
|
|
|
43
43
|
### Return type
|
|
44
44
|
|
|
@@ -49,7 +49,7 @@ Name | Type | Description | Notes
|
|
|
49
49
|
|
|
50
50
|
List budgets
|
|
51
51
|
|
|
52
|
-
Returns budgets list with summary information
|
|
52
|
+
Returns budgets list with summary information
|
|
53
53
|
|
|
54
54
|
### Parameters
|
|
55
55
|
This endpoint does not need any parameter.
|
data/docs/CategoriesApi.md
CHANGED
|
@@ -6,6 +6,8 @@ Method | HTTP request | Description
|
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**get_categories**](CategoriesApi.md#get_categories) | **GET** /budgets/{budget_id}/categories | List categories
|
|
8
8
|
[**get_category_by_id**](CategoriesApi.md#get_category_by_id) | **GET** /budgets/{budget_id}/categories/{category_id} | Single category
|
|
9
|
+
[**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
|
|
10
|
+
[**update_month_category**](CategoriesApi.md#update_month_category) | **PATCH** /budgets/{budget_id}/months/{month}/categories/{category_id} | Update an existing month category
|
|
9
11
|
|
|
10
12
|
|
|
11
13
|
# **get_categories**
|
|
@@ -13,13 +15,13 @@ Method | HTTP request | Description
|
|
|
13
15
|
|
|
14
16
|
List categories
|
|
15
17
|
|
|
16
|
-
Returns all categories grouped by category group
|
|
18
|
+
Returns all categories grouped by category group
|
|
17
19
|
|
|
18
20
|
### Parameters
|
|
19
21
|
|
|
20
22
|
Name | Type | Description | Notes
|
|
21
23
|
------------- | ------------- | ------------- | -------------
|
|
22
|
-
**budget_id** | [**String**](.md)| The
|
|
24
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
23
25
|
|
|
24
26
|
### Return type
|
|
25
27
|
|
|
@@ -36,8 +38,47 @@ Returns a single category
|
|
|
36
38
|
|
|
37
39
|
Name | Type | Description | Notes
|
|
38
40
|
------------- | ------------- | ------------- | -------------
|
|
39
|
-
**budget_id** | [**String**](.md)| The
|
|
40
|
-
**category_id** | [**String**](.md)| The
|
|
41
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
42
|
+
**category_id** | [**String**](.md)| The id of the category |
|
|
43
|
+
|
|
44
|
+
### Return type
|
|
45
|
+
|
|
46
|
+
[**CategoryResponse**](CategoryResponse.md)
|
|
47
|
+
|
|
48
|
+
# **get_month_category_by_id**
|
|
49
|
+
> CategoryResponse get_month_category_by_id(budget_id, month, category_id)
|
|
50
|
+
|
|
51
|
+
Single category for a specific budget month
|
|
52
|
+
|
|
53
|
+
Returns a single category for a specific budget month
|
|
54
|
+
|
|
55
|
+
### Parameters
|
|
56
|
+
|
|
57
|
+
Name | Type | Description | Notes
|
|
58
|
+
------------- | ------------- | ------------- | -------------
|
|
59
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
60
|
+
**month** | **Date**| the budget month in ISO format (e.g. 2016-12-30). (\"current\" can also be used to specify the current calendar month (UTC)) |
|
|
61
|
+
**category_id** | [**String**](.md)| The id of the category |
|
|
62
|
+
|
|
63
|
+
### Return type
|
|
64
|
+
|
|
65
|
+
[**CategoryResponse**](CategoryResponse.md)
|
|
66
|
+
|
|
67
|
+
# **update_month_category**
|
|
68
|
+
> CategoryResponse update_month_category(budget_id, month, category_id, month_category)
|
|
69
|
+
|
|
70
|
+
Update an existing month category
|
|
71
|
+
|
|
72
|
+
Update an existing month category
|
|
73
|
+
|
|
74
|
+
### Parameters
|
|
75
|
+
|
|
76
|
+
Name | Type | Description | Notes
|
|
77
|
+
------------- | ------------- | ------------- | -------------
|
|
78
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
79
|
+
**month** | **Date**| the budget month in ISO format (e.g. 2016-12-01). \"current\" can also be used to specify the current calendar month (UTC). |
|
|
80
|
+
**category_id** | [**String**](.md)| The id of the category |
|
|
81
|
+
**month_category** | [**SaveMonthCategoryWrapper**](SaveMonthCategoryWrapper.md)| The month category to update |
|
|
41
82
|
|
|
42
83
|
### Return type
|
|
43
84
|
|
data/docs/HybridTransaction.md
CHANGED
|
@@ -13,7 +13,8 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**account_id** | **String** | |
|
|
14
14
|
**payee_id** | **String** | |
|
|
15
15
|
**category_id** | **String** | |
|
|
16
|
-
**transfer_account_id** | **String** |
|
|
16
|
+
**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers |
|
|
17
|
+
**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer |
|
|
17
18
|
**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'. |
|
|
18
19
|
**deleted** | **BOOLEAN** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. |
|
|
19
20
|
**type** | **String** | Whether the hybrid transaction represents a regular transaction or a subtransaction |
|
data/docs/MonthDetail.md
CHANGED
|
@@ -10,6 +10,6 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**activity** | **Integer** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' |
|
|
11
11
|
**to_be_budgeted** | **Integer** | The available amount for 'To be Budgeted' |
|
|
12
12
|
**age_of_money** | **Integer** | The Age of Money as of the month |
|
|
13
|
-
**categories** | [**Array<Category>**](Category.md) |
|
|
13
|
+
**categories** | [**Array<Category>**](Category.md) | the budget month categories |
|
|
14
14
|
|
|
15
15
|
|
data/docs/MonthsApi.md
CHANGED
|
@@ -19,8 +19,8 @@ Returns a single budget month
|
|
|
19
19
|
|
|
20
20
|
Name | Type | Description | Notes
|
|
21
21
|
------------- | ------------- | ------------- | -------------
|
|
22
|
-
**budget_id** | [**String**](.md)| The
|
|
23
|
-
**month** | **Date**|
|
|
22
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
23
|
+
**month** | **Date**| the budget month in ISO format (e.g. 2016-12-01). \"current\" can also be used to specify the current calendar month (UTC). |
|
|
24
24
|
|
|
25
25
|
### Return type
|
|
26
26
|
|
|
@@ -37,7 +37,7 @@ Returns all budget months
|
|
|
37
37
|
|
|
38
38
|
Name | Type | Description | Notes
|
|
39
39
|
------------- | ------------- | ------------- | -------------
|
|
40
|
-
**budget_id** | [**String**](.md)| The
|
|
40
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
41
41
|
|
|
42
42
|
### Return type
|
|
43
43
|
|
data/docs/PayeeLocationsApi.md
CHANGED
|
@@ -20,7 +20,7 @@ Returns a single payee location
|
|
|
20
20
|
|
|
21
21
|
Name | Type | Description | Notes
|
|
22
22
|
------------- | ------------- | ------------- | -------------
|
|
23
|
-
**budget_id** | [**String**](.md)| The
|
|
23
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
24
24
|
**payee_location_id** | [**String**](.md)| ID of payee location |
|
|
25
25
|
|
|
26
26
|
### Return type
|
|
@@ -38,7 +38,7 @@ Returns all payee locations
|
|
|
38
38
|
|
|
39
39
|
Name | Type | Description | Notes
|
|
40
40
|
------------- | ------------- | ------------- | -------------
|
|
41
|
-
**budget_id** | [**String**](.md)| The
|
|
41
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
42
42
|
|
|
43
43
|
### Return type
|
|
44
44
|
|
|
@@ -55,8 +55,8 @@ Returns all payee locations for the specified payee
|
|
|
55
55
|
|
|
56
56
|
Name | Type | Description | Notes
|
|
57
57
|
------------- | ------------- | ------------- | -------------
|
|
58
|
-
**budget_id** | [**String**](.md)| The
|
|
59
|
-
**payee_id** | [**String**](.md)|
|
|
58
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
59
|
+
**payee_id** | [**String**](.md)| id of payee |
|
|
60
60
|
|
|
61
61
|
### Return type
|
|
62
62
|
|
data/docs/PayeesApi.md
CHANGED
|
@@ -19,8 +19,8 @@ Returns single payee
|
|
|
19
19
|
|
|
20
20
|
Name | Type | Description | Notes
|
|
21
21
|
------------- | ------------- | ------------- | -------------
|
|
22
|
-
**budget_id** | [**String**](.md)| The
|
|
23
|
-
**payee_id** | [**String**](.md)| The
|
|
22
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
23
|
+
**payee_id** | [**String**](.md)| The id of the payee |
|
|
24
24
|
|
|
25
25
|
### Return type
|
|
26
26
|
|
|
@@ -37,7 +37,7 @@ Returns all payees
|
|
|
37
37
|
|
|
38
38
|
Name | Type | Description | Notes
|
|
39
39
|
------------- | ------------- | ------------- | -------------
|
|
40
|
-
**budget_id** | [**String**](.md)| The
|
|
40
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
41
41
|
|
|
42
42
|
### Return type
|
|
43
43
|
|
data/docs/SaveTransaction.md
CHANGED
|
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**account_id** | **String** | |
|
|
7
7
|
**date** | **Date** | |
|
|
8
8
|
**amount** | **Integer** | The transaction amount in milliunits format |
|
|
9
|
-
**payee_id** | **String** | The payee for the transaction
|
|
9
|
+
**payee_id** | **String** | The payee for the transaction | [optional]
|
|
10
10
|
**payee_name** | **String** | The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified) or (2) a payee with the same name or (3) creation of a new payee. | [optional]
|
|
11
|
-
**category_id** | **String** | The category for the transaction. Split and Credit Card Payment categories are not permitted and will be ignored if supplied. | [optional]
|
|
11
|
+
**category_id** | **String** | The category for the transaction. Split and Credit Card Payment categories are not permitted and will be ignored if supplied. If an existing transaction has a Split category it cannot be changed. | [optional]
|
|
12
12
|
**memo** | **String** | | [optional]
|
|
13
13
|
**cleared** | **String** | The cleared status of the transaction | [optional]
|
|
14
14
|
**approved** | **BOOLEAN** | Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default. | [optional]
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# YNAB::SaveTransactionsResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**transaction_ids** | **Array<String>** | The transaction ids that were saved |
|
|
7
|
+
**transaction** | [**TransactionDetail**](TransactionDetail.md) | If a single transaction was specified, the transaction that was saved | [optional]
|
|
8
|
+
**transactions** | [**Array<TransactionDetail>**](TransactionDetail.md) | If multiple transactions were specified, the transactions that were saved | [optional]
|
|
9
|
+
**duplicate_import_ids** | **Array<String>** | If multiple transactions were specified, a list of import_ids that were not were created because of an existing import_id found on the same account | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# YNAB::SaveTransactionsWrapper
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**transaction** | [**SaveTransaction**](SaveTransaction.md) | | [optional]
|
|
7
|
+
**transactions** | [**Array<SaveTransaction>**](SaveTransaction.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -19,8 +19,8 @@ Returns a single scheduled transaction
|
|
|
19
19
|
|
|
20
20
|
Name | Type | Description | Notes
|
|
21
21
|
------------- | ------------- | ------------- | -------------
|
|
22
|
-
**budget_id** | [**String**](.md)| The
|
|
23
|
-
**scheduled_transaction_id** | [**String**](.md)| The
|
|
22
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
23
|
+
**scheduled_transaction_id** | [**String**](.md)| The id of the scheduled transaction |
|
|
24
24
|
|
|
25
25
|
### Return type
|
|
26
26
|
|
|
@@ -37,7 +37,7 @@ Returns all scheduled transactions
|
|
|
37
37
|
|
|
38
38
|
Name | Type | Description | Notes
|
|
39
39
|
------------- | ------------- | ------------- | -------------
|
|
40
|
-
**budget_id** | [**String**](.md)| The
|
|
40
|
+
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
41
41
|
|
|
42
42
|
### Return type
|
|
43
43
|
|