Skip to main content
Returns income analysis derived from bank transactions for a single connected account. Identifies income streams with historical averages, pay frequency, and the individual transactions used to detect each source.
Use the link_id from incomeReport - do not guess this value.

​
Parameters

ParameterTypeRequiredDefaultDescription
link_idstringYes-The link_id from the employment entry in incomeReport

​
Response

FieldTypeDescription
income_sourcesarrayDetected income streams
income_sources[].namestringSource name (e.g. employer)
income_sources[].categorystringIncome category
income_sources[].average_amountstringHistorical average per payment
income_sources[].frequencystringDetected payment frequency
income_sources[].transaction_countintegerNumber of transactions analyzed
income_sources[].transactionsarrayIndividual transactions used for detection

​
Example

Prompt: “Analyze the income deposits in my Chase checking account” First call incomeReport to get the link_id for the Chase connection, then call this tool: 
{
  "income_sources": [
    {
      "name": "Employer Direct Deposit",
      "category": "salary",
      "average_amount": "3250.00",
      "frequency": "BIWEEKLY",
      "transaction_count": 6,
      "transactions": [
        {
          "amount": "3250.00",
          "description": "Direct Deposit",
          "posted_at": "2026-03-28"
        }
      ]
    },
    {
      "name": "Freelance Payment",
      "category": "other",
      "average_amount": "800.00",
      "frequency": "MONTHLY",
      "transaction_count": 3
    }
  ]
}