18 KiB
{{classname}}
All URIs are relative to https://demo.firefly-iii.org/api
| Method | HTTP request | Description |
|---|---|---|
| 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 | Delete /v1/data/destroy | Endpoint to destroy user data |
| ExportAccounts | Get /v1/data/export/accounts | Export account data from Firefly III |
| ExportBills | Get /v1/data/export/bills | Export bills from Firefly III |
| ExportBudgets | Get /v1/data/export/budgets | Export budgets and budget amount data from Firefly III |
| ExportCategories | Get /v1/data/export/categories | Export category data from Firefly III |
| ExportPiggies | Get /v1/data/export/piggy-banks | Export piggy banks from Firefly III |
| ExportRecurring | Get /v1/data/export/recurring | Export recurring transaction data from Firefly III |
| ExportRules | Get /v1/data/export/rules | Export rule groups and rule data from Firefly III |
| ExportTags | Get /v1/data/export/tags | Export tag data from Firefly III |
| ExportTransactions | Get /v1/data/export/transactions | Export transaction data from Firefly III |
| 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, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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 | 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| Unique identifier associated with this request. |
Return type
(empty response body)
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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 | Unique identifier associated with this request. | |
| type_ | optional.Interface of ExportFileFilter | The file type the export file (CSV is currently the only option). |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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 | Unique identifier associated with this request. | |
| type_ | optional.Interface of ExportFileFilter | The file type the export file (CSV is currently the only option). |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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 | Unique identifier associated with this request. | |
| type_ | optional.Interface of ExportFileFilter | The file type the export file (CSV is currently the only option). |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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 | Unique identifier associated with this request. | |
| type_ | optional.Interface of ExportFileFilter | The file type the export file (CSV is currently the only option). |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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 | Unique identifier associated with this request. | |
| type_ | optional.Interface of ExportFileFilter | The file type the export file (CSV is currently the only option). |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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 | Unique identifier associated with this request. | |
| type_ | optional.Interface of ExportFileFilter | The file type the export file (CSV is currently the only option). |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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 | Unique identifier associated with this request. | |
| type_ | optional.Interface of ExportFileFilter | The file type the export file (CSV is currently the only option). |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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 | Unique identifier associated with this request. | |
| type_ | optional.Interface of ExportFileFilter | The file type the export file (CSV is currently the only option). |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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| 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| The file type the export file (CSV is currently the only option). |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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 | Unique identifier associated with this request. |
Return type
(empty response body)
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]