Skip to main content
Aggregates income from all connected sources and deduplicates entries that appear in both payroll and bank data. Returns one record per employer or income source. Use the link_id from each employment record to drill into details with getPayrollIncome or getBankIncome.

​
Parameters

No parameters required.

​
Response

FieldTypeDescription
employmentsarrayOne entry per income source
employments[].link_idstringUse with getPayrollIncome or getBankIncome
employments[].data_sourcestringpayroll or financial_accounts
employments[].providerstringProvider name (e.g. “ADP”, “Chase”)
employments[].companystringEmployer name
employments[].incomestringIncome amount
employments[].income_unitstringIncome unit (e.g. “YEARLY”, “MONTHLY”)
employments[].pay_ratestringPay rate
employments[].pay_frequencystringWEEKLY, BIWEEKLY, MONTHLY, etc.
employments[].is_activebooleanWhether currently active
employments[].job_titlestringJob title
employments[].statement_countintegerNumber of pay statements available
summaryobjectAggregate counts
summary.total_employmentsintegerTotal income sources
summary.payroll_sourcesintegerFrom payroll providers
summary.bank_sourcesintegerFrom bank transaction analysis

​
Example

Prompt: “What are my income sources?” 
{
  "employments": [
    {
      "link_id": "a83b2c1d4e5f6789012345abcdef0123",
      "data_source": "payroll",
      "provider": "ADP",
      "company": "Acme Corp",
      "income": "85000.00",
      "income_unit": "YEARLY",
      "pay_rate": "3269.23",
      "pay_frequency": "BIWEEKLY",
      "is_active": true,
      "job_title": "Software Engineer",
      "statement_count": 6
    }
  ],
  "summary": {
    "total_employments": 1,
    "payroll_sources": 1,
    "bank_sources": 0
  }
}