11 KiB
{{classname}}
All URIs are relative to https://demo.firefly-iii.org/api
| Method | HTTP request | Description |
|---|---|---|
| DeleteRecurrence | Delete /v1/recurrences/{id} | Delete a recurring transaction. |
| GetRecurrence | Get /v1/recurrences/{id} | Get a single recurring transaction. |
| ListRecurrence | Get /v1/recurrences | List all recurring transactions. |
| ListTransactionByRecurrence | Get /v1/recurrences/{id}/transactions | List all transactions created by a recurring transaction. |
| StoreRecurrence | Post /v1/recurrences | Store a new recurring transaction |
| UpdateRecurrence | Put /v1/recurrences/{id} | Update existing recurring transaction. |
DeleteRecurrence
DeleteRecurrence(ctx, id, optional) Delete a recurring transaction.
Delete a recurring transaction. Transactions created by the recurring transaction will not be deleted.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the recurring transaction. | |
| optional | *RecurrencesApiDeleteRecurrenceOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RecurrencesApiDeleteRecurrenceOpts 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]
GetRecurrence
RecurrenceSingle GetRecurrence(ctx, id, optional) Get a single recurring transaction.
Get a single recurring transaction.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the recurring transaction. | |
| optional | *RecurrencesApiGetRecurrenceOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RecurrencesApiGetRecurrenceOpts 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]
ListRecurrence
RecurrenceArray ListRecurrence(ctx, optional) List all recurring transactions.
List all recurring transactions.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *RecurrencesApiListRecurrenceOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RecurrencesApiListRecurrenceOpts 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]
ListTransactionByRecurrence
TransactionArray ListTransactionByRecurrence(ctx, id, optional) List all transactions created by a recurring transaction.
List all transactions created by a recurring transaction, optionally limited to the date ranges specified.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the recurring transaction. | |
| optional | *RecurrencesApiListTransactionByRecurrenceOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RecurrencesApiListTransactionByRecurrenceOpts 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. Both the start and end date must be present. | end | optional.String| A date formatted YYYY-MM-DD. Both the start and end date must be present. | 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]
StoreRecurrence
RecurrenceSingle StoreRecurrence(ctx, body, type_, title, description, firstDate, repeatUntil, nrOfRepetitions, applyRules, active, notes, repetitions, transactions, optional) Store a new recurring transaction
Creates a new recurring 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 | RecurrenceStore | JSON array or key=value pairs with the necessary recurring transaction information. See the model for the exact specifications. | |
| type_ | RecurrenceTransactionType | ||
| title | string | ||
| description | string | ||
| firstDate | string | ||
| repeatUntil | string | ||
| nrOfRepetitions | int32 | ||
| applyRules | bool | ||
| active | bool | ||
| notes | string | ||
| repetitions | **[]RecurrenceRepetitionStore** | ||
| transactions | **[]RecurrenceTransactionStore** | ||
| optional | *RecurrencesApiStoreRecurrenceOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RecurrencesApiStoreRecurrenceOpts 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]
UpdateRecurrence
RecurrenceSingle UpdateRecurrence(ctx, body, title, description, firstDate, repeatUntil, nrOfRepetitions, applyRules, active, notes, repetitions, transactions, id, optional) Update existing recurring transaction.
Update existing recurring transaction.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | RecurrenceUpdate | JSON array with updated recurring transaction information. See the model for the exact specifications. | |
| title | string | ||
| description | string | ||
| firstDate | string | ||
| repeatUntil | string | ||
| nrOfRepetitions | int32 | ||
| applyRules | bool | ||
| active | bool | ||
| notes | string | ||
| repetitions | **[]RecurrenceRepetitionUpdate** | ||
| transactions | **[]RecurrenceTransactionUpdate** | ||
| id | string | The ID of the recurring transaction. | |
| optional | *RecurrencesApiUpdateRecurrenceOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RecurrencesApiUpdateRecurrenceOpts 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]