diff options
Diffstat (limited to 'ynab-api/docs')
| -rw-r--r-- | ynab-api/docs/TransactionsApi.md | 8 | ||||
| -rw-r--r-- | ynab-api/docs/UpdateTransaction.md | 22 | ||||
| -rw-r--r-- | ynab-api/docs/UpdateTransactionWrapper.md | 11 | ||||
| -rw-r--r-- | ynab-api/docs/UpdateTransactionsResponse.md | 11 | ||||
| -rw-r--r-- | ynab-api/docs/UpdateTransactionsWrapper.md | 12 |
5 files changed, 60 insertions, 4 deletions
diff --git a/ynab-api/docs/TransactionsApi.md b/ynab-api/docs/TransactionsApi.md index 04b8bc3..64ecb4b 100644 --- a/ynab-api/docs/TransactionsApi.md +++ b/ynab-api/docs/TransactionsApi.md @@ -272,7 +272,7 @@ 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** | [**SaveTransactionWrapper**](SaveTransactionWrapper.md)| The transaction to update | + **data** | [**UpdateTransactionWrapper**](UpdateTransactionWrapper.md)| The transaction to update | ### Return type @@ -292,7 +292,7 @@ Name | Type | Description | Notes ## update_transactions -> ::models::SaveTransactionsResponse update_transactions(ctx, budget_id, data) +> ::models::UpdateTransactionsResponse update_transactions(ctx, budget_id, data) Update multiple transactions Updates multiple transactions, by 'id' or 'import_id'. @@ -304,11 +304,11 @@ 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 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. | + **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::SaveTransactionsResponse**](SaveTransactionsResponse.md) +[**::models::UpdateTransactionsResponse**](UpdateTransactionsResponse.md) ### Authorization diff --git a/ynab-api/docs/UpdateTransaction.md b/ynab-api/docs/UpdateTransaction.md new file mode 100644 index 0000000..6d6ecb0 --- /dev/null +++ b/ynab-api/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/ynab-api/docs/UpdateTransactionWrapper.md b/ynab-api/docs/UpdateTransactionWrapper.md new file mode 100644 index 0000000..df6846f --- /dev/null +++ b/ynab-api/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/ynab-api/docs/UpdateTransactionsResponse.md b/ynab-api/docs/UpdateTransactionsResponse.md new file mode 100644 index 0000000..77e6431 --- /dev/null +++ b/ynab-api/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/ynab-api/docs/UpdateTransactionsWrapper.md b/ynab-api/docs/UpdateTransactionsWrapper.md new file mode 100644 index 0000000..f039804 --- /dev/null +++ b/ynab-api/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) + + |