Recurring Group Schema
When a transaction is recurrent, the recurrence group contains the calculated information for that transaction and others within the same recurrence group. The schema of the RecurrenceGroup is as follows.
| attribute | type | summary |
|---|---|---|
| first_payment_date | date | Date of the first recurrent group's transaction. |
| latest_payment_date | date | Date of the last recurrent group's transaction. |
| periodicity_in_days | float | Median number of days between consecutive transactions in the recurrent group. |
| average_amount | float | Average amount of the recurrent group's transactions. |
| other_party | string | Source/merchant of the recurrent group's transactions. |
| id | string | Recurrent group identifier. |
| transaction_ids | list(string) | List of unique transaction identifier of the recurrence group. |
| total_amount | float | Sum of amounts of the recurrent group's transactions. |
| periodicity | enum | Detected periodicity (daily, weekly, bi-weekly, monthly, bi-monthly, quarterly, semi-yearly, yearly, other). |