diff options
Diffstat (limited to 'docs')
81 files changed, 309 insertions, 440 deletions
diff --git a/docs/AccountResponse.md b/docs/AccountResponse.md index eb39808..dbb74b3 100644 --- a/docs/AccountResponse.md +++ b/docs/AccountResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 d437a2f..3ae5b7c 100644 --- a/docs/AccountResponseData.md +++ b/docs/AccountResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**account** | [***::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 98270b9..1958f71 100644 --- a/docs/AccountsApi.md +++ b/docs/AccountsApi.md @@ -11,23 +11,22 @@ Method | HTTP request | Description ## get_account_by_id -> ::models::AccountResponse get_account_by_id(ctx, budget_id, account_id) +> crate::models::AccountResponse get_account_by_id(budget_id, account_id) Single account Returns a single account -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **account_id** | [**String**](.md)| The id of the 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 | ### Return type -[**::models::AccountResponse**](AccountResponse.md) +[**crate::models::AccountResponse**](AccountResponse.md) ### Authorization @@ -43,32 +42,22 @@ Name | Type | Description | Notes ## get_accounts -> ::models::AccountsResponse get_accounts(ctx, budget_id, optional) +> crate::models::AccountsResponse get_accounts(budget_id, last_knowledge_of_server) Account list Returns all accounts -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **optional** | **map[string]interface{}** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a map[string]interface{}. - -Name | Type | Description | 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) | - **last_knowledge_of_server** | **i64**| The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | +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. | | ### Return type -[**::models::AccountsResponse**](AccountsResponse.md) +[**crate::models::AccountsResponse**](AccountsResponse.md) ### Authorization diff --git a/docs/AccountsResponse.md b/docs/AccountsResponse.md index 6dc10dd..8ae5bea 100644 --- a/docs/AccountsResponse.md +++ b/docs/AccountsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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/AccountsResponseData.md b/docs/AccountsResponseData.md index 968cad8..75c4502 100644 --- a/docs/AccountsResponseData.md +++ b/docs/AccountsResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**accounts** | [**Vec<::models::Account>**](Account.md) | | +**accounts** | [**Vec<crate::models::Account>**](Account.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/BudgetDetail.md b/docs/BudgetDetail.md index 3dac64b..41741b1 100644 --- a/docs/BudgetDetail.md +++ b/docs/BudgetDetail.md @@ -9,18 +9,18 @@ Name | Type | Description | Notes **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** | [***::models::DateFormat**](DateFormat.md) | | [optional] -**currency_format** | [***::models::CurrencyFormat**](CurrencyFormat.md) | | [optional] -**accounts** | [**Vec<::models::Account>**](Account.md) | | [optional] -**payees** | [**Vec<::models::Payee>**](Payee.md) | | [optional] -**payee_locations** | [**Vec<::models::PayeeLocation>**](PayeeLocation.md) | | [optional] -**category_groups** | [**Vec<::models::CategoryGroup>**](CategoryGroup.md) | | [optional] -**categories** | [**Vec<::models::Category>**](Category.md) | | [optional] -**months** | [**Vec<::models::MonthDetail>**](MonthDetail.md) | | [optional] -**transactions** | [**Vec<::models::TransactionSummary>**](TransactionSummary.md) | | [optional] -**subtransactions** | [**Vec<::models::SubTransaction>**](SubTransaction.md) | | [optional] -**scheduled_transactions** | [**Vec<::models::ScheduledTransactionSummary>**](ScheduledTransactionSummary.md) | | [optional] -**scheduled_subtransactions** | [**Vec<::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md) | | [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] [[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 f5df347..6a922f5 100644 --- a/docs/BudgetDetailAllOf.md +++ b/docs/BudgetDetailAllOf.md @@ -4,16 +4,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**accounts** | [**Vec<::models::Account>**](Account.md) | | [optional] -**payees** | [**Vec<::models::Payee>**](Payee.md) | | [optional] -**payee_locations** | [**Vec<::models::PayeeLocation>**](PayeeLocation.md) | | [optional] -**category_groups** | [**Vec<::models::CategoryGroup>**](CategoryGroup.md) | | [optional] -**categories** | [**Vec<::models::Category>**](Category.md) | | [optional] -**months** | [**Vec<::models::MonthDetail>**](MonthDetail.md) | | [optional] -**transactions** | [**Vec<::models::TransactionSummary>**](TransactionSummary.md) | | [optional] -**subtransactions** | [**Vec<::models::SubTransaction>**](SubTransaction.md) | | [optional] -**scheduled_transactions** | [**Vec<::models::ScheduledTransactionSummary>**](ScheduledTransactionSummary.md) | | [optional] -**scheduled_subtransactions** | [**Vec<::models::ScheduledSubTransaction>**](ScheduledSubTransaction.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] [[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 97cc82e..08d9d7b 100644 --- a/docs/BudgetDetailResponse.md +++ b/docs/BudgetDetailResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 8697aae..88e4c7a 100644 --- a/docs/BudgetDetailResponseData.md +++ b/docs/BudgetDetailResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**budget** | [***::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 b0604b4..ff8d6b0 100644 --- a/docs/BudgetSettings.md +++ b/docs/BudgetSettings.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**date_format** | [***::models::DateFormat**](DateFormat.md) | | -**currency_format** | [***::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 ee92163..1b88253 100644 --- a/docs/BudgetSettingsResponse.md +++ b/docs/BudgetSettingsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 3d2c4cc..a84371e 100644 --- a/docs/BudgetSettingsResponseData.md +++ b/docs/BudgetSettingsResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**settings** | [***::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 f2e444b..eec8fba 100644 --- a/docs/BudgetSummary.md +++ b/docs/BudgetSummary.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **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** | [***::models::DateFormat**](DateFormat.md) | | [optional] -**currency_format** | [***::models::CurrencyFormat**](CurrencyFormat.md) | | [optional] +**date_format** | [***crate::models::DateFormat**](DateFormat.md) | | [optional] +**currency_format** | [***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 5b029dd..5c16c83 100644 --- a/docs/BudgetSummaryResponse.md +++ b/docs/BudgetSummaryResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 2836bfa..ecd5854 100644 --- a/docs/BudgetSummaryResponseData.md +++ b/docs/BudgetSummaryResponseData.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**budgets** | [**Vec<::models::BudgetSummary>**](BudgetSummary.md) | | -**default_budget** | [***::models::BudgetSummary**](BudgetSummary.md) | | [optional] +**budgets** | [**Vec<crate::models::BudgetSummary>**](BudgetSummary.md) | | +**default_budget** | [***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 563b754..d91cd6d 100644 --- a/docs/BudgetsApi.md +++ b/docs/BudgetsApi.md @@ -12,32 +12,22 @@ Method | HTTP request | Description ## get_budget_by_id -> ::models::BudgetDetailResponse get_budget_by_id(ctx, budget_id, optional) +> crate::models::BudgetDetailResponse get_budget_by_id(budget_id, last_knowledge_of_server) Single budget Returns a single budget with all related entities. This resource is effectively a full budget export. -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **optional** | **map[string]interface{}** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a map[string]interface{}. - -Name | Type | Description | 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) | - **last_knowledge_of_server** | **i64**| The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | +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. | | ### Return type -[**::models::BudgetDetailResponse**](BudgetDetailResponse.md) +[**crate::models::BudgetDetailResponse**](BudgetDetailResponse.md) ### Authorization @@ -53,22 +43,21 @@ Name | Type | Description | Notes ## get_budget_settings_by_id -> ::models::BudgetSettingsResponse get_budget_settings_by_id(ctx, budget_id) +> crate::models::BudgetSettingsResponse get_budget_settings_by_id(budget_id) Budget Settings Returns settings for a budget -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | +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 | ### Return type -[**::models::BudgetSettingsResponse**](BudgetSettingsResponse.md) +[**crate::models::BudgetSettingsResponse**](BudgetSettingsResponse.md) ### Authorization @@ -84,18 +73,18 @@ Name | Type | Description | Notes ## get_budgets -> ::models::BudgetSummaryResponse get_budgets(ctx, ) +> crate::models::BudgetSummaryResponse get_budgets() List budgets Returns budgets list with summary information -### Required Parameters +### Parameters This endpoint does not need any parameter. ### Return type -[**::models::BudgetSummaryResponse**](BudgetSummaryResponse.md) +[**crate::models::BudgetSummaryResponse**](BudgetSummaryResponse.md) ### Authorization diff --git a/docs/BulkResponse.md b/docs/BulkResponse.md index 009e60c..edcad4c 100644 --- a/docs/BulkResponse.md +++ b/docs/BulkResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 82fef82..0ae0658 100644 --- a/docs/BulkResponseData.md +++ b/docs/BulkResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**bulk** | [***::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/BulkTransactions.md b/docs/BulkTransactions.md index dc990e4..fd6987c 100644 --- a/docs/BulkTransactions.md +++ b/docs/BulkTransactions.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transactions** | [**Vec<::models::SaveTransaction>**](SaveTransaction.md) | | +**transactions** | [**Vec<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/CategoriesApi.md b/docs/CategoriesApi.md index 00294b8..4266752 100644 --- a/docs/CategoriesApi.md +++ b/docs/CategoriesApi.md @@ -13,32 +13,22 @@ Method | HTTP request | Description ## get_categories -> ::models::CategoriesResponse get_categories(ctx, budget_id, optional) +> crate::models::CategoriesResponse get_categories(budget_id, last_knowledge_of_server) List categories Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **optional** | **map[string]interface{}** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a map[string]interface{}. - -Name | Type | Description | 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) | - **last_knowledge_of_server** | **i64**| The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | +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. | | ### Return type -[**::models::CategoriesResponse**](CategoriesResponse.md) +[**crate::models::CategoriesResponse**](CategoriesResponse.md) ### Authorization @@ -54,23 +44,22 @@ Name | Type | Description | Notes ## get_category_by_id -> ::models::CategoryResponse get_category_by_id(ctx, budget_id, category_id) +> crate::models::CategoryResponse get_category_by_id(budget_id, category_id) Single category Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **category_id** | **String**| The id of the 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 | ### Return type -[**::models::CategoryResponse**](CategoryResponse.md) +[**crate::models::CategoryResponse**](CategoryResponse.md) ### Authorization @@ -86,24 +75,23 @@ Name | Type | Description | Notes ## get_month_category_by_id -> ::models::CategoryResponse get_month_category_by_id(ctx, budget_id, month, category_id) +> crate::models::CategoryResponse get_month_category_by_id(budget_id, month, category_id) Single category for a specific budget month Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **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)) | - **category_id** | **String**| The id of the 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 | +**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 -[**::models::CategoryResponse**](CategoryResponse.md) +[**crate::models::CategoryResponse**](CategoryResponse.md) ### Authorization @@ -119,25 +107,24 @@ Name | Type | Description | Notes ## update_month_category -> ::models::SaveCategoryResponse update_month_category(ctx, budget_id, month, category_id, data) +> crate::models::SaveCategoryResponse update_month_category(budget_id, month, category_id, data) Update a category for a specific month Update a category for a specific month -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **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)) | - **category_id** | **String**| The id of the category | - **data** | [**SaveMonthCategoryWrapper**](SaveMonthCategoryWrapper.md)| The category to update | +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 | ### Return type -[**::models::SaveCategoryResponse**](SaveCategoryResponse.md) +[**crate::models::SaveCategoryResponse**](SaveCategoryResponse.md) ### Authorization diff --git a/docs/CategoriesResponse.md b/docs/CategoriesResponse.md index e760b74..1d0374c 100644 --- a/docs/CategoriesResponse.md +++ b/docs/CategoriesResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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/CategoriesResponseData.md b/docs/CategoriesResponseData.md index 766aae4..d693e40 100644 --- a/docs/CategoriesResponseData.md +++ b/docs/CategoriesResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category_groups** | [**Vec<::models::CategoryGroupWithCategories>**](CategoryGroupWithCategories.md) | | +**category_groups** | [**Vec<crate::models::CategoryGroupWithCategories>**](CategoryGroupWithCategories.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/Category.md b/docs/Category.md index 217979b..9b6f7c9 100644 --- a/docs/Category.md +++ b/docs/Category.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **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 cagegory has a goal (TB=Target Category Balance, TBD=Target Category Balance by Date, MF=Monthly Funding) | [optional] +**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] diff --git a/docs/CategoryGroupWithCategories.md b/docs/CategoryGroupWithCategories.md index c1355c2..ff3ba4a 100644 --- a/docs/CategoryGroupWithCategories.md +++ b/docs/CategoryGroupWithCategories.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **name** | **String** | | **hidden** | **bool** | Whether or not the category group is hidden | **deleted** | **bool** | Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests. | -**categories** | [**Vec<::models::Category>**](Category.md) | Category group categories. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). | +**categories** | [**Vec<crate::models::Category>**](Category.md) | Category group categories. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). | [[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/CategoryGroupWithCategoriesAllOf.md b/docs/CategoryGroupWithCategoriesAllOf.md index 0a11fb9..72d1130 100644 --- a/docs/CategoryGroupWithCategoriesAllOf.md +++ b/docs/CategoryGroupWithCategoriesAllOf.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**categories** | [**Vec<::models::Category>**](Category.md) | Category group categories. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). | +**categories** | [**Vec<crate::models::Category>**](Category.md) | Category group categories. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). | [[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 efe3d40..84bb949 100644 --- a/docs/CategoryResponse.md +++ b/docs/CategoryResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 187bf07..1507ab4 100644 --- a/docs/CategoryResponseData.md +++ b/docs/CategoryResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | [***::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 85bdc80..712a3d9 100644 --- a/docs/DeprecatedApi.md +++ b/docs/DeprecatedApi.md @@ -10,23 +10,22 @@ Method | HTTP request | Description ## bulk_create_transactions -> ::models::BulkResponse bulk_create_transactions(ctx, budget_id, transactions) +> crate::models::BulkResponse bulk_create_transactions(budget_id, transactions) Bulk create transactions Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions. -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **transactions** | [**BulkTransactions**](BulkTransactions.md)| The list of transactions to create | +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 | ### Return type -[**::models::BulkResponse**](BulkResponse.md) +[**crate::models::BulkResponse**](BulkResponse.md) ### Authorization diff --git a/docs/ErrorResponse.md b/docs/ErrorResponse.md index 382b263..4e7daa3 100644 --- a/docs/ErrorResponse.md +++ b/docs/ErrorResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**error** | [***::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 c168944..a18de00 100644 --- a/docs/HybridTransaction.md +++ b/docs/HybridTransaction.md @@ -20,10 +20,10 @@ Name | Type | Description | Notes **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] **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 pararent transaction. For transaction types, this id will be always be null. | [optional] +**parent_transaction_id** | **String** | For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null. | [optional] **account_name** | **String** | | **payee_name** | **String** | | [optional] -**category_name** | **String** | | +**category_name** | **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 af38160..cb16249 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 pararent transaction. For transaction types, this id will be always be null. | [optional] +**parent_transaction_id** | **String** | For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null. | [optional] **account_name** | **String** | | **payee_name** | **String** | | [optional] -**category_name** | **String** | | +**category_name** | **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 df8437a..bd8be57 100644 --- a/docs/HybridTransactionsResponse.md +++ b/docs/HybridTransactionsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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/HybridTransactionsResponseData.md b/docs/HybridTransactionsResponseData.md index 241e7b6..3a175f5 100644 --- a/docs/HybridTransactionsResponseData.md +++ b/docs/HybridTransactionsResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transactions** | [**Vec<::models::HybridTransaction>**](HybridTransaction.md) | | +**transactions** | [**Vec<crate::models::HybridTransaction>**](HybridTransaction.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 1d7a22b..6b7b52e 100644 --- a/docs/MonthDetail.md +++ b/docs/MonthDetail.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **to_be_budgeted** | **i64** | The available amount for 'To be Budgeted' | **age_of_money** | **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<::models::Category>**](Category.md) | The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. | +**categories** | [**Vec<crate::models::Category>**](Category.md) | The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. | [[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/MonthDetailAllOf.md b/docs/MonthDetailAllOf.md index 81da8f5..dda7766 100644 --- a/docs/MonthDetailAllOf.md +++ b/docs/MonthDetailAllOf.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**categories** | [**Vec<::models::Category>**](Category.md) | The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. | +**categories** | [**Vec<crate::models::Category>**](Category.md) | The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. | [[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/MonthDetailResponse.md b/docs/MonthDetailResponse.md index bfeaae8..72755c2 100644 --- a/docs/MonthDetailResponse.md +++ b/docs/MonthDetailResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 83bab88..030e5a9 100644 --- a/docs/MonthDetailResponseData.md +++ b/docs/MonthDetailResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**month** | [***::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 fb7f315..1f97b29 100644 --- a/docs/MonthSummariesResponse.md +++ b/docs/MonthSummariesResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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/MonthSummariesResponseData.md b/docs/MonthSummariesResponseData.md index f9907b3..b6b9c17 100644 --- a/docs/MonthSummariesResponseData.md +++ b/docs/MonthSummariesResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**months** | [**Vec<::models::MonthSummary>**](MonthSummary.md) | | +**months** | [**Vec<crate::models::MonthSummary>**](MonthSummary.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/MonthsApi.md b/docs/MonthsApi.md index 337c03c..afa4884 100644 --- a/docs/MonthsApi.md +++ b/docs/MonthsApi.md @@ -11,23 +11,22 @@ Method | HTTP request | Description ## get_budget_month -> ::models::MonthDetailResponse get_budget_month(ctx, budget_id, month) +> crate::models::MonthDetailResponse get_budget_month(budget_id, month) Single budget month Returns a single budget month -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **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)) | +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 | ### Return type -[**::models::MonthDetailResponse**](MonthDetailResponse.md) +[**crate::models::MonthDetailResponse**](MonthDetailResponse.md) ### Authorization @@ -43,32 +42,22 @@ Name | Type | Description | Notes ## get_budget_months -> ::models::MonthSummariesResponse get_budget_months(ctx, budget_id, optional) +> crate::models::MonthSummariesResponse get_budget_months(budget_id, last_knowledge_of_server) List budget months Returns all budget months -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **optional** | **map[string]interface{}** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a map[string]interface{}. - -Name | Type | Description | 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) | - **last_knowledge_of_server** | **i64**| The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | +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. | | ### Return type -[**::models::MonthSummariesResponse**](MonthSummariesResponse.md) +[**crate::models::MonthSummariesResponse**](MonthSummariesResponse.md) ### Authorization diff --git a/docs/PayeeLocationResponse.md b/docs/PayeeLocationResponse.md index b34e691..83e7b59 100644 --- a/docs/PayeeLocationResponse.md +++ b/docs/PayeeLocationResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 bba1cb7..292a39d 100644 --- a/docs/PayeeLocationResponseData.md +++ b/docs/PayeeLocationResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payee_location** | [***::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 e51787a..d64a8fa 100644 --- a/docs/PayeeLocationsApi.md +++ b/docs/PayeeLocationsApi.md @@ -12,23 +12,22 @@ Method | HTTP request | Description ## get_payee_location_by_id -> ::models::PayeeLocationResponse get_payee_location_by_id(ctx, budget_id, payee_location_id) +> crate::models::PayeeLocationResponse get_payee_location_by_id(budget_id, payee_location_id) Single payee location Returns a single payee location -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **payee_location_id** | **String**| id of 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 | ### Return type -[**::models::PayeeLocationResponse**](PayeeLocationResponse.md) +[**crate::models::PayeeLocationResponse**](PayeeLocationResponse.md) ### Authorization @@ -44,22 +43,21 @@ Name | Type | Description | Notes ## get_payee_locations -> ::models::PayeeLocationsResponse get_payee_locations(ctx, budget_id) +> crate::models::PayeeLocationsResponse get_payee_locations(budget_id) List payee locations Returns all payee locations -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | +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 | ### Return type -[**::models::PayeeLocationsResponse**](PayeeLocationsResponse.md) +[**crate::models::PayeeLocationsResponse**](PayeeLocationsResponse.md) ### Authorization @@ -75,23 +73,22 @@ Name | Type | Description | Notes ## get_payee_locations_by_payee -> ::models::PayeeLocationsResponse get_payee_locations_by_payee(ctx, budget_id, payee_id) +> crate::models::PayeeLocationsResponse get_payee_locations_by_payee(budget_id, payee_id) List locations for a payee Returns all payee locations for the specified payee -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **payee_id** | **String**| id of 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 | ### Return type -[**::models::PayeeLocationsResponse**](PayeeLocationsResponse.md) +[**crate::models::PayeeLocationsResponse**](PayeeLocationsResponse.md) ### Authorization diff --git a/docs/PayeeLocationsResponse.md b/docs/PayeeLocationsResponse.md index f118e8e..b18dfd8 100644 --- a/docs/PayeeLocationsResponse.md +++ b/docs/PayeeLocationsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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/PayeeLocationsResponseData.md b/docs/PayeeLocationsResponseData.md index 4ad0748..126327b 100644 --- a/docs/PayeeLocationsResponseData.md +++ b/docs/PayeeLocationsResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payee_locations** | [**Vec<::models::PayeeLocation>**](PayeeLocation.md) | | +**payee_locations** | [**Vec<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/PayeeResponse.md b/docs/PayeeResponse.md index 6a38dfd..6b4174d 100644 --- a/docs/PayeeResponse.md +++ b/docs/PayeeResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 9618470..8e3e6e2 100644 --- a/docs/PayeeResponseData.md +++ b/docs/PayeeResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payee** | [***::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 173c79d..dfa1a17 100644 --- a/docs/PayeesApi.md +++ b/docs/PayeesApi.md @@ -11,23 +11,22 @@ Method | HTTP request | Description ## get_payee_by_id -> ::models::PayeeResponse get_payee_by_id(ctx, budget_id, payee_id) +> crate::models::PayeeResponse get_payee_by_id(budget_id, payee_id) Single payee Returns single payee -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **payee_id** | **String**| The id of the 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 | ### Return type -[**::models::PayeeResponse**](PayeeResponse.md) +[**crate::models::PayeeResponse**](PayeeResponse.md) ### Authorization @@ -43,32 +42,22 @@ Name | Type | Description | Notes ## get_payees -> ::models::PayeesResponse get_payees(ctx, budget_id, optional) +> crate::models::PayeesResponse get_payees(budget_id, last_knowledge_of_server) List payees Returns all payees -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **optional** | **map[string]interface{}** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a map[string]interface{}. - -Name | Type | Description | 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) | - **last_knowledge_of_server** | **i64**| The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | +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. | | ### Return type -[**::models::PayeesResponse**](PayeesResponse.md) +[**crate::models::PayeesResponse**](PayeesResponse.md) ### Authorization diff --git a/docs/PayeesResponse.md b/docs/PayeesResponse.md index 18bd7d2..a2bcfcf 100644 --- a/docs/PayeesResponse.md +++ b/docs/PayeesResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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/PayeesResponseData.md b/docs/PayeesResponseData.md index c3a5518..ab09314 100644 --- a/docs/PayeesResponseData.md +++ b/docs/PayeesResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payees** | [**Vec<::models::Payee>**](Payee.md) | | +**payees** | [**Vec<crate::models::Payee>**](Payee.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/SaveCategoryResponse.md b/docs/SaveCategoryResponse.md index 64a832f..05aa2f2 100644 --- a/docs/SaveCategoryResponse.md +++ b/docs/SaveCategoryResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 941f72f..92dfdc2 100644 --- a/docs/SaveCategoryResponseData.md +++ b/docs/SaveCategoryResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | [***::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 1b7e38a..65d4917 100644 --- a/docs/SaveMonthCategoryWrapper.md +++ b/docs/SaveMonthCategoryWrapper.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | [***::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 dabee87..77ab098 100644 --- a/docs/SaveTransaction.md +++ b/docs/SaveTransaction.md @@ -7,14 +7,14 @@ 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. | **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 | [optional] +**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\". *At the time of import* we will attempt to match \"imported\" transactions with non-imported (i.e. \"user-entered\") transactions.<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] +**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] [[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 a9f3fcc..1bc9fda 100644 --- a/docs/SaveTransactionWrapper.md +++ b/docs/SaveTransactionWrapper.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transaction** | [***::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 0458ef6..9a13135 100644 --- a/docs/SaveTransactionsResponse.md +++ b/docs/SaveTransactionsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 8617702..98b414b 100644 --- a/docs/SaveTransactionsResponseData.md +++ b/docs/SaveTransactionsResponseData.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transaction_ids** | **Vec<String>** | The transaction ids that were saved | -**transaction** | [***::models::TransactionDetail**](TransactionDetail.md) | | [optional] -**transactions** | [**Vec<::models::TransactionDetail>**](TransactionDetail.md) | If multiple transactions were specified, the transactions that were saved | [optional] +**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] **server_knowledge** | **i64** | The knowledge of the server | diff --git a/docs/SaveTransactionsWrapper.md b/docs/SaveTransactionsWrapper.md index d79e4ee..6f2dcfd 100644 --- a/docs/SaveTransactionsWrapper.md +++ b/docs/SaveTransactionsWrapper.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transaction** | [***::models::SaveTransaction**](SaveTransaction.md) | | [optional] -**transactions** | [**Vec<::models::SaveTransaction>**](SaveTransaction.md) | | [optional] +**transaction** | [***crate::models::SaveTransaction**](SaveTransaction.md) | | [optional] +**transactions** | [**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 6178bab..7b3cae4 100644 --- a/docs/ScheduledSubTransaction.md +++ b/docs/ScheduledSubTransaction.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **amount** | **i64** | The scheduled subtransaction amount in milliunits format | **memo** | **String** | | [optional] **payee_id** | **String** | | [optional] -**category_id** | **String** | | +**category_id** | **String** | | [optional] **transfer_account_id** | **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. | diff --git a/docs/ScheduledTransactionDetail.md b/docs/ScheduledTransactionDetail.md index 5f45c7e..a29c019 100644 --- a/docs/ScheduledTransactionDetail.md +++ b/docs/ScheduledTransactionDetail.md @@ -10,16 +10,16 @@ Name | Type | Description | Notes **frequency** | **String** | | **amount** | **i64** | The scheduled transaction amount in milliunits format | **memo** | **String** | | [optional] -**flag_color** | **String** | The scheduled transaction flag | +**flag_color** | **String** | The scheduled transaction flag | [optional] **account_id** | **String** | | **payee_id** | **String** | | [optional] -**category_id** | **String** | | +**category_id** | **String** | | [optional] **transfer_account_id** | **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** | | -**category_name** | **String** | | -**subtransactions** | [**Vec<::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md) | If a split scheduled transaction, the subtransactions. | +**payee_name** | **String** | | [optional] +**category_name** | **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 3c2757f..dc70d71 100644 --- a/docs/ScheduledTransactionDetailAllOf.md +++ b/docs/ScheduledTransactionDetailAllOf.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **account_name** | **String** | | -**payee_name** | **String** | | -**category_name** | **String** | | -**subtransactions** | [**Vec<::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md) | If a split scheduled transaction, the subtransactions. | +**payee_name** | **String** | | [optional] +**category_name** | **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 28c4b7e..4bc90f1 100644 --- a/docs/ScheduledTransactionResponse.md +++ b/docs/ScheduledTransactionResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 bd05d93..87dbc5d 100644 --- a/docs/ScheduledTransactionResponseData.md +++ b/docs/ScheduledTransactionResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**scheduled_transaction** | [***::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 4b248b0..4dda3bb 100644 --- a/docs/ScheduledTransactionSummary.md +++ b/docs/ScheduledTransactionSummary.md @@ -10,10 +10,10 @@ Name | Type | Description | Notes **frequency** | **String** | | **amount** | **i64** | The scheduled transaction amount in milliunits format | **memo** | **String** | | [optional] -**flag_color** | **String** | The scheduled transaction flag | +**flag_color** | **String** | The scheduled transaction flag | [optional] **account_id** | **String** | | **payee_id** | **String** | | [optional] -**category_id** | **String** | | +**category_id** | **String** | | [optional] **transfer_account_id** | **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. | diff --git a/docs/ScheduledTransactionsApi.md b/docs/ScheduledTransactionsApi.md index 48856a7..eebb224 100644 --- a/docs/ScheduledTransactionsApi.md +++ b/docs/ScheduledTransactionsApi.md @@ -11,23 +11,22 @@ Method | HTTP request | Description ## get_scheduled_transaction_by_id -> ::models::ScheduledTransactionResponse get_scheduled_transaction_by_id(ctx, budget_id, scheduled_transaction_id) +> crate::models::ScheduledTransactionResponse get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id) Single scheduled transaction Returns a single scheduled transaction -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **scheduled_transaction_id** | **String**| The id of the 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 | ### Return type -[**::models::ScheduledTransactionResponse**](ScheduledTransactionResponse.md) +[**crate::models::ScheduledTransactionResponse**](ScheduledTransactionResponse.md) ### Authorization @@ -43,32 +42,22 @@ Name | Type | Description | Notes ## get_scheduled_transactions -> ::models::ScheduledTransactionsResponse get_scheduled_transactions(ctx, budget_id, optional) +> crate::models::ScheduledTransactionsResponse get_scheduled_transactions(budget_id, last_knowledge_of_server) List scheduled transactions Returns all scheduled transactions -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **optional** | **map[string]interface{}** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a map[string]interface{}. - -Name | Type | Description | 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) | - **last_knowledge_of_server** | **i64**| The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | +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. | | ### Return type -[**::models::ScheduledTransactionsResponse**](ScheduledTransactionsResponse.md) +[**crate::models::ScheduledTransactionsResponse**](ScheduledTransactionsResponse.md) ### Authorization diff --git a/docs/ScheduledTransactionsResponse.md b/docs/ScheduledTransactionsResponse.md index b3dbffc..982dc02 100644 --- a/docs/ScheduledTransactionsResponse.md +++ b/docs/ScheduledTransactionsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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/ScheduledTransactionsResponseData.md b/docs/ScheduledTransactionsResponseData.md index f5bc860..8e4cfd4 100644 --- a/docs/ScheduledTransactionsResponseData.md +++ b/docs/ScheduledTransactionsResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**scheduled_transactions** | [**Vec<::models::ScheduledTransactionDetail>**](ScheduledTransactionDetail.md) | | +**scheduled_transactions** | [**Vec<crate::models::ScheduledTransactionDetail>**](ScheduledTransactionDetail.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/TransactionDetail.md b/docs/TransactionDetail.md index 3d23f44..3ba9072 100644 --- a/docs/TransactionDetail.md +++ b/docs/TransactionDetail.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes **account_name** | **String** | | **payee_name** | **String** | | [optional] **category_name** | **String** | | [optional] -**subtransactions** | [**Vec<::models::SubTransaction>**](SubTransaction.md) | If a split transaction, the subtransactions. | +**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 2db8459..663f5f6 100644 --- a/docs/TransactionDetailAllOf.md +++ b/docs/TransactionDetailAllOf.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **account_name** | **String** | | **payee_name** | **String** | | [optional] **category_name** | **String** | | [optional] -**subtransactions** | [**Vec<::models::SubTransaction>**](SubTransaction.md) | If a split transaction, the subtransactions. | +**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 ac81dfa..16e54b9 100644 --- a/docs/TransactionResponse.md +++ b/docs/TransactionResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 81977f0..be390dd 100644 --- a/docs/TransactionResponseData.md +++ b/docs/TransactionResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transaction** | [***::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/TransactionsApi.md b/docs/TransactionsApi.md index 64ecb4b..689031e 100644 --- a/docs/TransactionsApi.md +++ b/docs/TransactionsApi.md @@ -17,23 +17,22 @@ Method | HTTP request | Description ## create_transaction -> ::models::SaveTransactionsResponse create_transaction(ctx, budget_id, data) +> crate::models::SaveTransactionsResponse create_transaction(budget_id, data) Create a single transaction or multiple transactions Creates a single transaction or multiple transactions. If you provide a body containing a 'transaction' object, a single transaction will be created and if you provide a body containing a 'transactions' array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint. -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **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. | +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 | ### Return type -[**::models::SaveTransactionsResponse**](SaveTransactionsResponse.md) +[**crate::models::SaveTransactionsResponse**](SaveTransactionsResponse.md) ### Authorization @@ -49,23 +48,22 @@ Name | Type | Description | Notes ## get_transaction_by_id -> ::models::TransactionResponse get_transaction_by_id(ctx, budget_id, transaction_id) +> crate::models::TransactionResponse get_transaction_by_id(budget_id, transaction_id) Single transaction Returns a single transaction -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **transaction_id** | **String**| The id of the 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 | ### Return type -[**::models::TransactionResponse**](TransactionResponse.md) +[**crate::models::TransactionResponse**](TransactionResponse.md) ### Authorization @@ -81,34 +79,24 @@ Name | Type | Description | Notes ## get_transactions -> ::models::TransactionsResponse get_transactions(ctx, budget_id, optional) +> crate::models::TransactionsResponse get_transactions(budget_id, since_date, _type, last_knowledge_of_server) List transactions Returns budget transactions -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **optional** | **map[string]interface{}** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a map[string]interface{}. - -Name | Type | Description | 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) | - **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. | +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. | | ### Return type -[**::models::TransactionsResponse**](TransactionsResponse.md) +[**crate::models::TransactionsResponse**](TransactionsResponse.md) ### Authorization @@ -124,36 +112,25 @@ Name | Type | Description | Notes ## get_transactions_by_account -> ::models::TransactionsResponse get_transactions_by_account(ctx, budget_id, account_id, optional) +> crate::models::TransactionsResponse get_transactions_by_account(budget_id, account_id, since_date, _type, last_knowledge_of_server) List account transactions Returns all transactions for a specified account -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **account_id** | **String**| The id of the account | - **optional** | **map[string]interface{}** | optional parameters | nil if no parameters - -### Optional Parameters +### Parameters -Optional parameters are passed through a map[string]interface{}. -Name | Type | Description | 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) | - **account_id** | **String**| The id of the account | - **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. | +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. | | ### Return type -[**::models::TransactionsResponse**](TransactionsResponse.md) +[**crate::models::TransactionsResponse**](TransactionsResponse.md) ### Authorization @@ -169,36 +146,25 @@ Name | Type | Description | Notes ## get_transactions_by_category -> ::models::HybridTransactionsResponse get_transactions_by_category(ctx, budget_id, category_id, optional) +> crate::models::HybridTransactionsResponse get_transactions_by_category(budget_id, category_id, since_date, _type, last_knowledge_of_server) List category transactions Returns all transactions for a specified category -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **category_id** | **String**| The id of the category | - **optional** | **map[string]interface{}** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a map[string]interface{}. - -Name | Type | Description | 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) | - **category_id** | **String**| The id of the category | - **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. | +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. | | ### Return type -[**::models::HybridTransactionsResponse**](HybridTransactionsResponse.md) +[**crate::models::HybridTransactionsResponse**](HybridTransactionsResponse.md) ### Authorization @@ -214,36 +180,25 @@ Name | Type | Description | Notes ## get_transactions_by_payee -> ::models::HybridTransactionsResponse get_transactions_by_payee(ctx, budget_id, payee_id, optional) +> crate::models::HybridTransactionsResponse get_transactions_by_payee(budget_id, payee_id, since_date, _type, last_knowledge_of_server) List payee transactions Returns all transactions for a specified payee -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **payee_id** | **String**| The id of the payee | - **optional** | **map[string]interface{}** | optional parameters | nil if no parameters - -### Optional Parameters +### Parameters -Optional parameters are passed through a map[string]interface{}. -Name | Type | Description | 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) | - **payee_id** | **String**| The id of the payee | - **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. | +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. | | ### Return type -[**::models::HybridTransactionsResponse**](HybridTransactionsResponse.md) +[**crate::models::HybridTransactionsResponse**](HybridTransactionsResponse.md) ### Authorization @@ -259,24 +214,23 @@ Name | Type | Description | Notes ## update_transaction -> ::models::TransactionResponse update_transaction(ctx, budget_id, transaction_id, data) +> crate::models::TransactionResponse update_transaction(budget_id, transaction_id, data) Updates an existing transaction Updates a transaction -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **transaction_id** | **String**| The id of the transaction | - **data** | [**UpdateTransactionWrapper**](UpdateTransactionWrapper.md)| The transaction to update | +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 | ### Return type -[**::models::TransactionResponse**](TransactionResponse.md) +[**crate::models::TransactionResponse**](TransactionResponse.md) ### Authorization @@ -292,23 +246,22 @@ Name | Type | Description | Notes ## update_transactions -> ::models::UpdateTransactionsResponse update_transactions(ctx, budget_id, data) +> crate::models::SaveTransactionsResponse update_transactions(budget_id, data) Update multiple transactions Updates multiple transactions, by 'id' or 'import_id'. -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **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) | - **data** | [**UpdateTransactionsWrapper**](UpdateTransactionsWrapper.md)| The transactions to update. Optionally, transaction 'id' value(s) can be specified as null and an 'import_id' value can be provided which will allow transaction(s) to updated by their 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 | ### Return type -[**::models::UpdateTransactionsResponse**](UpdateTransactionsResponse.md) +[**crate::models::SaveTransactionsResponse**](SaveTransactionsResponse.md) ### Authorization diff --git a/docs/TransactionsResponse.md b/docs/TransactionsResponse.md index fec6f21..956caa7 100644 --- a/docs/TransactionsResponse.md +++ b/docs/TransactionsResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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/TransactionsResponseData.md b/docs/TransactionsResponseData.md index 2b64bf7..9ac1635 100644 --- a/docs/TransactionsResponseData.md +++ b/docs/TransactionsResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transactions** | [**Vec<::models::TransactionDetail>**](TransactionDetail.md) | | +**transactions** | [**Vec<crate::models::TransactionDetail>**](TransactionDetail.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/UpdateTransaction.md b/docs/UpdateTransaction.md index 6d6ecb0..bb01087 100644 --- a/docs/UpdateTransaction.md +++ b/docs/UpdateTransaction.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | | [optional] +**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. | **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 | [optional] +**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\". *At the time of import* we will attempt to match \"imported\" transactions with non-imported (i.e. \"user-entered\") transactions.<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] +**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] [[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/UpdateTransactionWrapper.md b/docs/UpdateTransactionAllOf.md index df6846f..250d446 100644 --- a/docs/UpdateTransactionWrapper.md +++ b/docs/UpdateTransactionAllOf.md @@ -1,10 +1,10 @@ -# UpdateTransactionWrapper +# UpdateTransactionAllOf ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transaction** | [***::models::UpdateTransaction**](UpdateTransaction.md) | | +**id** | **String** | | [[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/UpdateTransactionsResponse.md b/docs/UpdateTransactionsResponse.md deleted file mode 100644 index 77e6431..0000000 --- a/docs/UpdateTransactionsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# UpdateTransactionsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::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/UpdateTransactionsWrapper.md b/docs/UpdateTransactionsWrapper.md index f039804..4424384 100644 --- a/docs/UpdateTransactionsWrapper.md +++ b/docs/UpdateTransactionsWrapper.md @@ -4,8 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transaction** | [***::models::UpdateTransaction**](UpdateTransaction.md) | | [optional] -**transactions** | [**Vec<::models::UpdateTransaction>**](UpdateTransaction.md) | | [optional] +**transactions** | [**Vec<crate::models::UpdateTransaction>**](UpdateTransaction.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/UserApi.md b/docs/UserApi.md index c2f9359..042530b 100644 --- a/docs/UserApi.md +++ b/docs/UserApi.md @@ -10,18 +10,18 @@ Method | HTTP request | Description ## get_user -> ::models::UserResponse get_user(ctx, ) +> crate::models::UserResponse get_user() User info Returns authenticated user information -### Required Parameters +### Parameters This endpoint does not need any parameter. ### Return type -[**::models::UserResponse**](UserResponse.md) +[**crate::models::UserResponse**](UserResponse.md) ### Authorization diff --git a/docs/UserResponse.md b/docs/UserResponse.md index 31b0d2f..ea094b4 100644 --- a/docs/UserResponse.md +++ b/docs/UserResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [***::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 3aff41b..9669e8a 100644 --- a/docs/UserResponseData.md +++ b/docs/UserResponseData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user** | [***::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) |