438 lines
18 KiB
Markdown
438 lines
18 KiB
Markdown
|
# {{classname}}
|
||
|
|
|
||
|
|
All URIs are relative to *https://demo.firefly-iii.org/api*
|
||
|
|
|
||
|
|
Method | HTTP request | Description
|
||
|
|
------------- | ------------- | -------------
|
||
|
|
[**BulkUpdateTransactions**](DataApi.md#BulkUpdateTransactions) | **Post** /v1/data/bulk/transactions | Bulk update transaction properties. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/
|
||
|
|
[**DestroyData**](DataApi.md#DestroyData) | **Delete** /v1/data/destroy | Endpoint to destroy user data
|
||
|
|
[**ExportAccounts**](DataApi.md#ExportAccounts) | **Get** /v1/data/export/accounts | Export account data from Firefly III
|
||
|
|
[**ExportBills**](DataApi.md#ExportBills) | **Get** /v1/data/export/bills | Export bills from Firefly III
|
||
|
|
[**ExportBudgets**](DataApi.md#ExportBudgets) | **Get** /v1/data/export/budgets | Export budgets and budget amount data from Firefly III
|
||
|
|
[**ExportCategories**](DataApi.md#ExportCategories) | **Get** /v1/data/export/categories | Export category data from Firefly III
|
||
|
|
[**ExportPiggies**](DataApi.md#ExportPiggies) | **Get** /v1/data/export/piggy-banks | Export piggy banks from Firefly III
|
||
|
|
[**ExportRecurring**](DataApi.md#ExportRecurring) | **Get** /v1/data/export/recurring | Export recurring transaction data from Firefly III
|
||
|
|
[**ExportRules**](DataApi.md#ExportRules) | **Get** /v1/data/export/rules | Export rule groups and rule data from Firefly III
|
||
|
|
[**ExportTags**](DataApi.md#ExportTags) | **Get** /v1/data/export/tags | Export tag data from Firefly III
|
||
|
|
[**ExportTransactions**](DataApi.md#ExportTransactions) | **Get** /v1/data/export/transactions | Export transaction data from Firefly III
|
||
|
|
[**PurgeData**](DataApi.md#PurgeData) | **Delete** /v1/data/purge | Endpoint to purge user data
|
||
|
|
|
||
|
|
# **BulkUpdateTransactions**
|
||
|
|
> BulkUpdateTransactions(ctx, query)
|
||
|
|
Bulk update transaction properties. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/
|
||
|
|
|
||
|
|
Allows you to update transactions in bulk.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**query** | **string**| The JSON query. |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
(empty response body)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
||
|
|
|
||
|
|
### 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)
|
||
|
|
|
||
|
|
# **DestroyData**
|
||
|
|
> DestroyData(ctx, objects, optional)
|
||
|
|
Endpoint to destroy user data
|
||
|
|
|
||
|
|
A call to this endpoint deletes the requested data type. Use it with care and always with user permission. The demo user is incapable of using this endpoint.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**objects** | [**DataDestroyObject**](.md)| The type of data that you wish to destroy. You can only use one at a time. |
|
||
|
|
**optional** | ***DataApiDestroyDataOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a DataApiDestroyDataOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
(empty response body)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
||
|
|
|
||
|
|
### 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)
|
||
|
|
|
||
|
|
# **ExportAccounts**
|
||
|
|
> *os.File ExportAccounts(ctx, optional)
|
||
|
|
Export account data from Firefly III
|
||
|
|
|
||
|
|
This endpoint allows you to export your accounts from Firefly III into a file. Currently supports CSV exports only.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**optional** | ***DataApiExportAccountsOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a DataApiExportAccountsOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
**type_** | [**optional.Interface of ExportFileFilter**](.md)| The file type the export file (CSV is currently the only option). |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[***os.File**](*os.File.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: Not defined
|
||
|
|
- **Accept**: application/json, application/octet-stream
|
||
|
|
|
||
|
|
[[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)
|
||
|
|
|
||
|
|
# **ExportBills**
|
||
|
|
> *os.File ExportBills(ctx, optional)
|
||
|
|
Export bills from Firefly III
|
||
|
|
|
||
|
|
This endpoint allows you to export your bills from Firefly III into a file. Currently supports CSV exports only.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**optional** | ***DataApiExportBillsOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a DataApiExportBillsOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
**type_** | [**optional.Interface of ExportFileFilter**](.md)| The file type the export file (CSV is currently the only option). |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[***os.File**](*os.File.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: Not defined
|
||
|
|
- **Accept**: application/json, application/octet-stream
|
||
|
|
|
||
|
|
[[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)
|
||
|
|
|
||
|
|
# **ExportBudgets**
|
||
|
|
> *os.File ExportBudgets(ctx, optional)
|
||
|
|
Export budgets and budget amount data from Firefly III
|
||
|
|
|
||
|
|
This endpoint allows you to export your budgets and associated budget data from Firefly III into a file. Currently supports CSV exports only.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**optional** | ***DataApiExportBudgetsOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a DataApiExportBudgetsOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
**type_** | [**optional.Interface of ExportFileFilter**](.md)| The file type the export file (CSV is currently the only option). |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[***os.File**](*os.File.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: Not defined
|
||
|
|
- **Accept**: application/json, application/octet-stream
|
||
|
|
|
||
|
|
[[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)
|
||
|
|
|
||
|
|
# **ExportCategories**
|
||
|
|
> *os.File ExportCategories(ctx, optional)
|
||
|
|
Export category data from Firefly III
|
||
|
|
|
||
|
|
This endpoint allows you to export your categories from Firefly III into a file. Currently supports CSV exports only.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**optional** | ***DataApiExportCategoriesOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a DataApiExportCategoriesOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
**type_** | [**optional.Interface of ExportFileFilter**](.md)| The file type the export file (CSV is currently the only option). |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[***os.File**](*os.File.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: Not defined
|
||
|
|
- **Accept**: application/json, application/octet-stream
|
||
|
|
|
||
|
|
[[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)
|
||
|
|
|
||
|
|
# **ExportPiggies**
|
||
|
|
> *os.File ExportPiggies(ctx, optional)
|
||
|
|
Export piggy banks from Firefly III
|
||
|
|
|
||
|
|
This endpoint allows you to export your piggy banks from Firefly III into a file. Currently supports CSV exports only.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**optional** | ***DataApiExportPiggiesOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a DataApiExportPiggiesOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
**type_** | [**optional.Interface of ExportFileFilter**](.md)| The file type the export file (CSV is currently the only option). |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[***os.File**](*os.File.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: Not defined
|
||
|
|
- **Accept**: application/json, application/octet-stream
|
||
|
|
|
||
|
|
[[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)
|
||
|
|
|
||
|
|
# **ExportRecurring**
|
||
|
|
> *os.File ExportRecurring(ctx, optional)
|
||
|
|
Export recurring transaction data from Firefly III
|
||
|
|
|
||
|
|
This endpoint allows you to export your recurring transactions from Firefly III into a file. Currently supports CSV exports only.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**optional** | ***DataApiExportRecurringOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a DataApiExportRecurringOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
**type_** | [**optional.Interface of ExportFileFilter**](.md)| The file type the export file (CSV is currently the only option). |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[***os.File**](*os.File.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: Not defined
|
||
|
|
- **Accept**: application/json, application/octet-stream
|
||
|
|
|
||
|
|
[[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)
|
||
|
|
|
||
|
|
# **ExportRules**
|
||
|
|
> *os.File ExportRules(ctx, optional)
|
||
|
|
Export rule groups and rule data from Firefly III
|
||
|
|
|
||
|
|
This endpoint allows you to export your rules and rule groups from Firefly III into a file. Currently supports CSV exports only.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**optional** | ***DataApiExportRulesOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a DataApiExportRulesOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
**type_** | [**optional.Interface of ExportFileFilter**](.md)| The file type the export file (CSV is currently the only option). |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[***os.File**](*os.File.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: Not defined
|
||
|
|
- **Accept**: application/json, application/octet-stream
|
||
|
|
|
||
|
|
[[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)
|
||
|
|
|
||
|
|
# **ExportTags**
|
||
|
|
> *os.File ExportTags(ctx, optional)
|
||
|
|
Export tag data from Firefly III
|
||
|
|
|
||
|
|
This endpoint allows you to export your tags from Firefly III into a file. Currently supports CSV exports only.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**optional** | ***DataApiExportTagsOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a DataApiExportTagsOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
**type_** | [**optional.Interface of ExportFileFilter**](.md)| The file type the export file (CSV is currently the only option). |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[***os.File**](*os.File.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: Not defined
|
||
|
|
- **Accept**: application/json, application/octet-stream
|
||
|
|
|
||
|
|
[[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)
|
||
|
|
|
||
|
|
# **ExportTransactions**
|
||
|
|
> *os.File ExportTransactions(ctx, start, end, optional)
|
||
|
|
Export transaction data from Firefly III
|
||
|
|
|
||
|
|
This endpoint allows you to export transactions from Firefly III into a file. Currently supports CSV exports only.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**start** | **string**| A date formatted YYYY-MM-DD. |
|
||
|
|
**end** | **string**| A date formatted YYYY-MM-DD. |
|
||
|
|
**optional** | ***DataApiExportTransactionsOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a DataApiExportTransactionsOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
|
||
|
|
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
**accounts** | **optional.String**| Limit the export of transactions to these accounts only. Only asset accounts will be accepted. Other types will be silently dropped. |
|
||
|
|
**type_** | [**optional.Interface of ExportFileFilter**](.md)| The file type the export file (CSV is currently the only option). |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[***os.File**](*os.File.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: Not defined
|
||
|
|
- **Accept**: application/json, application/octet-stream
|
||
|
|
|
||
|
|
[[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)
|
||
|
|
|
||
|
|
# **PurgeData**
|
||
|
|
> PurgeData(ctx, optional)
|
||
|
|
Endpoint to purge user data
|
||
|
|
|
||
|
|
A call to this endpoint purges all previously deleted data. Use it with care and always with user permission. The demo user is incapable of using this endpoint.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**optional** | ***DataApiPurgeDataOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a DataApiPurgeDataOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
(empty response body)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
|
||
|
|
|
||
|
|
### 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)
|
||
|
|
|