Skip to main content

Income modules

Salary​

Required Scope: person-income-salary

This module returns several kinds of salary-payments. This covers all forms of salary and wages, including standard employment income, civil servant pay, expense-related allowances (e.g. coaching or training fees), bonuses, apprenticeship or trainee compensation, salary advances and short-time work benefits. It does not cover expense reimbursements, subsidy or assistance payments, and commission-based income.

Pension​

Required Scope: person-income-pension

This module returns pension and retirement income as well as private retirement benefits.

Child allowances​

Required Scope: person-income-child-benefit

This module returns child allowances, whether provided by public authorities or by family members.

Parental allowance​

Required Scope: person-income-parental-allowance

This module returns parental leave benefits.

Rental income​

Required Scope: person-income-rental

This module returns rental income, including income from leasing residential property, garages, parking spaces, and similar assets.

Investment revenues​

Required Scope: person-income-investment

This module returns capital income, such as dividends from securities, proceeds from the sale of securities, income from cryptocurrency sales, and interest earned on deposits or savings.

Loans​

Required Scope: person-income-loan

This module returns loan disbursements.

Support payments / alimony​

Required Scope: person-income-alimony

This module returns income from maintenance and support payments.

Self employment​

Required Scope: person-income-self-employment

This module returns income self-employment such as owner's drawings, commissions, and performance-based compensation.

Miscellaneous​

Required Scope: person-income-other

This module returns recurring income from various sources, like feed-in tariffs for electricity generation, pocket money, unemployment benefits, other government or public benefits, and recurring private contributions (e.g. for shared household expenses), as well as irregular / one-off income such as cash deposits, refunds for energy or utility costs, gambling winnings, one-off transfers, and similar payments.