diff options
Diffstat (limited to 'docs')
94 files changed, 2256 insertions, 0 deletions
diff --git a/docs/Account.md b/docs/Account.md new file mode 100644 index 0000000..265294b --- /dev/null +++ b/docs/Account.md @@ -0,0 +1,21 @@ +# Account + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**name** | **String** | | +**_type** | **String** | The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future. | +**on_budget** | **bool** | Whether this account is on budget or not | +**closed** | **bool** | Whether this account is closed or not | +**note** | **String** | | [optional] +**balance** | **i64** | The current balance of the account in milliunits format | +**cleared_balance** | **i64** | The current cleared balance of the account in milliunits format | +**uncleared_balance** | **i64** | The current uncleared balance of the account in milliunits format | +**transfer_payee_id** | **String** | The payee id which should be used when transferring to this account | +**deleted** | **bool** | Whether or not the account has been deleted. Deleted accounts will only be included in delta requests. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AccountResponse.md b/docs/AccountResponse.md new file mode 100644 index 0000000..eb39808 --- /dev/null +++ b/docs/AccountResponse.md @@ -0,0 +1,11 @@ +# AccountResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..d437a2f --- /dev/null +++ b/docs/AccountResponseData.md @@ -0,0 +1,11 @@ +# AccountResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account** | [***::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 new file mode 100644 index 0000000..98270b9 --- /dev/null +++ b/docs/AccountsApi.md @@ -0,0 +1,83 @@ +# \AccountsApi + +All URIs are relative to *https://api.youneedabudget.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_account_by_id**](AccountsApi.md#get_account_by_id) | **get** /budgets/{budget_id}/accounts/{account_id} | Single account +[**get_accounts**](AccountsApi.md#get_accounts) | **get** /budgets/{budget_id}/accounts | Account list + + + +## get_account_by_id + +> ::models::AccountResponse get_account_by_id(ctx, budget_id, account_id) +Single account + +Returns a single 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**](.md)| The id of the account | + +### Return type + +[**::models::AccountResponse**](AccountResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_accounts + +> ::models::AccountsResponse get_accounts(ctx, budget_id, optional) +Account list + +Returns all accounts + +### 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) | + **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. | + +### Return type + +[**::models::AccountsResponse**](AccountsResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/AccountsResponse.md b/docs/AccountsResponse.md new file mode 100644 index 0000000..6dc10dd --- /dev/null +++ b/docs/AccountsResponse.md @@ -0,0 +1,11 @@ +# AccountsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..968cad8 --- /dev/null +++ b/docs/AccountsResponseData.md @@ -0,0 +1,12 @@ +# AccountsResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accounts** | [**Vec<::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 new file mode 100644 index 0000000..3dac64b --- /dev/null +++ b/docs/BudgetDetail.md @@ -0,0 +1,27 @@ +# BudgetDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**name** | **String** | | +**last_modified_on** | **String** | The last time any changes were made to the budget from either a web or mobile client | [optional] +**first_month** | [***String**](string.md) | The earliest budget month | [optional] +**last_month** | [***String**](string.md) | The latest budget month | [optional] +**date_format** | [***::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] + +[[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 new file mode 100644 index 0000000..f5df347 --- /dev/null +++ b/docs/BudgetDetailAllOf.md @@ -0,0 +1,20 @@ +# BudgetDetailAllOf + +## Properties + +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] + +[[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 new file mode 100644 index 0000000..97cc82e --- /dev/null +++ b/docs/BudgetDetailResponse.md @@ -0,0 +1,11 @@ +# BudgetDetailResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..8697aae --- /dev/null +++ b/docs/BudgetDetailResponseData.md @@ -0,0 +1,12 @@ +# BudgetDetailResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**budget** | [***::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 new file mode 100644 index 0000000..b0604b4 --- /dev/null +++ b/docs/BudgetSettings.md @@ -0,0 +1,12 @@ +# BudgetSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**date_format** | [***::models::DateFormat**](DateFormat.md) | | +**currency_format** | [***::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 new file mode 100644 index 0000000..ee92163 --- /dev/null +++ b/docs/BudgetSettingsResponse.md @@ -0,0 +1,11 @@ +# BudgetSettingsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..3d2c4cc --- /dev/null +++ b/docs/BudgetSettingsResponseData.md @@ -0,0 +1,11 @@ +# BudgetSettingsResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**settings** | [***::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 new file mode 100644 index 0000000..f2e444b --- /dev/null +++ b/docs/BudgetSummary.md @@ -0,0 +1,17 @@ +# BudgetSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**name** | **String** | | +**last_modified_on** | **String** | The last time any changes were made to the budget from either a web or mobile client | [optional] +**first_month** | [***String**](string.md) | The earliest budget month | [optional] +**last_month** | [***String**](string.md) | The latest budget month | [optional] +**date_format** | [***::models::DateFormat**](DateFormat.md) | | [optional] +**currency_format** | [***::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 new file mode 100644 index 0000000..5b029dd --- /dev/null +++ b/docs/BudgetSummaryResponse.md @@ -0,0 +1,11 @@ +# BudgetSummaryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..2836bfa --- /dev/null +++ b/docs/BudgetSummaryResponseData.md @@ -0,0 +1,12 @@ +# BudgetSummaryResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**budgets** | [**Vec<::models::BudgetSummary>**](BudgetSummary.md) | | +**default_budget** | [***::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 new file mode 100644 index 0000000..563b754 --- /dev/null +++ b/docs/BudgetsApi.md @@ -0,0 +1,110 @@ +# \BudgetsApi + +All URIs are relative to *https://api.youneedabudget.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_budget_by_id**](BudgetsApi.md#get_budget_by_id) | **get** /budgets/{budget_id} | Single budget +[**get_budget_settings_by_id**](BudgetsApi.md#get_budget_settings_by_id) | **get** /budgets/{budget_id}/settings | Budget Settings +[**get_budgets**](BudgetsApi.md#get_budgets) | **get** /budgets | List budgets + + + +## get_budget_by_id + +> ::models::BudgetDetailResponse get_budget_by_id(ctx, budget_id, optional) +Single budget + +Returns a single budget with all related entities. This resource is effectively a full budget export. + +### 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) | + **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. | + +### Return type + +[**::models::BudgetDetailResponse**](BudgetDetailResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_budget_settings_by_id + +> ::models::BudgetSettingsResponse get_budget_settings_by_id(ctx, budget_id) +Budget Settings + +Returns settings for a budget + +### 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) | + +### Return type + +[**::models::BudgetSettingsResponse**](BudgetSettingsResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_budgets + +> ::models::BudgetSummaryResponse get_budgets(ctx, ) +List budgets + +Returns budgets list with summary information + +### Required Parameters + +This endpoint does not need any parameter. + +### Return type + +[**::models::BudgetSummaryResponse**](BudgetSummaryResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/BulkResponse.md b/docs/BulkResponse.md new file mode 100644 index 0000000..009e60c --- /dev/null +++ b/docs/BulkResponse.md @@ -0,0 +1,11 @@ +# BulkResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..82fef82 --- /dev/null +++ b/docs/BulkResponseData.md @@ -0,0 +1,11 @@ +# BulkResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bulk** | [***::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/BulkResponseDataBulk.md b/docs/BulkResponseDataBulk.md new file mode 100644 index 0000000..97ff1dc --- /dev/null +++ b/docs/BulkResponseDataBulk.md @@ -0,0 +1,12 @@ +# BulkResponseDataBulk + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transaction_ids** | **Vec<String>** | The list of Transaction ids that were created. | +**duplicate_import_ids** | **Vec<String>** | If any Transactions were not created because they had an import_id matching a transaction already on the same account, the specified import_id(s) will be included in this list. | + +[[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 new file mode 100644 index 0000000..dc990e4 --- /dev/null +++ b/docs/BulkTransactions.md @@ -0,0 +1,11 @@ +# BulkTransactions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transactions** | [**Vec<::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 new file mode 100644 index 0000000..00294b8 --- /dev/null +++ b/docs/CategoriesApi.md @@ -0,0 +1,152 @@ +# \CategoriesApi + +All URIs are relative to *https://api.youneedabudget.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_categories**](CategoriesApi.md#get_categories) | **get** /budgets/{budget_id}/categories | List categories +[**get_category_by_id**](CategoriesApi.md#get_category_by_id) | **get** /budgets/{budget_id}/categories/{category_id} | Single category +[**get_month_category_by_id**](CategoriesApi.md#get_month_category_by_id) | **get** /budgets/{budget_id}/months/{month}/categories/{category_id} | Single category for a specific budget month +[**update_month_category**](CategoriesApi.md#update_month_category) | **patch** /budgets/{budget_id}/months/{month}/categories/{category_id} | Update a category for a specific month + + + +## get_categories + +> ::models::CategoriesResponse get_categories(ctx, budget_id, optional) +List categories + +Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). + +### 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) | + **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. | + +### Return type + +[**::models::CategoriesResponse**](CategoriesResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_category_by_id + +> ::models::CategoryResponse get_category_by_id(ctx, 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 + + +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 | + +### Return type + +[**::models::CategoryResponse**](CategoryResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_month_category_by_id + +> ::models::CategoryResponse get_month_category_by_id(ctx, 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 + + +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 | + +### Return type + +[**::models::CategoryResponse**](CategoryResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## update_month_category + +> ::models::SaveCategoryResponse update_month_category(ctx, budget_id, month, category_id, data) +Update a category for a specific month + +Update a category for a specific month + +### 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) | + **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 | + +### Return type + +[**::models::SaveCategoryResponse**](SaveCategoryResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/CategoriesResponse.md b/docs/CategoriesResponse.md new file mode 100644 index 0000000..e760b74 --- /dev/null +++ b/docs/CategoriesResponse.md @@ -0,0 +1,11 @@ +# CategoriesResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..766aae4 --- /dev/null +++ b/docs/CategoriesResponseData.md @@ -0,0 +1,12 @@ +# CategoriesResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**category_groups** | [**Vec<::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 new file mode 100644 index 0000000..217979b --- /dev/null +++ b/docs/Category.md @@ -0,0 +1,25 @@ +# Category + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**category_group_id** | **String** | | +**name** | **String** | | +**hidden** | **bool** | Whether or not the category is hidden | +**original_category_group_id** | **String** | If category is hidden this is the id of the category group it originally belonged to before it was hidden. | [optional] +**note** | **String** | | [optional] +**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_creation_month** | [***String**](string.md) | The month a goal was created | [optional] +**goal_target** | **i64** | The goal target amount in milliunits | +**goal_target_month** | [***String**](string.md) | If the goal type is 'TBD' (Target Category Balance by Date), this is the target month for the goal to be completed | [optional] +**goal_percentage_complete** | **i32** | The percentage completion of the goal | [optional] +**deleted** | **bool** | Whether or not the category has been deleted. Deleted categories will only be included in delta requests. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CategoryGroup.md b/docs/CategoryGroup.md new file mode 100644 index 0000000..498f3c5 --- /dev/null +++ b/docs/CategoryGroup.md @@ -0,0 +1,14 @@ +# CategoryGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**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. | + +[[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/CategoryGroupWithCategories.md b/docs/CategoryGroupWithCategories.md new file mode 100644 index 0000000..c1355c2 --- /dev/null +++ b/docs/CategoryGroupWithCategories.md @@ -0,0 +1,15 @@ +# CategoryGroupWithCategories + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**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). | + +[[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 new file mode 100644 index 0000000..0a11fb9 --- /dev/null +++ b/docs/CategoryGroupWithCategoriesAllOf.md @@ -0,0 +1,11 @@ +# CategoryGroupWithCategoriesAllOf + +## Properties + +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). | + +[[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 new file mode 100644 index 0000000..efe3d40 --- /dev/null +++ b/docs/CategoryResponse.md @@ -0,0 +1,11 @@ +# CategoryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..187bf07 --- /dev/null +++ b/docs/CategoryResponseData.md @@ -0,0 +1,11 @@ +# CategoryResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**category** | [***::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/CurrencyFormat.md b/docs/CurrencyFormat.md new file mode 100644 index 0000000..98cd6fd --- /dev/null +++ b/docs/CurrencyFormat.md @@ -0,0 +1,18 @@ +# CurrencyFormat + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**iso_code** | **String** | | +**example_format** | **String** | | +**decimal_digits** | **i32** | | +**decimal_separator** | **String** | | +**symbol_first** | **bool** | | +**group_separator** | **String** | | +**currency_symbol** | **String** | | +**display_symbol** | **bool** | | + +[[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/DateFormat.md b/docs/DateFormat.md new file mode 100644 index 0000000..53add08 --- /dev/null +++ b/docs/DateFormat.md @@ -0,0 +1,11 @@ +# DateFormat + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**format** | **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/DeprecatedApi.md b/docs/DeprecatedApi.md new file mode 100644 index 0000000..85bdc80 --- /dev/null +++ b/docs/DeprecatedApi.md @@ -0,0 +1,41 @@ +# \DeprecatedApi + +All URIs are relative to *https://api.youneedabudget.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**bulk_create_transactions**](DeprecatedApi.md#bulk_create_transactions) | **post** /budgets/{budget_id}/transactions/bulk | Bulk create transactions + + + +## bulk_create_transactions + +> ::models::BulkResponse bulk_create_transactions(ctx, 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 + + +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 | + +### Return type + +[**::models::BulkResponse**](BulkResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ErrorDetail.md b/docs/ErrorDetail.md new file mode 100644 index 0000000..dd6d022 --- /dev/null +++ b/docs/ErrorDetail.md @@ -0,0 +1,13 @@ +# ErrorDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**name** | **String** | | +**detail** | **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/ErrorResponse.md b/docs/ErrorResponse.md new file mode 100644 index 0000000..382b263 --- /dev/null +++ b/docs/ErrorResponse.md @@ -0,0 +1,11 @@ +# ErrorResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | [***::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 new file mode 100644 index 0000000..c168944 --- /dev/null +++ b/docs/HybridTransaction.md @@ -0,0 +1,30 @@ +# HybridTransaction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) | +**amount** | **i64** | The transaction amount in milliunits format | +**memo** | **String** | | [optional] +**cleared** | **String** | The cleared status of the transaction | +**approved** | **bool** | Whether or not the transaction is approved | +**flag_color** | **String** | The transaction flag | [optional] +**account_id** | **String** | | +**payee_id** | **String** | | [optional] +**category_id** | **String** | | [optional] +**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional] +**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] +**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional] +**import_id** | **String** | If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. | [optional] +**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] +**account_name** | **String** | | +**payee_name** | **String** | | [optional] +**category_name** | **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/HybridTransactionAllOf.md b/docs/HybridTransactionAllOf.md new file mode 100644 index 0000000..af38160 --- /dev/null +++ b/docs/HybridTransactionAllOf.md @@ -0,0 +1,15 @@ +# HybridTransactionAllOf + +## Properties + +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] +**account_name** | **String** | | +**payee_name** | **String** | | [optional] +**category_name** | **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/HybridTransactionsResponse.md b/docs/HybridTransactionsResponse.md new file mode 100644 index 0000000..df8437a --- /dev/null +++ b/docs/HybridTransactionsResponse.md @@ -0,0 +1,11 @@ +# HybridTransactionsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..241e7b6 --- /dev/null +++ b/docs/HybridTransactionsResponseData.md @@ -0,0 +1,11 @@ +# HybridTransactionsResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transactions** | [**Vec<::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 new file mode 100644 index 0000000..1d7a22b --- /dev/null +++ b/docs/MonthDetail.md @@ -0,0 +1,19 @@ +# MonthDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**month** | [***String**](string.md) | | +**note** | **String** | | [optional] +**income** | **i64** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month | +**budgeted** | **i64** | The total amount budgeted in the month | +**activity** | **i64** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' | +**to_be_budgeted** | **i64** | The available amount for 'To be Budgeted' | +**age_of_money** | **i32** | The Age of Money as of the month | [optional] +**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. | + +[[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 new file mode 100644 index 0000000..81da8f5 --- /dev/null +++ b/docs/MonthDetailAllOf.md @@ -0,0 +1,11 @@ +# MonthDetailAllOf + +## Properties + +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. | + +[[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 new file mode 100644 index 0000000..bfeaae8 --- /dev/null +++ b/docs/MonthDetailResponse.md @@ -0,0 +1,11 @@ +# MonthDetailResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..83bab88 --- /dev/null +++ b/docs/MonthDetailResponseData.md @@ -0,0 +1,11 @@ +# MonthDetailResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**month** | [***::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 new file mode 100644 index 0000000..fb7f315 --- /dev/null +++ b/docs/MonthSummariesResponse.md @@ -0,0 +1,11 @@ +# MonthSummariesResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..f9907b3 --- /dev/null +++ b/docs/MonthSummariesResponseData.md @@ -0,0 +1,12 @@ +# MonthSummariesResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**months** | [**Vec<::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/MonthSummary.md b/docs/MonthSummary.md new file mode 100644 index 0000000..a78cbfc --- /dev/null +++ b/docs/MonthSummary.md @@ -0,0 +1,18 @@ +# MonthSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**month** | [***String**](string.md) | | +**note** | **String** | | [optional] +**income** | **i64** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month | +**budgeted** | **i64** | The total amount budgeted in the month | +**activity** | **i64** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' | +**to_be_budgeted** | **i64** | The available amount for 'To be Budgeted' | +**age_of_money** | **i32** | The Age of Money as of the month | [optional] +**deleted** | **bool** | Whether or not the month has been deleted. Deleted months will only be included in delta requests. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonthsApi.md b/docs/MonthsApi.md new file mode 100644 index 0000000..337c03c --- /dev/null +++ b/docs/MonthsApi.md @@ -0,0 +1,83 @@ +# \MonthsApi + +All URIs are relative to *https://api.youneedabudget.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_budget_month**](MonthsApi.md#get_budget_month) | **get** /budgets/{budget_id}/months/{month} | Single budget month +[**get_budget_months**](MonthsApi.md#get_budget_months) | **get** /budgets/{budget_id}/months | List budget months + + + +## get_budget_month + +> ::models::MonthDetailResponse get_budget_month(ctx, budget_id, month) +Single budget month + +Returns a single budget month + +### 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) | + **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)) | + +### Return type + +[**::models::MonthDetailResponse**](MonthDetailResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_budget_months + +> ::models::MonthSummariesResponse get_budget_months(ctx, budget_id, optional) +List budget months + +Returns all budget months + +### 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) | + **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. | + +### Return type + +[**::models::MonthSummariesResponse**](MonthSummariesResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Payee.md b/docs/Payee.md new file mode 100644 index 0000000..ff886e6 --- /dev/null +++ b/docs/Payee.md @@ -0,0 +1,14 @@ +# Payee + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**name** | **String** | | +**transfer_account_id** | **String** | If a transfer payee, the account_id to which this payee transfers to | [optional] +**deleted** | **bool** | Whether or not the payee has been deleted. Deleted payees will only be included in delta requests. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PayeeLocation.md b/docs/PayeeLocation.md new file mode 100644 index 0000000..f73c3be --- /dev/null +++ b/docs/PayeeLocation.md @@ -0,0 +1,15 @@ +# PayeeLocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**payee_id** | **String** | | +**latitude** | **String** | | +**longitude** | **String** | | +**deleted** | **bool** | Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PayeeLocationResponse.md b/docs/PayeeLocationResponse.md new file mode 100644 index 0000000..b34e691 --- /dev/null +++ b/docs/PayeeLocationResponse.md @@ -0,0 +1,11 @@ +# PayeeLocationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..bba1cb7 --- /dev/null +++ b/docs/PayeeLocationResponseData.md @@ -0,0 +1,11 @@ +# PayeeLocationResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payee_location** | [***::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 new file mode 100644 index 0000000..e51787a --- /dev/null +++ b/docs/PayeeLocationsApi.md @@ -0,0 +1,106 @@ +# \PayeeLocationsApi + +All URIs are relative to *https://api.youneedabudget.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_payee_location_by_id**](PayeeLocationsApi.md#get_payee_location_by_id) | **get** /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location +[**get_payee_locations**](PayeeLocationsApi.md#get_payee_locations) | **get** /budgets/{budget_id}/payee_locations | List payee locations +[**get_payee_locations_by_payee**](PayeeLocationsApi.md#get_payee_locations_by_payee) | **get** /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee + + + +## get_payee_location_by_id + +> ::models::PayeeLocationResponse get_payee_location_by_id(ctx, budget_id, payee_location_id) +Single payee location + +Returns a single payee location + +### 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_location_id** | **String**| id of payee location | + +### Return type + +[**::models::PayeeLocationResponse**](PayeeLocationResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_payee_locations + +> ::models::PayeeLocationsResponse get_payee_locations(ctx, budget_id) +List payee locations + +Returns all payee locations + +### 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) | + +### Return type + +[**::models::PayeeLocationsResponse**](PayeeLocationsResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_payee_locations_by_payee + +> ::models::PayeeLocationsResponse get_payee_locations_by_payee(ctx, budget_id, payee_id) +List locations for a payee + +Returns all payee locations for the 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**| id of payee | + +### Return type + +[**::models::PayeeLocationsResponse**](PayeeLocationsResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/PayeeLocationsResponse.md b/docs/PayeeLocationsResponse.md new file mode 100644 index 0000000..f118e8e --- /dev/null +++ b/docs/PayeeLocationsResponse.md @@ -0,0 +1,11 @@ +# PayeeLocationsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..4ad0748 --- /dev/null +++ b/docs/PayeeLocationsResponseData.md @@ -0,0 +1,11 @@ +# PayeeLocationsResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payee_locations** | [**Vec<::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 new file mode 100644 index 0000000..6a38dfd --- /dev/null +++ b/docs/PayeeResponse.md @@ -0,0 +1,11 @@ +# PayeeResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..9618470 --- /dev/null +++ b/docs/PayeeResponseData.md @@ -0,0 +1,11 @@ +# PayeeResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payee** | [***::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 new file mode 100644 index 0000000..173c79d --- /dev/null +++ b/docs/PayeesApi.md @@ -0,0 +1,83 @@ +# \PayeesApi + +All URIs are relative to *https://api.youneedabudget.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_payee_by_id**](PayeesApi.md#get_payee_by_id) | **get** /budgets/{budget_id}/payees/{payee_id} | Single payee +[**get_payees**](PayeesApi.md#get_payees) | **get** /budgets/{budget_id}/payees | List payees + + + +## get_payee_by_id + +> ::models::PayeeResponse get_payee_by_id(ctx, budget_id, payee_id) +Single payee + +Returns single 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 | + +### Return type + +[**::models::PayeeResponse**](PayeeResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_payees + +> ::models::PayeesResponse get_payees(ctx, budget_id, optional) +List payees + +Returns all payees + +### 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) | + **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. | + +### Return type + +[**::models::PayeesResponse**](PayeesResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/PayeesResponse.md b/docs/PayeesResponse.md new file mode 100644 index 0000000..18bd7d2 --- /dev/null +++ b/docs/PayeesResponse.md @@ -0,0 +1,11 @@ +# PayeesResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..c3a5518 --- /dev/null +++ b/docs/PayeesResponseData.md @@ -0,0 +1,12 @@ +# PayeesResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payees** | [**Vec<::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 new file mode 100644 index 0000000..64a832f --- /dev/null +++ b/docs/SaveCategoryResponse.md @@ -0,0 +1,11 @@ +# SaveCategoryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..941f72f --- /dev/null +++ b/docs/SaveCategoryResponseData.md @@ -0,0 +1,12 @@ +# SaveCategoryResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**category** | [***::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/SaveMonthCategory.md b/docs/SaveMonthCategory.md new file mode 100644 index 0000000..1c4abb9 --- /dev/null +++ b/docs/SaveMonthCategory.md @@ -0,0 +1,11 @@ +# SaveMonthCategory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**budgeted** | **i64** | Budgeted amount in milliunits format | + +[[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 new file mode 100644 index 0000000..1b7e38a --- /dev/null +++ b/docs/SaveMonthCategoryWrapper.md @@ -0,0 +1,11 @@ +# SaveMonthCategoryWrapper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**category** | [***::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 new file mode 100644 index 0000000..dabee87 --- /dev/null +++ b/docs/SaveTransaction.md @@ -0,0 +1,21 @@ +# SaveTransaction + +## Properties + +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_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] + +[[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 new file mode 100644 index 0000000..a9f3fcc --- /dev/null +++ b/docs/SaveTransactionWrapper.md @@ -0,0 +1,11 @@ +# SaveTransactionWrapper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transaction** | [***::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 new file mode 100644 index 0000000..0458ef6 --- /dev/null +++ b/docs/SaveTransactionsResponse.md @@ -0,0 +1,11 @@ +# SaveTransactionsResponse + +## 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/SaveTransactionsResponseData.md b/docs/SaveTransactionsResponseData.md new file mode 100644 index 0000000..8617702 --- /dev/null +++ b/docs/SaveTransactionsResponseData.md @@ -0,0 +1,15 @@ +# SaveTransactionsResponseData + +## Properties + +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] +**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 | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SaveTransactionsWrapper.md b/docs/SaveTransactionsWrapper.md new file mode 100644 index 0000000..d79e4ee --- /dev/null +++ b/docs/SaveTransactionsWrapper.md @@ -0,0 +1,12 @@ +# SaveTransactionsWrapper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transaction** | [***::models::SaveTransaction**](SaveTransaction.md) | | [optional] +**transactions** | [**Vec<::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 new file mode 100644 index 0000000..6178bab --- /dev/null +++ b/docs/ScheduledSubTransaction.md @@ -0,0 +1,18 @@ +# ScheduledSubTransaction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**scheduled_transaction_id** | **String** | | +**amount** | **i64** | The scheduled subtransaction amount in milliunits format | +**memo** | **String** | | [optional] +**payee_id** | **String** | | [optional] +**category_id** | **String** | | +**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. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScheduledTransactionDetail.md b/docs/ScheduledTransactionDetail.md new file mode 100644 index 0000000..5f45c7e --- /dev/null +++ b/docs/ScheduledTransactionDetail.md @@ -0,0 +1,26 @@ +# ScheduledTransactionDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**date_first** | [***String**](string.md) | The first date for which the Scheduled Transaction was scheduled. | +**date_next** | [***String**](string.md) | The next date for which the Scheduled Transaction is scheduled. | +**frequency** | **String** | | +**amount** | **i64** | The scheduled transaction amount in milliunits format | +**memo** | **String** | | [optional] +**flag_color** | **String** | The scheduled transaction flag | +**account_id** | **String** | | +**payee_id** | **String** | | [optional] +**category_id** | **String** | | +**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. | + +[[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 new file mode 100644 index 0000000..3c2757f --- /dev/null +++ b/docs/ScheduledTransactionDetailAllOf.md @@ -0,0 +1,14 @@ +# ScheduledTransactionDetailAllOf + +## Properties + +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. | + +[[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 new file mode 100644 index 0000000..28c4b7e --- /dev/null +++ b/docs/ScheduledTransactionResponse.md @@ -0,0 +1,11 @@ +# ScheduledTransactionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..bd05d93 --- /dev/null +++ b/docs/ScheduledTransactionResponseData.md @@ -0,0 +1,11 @@ +# ScheduledTransactionResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scheduled_transaction** | [***::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 new file mode 100644 index 0000000..4b248b0 --- /dev/null +++ b/docs/ScheduledTransactionSummary.md @@ -0,0 +1,22 @@ +# ScheduledTransactionSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**date_first** | [***String**](string.md) | The first date for which the Scheduled Transaction was scheduled. | +**date_next** | [***String**](string.md) | The next date for which the Scheduled Transaction is scheduled. | +**frequency** | **String** | | +**amount** | **i64** | The scheduled transaction amount in milliunits format | +**memo** | **String** | | [optional] +**flag_color** | **String** | The scheduled transaction flag | +**account_id** | **String** | | +**payee_id** | **String** | | [optional] +**category_id** | **String** | | +**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. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScheduledTransactionsApi.md b/docs/ScheduledTransactionsApi.md new file mode 100644 index 0000000..48856a7 --- /dev/null +++ b/docs/ScheduledTransactionsApi.md @@ -0,0 +1,83 @@ +# \ScheduledTransactionsApi + +All URIs are relative to *https://api.youneedabudget.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_scheduled_transaction_by_id**](ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | **get** /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Single scheduled transaction +[**get_scheduled_transactions**](ScheduledTransactionsApi.md#get_scheduled_transactions) | **get** /budgets/{budget_id}/scheduled_transactions | List scheduled transactions + + + +## get_scheduled_transaction_by_id + +> ::models::ScheduledTransactionResponse get_scheduled_transaction_by_id(ctx, budget_id, scheduled_transaction_id) +Single scheduled transaction + +Returns a single scheduled transaction + +### 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) | + **scheduled_transaction_id** | **String**| The id of the scheduled transaction | + +### Return type + +[**::models::ScheduledTransactionResponse**](ScheduledTransactionResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_scheduled_transactions + +> ::models::ScheduledTransactionsResponse get_scheduled_transactions(ctx, budget_id, optional) +List scheduled transactions + +Returns all scheduled transactions + +### 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) | + **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. | + +### Return type + +[**::models::ScheduledTransactionsResponse**](ScheduledTransactionsResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ScheduledTransactionsResponse.md b/docs/ScheduledTransactionsResponse.md new file mode 100644 index 0000000..b3dbffc --- /dev/null +++ b/docs/ScheduledTransactionsResponse.md @@ -0,0 +1,11 @@ +# ScheduledTransactionsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..f5bc860 --- /dev/null +++ b/docs/ScheduledTransactionsResponseData.md @@ -0,0 +1,12 @@ +# ScheduledTransactionsResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scheduled_transactions** | [**Vec<::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/SubTransaction.md b/docs/SubTransaction.md new file mode 100644 index 0000000..77bad7f --- /dev/null +++ b/docs/SubTransaction.md @@ -0,0 +1,18 @@ +# SubTransaction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**transaction_id** | **String** | | +**amount** | **i64** | The subtransaction amount in milliunits format | +**memo** | **String** | | [optional] +**payee_id** | **String** | | [optional] +**category_id** | **String** | | [optional] +**transfer_account_id** | **String** | If a transfer, the account_id which the subtransaction transfers to | [optional] +**deleted** | **bool** | Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TransactionDetail.md b/docs/TransactionDetail.md new file mode 100644 index 0000000..3d23f44 --- /dev/null +++ b/docs/TransactionDetail.md @@ -0,0 +1,29 @@ +# TransactionDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) | +**amount** | **i64** | The transaction amount in milliunits format | +**memo** | **String** | | [optional] +**cleared** | **String** | The cleared status of the transaction | +**approved** | **bool** | Whether or not the transaction is approved | +**flag_color** | **String** | The transaction flag | [optional] +**account_id** | **String** | | +**payee_id** | **String** | | [optional] +**category_id** | **String** | | [optional] +**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional] +**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] +**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional] +**import_id** | **String** | If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. | [optional] +**deleted** | **bool** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. | +**account_name** | **String** | | +**payee_name** | **String** | | [optional] +**category_name** | **String** | | [optional] +**subtransactions** | [**Vec<::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 new file mode 100644 index 0000000..2db8459 --- /dev/null +++ b/docs/TransactionDetailAllOf.md @@ -0,0 +1,14 @@ +# TransactionDetailAllOf + +## Properties + +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. | + +[[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 new file mode 100644 index 0000000..ac81dfa --- /dev/null +++ b/docs/TransactionResponse.md @@ -0,0 +1,11 @@ +# TransactionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..81977f0 --- /dev/null +++ b/docs/TransactionResponseData.md @@ -0,0 +1,11 @@ +# TransactionResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transaction** | [***::models::TransactionDetail**](TransactionDetail.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TransactionSummary.md b/docs/TransactionSummary.md new file mode 100644 index 0000000..fd93b15 --- /dev/null +++ b/docs/TransactionSummary.md @@ -0,0 +1,25 @@ +# TransactionSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) | +**amount** | **i64** | The transaction amount in milliunits format | +**memo** | **String** | | [optional] +**cleared** | **String** | The cleared status of the transaction | +**approved** | **bool** | Whether or not the transaction is approved | +**flag_color** | **String** | The transaction flag | [optional] +**account_id** | **String** | | +**payee_id** | **String** | | [optional] +**category_id** | **String** | | [optional] +**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional] +**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] +**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional] +**import_id** | **String** | If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. | [optional] +**deleted** | **bool** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TransactionsApi.md b/docs/TransactionsApi.md new file mode 100644 index 0000000..64ecb4b --- /dev/null +++ b/docs/TransactionsApi.md @@ -0,0 +1,323 @@ +# \TransactionsApi + +All URIs are relative to *https://api.youneedabudget.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_transaction**](TransactionsApi.md#create_transaction) | **post** /budgets/{budget_id}/transactions | Create a single transaction or multiple transactions +[**get_transaction_by_id**](TransactionsApi.md#get_transaction_by_id) | **get** /budgets/{budget_id}/transactions/{transaction_id} | Single transaction +[**get_transactions**](TransactionsApi.md#get_transactions) | **get** /budgets/{budget_id}/transactions | List transactions +[**get_transactions_by_account**](TransactionsApi.md#get_transactions_by_account) | **get** /budgets/{budget_id}/accounts/{account_id}/transactions | List account transactions +[**get_transactions_by_category**](TransactionsApi.md#get_transactions_by_category) | **get** /budgets/{budget_id}/categories/{category_id}/transactions | List category transactions +[**get_transactions_by_payee**](TransactionsApi.md#get_transactions_by_payee) | **get** /budgets/{budget_id}/payees/{payee_id}/transactions | List payee transactions +[**update_transaction**](TransactionsApi.md#update_transaction) | **put** /budgets/{budget_id}/transactions/{transaction_id} | Updates an existing transaction +[**update_transactions**](TransactionsApi.md#update_transactions) | **patch** /budgets/{budget_id}/transactions | Update multiple transactions + + + +## create_transaction + +> ::models::SaveTransactionsResponse create_transaction(ctx, 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 + + +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. | + +### Return type + +[**::models::SaveTransactionsResponse**](SaveTransactionsResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_transaction_by_id + +> ::models::TransactionResponse get_transaction_by_id(ctx, budget_id, transaction_id) +Single transaction + +Returns a single transaction + +### 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) | + **transaction_id** | **String**| The id of the transaction | + +### Return type + +[**::models::TransactionResponse**](TransactionResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_transactions + +> ::models::TransactionsResponse get_transactions(ctx, budget_id, optional) +List transactions + +Returns budget transactions + +### 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) | + **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. | + +### Return type + +[**::models::TransactionsResponse**](TransactionsResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_transactions_by_account + +> ::models::TransactionsResponse get_transactions_by_account(ctx, budget_id, account_id, optional) +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 + +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. | + +### Return type + +[**::models::TransactionsResponse**](TransactionsResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_transactions_by_category + +> ::models::HybridTransactionsResponse get_transactions_by_category(ctx, budget_id, category_id, optional) +List category transactions + +Returns all transactions for a specified category + +### 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) | + **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. | + +### Return type + +[**::models::HybridTransactionsResponse**](HybridTransactionsResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## get_transactions_by_payee + +> ::models::HybridTransactionsResponse get_transactions_by_payee(ctx, budget_id, payee_id, optional) +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 + +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. | + +### Return type + +[**::models::HybridTransactionsResponse**](HybridTransactionsResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## update_transaction + +> ::models::TransactionResponse update_transaction(ctx, budget_id, transaction_id, data) +Updates an existing transaction + +Updates a transaction + +### 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) | + **transaction_id** | **String**| The id of the transaction | + **data** | [**UpdateTransactionWrapper**](UpdateTransactionWrapper.md)| The transaction to update | + +### Return type + +[**::models::TransactionResponse**](TransactionResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## update_transactions + +> ::models::UpdateTransactionsResponse update_transactions(ctx, budget_id, data) +Update multiple transactions + +Updates multiple transactions, by 'id' or 'import_id'. + +### 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) | + **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. | + +### Return type + +[**::models::UpdateTransactionsResponse**](UpdateTransactionsResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TransactionsResponse.md b/docs/TransactionsResponse.md new file mode 100644 index 0000000..fec6f21 --- /dev/null +++ b/docs/TransactionsResponse.md @@ -0,0 +1,11 @@ +# TransactionsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..2b64bf7 --- /dev/null +++ b/docs/TransactionsResponseData.md @@ -0,0 +1,12 @@ +# TransactionsResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transactions** | [**Vec<::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 new file mode 100644 index 0000000..6d6ecb0 --- /dev/null +++ b/docs/UpdateTransaction.md @@ -0,0 +1,22 @@ +# UpdateTransaction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**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_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] + +[[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/UpdateTransactionWrapper.md new file mode 100644 index 0000000..df6846f --- /dev/null +++ b/docs/UpdateTransactionWrapper.md @@ -0,0 +1,11 @@ +# UpdateTransactionWrapper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transaction** | [***::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/UpdateTransactionsResponse.md b/docs/UpdateTransactionsResponse.md new file mode 100644 index 0000000..77e6431 --- /dev/null +++ b/docs/UpdateTransactionsResponse.md @@ -0,0 +1,11 @@ +# 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 new file mode 100644 index 0000000..f039804 --- /dev/null +++ b/docs/UpdateTransactionsWrapper.md @@ -0,0 +1,12 @@ +# UpdateTransactionsWrapper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transaction** | [***::models::UpdateTransaction**](UpdateTransaction.md) | | [optional] +**transactions** | [**Vec<::models::UpdateTransaction>**](UpdateTransaction.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/User.md b/docs/User.md new file mode 100644 index 0000000..28cb9e0 --- /dev/null +++ b/docs/User.md @@ -0,0 +1,11 @@ +# User + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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/UserApi.md b/docs/UserApi.md new file mode 100644 index 0000000..c2f9359 --- /dev/null +++ b/docs/UserApi.md @@ -0,0 +1,36 @@ +# \UserApi + +All URIs are relative to *https://api.youneedabudget.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_user**](UserApi.md#get_user) | **get** /user | User info + + + +## get_user + +> ::models::UserResponse get_user(ctx, ) +User info + +Returns authenticated user information + +### Required Parameters + +This endpoint does not need any parameter. + +### Return type + +[**::models::UserResponse**](UserResponse.md) + +### Authorization + +[bearer](../README.md#bearer) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/UserResponse.md b/docs/UserResponse.md new file mode 100644 index 0000000..31b0d2f --- /dev/null +++ b/docs/UserResponse.md @@ -0,0 +1,11 @@ +# UserResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [***::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 new file mode 100644 index 0000000..3aff41b --- /dev/null +++ b/docs/UserResponseData.md @@ -0,0 +1,11 @@ +# UserResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user** | [***::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) + + |