banks2ff/firefly-iii-api/docs/RecurrencesApi.md

\RecurrencesApi

All URIs are relative to https://demo.firefly-iii.org/api

Method	HTTP request	Description
delete_recurrence	DELETE /v1/recurrences/{id}	Delete a recurring transaction.
get_recurrence	GET /v1/recurrences/{id}	Get a single recurring transaction.
list_recurrence	GET /v1/recurrences	List all recurring transactions.
list_transaction_by_recurrence	GET /v1/recurrences/{id}/transactions	List all transactions created by a recurring transaction.
store_recurrence	POST /v1/recurrences	Store a new recurring transaction
update_recurrence	PUT /v1/recurrences/{id}	Update existing recurring transaction.

delete_recurrence

delete_recurrence(id, x_trace_id) Delete a recurring transaction.

Delete a recurring transaction. Transactions created by the recurring transaction will not be deleted.

Parameters

Name	Type	Description	Required	Notes
id	String	The ID of the recurring transaction.	[required]
x_trace_id	Option<uuid::Uuid>	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]

get_recurrence

models::RecurrenceSingle get_recurrence(id, x_trace_id) Get a single recurring transaction.

Get a single recurring transaction.

Parameters

Name	Type	Description	Required	Notes
id	String	The ID of the recurring transaction.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::RecurrenceSingle

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]

list_recurrence

models::RecurrenceArray list_recurrence(x_trace_id, limit, page) List all recurring transactions.

List all recurring transactions.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.

Return type

models::RecurrenceArray

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]

list_transaction_by_recurrence

models::TransactionArray list_transaction_by_recurrence(id, x_trace_id, limit, page, start, end, r#type) List all transactions created by a recurring transaction.

List all transactions created by a recurring transaction, optionally limited to the date ranges specified.

Parameters

Name	Type	Description	Required	Notes
id	String	The ID of the recurring transaction.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.
start	Option<String>	A date formatted YYYY-MM-DD. Both the start and end date must be present.
end	Option<String>	A date formatted YYYY-MM-DD. Both the start and end date must be present.
r#type	Option<TransactionTypeFilter>	Optional filter on the transaction type(s) returned

Return type

models::TransactionArray

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]

store_recurrence

models::RecurrenceSingle store_recurrence(recurrence_store, x_trace_id) 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.

Parameters

Name	Type	Description	Required	Notes
recurrence_store	RecurrenceStore	JSON array or key=value pairs with the necessary recurring transaction information. See the model for the exact specifications.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::RecurrenceSingle

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]

update_recurrence

models::RecurrenceSingle update_recurrence(id, recurrence_update, x_trace_id) Update existing recurring transaction.

Update existing recurring transaction.

Parameters

Name	Type	Description	Required	Notes
id	String	The ID of the recurring transaction.	[required]
recurrence_update	RecurrenceUpdate	JSON array with updated recurring transaction information. See the model for the exact specifications.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::RecurrenceSingle

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]