89 lines
3.6 KiB
Markdown
89 lines
3.6 KiB
Markdown
|
# {{classname}}
|
||
|
|
|
||
|
|
All URIs are relative to *https://demo.firefly-iii.org/api*
|
||
|
|
|
||
|
|
Method | HTTP request | Description
|
||
|
|
------------- | ------------- | -------------
|
||
|
|
[**SearchAccounts**](SearchApi.md#SearchAccounts) | **Get** /v1/search/accounts | Search for accounts
|
||
|
|
[**SearchTransactions**](SearchApi.md#SearchTransactions) | **Get** /v1/search/transactions | Search for transactions
|
||
|
|
|
||
|
|
# **SearchAccounts**
|
||
|
|
> AccountArray SearchAccounts(ctx, query, field, optional)
|
||
|
|
Search for accounts
|
||
|
|
|
||
|
|
Search for accounts
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**query** | **string**| The query you wish to search for. |
|
||
|
|
**field** | [**AccountSearchFieldFilter**](.md)| The account field(s) you want to search in. |
|
||
|
|
**optional** | ***SearchApiSearchAccountsOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a SearchApiSearchAccountsOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
|
||
|
|
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
**limit** | **optional.Int32**| Number of items per page. The default pagination is per 50 items. |
|
||
|
|
**page** | **optional.Int32**| Page number. The default pagination is per 50 items. |
|
||
|
|
**type_** | [**optional.Interface of AccountTypeFilter**](.md)| The type of accounts you wish to limit the search to. |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**AccountArray**](AccountArray.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/vnd.api+json, 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)
|
||
|
|
|
||
|
|
# **SearchTransactions**
|
||
|
|
> TransactionArray SearchTransactions(ctx, query, optional)
|
||
|
|
Search for transactions
|
||
|
|
|
||
|
|
Searches through the users transactions.
|
||
|
|
|
||
|
|
### Required Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||
|
|
**query** | **string**| The query you wish to search for. |
|
||
|
|
**optional** | ***SearchApiSearchTransactionsOpts** | optional parameters | nil if no parameters
|
||
|
|
|
||
|
|
### Optional Parameters
|
||
|
|
Optional parameters are passed through a pointer to a SearchApiSearchTransactionsOpts struct
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
|
||
|
|
**xTraceId** | [**optional.Interface of string**](.md)| Unique identifier associated with this request. |
|
||
|
|
**limit** | **optional.Int32**| Number of items per page. The default pagination is per 50 items. |
|
||
|
|
**page** | **optional.Int32**| Page number. The default pagination is per 50 items. |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**TransactionArray**](TransactionArray.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/vnd.api+json, 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)
|
||
|
|
|