diff options
Diffstat (limited to 'docs')
70 files changed, 236 insertions, 236 deletions
diff --git a/docs/Account.md b/docs/Account.md index 265294b..6acef65 100644 --- a/docs/Account.md +++ b/docs/Account.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **_type** | **String** | The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future. | **on_budget** | **bool** | Whether this account is on budget or not | **closed** | **bool** | Whether this account is closed or not | -**note** | **String** | | [optional] +**note** | Option<**String**> | | [optional] **balance** | **i64** | The current balance of the account in milliunits format | **cleared_balance** | **i64** | The current cleared balance of the account in milliunits format | **uncleared_balance** | **i64** | The current uncleared balance of the account in milliunits format | diff --git a/docs/AccountResponse.md b/docs/AccountResponse.md index dbb74b3..e584238 100644 --- a/docs/AccountResponse.md +++ b/docs/AccountResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::AccountResponseData**](AccountResponse_data.md) | | +**data** | [**crate::models::AccountResponseData**](AccountResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AccountResponseData.md b/docs/AccountResponseData.md index 3ae5b7c..aed4cf1 100644 --- a/docs/AccountResponseData.md +++ b/docs/AccountResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**account** | [***crate::models::Account**](Account.md) | | +**account** | [**crate::models::Account**](Account.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AccountsApi.md b/docs/AccountsApi.md index 1958f71..ff6d67f 100644 --- a/docs/AccountsApi.md +++ b/docs/AccountsApi.md @@ -21,8 +21,8 @@ Returns a single account Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**account_id** | [**String**](.md) | The id of the account | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**account_id** | [**String**](.md) | The id of the account | [required] | ### Return type @@ -52,8 +52,8 @@ Returns all accounts Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**last_knowledge_of_server** | **i64** | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**last_knowledge_of_server** | Option<**i64**> | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | ### Return type diff --git a/docs/AccountsResponse.md b/docs/AccountsResponse.md index 8ae5bea..7138cff 100644 --- a/docs/AccountsResponse.md +++ b/docs/AccountsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::AccountsResponseData**](AccountsResponse_data.md) | | +**data** | [**crate::models::AccountsResponseData**](AccountsResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BudgetDetail.md b/docs/BudgetDetail.md index 41741b1..92dccc2 100644 --- a/docs/BudgetDetail.md +++ b/docs/BudgetDetail.md @@ -6,21 +6,21 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | | **name** | **String** | | -**last_modified_on** | **String** | The last time any changes were made to the budget from either a web or mobile client | [optional] -**first_month** | [***String**](string.md) | The earliest budget month | [optional] -**last_month** | [***String**](string.md) | The latest budget month | [optional] -**date_format** | [***crate::models::DateFormat**](DateFormat.md) | | [optional] -**currency_format** | [***crate::models::CurrencyFormat**](CurrencyFormat.md) | | [optional] -**accounts** | [**Vec<crate::models::Account>**](Account.md) | | [optional] -**payees** | [**Vec<crate::models::Payee>**](Payee.md) | | [optional] -**payee_locations** | [**Vec<crate::models::PayeeLocation>**](PayeeLocation.md) | | [optional] -**category_groups** | [**Vec<crate::models::CategoryGroup>**](CategoryGroup.md) | | [optional] -**categories** | [**Vec<crate::models::Category>**](Category.md) | | [optional] -**months** | [**Vec<crate::models::MonthDetail>**](MonthDetail.md) | | [optional] -**transactions** | [**Vec<crate::models::TransactionSummary>**](TransactionSummary.md) | | [optional] -**subtransactions** | [**Vec<crate::models::SubTransaction>**](SubTransaction.md) | | [optional] -**scheduled_transactions** | [**Vec<crate::models::ScheduledTransactionSummary>**](ScheduledTransactionSummary.md) | | [optional] -**scheduled_subtransactions** | [**Vec<crate::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md) | | [optional] +**last_modified_on** | Option<**String**> | The last time any changes were made to the budget from either a web or mobile client | [optional] +**first_month** | Option<[**String**](string.md)> | The earliest budget month | [optional] +**last_month** | Option<[**String**](string.md)> | The latest budget month | [optional] +**date_format** | Option<[**crate::models::DateFormat**](DateFormat.md)> | | [optional] +**currency_format** | Option<[**crate::models::CurrencyFormat**](CurrencyFormat.md)> | | [optional] +**accounts** | Option<[**Vec<crate::models::Account>**](Account.md)> | | [optional] +**payees** | Option<[**Vec<crate::models::Payee>**](Payee.md)> | | [optional] +**payee_locations** | Option<[**Vec<crate::models::PayeeLocation>**](PayeeLocation.md)> | | [optional] +**category_groups** | Option<[**Vec<crate::models::CategoryGroup>**](CategoryGroup.md)> | | [optional] +**categories** | Option<[**Vec<crate::models::Category>**](Category.md)> | | [optional] +**months** | Option<[**Vec<crate::models::MonthDetail>**](MonthDetail.md)> | | [optional] +**transactions** | Option<[**Vec<crate::models::TransactionSummary>**](TransactionSummary.md)> | | [optional] +**subtransactions** | Option<[**Vec<crate::models::SubTransaction>**](SubTransaction.md)> | | [optional] +**scheduled_transactions** | Option<[**Vec<crate::models::ScheduledTransactionSummary>**](ScheduledTransactionSummary.md)> | | [optional] +**scheduled_subtransactions** | Option<[**Vec<crate::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md)> | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BudgetDetailAllOf.md b/docs/BudgetDetailAllOf.md index 6a922f5..22621bb 100644 --- a/docs/BudgetDetailAllOf.md +++ b/docs/BudgetDetailAllOf.md @@ -4,16 +4,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**accounts** | [**Vec<crate::models::Account>**](Account.md) | | [optional] -**payees** | [**Vec<crate::models::Payee>**](Payee.md) | | [optional] -**payee_locations** | [**Vec<crate::models::PayeeLocation>**](PayeeLocation.md) | | [optional] -**category_groups** | [**Vec<crate::models::CategoryGroup>**](CategoryGroup.md) | | [optional] -**categories** | [**Vec<crate::models::Category>**](Category.md) | | [optional] -**months** | [**Vec<crate::models::MonthDetail>**](MonthDetail.md) | | [optional] -**transactions** | [**Vec<crate::models::TransactionSummary>**](TransactionSummary.md) | | [optional] -**subtransactions** | [**Vec<crate::models::SubTransaction>**](SubTransaction.md) | | [optional] -**scheduled_transactions** | [**Vec<crate::models::ScheduledTransactionSummary>**](ScheduledTransactionSummary.md) | | [optional] -**scheduled_subtransactions** | [**Vec<crate::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md) | | [optional] +**accounts** | Option<[**Vec<crate::models::Account>**](Account.md)> | | [optional] +**payees** | Option<[**Vec<crate::models::Payee>**](Payee.md)> | | [optional] +**payee_locations** | Option<[**Vec<crate::models::PayeeLocation>**](PayeeLocation.md)> | | [optional] +**category_groups** | Option<[**Vec<crate::models::CategoryGroup>**](CategoryGroup.md)> | | [optional] +**categories** | Option<[**Vec<crate::models::Category>**](Category.md)> | | [optional] +**months** | Option<[**Vec<crate::models::MonthDetail>**](MonthDetail.md)> | | [optional] +**transactions** | Option<[**Vec<crate::models::TransactionSummary>**](TransactionSummary.md)> | | [optional] +**subtransactions** | Option<[**Vec<crate::models::SubTransaction>**](SubTransaction.md)> | | [optional] +**scheduled_transactions** | Option<[**Vec<crate::models::ScheduledTransactionSummary>**](ScheduledTransactionSummary.md)> | | [optional] +**scheduled_subtransactions** | Option<[**Vec<crate::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md)> | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BudgetDetailResponse.md b/docs/BudgetDetailResponse.md index 08d9d7b..211dac0 100644 --- a/docs/BudgetDetailResponse.md +++ b/docs/BudgetDetailResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::BudgetDetailResponseData**](BudgetDetailResponse_data.md) | | +**data** | [**crate::models::BudgetDetailResponseData**](BudgetDetailResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BudgetDetailResponseData.md b/docs/BudgetDetailResponseData.md index 88e4c7a..e66bc3f 100644 --- a/docs/BudgetDetailResponseData.md +++ b/docs/BudgetDetailResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**budget** | [***crate::models::BudgetDetail**](BudgetDetail.md) | | +**budget** | [**crate::models::BudgetDetail**](BudgetDetail.md) | | **server_knowledge** | **i64** | The knowledge of the server | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BudgetSettings.md b/docs/BudgetSettings.md index ff8d6b0..6679a67 100644 --- a/docs/BudgetSettings.md +++ b/docs/BudgetSettings.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**date_format** | [***crate::models::DateFormat**](DateFormat.md) | | -**currency_format** | [***crate::models::CurrencyFormat**](CurrencyFormat.md) | | +**date_format** | [**crate::models::DateFormat**](DateFormat.md) | | +**currency_format** | [**crate::models::CurrencyFormat**](CurrencyFormat.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BudgetSettingsResponse.md b/docs/BudgetSettingsResponse.md index 1b88253..f507f65 100644 --- a/docs/BudgetSettingsResponse.md +++ b/docs/BudgetSettingsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::BudgetSettingsResponseData**](BudgetSettingsResponse_data.md) | | +**data** | [**crate::models::BudgetSettingsResponseData**](BudgetSettingsResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BudgetSettingsResponseData.md b/docs/BudgetSettingsResponseData.md index a84371e..5da106c 100644 --- a/docs/BudgetSettingsResponseData.md +++ b/docs/BudgetSettingsResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**settings** | [***crate::models::BudgetSettings**](BudgetSettings.md) | | +**settings** | [**crate::models::BudgetSettings**](BudgetSettings.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BudgetSummary.md b/docs/BudgetSummary.md index eec8fba..4ac3e6d 100644 --- a/docs/BudgetSummary.md +++ b/docs/BudgetSummary.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | | **name** | **String** | | -**last_modified_on** | **String** | The last time any changes were made to the budget from either a web or mobile client | [optional] -**first_month** | [***String**](string.md) | The earliest budget month | [optional] -**last_month** | [***String**](string.md) | The latest budget month | [optional] -**date_format** | [***crate::models::DateFormat**](DateFormat.md) | | [optional] -**currency_format** | [***crate::models::CurrencyFormat**](CurrencyFormat.md) | | [optional] +**last_modified_on** | Option<**String**> | The last time any changes were made to the budget from either a web or mobile client | [optional] +**first_month** | Option<[**String**](string.md)> | The earliest budget month | [optional] +**last_month** | Option<[**String**](string.md)> | The latest budget month | [optional] +**date_format** | Option<[**crate::models::DateFormat**](DateFormat.md)> | | [optional] +**currency_format** | Option<[**crate::models::CurrencyFormat**](CurrencyFormat.md)> | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BudgetSummaryResponse.md b/docs/BudgetSummaryResponse.md index 5c16c83..887edf1 100644 --- a/docs/BudgetSummaryResponse.md +++ b/docs/BudgetSummaryResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::BudgetSummaryResponseData**](BudgetSummaryResponse_data.md) | | +**data** | [**crate::models::BudgetSummaryResponseData**](BudgetSummaryResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BudgetSummaryResponseData.md b/docs/BudgetSummaryResponseData.md index ecd5854..ef51be4 100644 --- a/docs/BudgetSummaryResponseData.md +++ b/docs/BudgetSummaryResponseData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **budgets** | [**Vec<crate::models::BudgetSummary>**](BudgetSummary.md) | | -**default_budget** | [***crate::models::BudgetSummary**](BudgetSummary.md) | | [optional] +**default_budget** | Option<[**crate::models::BudgetSummary**](BudgetSummary.md)> | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BudgetsApi.md b/docs/BudgetsApi.md index d91cd6d..3636f7b 100644 --- a/docs/BudgetsApi.md +++ b/docs/BudgetsApi.md @@ -22,8 +22,8 @@ Returns a single budget with all related entities. This resource is effectively Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**last_knowledge_of_server** | **i64** | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**last_knowledge_of_server** | Option<**i64**> | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | ### Return type @@ -53,7 +53,7 @@ Returns settings for a budget Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | ### Return type diff --git a/docs/BulkResponse.md b/docs/BulkResponse.md index edcad4c..1983fa9 100644 --- a/docs/BulkResponse.md +++ b/docs/BulkResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::BulkResponseData**](BulkResponse_data.md) | | +**data** | [**crate::models::BulkResponseData**](BulkResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BulkResponseData.md b/docs/BulkResponseData.md index 0ae0658..96a7d12 100644 --- a/docs/BulkResponseData.md +++ b/docs/BulkResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**bulk** | [***crate::models::BulkResponseDataBulk**](BulkResponse_data_bulk.md) | | +**bulk** | [**crate::models::BulkResponseDataBulk**](BulkResponse_data_bulk.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CategoriesApi.md b/docs/CategoriesApi.md index 4266752..29ecc5b 100644 --- a/docs/CategoriesApi.md +++ b/docs/CategoriesApi.md @@ -23,8 +23,8 @@ Returns all categories grouped by category group. Amounts (budgeted, activity, Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**last_knowledge_of_server** | **i64** | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**last_knowledge_of_server** | Option<**i64**> | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | ### Return type @@ -54,8 +54,8 @@ Returns a single category. Amounts (budgeted, activity, balance, etc.) are spec Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**category_id** | **String** | The id of the category | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**category_id** | **String** | The id of the category | [required] | ### Return type @@ -85,9 +85,9 @@ Returns a single category for a specific budget month. Amounts (budgeted, activ Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**month** | **String** | The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | Required | -**category_id** | **String** | The id of the category | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**month** | **String** | The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | [required] | +**category_id** | **String** | The id of the category | [required] | ### Return type @@ -117,10 +117,10 @@ Update a category for a specific month Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**month** | **String** | The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | Required | -**category_id** | **String** | The id of the category | Required | -**data** | [**SaveMonthCategoryWrapper**](SaveMonthCategoryWrapper.md) | The category to update | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**month** | **String** | The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | [required] | +**category_id** | **String** | The id of the category | [required] | +**data** | [**SaveMonthCategoryWrapper**](SaveMonthCategoryWrapper.md) | The category to update | [required] | ### Return type diff --git a/docs/CategoriesResponse.md b/docs/CategoriesResponse.md index 1d0374c..b79f85a 100644 --- a/docs/CategoriesResponse.md +++ b/docs/CategoriesResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::CategoriesResponseData**](CategoriesResponse_data.md) | | +**data** | [**crate::models::CategoriesResponseData**](CategoriesResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Category.md b/docs/Category.md index 9b6f7c9..d0c6208 100644 --- a/docs/Category.md +++ b/docs/Category.md @@ -8,16 +8,16 @@ Name | Type | Description | Notes **category_group_id** | **String** | | **name** | **String** | | **hidden** | **bool** | Whether or not the category is hidden | -**original_category_group_id** | **String** | If category is hidden this is the id of the category group it originally belonged to before it was hidden. | [optional] -**note** | **String** | | [optional] +**original_category_group_id** | Option<**String**> | If category is hidden this is the id of the category group it originally belonged to before it was hidden. | [optional] +**note** | Option<**String**> | | [optional] **budgeted** | **i64** | Budgeted amount in milliunits format | **activity** | **i64** | Activity amount in milliunits format | **balance** | **i64** | 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) | [optional] -**goal_creation_month** | [***String**](string.md) | The month a goal was created | [optional] -**goal_target** | **i64** | The goal target amount in milliunits | -**goal_target_month** | [***String**](string.md) | If the goal type is 'TBD' (Target Category Balance by Date), this is the target month for the goal to be completed | [optional] -**goal_percentage_complete** | **i32** | The percentage completion of the goal | [optional] +**goal_type** | Option<**String**> | The type of goal, if the category has a goal (TB=Target Category Balance, TBD=Target Category Balance by Date, MF=Monthly Funding) | [optional] +**goal_creation_month** | Option<[**String**](string.md)> | The month a goal was created | [optional] +**goal_target** | Option<**i64**> | The goal target amount in milliunits | [optional] +**goal_target_month** | Option<[**String**](string.md)> | If the goal type is 'TBD' (Target Category Balance by Date), this is the target month for the goal to be completed | [optional] +**goal_percentage_complete** | Option<**i32**> | The percentage completion of the goal | [optional] **deleted** | **bool** | Whether or not the category has been deleted. Deleted categories will only be included in delta requests. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CategoryResponse.md b/docs/CategoryResponse.md index 84bb949..247327a 100644 --- a/docs/CategoryResponse.md +++ b/docs/CategoryResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::CategoryResponseData**](CategoryResponse_data.md) | | +**data** | [**crate::models::CategoryResponseData**](CategoryResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CategoryResponseData.md b/docs/CategoryResponseData.md index 1507ab4..49fb17c 100644 --- a/docs/CategoryResponseData.md +++ b/docs/CategoryResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | [***crate::models::Category**](Category.md) | | +**category** | [**crate::models::Category**](Category.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/DeprecatedApi.md b/docs/DeprecatedApi.md index 712a3d9..0e3af9d 100644 --- a/docs/DeprecatedApi.md +++ b/docs/DeprecatedApi.md @@ -20,8 +20,8 @@ Creates multiple transactions. Although this endpoint is still supported, it is Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**transactions** | [**BulkTransactions**](BulkTransactions.md) | The list of transactions to create | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**transactions** | [**BulkTransactions**](BulkTransactions.md) | The list of transactions to create | [required] | ### Return type diff --git a/docs/ErrorResponse.md b/docs/ErrorResponse.md index 4e7daa3..ecb5983 100644 --- a/docs/ErrorResponse.md +++ b/docs/ErrorResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**error** | [***crate::models::ErrorDetail**](ErrorDetail.md) | | +**error** | [**crate::models::ErrorDetail**](ErrorDetail.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/HybridTransaction.md b/docs/HybridTransaction.md index a18de00..b765f51 100644 --- a/docs/HybridTransaction.md +++ b/docs/HybridTransaction.md @@ -5,25 +5,25 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | | -**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) | +**date** | [**String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) | **amount** | **i64** | The transaction amount in milliunits format | -**memo** | **String** | | [optional] +**memo** | Option<**String**> | | [optional] **cleared** | **String** | The cleared status of the transaction | **approved** | **bool** | Whether or not the transaction is approved | -**flag_color** | **String** | The transaction flag | [optional] +**flag_color** | Option<**String**> | The transaction flag | [optional] **account_id** | **String** | | -**payee_id** | **String** | | [optional] -**category_id** | **String** | | [optional] -**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional] -**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] -**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional] -**import_id** | **String** | If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. | [optional] +**payee_id** | Option<**String**> | | [optional] +**category_id** | Option<**String**> | | [optional] +**transfer_account_id** | Option<**String**> | If a transfer transaction, the account to which it transfers | [optional] +**transfer_transaction_id** | Option<**String**> | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] +**matched_transaction_id** | Option<**String**> | If transaction is matched, the id of the matched transaction | [optional] +**import_id** | Option<**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] **deleted** | **bool** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. | **_type** | **String** | Whether the hybrid transaction represents a regular transaction or a subtransaction | -**parent_transaction_id** | **String** | For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null. | [optional] +**parent_transaction_id** | Option<**String**> | For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null. | [optional] **account_name** | **String** | | -**payee_name** | **String** | | [optional] -**category_name** | **String** | | [optional] +**payee_name** | Option<**String**> | | [optional] +**category_name** | Option<**String**> | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/HybridTransactionAllOf.md b/docs/HybridTransactionAllOf.md index cb16249..7e4372b 100644 --- a/docs/HybridTransactionAllOf.md +++ b/docs/HybridTransactionAllOf.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_type** | **String** | Whether the hybrid transaction represents a regular transaction or a subtransaction | -**parent_transaction_id** | **String** | For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null. | [optional] +**parent_transaction_id** | Option<**String**> | For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null. | [optional] **account_name** | **String** | | -**payee_name** | **String** | | [optional] -**category_name** | **String** | | [optional] +**payee_name** | Option<**String**> | | [optional] +**category_name** | Option<**String**> | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/HybridTransactionsResponse.md b/docs/HybridTransactionsResponse.md index bd8be57..d179114 100644 --- a/docs/HybridTransactionsResponse.md +++ b/docs/HybridTransactionsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::HybridTransactionsResponseData**](HybridTransactionsResponse_data.md) | | +**data** | [**crate::models::HybridTransactionsResponseData**](HybridTransactionsResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MonthDetail.md b/docs/MonthDetail.md index 6b7b52e..ac58a28 100644 --- a/docs/MonthDetail.md +++ b/docs/MonthDetail.md @@ -4,13 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**month** | [***String**](string.md) | | -**note** | **String** | | [optional] +**month** | [**String**](string.md) | | +**note** | Option<**String**> | | [optional] **income** | **i64** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month | **budgeted** | **i64** | The total amount budgeted in the month | **activity** | **i64** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' | **to_be_budgeted** | **i64** | The available amount for 'To be Budgeted' | -**age_of_money** | **i32** | The Age of Money as of the month | [optional] +**age_of_money** | Option<**i32**> | The Age of Money as of the month | [optional] **deleted** | **bool** | Whether or not the month has been deleted. Deleted months will only be included in delta requests. | **categories** | [**Vec<crate::models::Category>**](Category.md) | The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. | diff --git a/docs/MonthDetailResponse.md b/docs/MonthDetailResponse.md index 72755c2..149ec91 100644 --- a/docs/MonthDetailResponse.md +++ b/docs/MonthDetailResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::MonthDetailResponseData**](MonthDetailResponse_data.md) | | +**data** | [**crate::models::MonthDetailResponseData**](MonthDetailResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MonthDetailResponseData.md b/docs/MonthDetailResponseData.md index 030e5a9..162273f 100644 --- a/docs/MonthDetailResponseData.md +++ b/docs/MonthDetailResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**month** | [***crate::models::MonthDetail**](MonthDetail.md) | | +**month** | [**crate::models::MonthDetail**](MonthDetail.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MonthSummariesResponse.md b/docs/MonthSummariesResponse.md index 1f97b29..133e251 100644 --- a/docs/MonthSummariesResponse.md +++ b/docs/MonthSummariesResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::MonthSummariesResponseData**](MonthSummariesResponse_data.md) | | +**data** | [**crate::models::MonthSummariesResponseData**](MonthSummariesResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MonthSummary.md b/docs/MonthSummary.md index a78cbfc..8c0b086 100644 --- a/docs/MonthSummary.md +++ b/docs/MonthSummary.md @@ -4,13 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**month** | [***String**](string.md) | | -**note** | **String** | | [optional] +**month** | [**String**](string.md) | | +**note** | Option<**String**> | | [optional] **income** | **i64** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month | **budgeted** | **i64** | The total amount budgeted in the month | **activity** | **i64** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' | **to_be_budgeted** | **i64** | The available amount for 'To be Budgeted' | -**age_of_money** | **i32** | The Age of Money as of the month | [optional] +**age_of_money** | Option<**i32**> | The Age of Money as of the month | [optional] **deleted** | **bool** | Whether or not the month has been deleted. Deleted months will only be included in delta requests. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MonthsApi.md b/docs/MonthsApi.md index afa4884..aecf1ce 100644 --- a/docs/MonthsApi.md +++ b/docs/MonthsApi.md @@ -21,8 +21,8 @@ Returns a single budget month Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**month** | **String** | The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**month** | **String** | The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | [required] | ### Return type @@ -52,8 +52,8 @@ Returns all budget months Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**last_knowledge_of_server** | **i64** | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**last_knowledge_of_server** | Option<**i64**> | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | ### Return type diff --git a/docs/Payee.md b/docs/Payee.md index ff886e6..19d9ab6 100644 --- a/docs/Payee.md +++ b/docs/Payee.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | | **name** | **String** | | -**transfer_account_id** | **String** | If a transfer payee, the account_id to which this payee transfers to | [optional] +**transfer_account_id** | Option<**String**> | If a transfer payee, the account_id to which this payee transfers to | [optional] **deleted** | **bool** | Whether or not the payee has been deleted. Deleted payees will only be included in delta requests. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PayeeLocationResponse.md b/docs/PayeeLocationResponse.md index 83e7b59..c5b3d2d 100644 --- a/docs/PayeeLocationResponse.md +++ b/docs/PayeeLocationResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::PayeeLocationResponseData**](PayeeLocationResponse_data.md) | | +**data** | [**crate::models::PayeeLocationResponseData**](PayeeLocationResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PayeeLocationResponseData.md b/docs/PayeeLocationResponseData.md index 292a39d..e52c0bc 100644 --- a/docs/PayeeLocationResponseData.md +++ b/docs/PayeeLocationResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payee_location** | [***crate::models::PayeeLocation**](PayeeLocation.md) | | +**payee_location** | [**crate::models::PayeeLocation**](PayeeLocation.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PayeeLocationsApi.md b/docs/PayeeLocationsApi.md index d64a8fa..25cc850 100644 --- a/docs/PayeeLocationsApi.md +++ b/docs/PayeeLocationsApi.md @@ -22,8 +22,8 @@ Returns a single payee location Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**payee_location_id** | **String** | id of payee location | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**payee_location_id** | **String** | id of payee location | [required] | ### Return type @@ -53,7 +53,7 @@ Returns all payee locations Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | ### Return type @@ -83,8 +83,8 @@ Returns all payee locations for the specified payee Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**payee_id** | **String** | id of payee | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**payee_id** | **String** | id of payee | [required] | ### Return type diff --git a/docs/PayeeLocationsResponse.md b/docs/PayeeLocationsResponse.md index b18dfd8..dd47ec2 100644 --- a/docs/PayeeLocationsResponse.md +++ b/docs/PayeeLocationsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::PayeeLocationsResponseData**](PayeeLocationsResponse_data.md) | | +**data** | [**crate::models::PayeeLocationsResponseData**](PayeeLocationsResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PayeeResponse.md b/docs/PayeeResponse.md index 6b4174d..0ff0db4 100644 --- a/docs/PayeeResponse.md +++ b/docs/PayeeResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::PayeeResponseData**](PayeeResponse_data.md) | | +**data** | [**crate::models::PayeeResponseData**](PayeeResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PayeeResponseData.md b/docs/PayeeResponseData.md index 8e3e6e2..8b5e3ab 100644 --- a/docs/PayeeResponseData.md +++ b/docs/PayeeResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payee** | [***crate::models::Payee**](Payee.md) | | +**payee** | [**crate::models::Payee**](Payee.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PayeesApi.md b/docs/PayeesApi.md index dfa1a17..6ee2d4d 100644 --- a/docs/PayeesApi.md +++ b/docs/PayeesApi.md @@ -21,8 +21,8 @@ Returns single payee Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**payee_id** | **String** | The id of the payee | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**payee_id** | **String** | The id of the payee | [required] | ### Return type @@ -52,8 +52,8 @@ Returns all payees Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**last_knowledge_of_server** | **i64** | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**last_knowledge_of_server** | Option<**i64**> | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | ### Return type diff --git a/docs/PayeesResponse.md b/docs/PayeesResponse.md index a2bcfcf..ba10f6a 100644 --- a/docs/PayeesResponse.md +++ b/docs/PayeesResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::PayeesResponseData**](PayeesResponse_data.md) | | +**data** | [**crate::models::PayeesResponseData**](PayeesResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SaveCategoryResponse.md b/docs/SaveCategoryResponse.md index 05aa2f2..97c0df9 100644 --- a/docs/SaveCategoryResponse.md +++ b/docs/SaveCategoryResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::SaveCategoryResponseData**](SaveCategoryResponse_data.md) | | +**data** | [**crate::models::SaveCategoryResponseData**](SaveCategoryResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SaveCategoryResponseData.md b/docs/SaveCategoryResponseData.md index 92dfdc2..d6b4961 100644 --- a/docs/SaveCategoryResponseData.md +++ b/docs/SaveCategoryResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | [***crate::models::Category**](Category.md) | | +**category** | [**crate::models::Category**](Category.md) | | **server_knowledge** | **i64** | The knowledge of the server | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SaveMonthCategoryWrapper.md b/docs/SaveMonthCategoryWrapper.md index 65d4917..3a3a65d 100644 --- a/docs/SaveMonthCategoryWrapper.md +++ b/docs/SaveMonthCategoryWrapper.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | [***crate::models::SaveMonthCategory**](SaveMonthCategory.md) | | +**category** | [**crate::models::SaveMonthCategory**](SaveMonthCategory.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SaveTransaction.md b/docs/SaveTransaction.md index 77ab098..62675bd 100644 --- a/docs/SaveTransaction.md +++ b/docs/SaveTransaction.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **account_id** | **String** | | -**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored. | +**date** | [**String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored. | **amount** | **i64** | The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored. | -**payee_id** | **String** | The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as tranfer_payee_id on the account resource. | [optional] -**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] -**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] -**memo** | **String** | | [optional] -**cleared** | **String** | The cleared status of the transaction | [optional] -**approved** | **bool** | Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default. | [optional] -**flag_color** | **String** | The transaction flag | [optional] -**import_id** | **String** | If specified, the new transaction will be assigned this import_id and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in 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'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API). | [optional] +**payee_id** | Option<**String**> | The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as tranfer_payee_id on the account resource. | [optional] +**payee_name** | Option<**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] +**category_id** | Option<**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] +**memo** | Option<**String**> | | [optional] +**cleared** | Option<**String**> | The cleared status of the transaction | [optional] +**approved** | Option<**bool**> | Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default. | [optional] +**flag_color** | Option<**String**> | The transaction flag | [optional] +**import_id** | Option<**String**> | If specified, the new transaction will be assigned this import_id and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in 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'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API). | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SaveTransactionWrapper.md b/docs/SaveTransactionWrapper.md index 1bc9fda..143b778 100644 --- a/docs/SaveTransactionWrapper.md +++ b/docs/SaveTransactionWrapper.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transaction** | [***crate::models::SaveTransaction**](SaveTransaction.md) | | +**transaction** | [**crate::models::SaveTransaction**](SaveTransaction.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SaveTransactionsResponse.md b/docs/SaveTransactionsResponse.md index 9a13135..d7a067b 100644 --- a/docs/SaveTransactionsResponse.md +++ b/docs/SaveTransactionsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::SaveTransactionsResponseData**](SaveTransactionsResponse_data.md) | | +**data** | [**crate::models::SaveTransactionsResponseData**](SaveTransactionsResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SaveTransactionsResponseData.md b/docs/SaveTransactionsResponseData.md index 98b414b..7675def 100644 --- a/docs/SaveTransactionsResponseData.md +++ b/docs/SaveTransactionsResponseData.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transaction_ids** | **Vec<String>** | The transaction ids that were saved | -**transaction** | [***crate::models::TransactionDetail**](TransactionDetail.md) | | [optional] -**transactions** | [**Vec<crate::models::TransactionDetail>**](TransactionDetail.md) | If multiple transactions were specified, the transactions that were saved | [optional] -**duplicate_import_ids** | **Vec<String>** | If multiple transactions were specified, a list of import_ids that were not created because of an existing import_id found on the same account | [optional] +**transaction** | Option<[**crate::models::TransactionDetail**](TransactionDetail.md)> | | [optional] +**transactions** | Option<[**Vec<crate::models::TransactionDetail>**](TransactionDetail.md)> | If multiple transactions were specified, the transactions that were saved | [optional] +**duplicate_import_ids** | Option<**Vec<String>**> | If multiple transactions were specified, a list of import_ids that were not created because of an existing import_id found on the same account | [optional] **server_knowledge** | **i64** | The knowledge of the server | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SaveTransactionsWrapper.md b/docs/SaveTransactionsWrapper.md index 6f2dcfd..bff3f3f 100644 --- a/docs/SaveTransactionsWrapper.md +++ b/docs/SaveTransactionsWrapper.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transaction** | [***crate::models::SaveTransaction**](SaveTransaction.md) | | [optional] -**transactions** | [**Vec<crate::models::SaveTransaction>**](SaveTransaction.md) | | [optional] +**transaction** | Option<[**crate::models::SaveTransaction**](SaveTransaction.md)> | | [optional] +**transactions** | Option<[**Vec<crate::models::SaveTransaction>**](SaveTransaction.md)> | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ScheduledSubTransaction.md b/docs/ScheduledSubTransaction.md index 7b3cae4..c23b676 100644 --- a/docs/ScheduledSubTransaction.md +++ b/docs/ScheduledSubTransaction.md @@ -7,10 +7,10 @@ Name | Type | Description | Notes **id** | **String** | | **scheduled_transaction_id** | **String** | | **amount** | **i64** | The scheduled subtransaction amount in milliunits format | -**memo** | **String** | | [optional] -**payee_id** | **String** | | [optional] -**category_id** | **String** | | [optional] -**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled subtransaction transfers to | [optional] +**memo** | Option<**String**> | | [optional] +**payee_id** | Option<**String**> | | [optional] +**category_id** | Option<**String**> | | [optional] +**transfer_account_id** | Option<**String**> | If a transfer, the account_id which the scheduled subtransaction transfers to | [optional] **deleted** | **bool** | Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ScheduledTransactionDetail.md b/docs/ScheduledTransactionDetail.md index a29c019..3324e0c 100644 --- a/docs/ScheduledTransactionDetail.md +++ b/docs/ScheduledTransactionDetail.md @@ -5,20 +5,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | | -**date_first** | [***String**](string.md) | The first date for which the Scheduled Transaction was scheduled. | -**date_next** | [***String**](string.md) | The next date for which the Scheduled Transaction is scheduled. | +**date_first** | [**String**](string.md) | The first date for which the Scheduled Transaction was scheduled. | +**date_next** | [**String**](string.md) | The next date for which the Scheduled Transaction is scheduled. | **frequency** | **String** | | **amount** | **i64** | The scheduled transaction amount in milliunits format | -**memo** | **String** | | [optional] -**flag_color** | **String** | The scheduled transaction flag | [optional] +**memo** | Option<**String**> | | [optional] +**flag_color** | Option<**String**> | The scheduled 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] +**payee_id** | Option<**String**> | | [optional] +**category_id** | Option<**String**> | | [optional] +**transfer_account_id** | Option<**String**> | If a transfer, the account_id which the scheduled transaction transfers to | [optional] **deleted** | **bool** | Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests. | **account_name** | **String** | | -**payee_name** | **String** | | [optional] -**category_name** | **String** | | [optional] +**payee_name** | Option<**String**> | | [optional] +**category_name** | Option<**String**> | | [optional] **subtransactions** | [**Vec<crate::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md) | If a split scheduled transaction, the subtransactions. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ScheduledTransactionDetailAllOf.md b/docs/ScheduledTransactionDetailAllOf.md index dc70d71..1699e6f 100644 --- a/docs/ScheduledTransactionDetailAllOf.md +++ b/docs/ScheduledTransactionDetailAllOf.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **account_name** | **String** | | -**payee_name** | **String** | | [optional] -**category_name** | **String** | | [optional] +**payee_name** | Option<**String**> | | [optional] +**category_name** | Option<**String**> | | [optional] **subtransactions** | [**Vec<crate::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md) | If a split scheduled transaction, the subtransactions. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ScheduledTransactionResponse.md b/docs/ScheduledTransactionResponse.md index 4bc90f1..0f6368f 100644 --- a/docs/ScheduledTransactionResponse.md +++ b/docs/ScheduledTransactionResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::ScheduledTransactionResponseData**](ScheduledTransactionResponse_data.md) | | +**data** | [**crate::models::ScheduledTransactionResponseData**](ScheduledTransactionResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ScheduledTransactionResponseData.md b/docs/ScheduledTransactionResponseData.md index 87dbc5d..111b248 100644 --- a/docs/ScheduledTransactionResponseData.md +++ b/docs/ScheduledTransactionResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**scheduled_transaction** | [***crate::models::ScheduledTransactionDetail**](ScheduledTransactionDetail.md) | | +**scheduled_transaction** | [**crate::models::ScheduledTransactionDetail**](ScheduledTransactionDetail.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ScheduledTransactionSummary.md b/docs/ScheduledTransactionSummary.md index 4dda3bb..117f4e3 100644 --- a/docs/ScheduledTransactionSummary.md +++ b/docs/ScheduledTransactionSummary.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | | -**date_first** | [***String**](string.md) | The first date for which the Scheduled Transaction was scheduled. | -**date_next** | [***String**](string.md) | The next date for which the Scheduled Transaction is scheduled. | +**date_first** | [**String**](string.md) | The first date for which the Scheduled Transaction was scheduled. | +**date_next** | [**String**](string.md) | The next date for which the Scheduled Transaction is scheduled. | **frequency** | **String** | | **amount** | **i64** | The scheduled transaction amount in milliunits format | -**memo** | **String** | | [optional] -**flag_color** | **String** | The scheduled transaction flag | [optional] +**memo** | Option<**String**> | | [optional] +**flag_color** | Option<**String**> | The scheduled 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] +**payee_id** | Option<**String**> | | [optional] +**category_id** | Option<**String**> | | [optional] +**transfer_account_id** | Option<**String**> | If a transfer, the account_id which the scheduled transaction transfers to | [optional] **deleted** | **bool** | Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ScheduledTransactionsApi.md b/docs/ScheduledTransactionsApi.md index eebb224..c03c0de 100644 --- a/docs/ScheduledTransactionsApi.md +++ b/docs/ScheduledTransactionsApi.md @@ -21,8 +21,8 @@ Returns a single scheduled transaction Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**scheduled_transaction_id** | **String** | The id of the scheduled transaction | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**scheduled_transaction_id** | **String** | The id of the scheduled transaction | [required] | ### Return type @@ -52,8 +52,8 @@ Returns all scheduled transactions Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**last_knowledge_of_server** | **i64** | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**last_knowledge_of_server** | Option<**i64**> | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | ### Return type diff --git a/docs/ScheduledTransactionsResponse.md b/docs/ScheduledTransactionsResponse.md index 982dc02..abd0ecf 100644 --- a/docs/ScheduledTransactionsResponse.md +++ b/docs/ScheduledTransactionsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::ScheduledTransactionsResponseData**](ScheduledTransactionsResponse_data.md) | | +**data** | [**crate::models::ScheduledTransactionsResponseData**](ScheduledTransactionsResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SubTransaction.md b/docs/SubTransaction.md index 77bad7f..1e3b0ec 100644 --- a/docs/SubTransaction.md +++ b/docs/SubTransaction.md @@ -7,10 +7,10 @@ Name | Type | Description | Notes **id** | **String** | | **transaction_id** | **String** | | **amount** | **i64** | The subtransaction amount in milliunits format | -**memo** | **String** | | [optional] -**payee_id** | **String** | | [optional] -**category_id** | **String** | | [optional] -**transfer_account_id** | **String** | If a transfer, the account_id which the subtransaction transfers to | [optional] +**memo** | Option<**String**> | | [optional] +**payee_id** | Option<**String**> | | [optional] +**category_id** | Option<**String**> | | [optional] +**transfer_account_id** | Option<**String**> | If a transfer, the account_id which the subtransaction transfers to | [optional] **deleted** | **bool** | Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TransactionDetail.md b/docs/TransactionDetail.md index 3ba9072..b354332 100644 --- a/docs/TransactionDetail.md +++ b/docs/TransactionDetail.md @@ -5,23 +5,23 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | | -**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) | +**date** | [**String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) | **amount** | **i64** | The transaction amount in milliunits format | -**memo** | **String** | | [optional] +**memo** | Option<**String**> | | [optional] **cleared** | **String** | The cleared status of the transaction | **approved** | **bool** | Whether or not the transaction is approved | -**flag_color** | **String** | The transaction flag | [optional] +**flag_color** | Option<**String**> | The transaction flag | [optional] **account_id** | **String** | | -**payee_id** | **String** | | [optional] -**category_id** | **String** | | [optional] -**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional] -**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] -**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional] -**import_id** | **String** | If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. | [optional] +**payee_id** | Option<**String**> | | [optional] +**category_id** | Option<**String**> | | [optional] +**transfer_account_id** | Option<**String**> | If a transfer transaction, the account to which it transfers | [optional] +**transfer_transaction_id** | Option<**String**> | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] +**matched_transaction_id** | Option<**String**> | If transaction is matched, the id of the matched transaction | [optional] +**import_id** | Option<**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] **deleted** | **bool** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. | **account_name** | **String** | | -**payee_name** | **String** | | [optional] -**category_name** | **String** | | [optional] +**payee_name** | Option<**String**> | | [optional] +**category_name** | Option<**String**> | | [optional] **subtransactions** | [**Vec<crate::models::SubTransaction>**](SubTransaction.md) | If a split transaction, the subtransactions. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TransactionDetailAllOf.md b/docs/TransactionDetailAllOf.md index 663f5f6..6cc4c8b 100644 --- a/docs/TransactionDetailAllOf.md +++ b/docs/TransactionDetailAllOf.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **account_name** | **String** | | -**payee_name** | **String** | | [optional] -**category_name** | **String** | | [optional] +**payee_name** | Option<**String**> | | [optional] +**category_name** | Option<**String**> | | [optional] **subtransactions** | [**Vec<crate::models::SubTransaction>**](SubTransaction.md) | If a split transaction, the subtransactions. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TransactionResponse.md b/docs/TransactionResponse.md index 16e54b9..8897033 100644 --- a/docs/TransactionResponse.md +++ b/docs/TransactionResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::TransactionResponseData**](TransactionResponse_data.md) | | +**data** | [**crate::models::TransactionResponseData**](TransactionResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TransactionResponseData.md b/docs/TransactionResponseData.md index be390dd..a1731b6 100644 --- a/docs/TransactionResponseData.md +++ b/docs/TransactionResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transaction** | [***crate::models::TransactionDetail**](TransactionDetail.md) | | +**transaction** | [**crate::models::TransactionDetail**](TransactionDetail.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TransactionSummary.md b/docs/TransactionSummary.md index fd93b15..e8e7db6 100644 --- a/docs/TransactionSummary.md +++ b/docs/TransactionSummary.md @@ -5,19 +5,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | | -**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) | +**date** | [**String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) | **amount** | **i64** | The transaction amount in milliunits format | -**memo** | **String** | | [optional] +**memo** | Option<**String**> | | [optional] **cleared** | **String** | The cleared status of the transaction | **approved** | **bool** | Whether or not the transaction is approved | -**flag_color** | **String** | The transaction flag | [optional] +**flag_color** | Option<**String**> | The transaction flag | [optional] **account_id** | **String** | | -**payee_id** | **String** | | [optional] -**category_id** | **String** | | [optional] -**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional] -**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] -**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional] -**import_id** | **String** | If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. | [optional] +**payee_id** | Option<**String**> | | [optional] +**category_id** | Option<**String**> | | [optional] +**transfer_account_id** | Option<**String**> | If a transfer transaction, the account to which it transfers | [optional] +**transfer_transaction_id** | Option<**String**> | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] +**matched_transaction_id** | Option<**String**> | If transaction is matched, the id of the matched transaction | [optional] +**import_id** | Option<**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] **deleted** | **bool** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TransactionsApi.md b/docs/TransactionsApi.md index 689031e..8e7a646 100644 --- a/docs/TransactionsApi.md +++ b/docs/TransactionsApi.md @@ -27,8 +27,8 @@ Creates a single transaction or multiple transactions. If you provide a body co Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**data** | [**SaveTransactionsWrapper**](SaveTransactionsWrapper.md) | The transaction or transactions to create. To create a single transaction you can specify a value for the 'transaction' object and to create multiple transactions you can specify an array of 'transactions'. It is expected that you will only provide a value for one of these objects. | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**data** | [**SaveTransactionsWrapper**](SaveTransactionsWrapper.md) | The transaction or transactions to create. To create a single transaction you can specify a value for the 'transaction' object and to create multiple transactions you can specify an array of 'transactions'. It is expected that you will only provide a value for one of these objects. | [required] | ### Return type @@ -58,8 +58,8 @@ Returns a single transaction Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**transaction_id** | **String** | The id of the transaction | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**transaction_id** | **String** | The id of the transaction | [required] | ### Return type @@ -89,10 +89,10 @@ Returns budget transactions Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**since_date** | **String** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | | -**_type** | **String** | If specified, only transactions of the specified type will be included. 'uncategorized' and 'unapproved' are currently supported. | | -**last_knowledge_of_server** | **i64** | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**since_date** | Option<**String**> | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | | +**_type** | Option<**String**> | If specified, only transactions of the specified type will be included. 'uncategorized' and 'unapproved' are currently supported. | | +**last_knowledge_of_server** | Option<**i64**> | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | ### Return type @@ -122,11 +122,11 @@ Returns all transactions for a specified account Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**account_id** | **String** | The id of the account | Required | -**since_date** | **String** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | | -**_type** | **String** | If specified, only transactions of the specified type will be included. 'uncategorized' and 'unapproved' are currently supported. | | -**last_knowledge_of_server** | **i64** | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**account_id** | **String** | The id of the account | [required] | +**since_date** | Option<**String**> | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | | +**_type** | Option<**String**> | If specified, only transactions of the specified type will be included. 'uncategorized' and 'unapproved' are currently supported. | | +**last_knowledge_of_server** | Option<**i64**> | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | ### Return type @@ -156,11 +156,11 @@ Returns all transactions for a specified category Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**category_id** | **String** | The id of the category | Required | -**since_date** | **String** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | | -**_type** | **String** | If specified, only transactions of the specified type will be included. 'uncategorized' and 'unapproved' are currently supported. | | -**last_knowledge_of_server** | **i64** | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**category_id** | **String** | The id of the category | [required] | +**since_date** | Option<**String**> | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | | +**_type** | Option<**String**> | If specified, only transactions of the specified type will be included. 'uncategorized' and 'unapproved' are currently supported. | | +**last_knowledge_of_server** | Option<**i64**> | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | ### Return type @@ -190,11 +190,11 @@ Returns all transactions for a specified payee Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**payee_id** | **String** | The id of the payee | Required | -**since_date** | **String** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | | -**_type** | **String** | If specified, only transactions of the specified type will be included. 'uncategorized' and 'unapproved' are currently supported. | | -**last_knowledge_of_server** | **i64** | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**payee_id** | **String** | The id of the payee | [required] | +**since_date** | Option<**String**> | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | | +**_type** | Option<**String**> | If specified, only transactions of the specified type will be included. 'uncategorized' and 'unapproved' are currently supported. | | +**last_knowledge_of_server** | Option<**i64**> | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | ### Return type @@ -224,9 +224,9 @@ Updates a transaction Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**transaction_id** | **String** | The id of the transaction | Required | -**data** | [**SaveTransactionWrapper**](SaveTransactionWrapper.md) | The transaction to update | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**transaction_id** | **String** | The id of the transaction | [required] | +**data** | [**SaveTransactionWrapper**](SaveTransactionWrapper.md) | The transaction to update | [required] | ### Return type @@ -256,8 +256,8 @@ Updates multiple transactions, by 'id' or 'import_id'. Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | -**data** | [**UpdateTransactionsWrapper**](UpdateTransactionsWrapper.md) | The transactions to update. Each transaction must have either an 'id' or 'import_id' specified. If 'id' is specified as null an 'import_id' value can be provided which will allow transaction(s) to be updated by their import_id. If an id is specified, it will always be used for lookup. | Required | +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | [required] | +**data** | [**UpdateTransactionsWrapper**](UpdateTransactionsWrapper.md) | The transactions to update. Each transaction must have either an 'id' or 'import_id' specified. If 'id' is specified as null an 'import_id' value can be provided which will allow transaction(s) to be updated by their import_id. If an id is specified, it will always be used for lookup. | [required] | ### Return type diff --git a/docs/TransactionsResponse.md b/docs/TransactionsResponse.md index 956caa7..81fcfa6 100644 --- a/docs/TransactionsResponse.md +++ b/docs/TransactionsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::TransactionsResponseData**](TransactionsResponse_data.md) | | +**data** | [**crate::models::TransactionsResponseData**](TransactionsResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateTransaction.md b/docs/UpdateTransaction.md index bb01087..5c42d0c 100644 --- a/docs/UpdateTransaction.md +++ b/docs/UpdateTransaction.md @@ -6,16 +6,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | | **account_id** | **String** | | -**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored. | +**date** | [**String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored. | **amount** | **i64** | The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored. | -**payee_id** | **String** | The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as tranfer_payee_id on the account resource. | [optional] -**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] -**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] -**memo** | **String** | | [optional] -**cleared** | **String** | The cleared status of the transaction | [optional] -**approved** | **bool** | Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default. | [optional] -**flag_color** | **String** | The transaction flag | [optional] -**import_id** | **String** | If specified, the new transaction will be assigned this import_id and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in 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'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API). | [optional] +**payee_id** | Option<**String**> | The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as tranfer_payee_id on the account resource. | [optional] +**payee_name** | Option<**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] +**category_id** | Option<**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] +**memo** | Option<**String**> | | [optional] +**cleared** | Option<**String**> | The cleared status of the transaction | [optional] +**approved** | Option<**bool**> | Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default. | [optional] +**flag_color** | Option<**String**> | The transaction flag | [optional] +**import_id** | Option<**String**> | If specified, the new transaction will be assigned this import_id and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in 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'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API). | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UserResponse.md b/docs/UserResponse.md index ea094b4..98138a3 100644 --- a/docs/UserResponse.md +++ b/docs/UserResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***crate::models::UserResponseData**](UserResponse_data.md) | | +**data** | [**crate::models::UserResponseData**](UserResponse_data.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UserResponseData.md b/docs/UserResponseData.md index 9669e8a..81e3343 100644 --- a/docs/UserResponseData.md +++ b/docs/UserResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user** | [***crate::models::User**](User.md) | | +**user** | [**crate::models::User**](User.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |