17 KiB
{{classname}}
All URIs are relative to https://demo.firefly-iii.org/api
| Method | HTTP request | Description |
|---|---|---|
| DeleteTransaction | Delete /v1/transactions/{id} | Delete a transaction. |
| DeleteTransactionJournal | Delete /v1/transaction-journals/{id} | Delete split from transaction |
| GetTransaction | Get /v1/transactions/{id} | Get a single transaction. |
| GetTransactionByJournal | Get /v1/transaction-journals/{id} | Get a single transaction, based on one of the underlying transaction journals (transaction splits). |
| ListAttachmentByTransaction | Get /v1/transactions/{id}/attachments | Lists all attachments. |
| ListEventByTransaction | Get /v1/transactions/{id}/piggy-bank-events | Lists all piggy bank events. |
| ListLinksByJournal | Get /v1/transaction-journals/{id}/links | Lists all the transaction links for an individual journal (individual split). |
| ListTransaction | Get /v1/transactions | List all the user's transactions. |
| StoreTransaction | Post /v1/transactions | Store a new transaction |
| UpdateTransaction | Put /v1/transactions/{id} | Update existing transaction. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/ |
DeleteTransaction
DeleteTransaction(ctx, id, optional) Delete a transaction.
Delete a transaction.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the transaction. | |
| optional | *TransactionsApiDeleteTransactionOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a TransactionsApiDeleteTransactionOpts 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]
DeleteTransactionJournal
DeleteTransactionJournal(ctx, id, optional) Delete split from transaction
Delete an individual journal (split) from a transaction.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the transaction journal (the split) you wish to delete. | |
| optional | *TransactionsApiDeleteTransactionJournalOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a TransactionsApiDeleteTransactionJournalOpts 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]
GetTransaction
TransactionSingle GetTransaction(ctx, id, optional) Get a single transaction.
Get a single transaction.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the transaction. | |
| optional | *TransactionsApiGetTransactionOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a TransactionsApiGetTransactionOpts struct
| Name | Type | Description | Notes |
|---|
xTraceId | optional.Interface of string| Unique identifier associated with this request. |
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]
GetTransactionByJournal
TransactionSingle GetTransactionByJournal(ctx, id, optional) Get a single transaction, based on one of the underlying transaction journals (transaction splits).
Get a single transaction by underlying journal (split).
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the transaction journal (split). | |
| optional | *TransactionsApiGetTransactionByJournalOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a TransactionsApiGetTransactionByJournalOpts struct
| Name | Type | Description | Notes |
|---|
xTraceId | optional.Interface of string| Unique identifier associated with this request. |
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]
ListAttachmentByTransaction
AttachmentArray ListAttachmentByTransaction(ctx, id, optional) Lists all attachments.
Lists all attachments.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the transaction. | |
| optional | *TransactionsApiListAttachmentByTransactionOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a TransactionsApiListAttachmentByTransactionOpts 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]
ListEventByTransaction
PiggyBankEventArray ListEventByTransaction(ctx, id, optional) Lists all piggy bank events.
Lists all piggy bank events.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the transaction. | |
| optional | *TransactionsApiListEventByTransactionOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a TransactionsApiListEventByTransactionOpts 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]
ListLinksByJournal
TransactionLinkArray ListLinksByJournal(ctx, id, optional) Lists all the transaction links for an individual journal (individual split).
Lists all the transaction links for an individual journal (a split). Don't use the group ID, you need the actual underlying journal (the split).
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the transaction journal / the split. | |
| optional | *TransactionsApiListLinksByJournalOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a TransactionsApiListLinksByJournalOpts 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]
ListTransaction
TransactionArray ListTransaction(ctx, optional) List all the user's transactions.
List all the user's transactions.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *TransactionsApiListTransactionOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a TransactionsApiListTransactionOpts 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. | |
| start | optional.String | A date formatted YYYY-MM-DD. This is the start date of the selected range (inclusive). | |
| end | optional.String | A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive). | |
| type_ | optional.Interface of TransactionTypeFilter | Optional filter on the transaction type(s) returned. |
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]
StoreTransaction
TransactionSingle StoreTransaction(ctx, body, errorIfDuplicateHash, applyRules, fireWebhooks, groupTitle, transactions, optional) Store a new transaction
Creates a new transaction. The data required can be submitted as a JSON body or as a list of parameters.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | TransactionStore | JSON array or key=value pairs with the necessary transaction information. See the model for the exact specifications. | |
| errorIfDuplicateHash | bool | ||
| applyRules | bool | ||
| fireWebhooks | bool | ||
| groupTitle | string | ||
| transactions | **[]TransactionSplitStore** | ||
| optional | *TransactionsApiStoreTransactionOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a TransactionsApiStoreTransactionOpts struct
| Name | Type | Description | Notes |
|---|
xTraceId | optional.Interface of string| Unique identifier associated with this request. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateTransaction
TransactionSingle UpdateTransaction(ctx, body, applyRules, fireWebhooks, groupTitle, transactions, id, optional) Update existing transaction. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/
Update an existing transaction.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | TransactionUpdate | JSON array with updated transaction information. See the model for the exact specifications. | |
| applyRules | bool | ||
| fireWebhooks | bool | ||
| groupTitle | string | ||
| transactions | **[]TransactionSplitUpdate** | ||
| id | string | The ID of the transaction. | |
| optional | *TransactionsApiUpdateTransactionOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a TransactionsApiUpdateTransactionOpts struct
| Name | Type | Description | Notes |
|---|
xTraceId | optional.Interface of string| Unique identifier associated with this request. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]