23d8982b533d
List Predicted Recurring Transactions
List predicted recurring transactions for a user. All fields are optional, which means that setting none of the fields will return 30 days of predictions for all of a user's active groups.
To forecast recurring transactions for 30 days ahead, the model checks if an existing recurring transactions group is active. If that is the case, the model will look at the last date for when the transactions occurred and calculate that together with the found periodicity for that recurring transaction.
Only one prediction will be made for each group, unless the group has a WEEKLY or a BI_WEEKLY periodicity.
Query parameters
An optional pagination page size. Default value is 10, max value is 100. Must be a positive integer.
The prediction span in days from today's date. The default value is 30 days. Must be a positive integer. Optional.
An optional pagination token specifying the page of results to retrieve.
A list of ids of the recurring transactions group to predict transactions for. Note that this cannot be used in combination with any of the other group id fields. Must be a valid UUID. Optional.
A list of account ids to predict transactions for. Note that this cannot be used in combination with any of the other account id fields. Must be a valid UUID. Optional.
Response
Returns 200 Ok for successful operation.