3.6 KiB
{{classname}}
All URIs are relative to https://demo.firefly-iii.org/api
| Method | HTTP request | Description |
|---|---|---|
| SearchAccounts | Get /v1/search/accounts | Search for accounts |
| 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 | 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| 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| The type of accounts you wish to limit the search to. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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| 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
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]