The Recurring Transactions object

The Recurring Transactions response separates recurring transactions into inflows (income) and outflows (expenses), with details about frequency, amounts, and status.

Query parameters

Parameter	Type	Default	Description
status	string	`active`	Filter by recurring status: `active`, `inactive`, or `irregular`. The default `active` hides inactive and irregular series, so pass an explicit value to include them.

Inflow attributes

Attribute	Type	Description
source_id	string	Unique identifier of the income source
source_name	string	Name of the income source (e.g. employer name)
account_id	string	ID of the associated account
description	string	Transaction description
frequency	string	Payment frequency (`WEEKLY`, `BIWEEKLY`, `MONTHLY`, etc.)
average_amount	string	Average payment amount
median_amount	string	Median payment amount
last_amount	string	Most recent payment amount
logo_url	string	Logo URL for the source
status	string	`active`, `inactive`, or `irregular`
income_type	string	Type of income (e.g. `salary`)
first_detected	string	Date first detected (YYYY-MM-DD)
last_transaction_date	string	Date of most recent transaction
next_expected_date	string	Predicted next payment date
historical_transactions	array of objects	Past transactions for this source

Outflow attributes

Attribute	Type	Description
source_id	string	Unique identifier of the expense source
source_name	string	Name of the merchant or service
account_id	string	ID of the associated account
categories	array of strings	Assigned categories
description	string	Transaction description
merchant_category_code	string	ISO 18245 category code
frequency	string	Payment frequency
status	string	`active`, `inactive`, or `irregular`
average_amount	string	Average payment amount
median_amount	string	Median payment amount
last_amount	string	Most recent payment amount
logo_url	string	Logo URL for the merchant
first_detected	string	Date first detected (YYYY-MM-DD)
last_transaction_date	string	Date of most recent transaction
next_expected_date	string	Predicted next payment date
historical_transactions	array of objects	Past transactions for this source

Endpoints

Get recurring transactions

Example response

{
  "recurring_transactions": {
    "inflows": [
      {
        "source_id": "a1b2c3d4e5f6789012345678abcdef01",
        "source_name": "Acme Corp",
        "account_id": "24d7e80942ce4ad58a93f70ce4115f5c",
        "description": "Salary",
        "frequency": "BIWEEKLY",
        "average_amount": "3500.00",
        "median_amount": "3500.00",
        "last_amount": "3500.00",
        "status": "active",
        "income_type": "salary",
        "first_detected": "2024-01-01",
        "last_transaction_date": "2024-11-15",
        "next_expected_date": "2024-11-29"
      }
    ],
    "outflows": [
      {
        "source_id": "f9e8d7c6b5a4321098765432fedcba10",
        "source_name": "Netflix",
        "account_id": "24d7e80942ce4ad58a93f70ce4115f5c",
        "categories": ["Entertainment"],
        "description": "NETFLIX.COM",
        "frequency": "MONTHLY",
        "status": "active",
        "average_amount": "15.99",
        "median_amount": "15.99",
        "last_amount": "15.99",
        "first_detected": "2024-01-15",
        "last_transaction_date": "2024-11-15",
        "next_expected_date": "2024-12-15"
      }
    ]
  }
}

​Query parameters

​Inflow attributes

​Outflow attributes

​Endpoints

​Example response

Query parameters

Inflow attributes

Outflow attributes

Endpoints

Example response