create_income_projection

Creates an income projection (expected future income).

Description

Creates an income projection (expected future income).

Requires name. The name may be a natural-language request (e.g. "Add a $5000/month salary income projection"): the amount ($5000, $5k), repeatFrequency (MONTHLY or YEARLY) and category are inferred from it, startMonth defaults to the current month, and the stored name is cleaned ("Salary").
If no amount is given or inferred, or the cadence is weekly/biweekly (unsupported), it returns guidance instead of creating.
startMonth is ISO 8601 (e.g. 2024-01-01T00:00:00Z). amount is cents. repeatFrequency is NO_REPEAT, MONTHLY, YEARLY, or CUSTOM.
After creation, call list_income_projections to verify or get_financial_plan for the full plan.

Input parameters

NameTypeRequiredDescription
amountintegerNo
categorystringNo
customRepeatFrequencyobjectNo
endMonthstringNo
namestringYes
overridesarrayNo
repeatFrequencystringNo
startMonthstringNo