Recurring Transactions Report

Group recurring transaction by categories, brand, amount and period. Only monthly period is supported at the moment.

This report can be requested via the Modular Report endpoint.

ReportOptions

This report has no options to be considered.

Response Structure of Recurring Transactions Report

The generated report will be part of the modular report response.

{
    "type": "RECURRING_TRANSACTIONS",
    "intervals": Array<Interval>
}

type String, always present

The type always contains the value "RECURRING_TRANSACTIONS" for this report.

intervals Interval[], required

A list of intervals, there is a maximum of one entry per distinct interval.

Interval

{
    "interval":  Enum<'MONTHLY'>,
    "income_amount": Amount,
    "expense_amount": Amount,
    "transaction_groups": Array<TransactionGroup>
}

An Interval contains information about how often a transaction recurs. For that similar transactions are grouped into TransactionGroup. For example: if interval is MONTHLY and transaction_groups contains one entry there is one recurring transaction every month.

interval Enum, always present

The interval that all transactions have, e.g. MONTHLY means that the transactions recur once every month.

income_amount Amount, always present

The sum of all transaction group average_amount-values in this interval that are classified as income.

expense_amount Amount, always present

The sum of all transaction group average_amount-values in this interval that are classified as expense.

transaction_groups TransactionGroup[], required

A list of TransactionGroup-objects that recur in the specified interval.

TransactionGroup

{
    "earliest_day":  Integer,
    "latest_day": Integer,
    "average_amount": Amount,
    "transaction_ids": Array<String>,
    "categories": Array<Category>,
    "brand": ?Brand
}

A group is a collection of multiple transactions that have the same categories, brand, a similar amount and dates which match the interval.

earliest_day Integer, always present

The arliest day of month that a transaction was found for this group

latest_day Integer, always present

The latest day of month that a transaction was found for this group. Can be up to 6 days after earliest_day.

average_amount Amount, always present

The average amount of all transaction in this group. It can vary by up to 10% between transactions.

transaction_ids String[], always present

A list of transaction ids, to get all information about these transactions use the Categorized Transactions Report The length of this list depends on the amount of data available, but the minimum is two.

categories Category[], always present

A list of categories that all transactions of this group have. Can be empty.

brand Brand, optional

An optional brand that all transactions of this group have.

Example request

{
    "insights_consumer_id": "6c03aff-8fa0046-ffae74-b0cbc-4d5fd1",
    "report_days": 3,
    "reports": [
        {
            "type": "RECURRING_TRANSACTIONS"
        }
    ]
}

Example response

{
    "data": {
        "accounts": [
            {
                "insights_account_id": "3b3d678f-66b7-4b23-a2a5-0bfd275e86a1",
                "reports": [
                    {
                        "type": "RECURRING_TRANSACTIONS",
                        "intervals": [
                            {
                                "interval": "MONTHLY",
                                "income_amount": {
                                    "amount": 120000
                                },
                                "expense_amount": {
                                    "amount": -70000
                                },
                                "transaction_groups": [
                                    {
                                        "earliest_day": 2,
                                        "latest_day": 3,
                                        "average_amount": {
                                            "amount": 120000,
                                            "currency": "EUR"
                                        },
                                        "categories": [
                                            {
                                                "id": "8f7614f5-845d-5463-b145-8a1d57a40bd4",
                                                "name": "Salary & Wages & Paycheck"
                                            }
                                        ],
                                        "transaction_ids": [
                                            "26591975-811d-4fb7-8488-7e20d71a19c5",
                                            "a0855f13-6ac9-470e-820b-eb04db06ea06"
                                        ]
                                    },
                                    {
                                        "earliest_day": 19,
                                        "latest_day": 21,
                                        "average_amount": {
                                            "amount": -2000,
                                            "currency": "EUR"
                                        },
                                        "categories": [
                                            {
                                                "id": "13e8d66c-fe7d-53c4-ac21-70274ae0de6b",
                                                "name": "TV streaming subscriptions"
                                            }
                                        ],
                                        "brand": {
                                            "id": "e716771c-729c-5545-a73c-167f27071d82",
                                            "name": "Movie Stream"
                                        },
                                        "transaction_ids": [
                                            "941db735-efbb-5a0e-b4a4-bec4972441e7",
                                            "51e4d707-e779-4612-ad9f-88402a21d874"
                                        ]
                                    },
                                    {
                                        "earliest_day": 24,
                                        "latest_day": 24,
                                        "average_amount": {
                                            "amount": -5000,
                                            "currency": "EUR"
                                        },
                                        "categories": [
                                            {
                                                "id": "653ce528-43f2-5e60-95d5-c258f6ade300",
                                                "name": "Mobile Phone"
                                            }
                                        ],
                                        "brand": {
                                            "id": "ed558b36-3c41-5bd6-83f6-0869aedb0914",
                                            "name": "Large Phone Company"
                                        },
                                        "transaction_ids": [
                                            "e94261e5-464d-4dda-b16e-57743a7f3744",
                                            "0c6afa7c-0385-5507-86ee-3095317108c4"
                                        ]
                                    },
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

results matching ""

    No results matching ""