FinCalc API
  • Documentation
  • API Reference
Information
Other endpoints
    Retirement PlanningpostEducation Funding GoalspostSurvivor Life Insurance NeedspostLong-Term Care NeedspostDisability Income NeedspostShould I lease or purchase an auto?postIs dealership financing better for me than traditional auto loan financing?postWhat would my auto payments be?postShould I upgrade to a more fuel efficient vehicle?postAuto loan: Accelerated payoffpostHow much vehicle can I afford?postShould I refinance my auto loan at a lower rate?postHow much can I lower my monthly payment with a new auto loan?postHow much might my vehicle depreciate?postCalculate my RV loan payments including balloonpostFuel Cost CalculatorpostShould I buy an electric or gas powered vehicle?postHow does inflation impact my standard of living?postHow much am I spending?postHow much do I need for emergencies?postShould I pay down debt or invest my monthly surplus?postHow long will my money last with systematic withdrawals?postShould my spouse enter the work force?postWhat is my current net worth?postWhat is my projected net worth?postWhat is my current cash flow?postWhat is my projected cash flow?postWhat is the value of reducing, postponing or foregoing expenses?postHistorical inflation - Compare purchasing powerpostBalance My CheckbookpostCost of Living ComparisonpostWhat are the tax savings of a qualified retirement/cafeteria plan?postWhat are my new business startup costs?postShould I pay or charge monthly, quarterly or annually?postWhat is the value of my business?postHow many units do I need to sell to breakeven?postShould I lease or buy equipment?postWhat are my business financial ratios?postWhat is my employee total compensation package worth?postWhat are my tax savings with Section 179 deduction?postEmployer FSA Savings CalculatorpostWhat should I price my product/service in order to be profitable?postHow much should I be saving for college?postCalculate your ability to pay back student loans.postWhat are the advantages of a Coverdell ESA?postWhat are the advantages of a 529 college savings plan?postWhat is the value of a college education?postWhat are the payments on a parental (PLUS) loan?postShould I live at home, on campus, or off campus?postWhen should I begin saving for my child's college?postWhat expenses should I expect before college?postHow soon can I breakeven if I refinance?postEvaluate Your Saving StrategypostCompare Roth 401(k) Versus Before-TaxpostHow long will it take to pay off my credit card?postHow long until my loan is paid off?postWhat would my loan payments be?postDo I have too much debt?postWhat is the balance on my loan?postWill consolidating my debt into a new loan be beneficial?postRestructuring debts for accelerated payoffpostWhich is better: Cash up front or payments over time?postWhat is the impact of making extra payments on my debt?postShould I pay off debt or invest?postShould I transfer my credit card balances?postWhat is my credit score?postHow much can I afford to borrow?postWhat is my loan rate?postWhat monthly payments are needed to pay off my loan sooner?postHow much house can I afford?postShould I refinance my mortgage?postEstimate my monthly mortgage paymentpostComparing mortgage termspostShould I pay discount points for a lower interest rate?postShould I rent or buy a home?postShould I convert to a bi-weekly payment schedule?postCompare a 'no-cost' vs. traditional mortgagepostWhat are the tax savings generated by my mortgage?postWhich is better: Fixed or adjustable-rate mortgage?postAdjustable rate mortgage calculatorpostHow do closing costs impact the interest rate?postCompare an interest-only vs. traditional mortgagepostCalculate Your Estimated Borrowing Capacity Using A Home Equity Line of Credit (HELOC)postDiscover the better option between loans.postHow does a reverse mortgage work?postWhat are my HELOC payments?postBalloon mortgagepostComparing Mortgage Terms (i.e. 15, 20, 30 year)postWhat is my potential estate tax liability?postShould I adjust my payroll withholdings?postWill my investment interest be deductible?postHow much self-employment tax will I pay?postLong-term Capital Gains Tax EstimatorpostCompare taxable, tax-deferred and tax-free investment growthpostHow much of my social security benefit may be taxed?postWhat are the tax implications of paying interest?postShould I itemize or take the standard deduction?postWhat is my tax-equivalent yield?postHow much life insurance do I need?postCalculate Your Estimated Life ExpectancypostWhat are my needs for burial and final expenses?postHow much disability income insurance do I need?postWhat are my chances of becoming disabled?postWhat are my long-term care insurance needs?postHow much will I earn in my lifetime?postWhat are the tax advantages of an annuity?postHow long will my current life insurance proceeds last?postWhat is the future value of an annuity?postWhich is better, comprehensive plan or high-deductible plan with HSA?postCompare a taxable investment to a tax-deferred annuitypostWhat are the payments on an immediate annuity?postHow should I allocate my assets?postCompare taxable vs. tax-free investment returnpostWhat is the value of a bond?postWhat is the return on my real estate investment?postWhat is the value of compound interest?postWhat is the value of a call or put option?postTaxable vs. tax-advantaged savings?postWhat is my risk tolerance?postWhat is the long-term impact of increased investment return?postCalculate Your Certificate of Deposit (CD) ValuepostWhat is the dividend yield on a stock?postHow do expenses impact mutual fund returns?postCertificate of deposit (CD) laddering strategypostWhat return do I need to get back to where I started?postHow much will my company bonus net after taxes?postHow will payroll adjustments affect my take-home pay?postConvert my salary to an equivalent hourly wagepostConvert my hourly wage to an equivalent annual salarypostWhat is the future value of my employee stock options?postShould I exercise my 'in-the-money' stock options?postWhat may my 401k be worth?postWhat is the impact of increasing my 401(k) contribution?postWhat may my 403(b) Plan be worth?postWhat may my Health Savings Account (HSA) be worth?postWhat may my company ESOP be worth?postShould I contribute more to receive the maximum 401(k) match?postEvaluate my company pension payout optionspostHow much can I contribute to an IRA?postHow much retirement income may an IRA provide?postShould I convert to a Roth IRA?postWhat will my qualified plan(s) be worth at retirement?postWhat is my current year required minimum distribution?postWhat are my projected required minimum distributions?postWhat are my lump sum distribution options?postHow do I maximize my employer 401(k) match?postWhat is the impact of borrowing from my retirement plan?postWhat is the impact of early withdrawal from my 401(k)?postI'm self-employed, how much can I contribute to a retirement plan?postNet unrealized appreciation (NUA) vs. IRA rollover?postWhat Is My Beneficiary Required Minimum Distribution?post72(t) early distribution analysispostHow will retirement impact my living expenses?postAm I saving enough for my retirement?postAre my current retirement savings sufficient?postSocial security retirement income estimatorpostHow does inflation impact my retirement income needs?postI'm retired, how long will my savings last?postWhen should I begin saving for retirement?postShould I convert discretionary expenses to savings?postHow much retirement income may my 401(k) provide?postCompare a Roth 401(k) to a Traditional 401(k)postWhat is the value of catch-up contributions for retirement?postBecoming a millionairepostIncome generated by a savings planpostHow long will it take to double my savings?postHow long until my savings reach my goal?postSave now vs. save laterpostHow much should I save to reach my goal?postWhat could my current savings grow to?postCalculate rate of returnpostHow do taxes and inflation impact my investment return?postWhat is the effective annual yield on my investment?postWhat could my recurring savings grow to?postIs my savings plan on track?postHow long would I need to work to buy something?postHow much should I save to reach my goal?post
Schemas
powered by Zuplo
FinCalc API
FinCalc API

Schemas


MonetaryAmount

string · pattern: ^-?\d+(\.\d{1,2})?$

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Rate

number

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Problem

RFC 9457 problem details (application/problem+json).
type
​string

A URI reference identifying the problem type.

title
​string

A short, human-readable summary of the problem type.

status
​integer

The HTTP status code generated for this occurrence.

detail
​string

A human-readable explanation specific to this occurrence.

instance
​string

A URI reference identifying this specific occurrence.

​object[]

Field-level validation errors, present on 422 responses.

Adv01Request

Inputs for the adv01 calculation.
clientFirstName
​string · required
spouseFirstName
​string · required
clientLastName
​string · required
spouseLastName
​string · required
clientDOB
​string · required
clientAge
​integer · min: 0 · max: 120 · required
Default: 0
spouseDOB
​string · required
spouseAge
​integer · min: 0 · max: 120 · required
Default: 0
clientAddress
​string · required
clientCity
​string · required
clientState
​string · required
clientZip
​string · required
clientPhone
​string · required
advisorName
​string · required
advisorCompanyName
​string · required
companyAddress1
​string · required
companyAddress2
​string · required
companyCity
​string · required
companyState
​string · required
companyZip
​string · required
companyPhone
​string · required
clientIncome
​number · required
spouseIncome
​number · required
clientPayIncrease
​number · min: 0 · max: 0.2 · required
Default: 0.05
spousePayIncrease
​number · min: 0 · max: 0.2 · required
Default: 0.05
clientRetirementAge
​integer · min: 0 · max: 120 · required
Default: 67
spouseRetirementAge
​integer · min: 0 · max: 120 · required
Default: 67
clientDeathAge
​integer · min: 0 · max: 120 · required
Default: 95
spouseDeathAge
​integer · min: 0 · max: 120 · required
Default: 95
assetDescription1
​string · required
assetValue1
​number · required
assetOwner1
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType1
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription2
​string · required
assetValue2
​number · required
Default: 0
assetOwner2
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType2
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription3
​string · required
assetValue3
​number · required
Default: 0
assetOwner3
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType3
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription4
​string · required
assetValue4
​number · required
Default: 0
assetOwner4
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType4
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription5
​string · required
assetValue5
​number · required
Default: 0
assetOwner5
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType5
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription6
​string · required
assetValue6
​number · required
Default: 0
assetOwner6
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType6
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription7
​string · required
assetValue7
​number · required
Default: 0
assetOwner7
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType7
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription8
​string · required
assetValue8
​number · required
Default: 0
assetOwner8
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType8
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription9
​string · required
assetValue9
​number · required
Default: 0
assetOwner9
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType9
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription10
​string · required
assetValue10
​number · required
Default: 0
assetOwner10
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType10
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription11
​string · required
assetValue11
​number · required
assetOwner11
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType11
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription12
​string · required
assetValue12
​number · required
Default: 0
assetOwner12
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType12
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription13
​string · required
assetValue13
​number · required
Default: 0
assetOwner13
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType13
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription14
​string · required
assetValue14
​number · required
Default: 0
assetOwner14
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType14
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription15
​string · required
assetValue15
​number · required
Default: 0
assetOwner15
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType15
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription16
​string · required
assetValue16
​number · required
Default: 0
assetOwner16
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType16
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription17
​string · required
assetValue17
​number · required
Default: 0
assetOwner17
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType17
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription18
​string · required
assetValue18
​number · required
Default: 0
assetOwner18
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType18
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription19
​string · required
assetValue19
​number · required
Default: 0
assetOwner19
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType19
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
assetDescription20
​string · required
assetValue20
​number · required
Default: 0
assetOwner20
​string · enum · required
Enum values:
Client
Spouse
Joint
ComProp
Default: Client
assetType20
​string · enum · required
Enum values:
Liquid
Business
QualTrad
QualRoth
NonQualInv
Default: Liquid
clientQualAnnual
​number · required
Default: 2000
spouseQualAnnual
​number · required
Default: 2000
qualIncreases
​string · enum · required
Enum values:
N
Y
Default: N
clientRothAnnual
​number · required
Default: 0
spouseRothAnnual
​number · required
Default: 0
rothIncreases
​string · enum · required
Enum values:
N
Y
Default: N
clientNonQualAnnual
​number · required
Default: 0
spouseNonQualAnnual
​number · required
Default: 0
nonQualIncreases
​string · enum · required
Enum values:
N
Y
Default: N
forceRMD
​string · enum · required
Enum values:
N
Y
Default: N
clientPension
​number · required
Default: 15000
clientPensionLS
​number · required
Default: 0
spousePension
​number · required
Default: 0
spousePensionLS
​number · required
Default: 0
clientPensionIncreases
​string · enum · required
Enum values:
N
Y
Default: N
spousePensionIncreases
​string · enum · required
Enum values:
N
Y
Default: N
clientPensionAge
​integer · min: 0 · max: 120 · required
Default: 67
spousePensionAge
​integer · min: 0 · max: 120 · required
Default: 67
otherIncomeDescription1
​string · required
otherIncomeAmount1
​number · required
otherIncomeStartAge1
​integer · min: 0 · max: 120 · required
otherIncomeEndAge1
​integer · min: 0 · max: 120 · required
otherIncomeIncreases1
​number · min: 0 · max: 0.2 · required
Default: 0.05
otherIncomeReceiptType1
​string · enum · required
Enum values:
Receipt
Expense
Default: Receipt
otherIncomeTaxable1
​string · enum · required
Enum values:
N
Y
Default: Y
otherIncomeDescription2
​string · required
otherIncomeAmount2
​number · required
otherIncomeStartAge2
​integer · min: 0 · max: 120 · required
otherIncomeEndAge2
​integer · min: 0 · max: 120 · required
otherIncomeIncreases2
​number · min: 0 · max: 0.2 · required
Default: 0.05
otherIncomeReceiptType2
​string · enum · required
Enum values:
Receipt
Expense
Default: Receipt
otherIncomeTaxable2
​string · enum · required
Enum values:
N
Y
Default: Y
otherIncomeDescription3
​string · required
otherIncomeAmount3
​number · required
otherIncomeStartAge3
​integer · min: 0 · max: 120 · required
otherIncomeEndAge3
​integer · min: 0 · max: 120 · required
otherIncomeIncreases3
​number · min: 0 · max: 0.2 · required
Default: 0.05
otherIncomeReceiptType3
​string · enum · required
Enum values:
Receipt
Expense
Default: Receipt
otherIncomeTaxable3
​string · enum · required
Enum values:
N
Y
Default: Y
otherIncomeDescription4
​string · required
otherIncomeAmount4
​number · required
otherIncomeStartAge4
​integer · min: 0 · max: 120 · required
otherIncomeEndAge4
​integer · min: 0 · max: 120 · required
otherIncomeIncreases4
​number · min: 0 · max: 0.2 · required
Default: 0.05
otherIncomeReceiptType4
​string · enum · required
Enum values:
Receipt
Expense
Default: Receipt
otherIncomeTaxable4
​string · enum · required
Enum values:
N
Y
Default: Y
otherIncomeDescription5
​string · required
otherIncomeAmount5
​number · required
otherIncomeStartAge5
​integer · min: 0 · max: 120 · required
otherIncomeEndAge5
​integer · min: 0 · max: 120 · required
otherIncomeIncreases5
​number · min: 0 · max: 0.2 · required
Default: 0.05
otherIncomeReceiptType5
​string · enum · required
Enum values:
Receipt
Expense
Default: Receipt
otherIncomeTaxable5
​string · enum · required
Enum values:
N
Y
Default: Y
otherIncomeDescription6
​string · required
otherIncomeAmount6
​number · required
otherIncomeStartAge6
​integer · min: 0 · max: 120 · required
otherIncomeEndAge6
​integer · min: 0 · max: 120 · required
otherIncomeIncreases6
​number · min: 0 · max: 0.2 · required
Default: 0.05
otherIncomeReceiptType6
​string · enum · required
Enum values:
Receipt
Expense
Default: Receipt
otherIncomeTaxable6
​string · enum · required
Enum values:
N
Y
Default: Y
retirementGoalPercentage
​number · min: 0 · max: 1 · required
Default: 0.75
retirementGoalAmount
​number · required
Default: 0
legacyAmount
​number · required
Default: 0
legacyIncreases
​string · enum · required
Enum values:
N
Y
Default: N
includeSS
​string · enum · required
Enum values:
N
Y
Default: N
inflationSS
​number · min: 0 · max: 0.1 · required
Default: 0.03
ssBenefitsTaxable
​integer · enum · required
Enum values:
1
2
9
3
Default: 1
clientSSEligible
​string · enum · required
Enum values:
N
Y
Default: Y
spouseSSEligible
​string · enum · required
Enum values:
N
Y
Default: Y
clientSSOverrideAge
​integer · min: 0 · max: 120 · required
Default: 0
spouseSSOverrideAge
​integer · min: 0 · max: 120 · required
Default: 0
clientSSOverride
​number · required
Default: 0
spouseSSOverride
​number · required
Default: 0
recommendedSavingsIncreases
​string · enum · required
Enum values:
N
Y
Default: N
preRetirementReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.06
postRetirementReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.06
preRetirementTaxRate
​number · min: 0 · max: 0.75 · required
Default: 0.22
postRetirementTaxRate
​number · min: 0 · max: 0.75 · required
Default: 0.22
inflation
​number · min: 0 · max: 0.1 · required
Default: 0.03
earlyRetirementGoal
​number · required
earlyRetirementYears
​integer · min: 0 · max: 120 · required
middleRetirementGoal
​number · required
middleRetirementYears
​integer · min: 0 · max: 120 · required
assetContribution1
​number · required
assetContribution2
​number · required
assetContribution3
​number · required
assetContribution4
​number · required
assetContribution5
​number · required
assetContribution6
​number · required
assetContribution7
​number · required
assetContribution8
​number · required
assetContribution9
​number · required
assetContribution10
​number · required

Adv01Result

Result of the adv01 calculation.
purchasingPower
​number · required
currentPlans
​number · required
shortfall
​number · required
goalReplacementRatio
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
replacementRatio
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
needsToday
​number · required
needsAtRetirement
​number · required
needsAtDeath
​number · required
​Adv01YearRow[] · required

Adv01YearRow

tableId
​string · required
year
​number | null · required
yourAge
​number | null · required
spouseAge
​number | null · required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required

Adv02Request

Inputs for the adv02 calculation.
clientFirstName
​string · required
clientLastName
​string · required
spouseFirstName
​string · required
spouseLastName
​string · required
clientAddress
​string · required
clientCity
​string · required
clientState
​string · required
clientZip
​string · required
clientPhone
​string · required
advisorName
​string · required
advisorCompanyName
​string · required
companyAddress1
​string · required
companyAddress2
​string · required
companyCity
​string · required
companyState
​string · required
companyZip
​string · required
companyPhone
​string · required
​object[] · minItems: 1 · maxItems: 6 · required
child1Savings529
​number · required
Default: 0
child2Savings529
​number · required
Default: 0
child3Savings529
​number · required
Default: 0
child4Savings529
​number · required
Default: 0
child5Savings529
​number · required
Default: 0
child6Savings529
​number · required
Default: 0
collegeInflation
​number · min: 0 · max: 0.1 · required
Default: 0.06
collegeReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
preRetirementTaxRate
​number · min: 0 · max: 0.75 · required
Default: 0.22
collegeSavingsIncrease
​number · min: 0 · max: 0.2 · required
Default: 0
thruSchool
​string · enum · required
Enum values:
N
Y
Default: N

Adv02Result

Result of the adv02 calculation.
totalCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCostNoInflation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualSavingsTaxable
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
lumpSumTaxable
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlySavingsNeeded
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
lumpSumNeeded
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Adv02DependentRow[] · required
​Adv02StrategyRow[] · required
​Adv02DependentCostRow[] · required
​Adv02AnnualTaxableYearRow[] · required
​Adv02AnnualAdvantagedYearRow[] · required
​Adv02LumpSumTaxableYearRow[] · required
​Adv02LumpSumAdvantagedYearRow[] · required

Adv02DependentRow

​required
​required
​required
​required

Adv02StrategyRow

​required
​required
​required
​required
​required

Adv02DependentCostRow

year
​integer · required
child1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
child2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
child3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
child4
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
child5
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
child6
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
total
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Adv02AnnualTaxableYearRow

beginBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
withdrawals
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
savings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Adv02AnnualAdvantagedYearRow

beginBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
withdrawals
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
savings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Adv02LumpSumTaxableYearRow

beginBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
withdrawals
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
savings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Adv02LumpSumAdvantagedYearRow

beginBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
withdrawals
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
savings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Adv03Request

Inputs for the adv03 calculation.
clientFirstName
​string · required
spouseFirstName
​string · required
clientLastName
​string · required
spouseLastName
​string · required
clientDOB
​string · required
spouseDOB
​string · required
clientAddress
​string · required
clientCity
​string · required
clientState
​string · required
clientZip
​string · required
clientPhone
​string · required
advisorName
​string · required
advisorCompanyName
​string · required
companyAddress1
​string · required
companyAddress2
​string · required
companyCity
​string · required
companyState
​string · required
companyZip
​string · required
companyPhone
​string · required
clientIncome
​number · required
Default: 0
spouseIncome
​number · required
Default: 0
clientPayIncrease
​number · min: 0 · max: 0.2 · required
Default: 0.03
spousePayIncrease
​number · min: 0 · max: 0.2 · required
Default: 0.03
clientRetirementAge
​integer · min: 1 · max: 120 · required
Default: 65
spouseRetirementAge
​integer · min: 1 · max: 120 · required
Default: 65
assetValue1
​number · required
Default: 0
assetValue2
​number · required
Default: 0
assetValue3
​number · required
Default: 0
clientPension
​number · required
Default: 0
spousePension
​number · required
Default: 0
clientPensionDeath
​number · required
Default: 0
spousePensionDeath
​number · required
Default: 0
clientPensionIncreases
​string · enum · required
Enum values:
N
Y
Default: N
spousePensionIncreases
​string · enum · required
Enum values:
N
Y
Default: N
insuranceAmount1
​number · required
Default: 0
insuranceAmount2
​number · required
Default: 0
totalCollegeCosts
​number · required
Default: 0
debtValue1
​number · required
Default: 0
debtValue2
​number · required
Default: 0
funeral
​number · required
Default: 0
estateAdmin
​number · required
Default: 0
clientSurvivorsAmount1
​number · required
Default: 0
clientSurvivorsYears1
​integer · required
Default: 0
clientSurvivorsAmount2
​number · required
Default: 0
clientSurvivorsYears2
​integer · required
Default: 0
spouseSurvivorsAmount1
​number · required
Default: 0
spouseSurvivorsYears1
​integer · required
Default: 0
spouseSurvivorsAmount2
​number · required
Default: 0
spouseSurvivorsYears2
​integer · required
Default: 0
spouseDiesClientEarningsChange
​number · required
Default: 0
clientDiesSpouseEarningsChange
​number · required
Default: 0
​object[] · minItems: 1 · maxItems: 6 · required
preRetirementReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
preRetirementTaxRate
​number · min: 0 · max: 0.75 · required
Default: 0.22
inflation
​number · min: 0 · max: 0.1 · required
Default: 0.03
clientAge
​integer · min: 0 · max: 120 · required
Default: 0
spouseAge
​integer · min: 0 · max: 120 · required
Default: 0

Adv03Result

Result of the adv03 calculation.
clientImmediateNeeds
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientImmediateResources
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientImmediateShortfall
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientSurvivorNeeds
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientSurvivorResources
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientSurvivorShortfall
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​required
​required
​required
​required
​required
​required
clientFuneralCosts
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientEstateAdminCosts
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientMortgageDebt
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientOtherDebt
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientEmergencyFund
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientEducationFunding
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientCashAvailable
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientExistingLifeInsurance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAdjustedAssetsPV
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientPensionPlansAfterTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientSurvivorEarningsPV
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientSocialSecurityPV
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientTotalSurplus
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
clientCurrentAge
​number · required
spouseCurrentAge
​number · required
maritalStatus
​MaritalStatus · enum · required
Enum values:
married
single
​Adv03YearRow[] · required
​Adv03ClientYearRow[] · required
​Adv03SpouseYearRow[] · required

Adv03YearRow

category
​string · required
current
​string · required
projected
​string · required
change
​string · required

Adv03ClientYearRow

survivorAge
​number | null · required
desiredIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
personalIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
employerPrograms
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
governmentPrograms
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fromInvestments
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
shortfall
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Adv03SpouseYearRow

survivorAge
​number · required
desiredIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
personalIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
employerPrograms
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
governmentPrograms
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fromInvestments
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
shortfall
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

MaritalStatus

string · enum
Enum values:
married
single

Adv04Request

Inputs for the adv04 calculation.
clientFirstName
​string · required
spouseFirstName
​string · required
clientLastName
​string · required
spouseLastName
​string · required
clientDOB
​string · required
spouseDOB
​string · required
clientAge
​integer · min: 0 · max: 120 · required
Default: 0
spouseAge
​integer · min: 0 · max: 120 · required
Default: 0
clientAddress
​string · required
clientCity
​string · required
clientState
​string · required
clientZip
​string · required
clientPhone
​string · required
advisorName
​string · required
advisorCompanyName
​string · required
companyAddress1
​string · required
companyAddress2
​string · required
companyCity
​string · required
companyState
​string · required
companyZip
​string · required
companyPhone
​string · required
clientLTCAge
​integer · min: 1 · max: 120 · required
Default: 70
spouseLTCAge
​integer · min: 1 · max: 120 · required
Default: 70
clientLTCCost
​number · required
Default: 0
spouseLTCCost
​number · required
Default: 0
clientLTCYears
​integer · min: 1 · max: 40 · required
Default: 10
spouseLTCYears
​integer · min: 1 · max: 40 · required
Default: 10
clientLTCPremium
​number · required
Default: 0
spouseLTCPremium
​number · required
Default: 0
ltcInflation
​number · min: -0.12 · max: 0.12 · required
Default: 0.05
ltcAssets
​number · required
Default: 0
preRetirementReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.07
combinedMarginalTaxRate
​number · min: 0 · max: 0.75 · required
Default: 0.22

Adv04Result

Result of the adv04 calculation.
clientCurrentAge
​number · required
spouseCurrentAge
​number · required
clientYearsToSave1
​number · required
clientYearsToSave2
​number · required
clientYearsToSave3
​number · required
spouseYearsToSave1
​number | null · required
spouseYearsToSave2
​number | null · required
spouseYearsToSave3
​number | null · required
clientLumpSum1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientLumpSum2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientLumpSum3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​required
​required
​required
clientAnnual1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAnnual2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAnnual3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​required
​required
​required
clientDailyBenefit1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientDailyBenefit2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientDailyBenefit3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​required
​required
​required
clientPremiumsPaid1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientPremiumsPaid2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientPremiumsPaid3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​required
​required
​required
clientBE1
​number · required
clientBE2
​number · required
clientBE3
​number · required
spouseBE1
​number | null · required
spouseBE2
​number | null · required
spouseBE3
​number | null · required
maritalStatus
​MaritalStatus · enum · required
Enum values:
married
single
​Adv04LtcYearRow[] · required
​Adv04YearRow[] · required

Adv04LtcYearRow

year
​number · required
availableCapital
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ltcNeed
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netCapital
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
yearEndCapital
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
needClient
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
needSpouse
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Adv04YearRow

category
​string · required
current
​string · required
projected
​string · required
change
​string · required

Adv05Request

Inputs for the adv05 calculation.
clientFirstName
​string · required
spouseFirstName
​string · required
clientLastName
​string · required
spouseLastName
​string · required
clientDOB
​string · required
spouseDOB
​string · required
clientAddress
​string · required
clientCity
​string · required
clientState
​string · required
clientZip
​string · required
clientPhone
​string · required
advisorName
​string · required
advisorCompanyName
​string · required
companyAddress1
​string · required
companyAddress2
​string · required
companyCity
​string · required
companyState
​string · required
companyZip
​string · required
companyPhone
​string · required
clientIncome
​number · required
Default: 0
spouseIncome
​number · required
Default: 0
clientPayIncreases
​number · min: 0 · max: 0.2 · required
Default: 0
spousePayIncreases
​number · min: 0 · max: 0.2 · required
Default: 0
clientRetirementAge
​integer · min: 1 · max: 120 · required
Default: 65
spouseRetirementAge
​integer · min: 1 · max: 120 · required
Default: 65
assetValue1
​number · required
Default: 0
assetValue2
​number · required
Default: 0
clientDisabilityPension
​number · required
Default: 0
spouseDisabilityPension
​number · required
Default: 0
clientDisabilityPensionIndex
​string · enum · required
Enum values:
N
Y
Default: N
spouseDisabilityPensionIndex
​string · enum · required
Enum values:
N
Y
Default: N
clientAge
​integer · min: 0 · max: 120 · required
Default: 0
spouseAge
​integer · min: 0 · max: 120 · required
Default: 0
disabilityCompany1
​string · required
disabilityPremium1
​number · required
Default: 0
disabilityInsured1
​string · enum · required
Enum values:
Client
Spouse
Default: Client
disabilityBenefit1
​number · required
Default: 0
disabilityWaiting1
​integer · required
Default: 0
disabilityBenefitYears1
​integer · required
Default: 0
disabilityMaximumAge1
​integer · min: 0 · max: 120 · required
Default: 0
disabilityIndexed1
​string · enum · required
Enum values:
N
Y
Default: N
disabilityCompany2
​string · required
disabilityPremium2
​number · required
Default: 0
disabilityInsured2
​string · enum · required
Enum values:
Client
Spouse
Default: Client
disabilityBenefit2
​number · required
Default: 0
disabilityWaiting2
​integer · required
Default: 0
disabilityBenefitYears2
​integer · required
Default: 0
disabilityMaximumAge2
​integer · min: 0 · max: 120 · required
Default: 0
disabilityIndexed2
​string · enum · required
Enum values:
N
Y
Default: N
disabilityCompany3
​string · required
disabilityPremium3
​number · required
Default: 0
disabilityInsured3
​string · enum · required
Enum values:
Client
Spouse
Default: Client
disabilityBenefit3
​number · required
Default: 0
disabilityWaiting3
​integer · required
Default: 0
disabilityBenefitYears3
​integer · required
Default: 0
disabilityMaximumAge3
​integer · min: 0 · max: 120 · required
Default: 0
disabilityIndexed3
​string · enum · required
Enum values:
N
Y
Default: N
disabilityCompany4
​string · required
disabilityPremium4
​number · required
Default: 0
disabilityInsured4
​string · enum · required
Enum values:
Client
Spouse
Default: Client
disabilityBenefit4
​number · required
Default: 0
disabilityWaiting4
​integer · required
Default: 0
disabilityBenefitYears4
​integer · required
Default: 0
disabilityMaximumAge4
​integer · min: 0 · max: 120 · required
Default: 0
disabilityIndexed4
​string · enum · required
Enum values:
N
Y
Default: N
clientSpending1
​number · required
Default: 0
​object[] · minItems: 1 · maxItems: 2 · required
clientSpending2
​number · required
Default: 0
spouseSpending1
​number · required
Default: 0
​object[] · minItems: 1 · maxItems: 2 · required
spouseSpending2
​number · required
Default: 0
spouseIncomeChange
​number · required
Default: 0
clientIncomeChange
​number · required
Default: 0
​object[] · minItems: 1 · maxItems: 6 · required
preRetirementReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
combinedMarginalTaxRate
​number · min: 0 · max: 0.75 · required
Default: 0.22
inflation
​number · min: 0 · max: 0.1 · required
Default: 0.03

Adv05Result

Result of the adv05 calculation.
clientAnnualShortfall
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageEarnings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageEarningsAnnual
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageInsurance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageInsuranceAnnual
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageInvestment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageInvestmentAnnual
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageNeed
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageNeedAnnual
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAveragePension
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAveragePensionAnnual
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageResources
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageResourcesAnnual
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageSS
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageSSAnnual
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageSurplus
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientAverageSurplusAnnual
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clientMonthlyShortfall
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
clientCurrentAge
​number · required
spouseCurrentAge
​number · required
maritalStatus
​MaritalStatus · enum · required
Enum values:
married
single
​Adv05YearRow[] · required

Adv05YearRow

category
​string · required
current
​string · required
projected
​string · required
change
​string · required

Aut01Request

Inputs for the aut01 calculation.
downPayment
​number · required
Default: 0
termMonths
​integer · min: 1 · max: 360 · required
Default: 36
rebate
​number · required
Default: 0
leasePayment
​number · required
Default: 0
leaseDeposit
​number · required
Default: 0
purchasePrice
​number · required
Default: 0
salesTax
​number · min: 0 · max: 0.75 · required
Default: 0.05
purchaseCosts
​number · required
Default: 0
loanRate
​number · min: 0 · max: 0.4 · required
Default: 0.06
residualValue
​number · required
Default: 0

Aut01Result

Result of the aut01 calculation.
totalLease
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
yearlyLease
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
salesTaxO
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalPurchase
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
yearlyPurchase
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalLeasePayments
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
buySavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
leaseSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Aut02Request

Inputs for the aut02 calculation.
salesPrice
​number · required
Default: 0
rebate
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0
termYears
​integer · min: 1 · max: 30 · required
Default: 5

Aut02Result

Result of the aut02 calculation.
monthsBreakEven
​integer · required
yearsBreakEven
​number · required
initialDifference
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Aut02YearRow[] · required

Aut02YearRow

month
​integer · required
begBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
loanPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
loanEnding
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
zeroPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
zeroEnding
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
difference
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Aut03Request

Inputs for the aut03 calculation.
purchasePrice
​number · required
Default: 0
cashRebate
​number · required
Default: 0
tradeIn
​number · required
Default: 0
tradeInOwed
​number · required
Default: 0
downPayment
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.07
termMonths
​integer · min: 1 · max: 360 · required
Default: 48
amortization
​integer · enum · required
Enum values:
1
2
Default: 2

Aut03Result

Result of the aut03 calculation.
monthlyPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Aut03YearRow[] · required

Aut03YearRow

period
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
payment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Aut04Request

Inputs for the aut04 calculation.
gasCost
​number · required
Default: 2
miles
​integer · min: 0 · max: 1000 · required
Default: 30
mpgOld
​integer · min: 0 · max: 1000 · required
Default: 15
mpgNew
​integer · min: 0 · max: 1000 · required
Default: 35
paymentOld
​number · required
Default: 0
termOld
​integer · min: 1 · max: 360 · required
Default: 36
salesOld
​number · required
Default: 0
paymentNew
​number · required
Default: 0
termNew
​integer · min: 1 · max: 360 · required
Default: 48
salesNew
​number · required
Default: 0
feesNew
​number · required
Default: 0
creditNew
​number · required
Default: 0

Aut04Result

Result of the aut04 calculation.
netCostCompare
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
gasSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
breakEven
​integer · required
newCarNetCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
oldCarNetCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Aut05Request

Inputs for the aut05 calculation.
loanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0
termMonths
​integer · min: 1 · max: 120 · required
Default: 48
paymentsMade
​integer · min: 1 · max: 360 · required
Default: 24
additionalPayment
​number · required
Default: 0

Aut05Result

Result of the aut05 calculation.
initialPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
remainingTerm
​integer · required
remainingPrincipal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
newPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentYears
​number · required
proposedYears
​number · required
savedYears
​number · required
currentInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
proposedInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Aut05YearRow[] · required

Aut05YearRow

year
​number | null · required
​required
​required
​required
​required
​required

Aut06Request

Inputs for the aut06 calculation.
downPayment
​number · required
Default: 0
monthlyPayment
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0
termMonths
​integer · min: 1 · max: 360 · required
Default: 48

Aut06Result

Result of the aut06 calculation.
loanAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
vehicleAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Aut06YearRow[] · required

Aut06YearRow

period
​integer | null · required
​required
​required
​required
​required

Aut07Request

Inputs for the aut07 calculation.
currentBalance
​number · required
Default: 0
currentRate
​number · min: 0 · max: 0.4 · required
Default: 0.07
currentPayment
​number · required
Default: 0
proposedRate
​number · min: 0 · max: 0.4 · required
Default: 0.05

Aut07Result

Result of the aut07 calculation.
proposedPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentMonths
​number · required
proposedMonths
​number · required
currentInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
proposedInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestSaved
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestOnlyPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Aut08Request

Inputs for the aut08 calculation.
currentBalance
​number · required
Default: 0
currentRate
​number · min: 0 · max: 0.4 · required
Default: 0.07
currentPayment
​number · required
Default: 0
proposedRate
​number · min: 0 · max: 0.4 · required
Default: 0.05
proposedTerm
​integer · min: 1 · max: 120 · required
Default: 60

Aut08Result

Result of the aut08 calculation.
proposedPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentMonths
​number · required
proposedMonths
​number · required
currentInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
proposedInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestOnlyPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestSaved
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Aut09Request

Inputs for the aut09 calculation.
newUsed
​string · enum · required
Enum values:
1
2
Default: 1
value
​number · required
Default: 0

Aut09Result

Result of the aut09 calculation.
year1Value
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year2Value
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year3Value
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year4Value
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year5Value
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year6Value
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year1Depreciation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year2Depreciation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year1DepreciationPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
year2DepreciationPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
year3Depreciation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year3DepreciationPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
year4Depreciation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year4DepreciationPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
year5Depreciation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year5DepreciationPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
year6Depreciation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year6DepreciationPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
newUsedN
​number · required

Aut10Request

Inputs for the aut10 calculation.
loanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.0574
termYears
​string · enum · required
Enum values:
1
2
Default: 1
balloonYears
​string · enum · required
Enum values:
1
2
Default: 1
amortization
​integer · enum · required
Enum values:
1
2
Default: 2

Aut10Result

Result of the aut10 calculation.
estimatedMonthlyPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
yearlyPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
balloonPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Aut10YearRow[] · required

Aut10YearRow

period
​integer | null · required
​required
​required
​required
​required

Aut11Request

Inputs for the aut11 calculation.
tripType
​integer · enum · required
Enum values:
1
2
Default: 1
milesPerGallon
​integer · min: 1 · max: 99 · required
Default: 20
fuelCost
​number · required
Default: 5.19
tripMiles
​number · required
Default: 0
commuteMiles
​number · required
Default: 0

Aut11Result

Result of the aut11 calculation.
commuteDayCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
commuteMonthCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
commuteYearCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
tripCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Aut12Request

Inputs for the aut12 calculation.
kwh
​number · min: 0 · max: 1 · required
Default: 0.278
electricVehiclePurchase
​number · required
Default: 60000
monthlyMiles
​number · required
Default: 1000
electricityCostPerKwh
​number · min: 0 · max: 1 · required
Default: 0.12
gasCost
​number · required
Default: 3.75
gasVehiclePurchase
​number · required
Default: 50000
mpg
​number · min: 0 · max: 99 · required
Default: 20
gasVehicleMaintenance
​number · required
Default: 600

Aut12Result

Result of the aut12 calculation.
annualMaintenanceSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyGasCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyElectricityCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualEvSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
breakevenYears
​number · required
gasCostPerMile
​number · required
electricCostPerMile
​number · required
monthlyFuelSaving
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bud01Request

Inputs for the bud01 calculation.
numYears
​integer · min: 1 · max: 20 · required
Default: 20
inflation
​number · min: 0 · max: 0.1 · required
Default: 0.03
mode
​integer · enum · required
Enum values:
0
1
Default: 0
mortgage
​number · required
Default: 0
vacation
​number · required
Default: 0
autoloan
​number · required
Default: 0
persloan
​number · required
Default: 0
cc
​number · required
Default: 0
fedtaxes
​number · required
Default: 0
statetaxes
​number · required
Default: 0
fica
​number · required
Default: 0
retaxes
​number · required
Default: 0
othertaxes
​number · required
Default: 0
utilities
​number · required
Default: 0
repairs
​number · required
Default: 0
food
​number · required
Default: 0
clothing
​number · required
Default: 0
education
​number · required
Default: 0
childcare
​number · required
Default: 0
autoexp
​number · required
Default: 0
transexp
​number · required
Default: 0
lifeins
​number · required
Default: 0
homeowners
​number · required
Default: 0
autoins
​number · required
Default: 0
medical
​number · required
Default: 0
entertain
​number · required
Default: 0
travel
​number · required
Default: 0
club
​number · required
Default: 0
hobbies
​number · required
Default: 0
gifts
​number · required
Default: 0
homeimp
​number · required
Default: 0
services
​number · required
Default: 0
charity
​number · required
Default: 0
other
​number · required
Default: 0

Bud01Result

Result of the bud01 calculation.
beginExpenses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endExpenses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
increasePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
​Bud01YearRow[] · required

Bud01YearRow

period
​number | null · required
​required
​required
​required

Bud02Request

Inputs for the bud02 calculation.
mode
​integer · enum · required
Enum values:
0
1
Default: 0
mortgage
​number · required
Default: 0
vacation
​number · required
Default: 0
autoloan
​number · required
Default: 0
persloan
​number · required
Default: 0
cc
​number · required
Default: 0
fedtaxes
​number · required
Default: 0
statetaxes
​number · required
Default: 0
fica
​number · required
Default: 0
retaxes
​number · required
Default: 0
othertaxes
​number · required
Default: 0
utilities
​number · required
Default: 0
repairs
​number · required
Default: 0
food
​number · required
Default: 0
clothing
​number · required
Default: 0
education
​number · required
Default: 0
childcare
​number · required
Default: 0
autoexp
​number · required
Default: 0
transexp
​number · required
Default: 0
lifeins
​number · required
Default: 0
homeowners
​number · required
Default: 0
autoins
​number · required
Default: 0
medical
​number · required
Default: 0
entertain
​number · required
Default: 0
travel
​number · required
Default: 0
club
​number · required
Default: 0
hobbies
​number · required
Default: 0
gifts
​number · required
Default: 0
homeimp
​number · required
Default: 0
services
​number · required
Default: 0
charity
​number · required
Default: 0
other
​number · required
Default: 0

Bud02Result

Result of the bud02 calculation.
total
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Bud02YearRow[] · required

Bud02YearRow

category
​string · required
amount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
percent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Bud03Request

Inputs for the bud03 calculation.
monthlyIncome
​number · required
Default: 0
fundsAvailable
​number · required
Default: 0
fundsLast
​integer · min: 1 · max: 360 · required
Default: 6
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
monthsAccumulate
​integer · min: 1 · max: 360 · required
Default: 36
monthlyExpenses
​number · required
Default: 0
mortgage
​number · required
Default: 0
vacation
​number · required
Default: 0
autoloan
​number · required
Default: 0
persloan
​number · required
Default: 0
cc
​number · required
Default: 0
fedtaxes
​number · required
Default: 0
statetaxes
​number · required
Default: 0
fica
​number · required
Default: 0
retaxes
​number · required
Default: 0
othertaxes
​number · required
Default: 0
utilities
​number · required
Default: 0
repairs
​number · required
Default: 0
food
​number · required
Default: 0
clothing
​number · required
Default: 0
education
​number · required
Default: 0
childcare
​number · required
Default: 0
autoexp
​number · required
Default: 0
transexp
​number · required
Default: 0
lifeins
​number · required
Default: 0
homeowners
​number · required
Default: 0
autoins
​number · required
Default: 0
medical
​number · required
Default: 0
entertain
​number · required
Default: 0
travel
​number · required
Default: 0
club
​number · required
Default: 0
hobbies
​number · required
Default: 0
gifts
​number · required
Default: 0
homeimp
​number · required
Default: 0
services
​number · required
Default: 0
charity
​number · required
Default: 0
other
​number · required
Default: 0

Bud03Result

Result of the bud03 calculation.
expenses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fundNeeded
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalShortfall
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
lumpsumNeeded
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyNeeded
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyCash
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
expensestoincomeRatio
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
reqsavingstoincomeRatio
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
​Bud03YearRow[] · required

Bud03YearRow

monthNumber
​integer · required
begBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
earnings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bud04Request

Inputs for the bud04 calculation.
debtInterestRate
​number · min: 0 · max: 0.4 · required
Default: 0.06
interestDeductible
​string · enum · required
Enum values:
N
Y
Default: N
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
interestTaxable
​string · enum · required
Enum values:
N
Y
Default: Y
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0
monthlySurplus
​number · required
Default: 0

Bud04Result

Result of the bud04 calculation.
afterTaxCostOfDebt
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
afterTaxInvestmentReturn
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
interestSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bud05Request

Inputs for the bud05 calculation.
savingsBalance
​number · required
Default: 0
monthlyWithdrawal
​number · required
Default: 0
withdrawalIncreases
​number · min: 0 · max: 0.4 · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
amortization
​integer · enum · required
Enum values:
1
2
Default: 1

Bud05Result

Result of the bud05 calculation.
moneyRunsOutMonth
​integer · required
moneyRunsOutYear
​number · required
totalWithdrawals
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Bud05YearRow[] · required

Bud05YearRow

month
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxes
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
withdrawal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bud06Request

Inputs for the bud06 calculation.
currDaycare
​number · required
Default: 0
currInsurance
​number · required
Default: 0
currMedical
​number · required
Default: 0
spouseIncome
​number · required
Default: 0
empplanCont
​number · min: 0 · max: 0.2 · required
Default: 0
empMatch
​number · min: 0 · max: 3 · required
Default: 1
maxMatch
​number · min: 0 · max: 0.2 · required
Default: 0.03
workInsurance
​number · required
Default: 0
workMedical
​number · required
Default: 0
workEntertain
​number · required
Default: 0
workDaycare
​number · required
Default: 0
workClothing
​number · required
Default: 0
workHousekeeping
​number · required
Default: 0
workMeals
​number · required
Default: 0
workTransportation
​number · required
Default: 0
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
stateTaxBracket
​number · min: 0 · max: 0.75 · required
Default: 0
selfEmployed
​string · enum · required
Enum values:
N
Y
Default: N

Bud06Result

Result of the bud06 calculation.
saveInsurance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
saveMedical
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
empDollarMatch
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
costDayCare
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fedTaxes
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
stateTaxes
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fica
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
businessEntertainment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
clothing
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
grossMonthlyEarnings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
housekeeping
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
meals
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
transportation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bud07Request

Inputs for the bud07 calculation.
residence
​number · required
Default: 0
residenceGrowth
​number · required
Default: 0
vacation
​number · required
Default: 0
vacationGrowth
​number · required
Default: 0
furnishings
​number · required
Default: 0
furnishingsGrowth
​number · required
Default: 0
autos
​number · required
Default: 0
autosGrowth
​number · required
Default: 0
realEstate
​number · required
Default: 0
realEstateGrowth
​number · required
Default: 0
art
​number · required
Default: 0
artGrowth
​number · required
Default: 0
stocks
​number · required
Default: 0
stocksGrowth
​number · required
Default: 0
varAnnuities
​number · required
Default: 0
varAnnuitiesGrowth
​number · required
Default: 0
limitedPartner
​number · required
Default: 0
limitedPartnerGrowth
​number · required
Default: 0
business
​number · required
Default: 0
businessGrowth
​number · required
Default: 0
fixedAnnuities
​number · required
Default: 0
fixedAnnuitiesGrowth
​number · required
Default: 0
trustDeeds
​number · required
Default: 0
trustDeedsGrowth
​number · required
Default: 0
otherFixed
​number · required
Default: 0
otherFixedGrowth
​number · required
Default: 0
govtBonds
​number · required
Default: 0
govtBondsGrowth
​number · required
Default: 0
muniBonds
​number · required
Default: 0
muniBondsGrowth
​number · required
Default: 0
corpBonds
​number · required
Default: 0
corpBondsGrowth
​number · required
Default: 0
faceCertificates
​number · required
Default: 0
faceCertificatesGrowth
​number · required
Default: 0
debtMutuals
​number · required
Default: 0
debtMutualsGrowth
​number · required
Default: 0
checking
​number · required
Default: 0
checkingGrowth
​number · required
Default: 0
savings
​number · required
Default: 0
savingsGrowth
​number · required
Default: 0
moneyMarket
​number · required
Default: 0
moneyMarketGrowth
​number · required
Default: 0
cd
​number · required
Default: 0
cdGrowth
​number · required
Default: 0
otherCash
​number · required
Default: 0
otherCashGrowth
​number · required
Default: 0
homeMortgage
​number · required
Default: 0
homeMortgageGrowth
​number · required
Default: 0
otherMortgage
​number · required
Default: 0
otherMortgageGrowth
​number · required
Default: 0
autoLoan
​number · required
Default: 0
autoLoanGrowth
​number · required
Default: 0
bankLoan
​number · required
Default: 0
bankLoanGrowth
​number · required
Default: 0
personalLoan
​number · required
Default: 0
personalLoanGrowth
​number · required
Default: 0
creditCards
​number · required
Default: 0
creditCardsGrowth
​number · required
Default: 0
otherDebts
​number · required
Default: 0
otherDebtsGrowth
​number · required
Default: 0
projectedYears
​integer · required
Default: -1

Bud07Result

Result of the bud07 calculation.
residencePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
vacationPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
furnishingsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
autosPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
realEstatePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
artPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
stocksPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
varAnnuitiesPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
limitedPartnerPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
businessPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
fixedAnnuitiesPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
trustDeedsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
otherFixedPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
govtBondsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
muniBondsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
corpBondsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
faceCertificatesPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
debtMutualsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
checkingPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
savingsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
moneyMarketPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
cdPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
otherCashPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
homeMortgagePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
otherMortgagePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
autoLoanPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
bankLoanPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
personalLoanPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
creditCardsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
otherDebtsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalTangibleAssetsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalEquityAssetsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalFixedPrincipalAssetsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalFixedRateAssetsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalCashAssetsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalTangibleAssets
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalEquityAssets
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalFixedPrincipalAssets
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalFixedRateAssets
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCashAssets
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalAssets
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalLiabilities
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netWorth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netWorthProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netWorthChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
residenceProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
residenceChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
vacationProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
vacationChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
furnishingsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
furnishingsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
autosProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
autosChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
realEstateProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
realEstateChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
artProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
artChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
stocksProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
stocksChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
varAnnuitiesProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
varAnnuitiesChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
limitedPartnerProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
limitedPartnerChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
businessProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
businessChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fixedAnnuitiesProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fixedAnnuitiesChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
trustDeedsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
trustDeedsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherFixedProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherFixedChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
govtBondsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
govtBondsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
muniBondsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
muniBondsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
corpBondsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
corpBondsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
faceCertificatesProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
faceCertificatesChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
debtMutualsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
debtMutualsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
checkingProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
checkingChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
savingsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
savingsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
moneyMarketProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
moneyMarketChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
cdProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
cdChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherCashProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherCashChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
homeMortgageProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
homeMortgageChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherMortgageProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherMortgageChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
autoLoanProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
autoLoanChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
bankLoanProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
bankLoanChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
personalLoanProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
personalLoanChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
creditCardsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
creditCardsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherDebtsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherDebtsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalTangibleAssetsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalTangibleAssetsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalEquityAssetsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalEquityAssetsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalFixedPrincipalAssetsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalFixedPrincipalAssetsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalFixedRateAssetsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalFixedRateAssetsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCashAssetsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCashAssetsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalAssetsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalAssetsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalLiabilitiesProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalLiabilitiesChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bud08Request

Inputs for the bud08 calculation.
projectedYears
​integer · min: 1 · max: 120 · required
Default: 5
residence
​number · required
Default: 0
residenceGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
vacation
​number · required
Default: 0
vacationGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
furnishings
​number · required
Default: 0
furnishingsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
autos
​number · required
Default: 0
autosGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
realEstate
​number · required
Default: 0
realEstateGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
art
​number · required
Default: 0
artGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
stocks
​number · required
Default: 0
stocksGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
varAnnuities
​number · required
Default: 0
varAnnuitiesGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
limitedPartner
​number · required
Default: 0
limitedPartnerGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
business
​number · required
Default: 0
businessGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
fixedAnnuities
​number · required
Default: 0
fixedAnnuitiesGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
trustDeeds
​number · required
Default: 0
trustDeedsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
otherFixed
​number · required
Default: 0
otherFixedGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
govtBonds
​number · required
Default: 0
govtBondsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
muniBonds
​number · required
Default: 0
muniBondsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
corpBonds
​number · required
Default: 0
corpBondsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
faceCertificates
​number · required
Default: 0
faceCertificatesGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
debtMutuals
​number · required
Default: 0
debtMutualsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
checking
​number · required
Default: 0
checkingGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
savings
​number · required
Default: 0
savingsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
moneyMarket
​number · required
Default: 0
moneyMarketGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
cd
​number · required
Default: 0
cdGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
otherCash
​number · required
Default: 0
otherCashGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
homeMortgage
​number · required
Default: 0
homeMortgageGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
otherMortgage
​number · required
Default: 0
otherMortgageGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
autoLoan
​number · required
Default: 0
autoLoanGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
bankLoan
​number · required
Default: 0
bankLoanGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
personalLoan
​number · required
Default: 0
personalLoanGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
creditCards
​number · required
Default: 0
creditCardsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
otherDebts
​number · required
Default: 0
otherDebtsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0

Bud08Result

Result of the bud08 calculation.
residenceProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
vacationProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
furnishingsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
autosProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
realEstateProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
artProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
stocksProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
varAnnuitiesProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
limitedPartnerProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
businessProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fixedAnnuitiesProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
trustDeedsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherFixedProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
govtBondsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
muniBondsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
corpBondsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
faceCertificatesProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
debtMutualsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
checkingProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
savingsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
moneyMarketProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
cdProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherCashProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
homeMortgageProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherMortgageProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
autoLoanProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
bankLoanProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
personalLoanProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
creditCardsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherDebtsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
residenceChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
vacationChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
furnishingsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
autosChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
realEstateChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
artChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
stocksChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
varAnnuitiesChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
limitedPartnerChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
businessChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fixedAnnuitiesChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
trustDeedsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherFixedChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
govtBondsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
muniBondsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
corpBondsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
faceCertificatesChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
debtMutualsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
checkingChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
savingsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
moneyMarketChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
cdChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherCashChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
homeMortgageChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherMortgageChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
autoLoanChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
bankLoanChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
personalLoanChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
creditCardsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherDebtsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalTangibleAssets
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalEquityAssets
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalFixedPrincipalAssets
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalFixedRateAssets
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCashAssets
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalTangibleAssetsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalEquityAssetsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalFixedPrincipalAssetsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalFixedRateAssetsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCashAssetsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalTangibleAssetsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalEquityAssetsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalFixedPrincipalAssetsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalFixedRateAssetsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCashAssetsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalAssets
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalAssetsProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalAssetsChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalLiabilities
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalLiabilitiesProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalLiabilitiesChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netWorth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netWorthProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netWorthChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bud09Request

Inputs for the bud09 calculation.
mode
​integer · enum · required
Enum values:
0
1
Default: 0
wages
​number · required
Default: 0
interest
​number · required
Default: 0
dividends
​number · required
Default: 0
socialsecurity
​number · required
Default: 0
pensions
​number · required
Default: 0
alimony
​number · required
Default: 0
otherincome
​number · required
Default: 0
charity
​number · required
Default: 0
mortgage
​number · required
Default: 0
vacation
​number · required
Default: 0
autoloan
​number · required
Default: 0
persloan
​number · required
Default: 0
cc
​number · required
Default: 0
fedtaxes
​number · required
Default: 0
statetaxes
​number · required
Default: 0
fica
​number · required
Default: 0
retaxes
​number · required
Default: 0
othertaxes
​number · required
Default: 0
utilities
​number · required
Default: 0
repairs
​number · required
Default: 0
food
​number · required
Default: 0
clothing
​number · required
Default: 0
education
​number · required
Default: 0
childcare
​number · required
Default: 0
autoexp
​number · required
Default: 0
transexp
​number · required
Default: 0
lifeins
​number · required
Default: 0
homeowners
​number · required
Default: 0
autoins
​number · required
Default: 0
medical
​number · required
Default: 0
entertain
​number · required
Default: 0
travel
​number · required
Default: 0
club
​number · required
Default: 0
hobbies
​number · required
Default: 0
gifts
​number · required
Default: 0
homeimp
​number · required
Default: 0
services
​number · required
Default: 0
other
​number · required
Default: 0

Bud09Result

Result of the bud09 calculation.
totalIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalExpenses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalNet
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalNetPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
​Bud09YearRow[] · required

Bud09YearRow

category
​string · required
monthly
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annual
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
percent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Bud10Request

Inputs for the bud10 calculation.
mode
​integer · enum · required
Enum values:
0
1
Default: 1
projectedYears
​integer · min: 1 · max: 120 · required
Default: 5
wages
​number · required
Default: 0
wagesGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
alimony
​number · required
Default: 0
alimonyGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
dividends
​number · required
Default: 0
dividendsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
interest
​number · required
Default: 0
interestGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
socialsecurity
​number · required
Default: 0
socialsecurityGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
pensions
​number · required
Default: 0
pensionsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
otherincome
​number · required
Default: 0
otherincomeGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
mortgage
​number · required
Default: 0
mortgageGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
vacation
​number · required
Default: 0
vacationGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
autoloan
​number · required
Default: 0
autoloanGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
persloan
​number · required
Default: 0
persloanGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
cc
​number · required
Default: 0
ccGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
fedtaxes
​number · required
Default: 0
fedtaxesGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
statetaxes
​number · required
Default: 0
statetaxesGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
fica
​number · required
Default: 0
ficaGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
retaxes
​number · required
Default: 0
retaxesGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
othertaxes
​number · required
Default: 0
othertaxesGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
utilities
​number · required
Default: 0
utilitiesGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
repairs
​number · required
Default: 0
repairsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
food
​number · required
Default: 0
foodGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
clothing
​number · required
Default: 0
clothingGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
education
​number · required
Default: 0
educationGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
childcare
​number · required
Default: 0
childcareGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
autoexp
​number · required
Default: 0
autoexpGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
transexp
​number · required
Default: 0
transexpGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
lifeins
​number · required
Default: 0
lifeinsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
homeowners
​number · required
Default: 0
homeownersGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
autoins
​number · required
Default: 0
autoinsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
medical
​number · required
Default: 0
medicalGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
entertain
​number · required
Default: 0
entertainGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
travel
​number · required
Default: 0
travelGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
club
​number · required
Default: 0
clubGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
hobbies
​number · required
Default: 0
hobbiesGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
gifts
​number · required
Default: 0
giftsGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
homeimp
​number · required
Default: 0
homeimpGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
services
​number · required
Default: 0
servicesGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
charity
​number · required
Default: 0
charityGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0
other
​number · required
Default: 0
otherGrowth
​number · min: -0.12 · max: 0.12 · required
Default: 0

Bud10Result

Result of the bud10 calculation.
income
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
incomeProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
incomeChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
expenses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
expensesProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
expensesChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netCashFlow
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netCashFlowProjected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netCashFlowChange
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Bud10YearRow[] · required

Bud10YearRow

category
​string · required
current
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
change
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bud11Request

Inputs for the bud11 calculation.
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.05
years
​integer · min: 1 · max: 30 · required
Default: 10
description1
​string · required
Default: eat out less
savings1
​number · required
Default: 150
description2
​string · required
Default: carpool to work
savings2
​number · required
Default: 100
description3
​string · required
Default: drink less bottled water
savings3
​number · required
Default: 15
description4
​string · required
Default: [type here]
savings4
​number · required
Default: 0
description5
​string · required
Default: [type here]
savings5
​number · required
Default: 0
description6
​string · required
Default: [type here]
savings6
​number · required
Default: 0

Bud11Result

Result of the bud11 calculation.
annualSavings1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
cumulativeSavings1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedFutureValue1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualSavings2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
cumulativeSavings2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedFutureValue2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualSavings3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
cumulativeSavings3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedFutureValue3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualSavings4
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
cumulativeSavings4
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedFutureValue4
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualSavings5
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
cumulativeSavings5
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedFutureValue5
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualSavings6
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
cumulativeSavings6
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedFutureValue6
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalAnnualSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCumulativeSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalProjectedFutureValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bud12Request

Inputs for the bud12 calculation.
startAmount
​number · required
Default: 1
beginYear
​integer · min: 1914 · max: 2025 · required
Default: 1950
endYear
​integer · min: 1914 · max: 2025 · required
Default: 2025

Bud12Result

Result of the bud12 calculation.
purchasingPower
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Bud12YearRow[] · required

Bud12YearRow

year
​number | null · required
​required

Bud13Request

Inputs for the bud13 calculation.
beginningBalance
​number · required
Default: 0
deposit1
​number · required
Default: 0
deposit2
​number · required
Default: 0
deposit3
​number · required
Default: 0
deposit4
​number · required
Default: 0
deposit5
​number · required
Default: 0
check1
​number · required
Default: 0
check2
​number · required
Default: 0
check3
​number · required
Default: 0
check4
​number · required
Default: 0
check5
​number · required
Default: 0
check6
​number · required
Default: 0
check7
​number · required
Default: 0
check8
​number · required
Default: 0
check9
​number · required
Default: 0
check10
​number · required
Default: 0

Bud13Result

Result of the bud13 calculation.
totalDeposits
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalChecks
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
registerBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
statementBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bud14Request

Inputs for the bud14 calculation.
householdIncome
​number · required
Default: 100000
currentCity
​string · enum · required
Enum values:
1
2
3
4
5
6
7
8
Default: 306
newCity
​string · enum · required
Enum values:
1
2
3
4
5
6
7
8
Default: 30

Bud14Result

Result of the bud14 calculation.
newIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
incomeChange
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Bus01Request

Inputs for the bus01 calculation.
grossPay
​number · required
Default: 0
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
postTaxSavings
​number · required
Default: 0
postTaxExpenses
​number · required
Default: 0
sameTakeHome
​string · enum · required
Enum values:
N
Y
Default: Y
employerMatch
​number · required
Default: 0
employees
​integer · required
Default: 0

Bus01Result

Result of the bus01 calculation.
increasedTakeHome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
increasedRetirement
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ficaSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforeGrossPay
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforeQualified
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforeCafeteria
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforeReducedPay
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforeTaxesPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforeFica
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforeTakeHome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforePostTaxRetirement
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforePostTaxInsurance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforeNetTakeHome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterGrossPay
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterQualified
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterCafeteria
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterReducedPay
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxesPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterFica
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTakeHome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterPostTaxRetirement
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterPostTaxInsurance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterNetTakeHome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bus02Request

Inputs for the bus02 calculation.
months
​integer · required
Default: 3
ownerSalaries
​number · required
Default: 0
employeeSalaries
​number · required
Default: 0
rent
​number · required
Default: 0
advertising
​number · required
Default: 0
postage
​number · required
Default: 0
supplies
​number · required
Default: 0
telephone
​number · required
Default: 0
utilities
​number · required
Default: 0
insurance
​number · required
Default: 0
taxes
​number · required
Default: 0
interest
​number · required
Default: 0
maintenance
​number · required
Default: 0
legal
​number · required
Default: 0
monthlyMisc
​number · required
Default: 0
office
​number · required
Default: 0
building
​number · required
Default: 0
rentDeposit
​number · required
Default: 0
inventory
​number · required
Default: 0
utilityDeposit
​number · required
Default: 0
professionalFees
​number · required
Default: 0
licenses
​number · required
Default: 0
website
​number · required
Default: 0
cash
​number · required
Default: 0
onetimeMisc
​number · required
Default: 0

Bus02Result

Result of the bus02 calculation.
totalCapital
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalMonthly
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ownerSalariesTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ownerSalariesPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
employeeSalariesTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
employeeSalariesPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
rentTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rentPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
advertisingTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
advertisingPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
postageTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
postagePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
suppliesTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
suppliesPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
telephoneTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
telephonePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
utilitiesTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
utilitiesPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
insuranceTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
insurancePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
taxesTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxesPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
interestTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
maintenanceTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
maintenancePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
legalTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
legalPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
miscellaneousTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
miscellaneousPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalMonthlyPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
officePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
buildingPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
rentDepositPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
inventoryPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
utilityDepositPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
professionalFeesPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
licensesPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
websitePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
cashPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
onetimeMiscPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalOneTimePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalOneTime
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bus03Request

Inputs for the bus03 calculation.
modalPayment
​number · required
Default: 0
paymentFrequency
​string · enum · required
Enum values:
s
q
m
Default: m
annualPayment
​number · required
Default: 0

Bus03Result

Result of the bus03 calculation.
numPayments
​number · required
totalPayments
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
semiannualAPR
​number · required
quarterlyAPR
​number · required
monthlyAPR
​number · required
valueUsed
​number · required
extraAmountPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Bus03YearRow[] · required

Bus03YearRow

paymentNumber
​number | null · required
​required
​required
​required

Bus04Request

Inputs for the bus04 calculation.
earnings
​number · required
Default: 0
compensation
​number · required
Default: 0
earningsGrowth
​number · min: 0 · max: 1 · required
Default: 0
years
​integer · min: 0 · max: 10 · required
Default: 10
risk
​string · enum · required
Enum values:
1
2
3
4
5
Default: 3
size
​number · min: -1 · max: 1 · required
Default: 0.22

Bus04Result

Result of the bus04 calculation.
futureEarnings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
calculatedDiscount
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
todayEarnings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
adjustment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
businessValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Bus04YearRow[] · required

Bus04YearRow

year
​number | null · required
​required
​required

Bus05Request

Inputs for the bus05 calculation.
fixedCosts
​number · required
Default: 0
variableCosts
​number · required
Default: 0
salesPrice
​number · required
Default: 0
expectedSales
​integer · required
Default: 0

Bus05Result

Result of the bus05 calculation.
breakevenUnits
​number · required
expectedProfit
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Bus05YearRow[] · required

Bus05YearRow

unitsSold
​number · required
salesRevenues
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
variableCosts
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fixedCosts
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
operatingProfit
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bus06Request

Inputs for the bus06 calculation.
purchasePrice
​number · required
Default: 0
downPayment
​number · required
Default: 0
salesTax
​number · min: 0 · max: 0.75 · required
Default: 0
leaseTerm
​integer · min: 1 · max: 360 · required
Default: 24
residualValue
​number · required
Default: 0
leaseRate
​number · min: 0 · max: 0.75 · required
Default: 0.08
leaseCosts
​number · required
Default: 0
loanRate
​number · min: 0 · max: 0.4 · required
Default: 0.06
termMonths
​integer · min: 1 · max: 360 · required
Default: 60
purchaseCosts
​number · required
Default: 0

Bus06Result

Result of the bus06 calculation.
leasePayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalLeasePayments
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalLease
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
yearlyLease
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
loanPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalLoanPayments
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
loanBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalPurchase
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
yearlyPurchase
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
buySavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
leaseSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bus07Request

Inputs for the bus07 calculation.
cash
​number · required
Default: 0
accountsReceivable
​number · required
Default: 0
inventory
​number · required
Default: 0
currentAssets
​number · required
Default: 0
fixedAssets
​number · required
Default: 0
currentLiabilities
​number · required
Default: 0
longTermLiabilities
​number · required
Default: 0
shareHolderEquity
​number · required
Default: 0
sales
​number · required
Default: 0
cogs
​number · required
Default: 0
grossProfit
​number · required
Default: 0
operatingExpenses
​number · required
Default: 0
excessCompensation
​number · required
Default: 0
operatingIncome
​number · required
Default: 0
investmentIncome
​number · required
Default: 0
interestExpense
​number · required
Default: 0
incomeBeforeTaxes
​number · required
Default: 0
taxes
​number · required
Default: 0
netProfit
​number · required
Default: 0
adjustedNetProfit
​number · required
Default: 0

Bus07Result

Result of the bus07 calculation.
income
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
expenses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netProfit
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentRatio
​number · required
quickRatio
​number · required
inventoryRatio
​number · required
fixedTurnoverRatio
​number · required
assetTurnoverRatio
​number · required
tieRatio
​number · required
collectionRatio
​number · required
debtAssetRatio
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
profitMarginRatio
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
earningPowerRatio
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
roaRatio
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
roeRatio
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Bus08Request

Inputs for the bus08 calculation.
income
​number · required
Default: 0
dailyWage
​number · required
Default: 0
vacation
​integer · min: 0 · max: 365 · required
Default: 10
holidays
​integer · min: 0 · max: 365 · required
Default: 7
personal
​integer · min: 0 · max: 365 · required
Default: 10
breakMinutes
​integer · min: 0 · max: 360 · required
Default: 20
workersComp
​number · min: 0 · max: 1 · required
Default: 0.01
unemployment
​number · required
Default: 250
medical
​number · required
Default: 0
life
​number · required
Default: 0
disability
​number · required
Default: 0
dental
​number · required
Default: 0
supplemental
​number · required
Default: 0
otherInsurance
​number · required
Default: 0
retirementPercent
​number · min: 0 · max: 1 · required
Default: 0
retirementDollar
​number · required
Default: 0
otherName1
​string · required
Default: Parking
otherAmount1
​number · required
Default: 0
otherName2
​string · required
Default: CE/Tuition
otherAmount2
​number · required
Default: 0
otherName3
​string · required
Default: Gym membership
otherAmount3
​number · required
Default: 0

Bus08Result

Result of the bus08 calculation.
income
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
dailyWage
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
vacationValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
vacationPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
holidayValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
holidayPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
personalValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
personalPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
breakMinutesValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
breakMinutesPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalTimeOffValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalTimeOffPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
socialSecValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
socialSecPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
workersCompValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
workersCompPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
unemploymentValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
unemploymentPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
medicalValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
medicalPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
lifeValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
lifePercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
disabilityValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
disabilityPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
dentalValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
dentalPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
supplementalValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
supplementalPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
otherInsValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherInsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
retire1Value
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
retire1Percent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
retire2Value
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
retire2Percent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
otherAmount1Value
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherAmount1Percent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
otherAmount2Value
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherAmount2Percent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
otherAmount3Value
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherAmount3Percent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
benefitsDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
benefitsPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalComp
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bus09Request

Inputs for the bus09 calculation.
equipmentCost
​number · required
Default: 0

Bus09Result

Result of the bus09 calculation.
section179
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
adjustedBaseFirst
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
bonusDepreciation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
adjustedBaseSecond
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
firstYearDepreciation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
finalAdjustedGross
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
firstYearDeduction
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
costAfterTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
discountPercentage
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Bus10Request

Inputs for the bus10 calculation.
initialHealthParticipation
​number · min: 0 · max: 1 · required
Default: 0.2
averageHealthContribution
​number · min: 0 · max: 3400 · required
Default: 2000
initialDependentParticipation
​number · min: 0 · max: 1 · required
Default: 0.03
averageDependentContribution
​number · min: 0 · max: 7500 · required
Default: 4000
numberEmployees
​number · required
Default: 0
healthParticipationIncrease
​number · min: 0 · max: 1 · required
Default: 0.1
dependentParticipationIncrease
​number · min: 0 · max: 1 · required
Default: 0.05
earningLessSS
​number · min: 0 · max: 1 · required
Default: 0.9
earningGreaterSS
​number · min: 0 · max: 1 · required
Default: 0.1

Bus10Result

Result of the bus10 calculation.
year1DependentSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year1HealthSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year1TotalSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year2DependentSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year2HealthSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
year2TotalSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Bus11Request

Inputs for the bus11 calculation.
itemCost
​number · required
Default: 0
packagingCost
​number · required
Default: 0
shippingCost
​number · required
Default: 0
advertisingFees
​number · required
Default: 0
websiteFees
​number · required
Default: 0
overheadCosts
​number · required
Default: 0
itemsSold
​number · required
Default: 0
desiredProfit
​number · min: 0 · max: 0.8 · required
Default: 0

Bus11Result

Result of the bus11 calculation.
optimalPrice
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Bus11YearRow[] · required

Bus11YearRow

unitsSold
​number | null · required
​required
​required
​required

Col01Request

Inputs for the col01 calculation.
collegeInflation
​number · min: 0 · max: 0.1 · required
Default: 0.06
amountSaved
​number · required
Default: 0
​object[] · minItems: 1 · maxItems: 6 · required
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
annualIncreases
​number · min: 0 · max: 0.2 · required
Default: 0

Col01Result

Result of the col01 calculation.
totalCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlySavingsNeeded
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
lumpSumNeeded
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Col01YearRow[] · required

Col01YearRow

year
​integer | null · required
​required
​required
​required
​required
​required
​required

Col02Request

Inputs for the col02 calculation.
expectedIncome
​number · required
Default: 0
loanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.055
termMonths
​integer · min: 1 · max: 480 · required
Default: 120

Col02Result

Result of the col02 calculation.
monthlyPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
debtRatio
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
trafficLight
​TrafficLight · enum · required
Enum values:
green
red
yellow

TrafficLight

string · enum
Enum values:
green
red
yellow

Col03Request

Inputs for the col03 calculation.
annualSavings
​number · min: 0 · max: 2000 · required
Default: 0
numYears
​integer · min: 0 · max: 30 · required
Default: 18
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22

Col03Result

Result of the col03 calculation.
afterTaxCoverdell
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxableAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxAdvantagedAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Col03YearRow[] · required

Col03YearRow

yearNumber
​integer | null · required
​required
​required
​required
​required
​required
​required
​required
​required

Col04Request

Inputs for the col04 calculation.
initialDeposit
​number · required
Default: 0
annualSavings
​number · required
Default: 0
numYears
​integer · min: 0 · max: 30 · required
Default: 18
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22

Col04Result

Result of the col04 calculation.
afterTaxValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxableAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxAdvantagedAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Col04YearRow[] · required

Col04YearRow

yearNumber
​integer | null · required
​required
​required
​required
​required
​required
​required
​required
​required

Col05Request

Inputs for the col05 calculation.
currentAge
​integer · min: 1 · max: 120 · required
Default: 25
retirementAge
​integer · min: 1 · max: 120 · required
Default: 65
uneducatedIncome
​number · required
Default: 46228
uneducatedIncreases
​number · min: 0 · max: 0.1 · required
Default: 0.03
educatedIncome
​number · required
Default: 82576
educatedIncreases
​number · min: 0 · max: 0.1 · required
Default: 0.03

Col05Result

Result of the col05 calculation.
difference
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalNoDegree
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalWithDegree
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Col05YearRow[] · required

Col05YearRow

year
​integer | null · required
​required
​required
​required
​required

Col06Request

Inputs for the col06 calculation.
loanYear1
​number · required
Default: 0
loanYear2
​number · required
Default: 0
loanYear3
​number · required
Default: 0
loanYear4
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.0275
termMonths
​integer · min: 1 · max: 360 · required
Default: 120
amortization
​integer · enum · required
Enum values:
1
2
Default: 2

Col06Result

Result of the col06 calculation.
monthlyPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
loanAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Col06YearRow[] · required

Col06YearRow

period
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
payment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Col07Request

Inputs for the col07 calculation.
years
​integer · min: 0 · max: 10 · required
Default: 0
inflationRate
​number · min: 0 · max: 0.1 · required
Default: 0
mosRecurring
​integer · min: 1 · max: 12 · required
Default: 9
cellphone1
​number · required
Default: 0
cellphone2
​number · required
Default: 0
cellphone3
​number · required
Default: 0
clothing1
​number · required
Default: 0
clothing2
​number · required
Default: 0
clothing3
​number · required
Default: 0
fees1
​number · required
Default: 0
fees2
​number · required
Default: 0
fees3
​number · required
Default: 0
computer1
​number · required
Default: 0
computer2
​number · required
Default: 0
computer3
​number · required
Default: 0
entertainment1
​number · required
Default: 0
entertainment2
​number · required
Default: 0
entertainment3
​number · required
Default: 0
meals1
​number · required
Default: 0
meals2
​number · required
Default: 0
meals3
​number · required
Default: 0
snacks1
​number · required
Default: 0
snacks2
​number · required
Default: 0
snacks3
​number · required
Default: 0
furnishingsone1
​number · required
Default: 0
furnishingsone2
​number · required
Default: 0
furnishingsone3
​number · required
Default: 0
furnishingsmany1
​number · required
Default: 0
furnishingsmany2
​number · required
Default: 0
furnishingsmany3
​number · required
Default: 0
health1
​number · required
Default: 0
health2
​number · required
Default: 0
health3
​number · required
Default: 0
cable1
​number · required
Default: 0
cable2
​number · required
Default: 0
cable3
​number · required
Default: 0
rentins1
​number · required
Default: 0
rentins2
​number · required
Default: 0
rentins3
​number · required
Default: 0
utilities1
​number · required
Default: 0
utilities2
​number · required
Default: 0
utilities3
​number · required
Default: 0
rent1
​number · required
Default: 0
rent2
​number · required
Default: 0
rent3
​number · required
Default: 0
housedeposit1
​number · required
Default: 0
housedeposit2
​number · required
Default: 0
housedeposit3
​number · required
Default: 0
internet1
​number · required
Default: 0
internet2
​number · required
Default: 0
internet3
​number · required
Default: 0
laundry1
​number · required
Default: 0
laundry2
​number · required
Default: 0
laundry3
​number · required
Default: 0
membership1
​number · required
Default: 0
membership2
​number · required
Default: 0
membership3
​number · required
Default: 0
parking1
​number · required
Default: 0
parking2
​number · required
Default: 0
parking3
​number · required
Default: 0
personal1
​number · required
Default: 0
personal2
​number · required
Default: 0
personal3
​number · required
Default: 0
phone1
​number · required
Default: 0
phone2
​number · required
Default: 0
phone3
​number · required
Default: 0
gas1
​number · required
Default: 0
gas2
​number · required
Default: 0
gas3
​number · required
Default: 0
autoins1
​number · required
Default: 0
autoins2
​number · required
Default: 0
autoins3
​number · required
Default: 0
automaint1
​number · required
Default: 0
automaint2
​number · required
Default: 0
automaint3
​number · required
Default: 0
autopayments1
​number · required
Default: 0
autopayments2
​number · required
Default: 0
autopayments3
​number · required
Default: 0
travel1
​number · required
Default: 0
travel2
​number · required
Default: 0
travel3
​number · required
Default: 0
utilityDeposit1
​number · required
Default: 0
utilityDeposit2
​number · required
Default: 0
utilityDeposit3
​number · required
Default: 0

Col07Result

Result of the col07 calculation.
currentOneHome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentOneOn
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentOneOff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentMonthlyHome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentMonthlyOn
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentMonthlyOff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentAnnualHome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentAnnualOn
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentAnnualOff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedOneHome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedOneOn
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedOneOff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedMonthlyHome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedMonthlyOn
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedMonthlyOff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedAnnualHome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedAnnualOn
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projectedAnnualOff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
highestCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
lowestCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
spreadCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Col08Request

Inputs for the col08 calculation.
currentAge
​integer · min: 0 · max: 17 · required
Default: 2
monthlySavings
​number · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.06
compounding
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 12
currentSavings
​number · required
Default: 0

Col08Result

Result of the col08 calculation.
​required
​required
​Col08YearRow[] · required

Col08YearRow

yearsToWait
​integer | null · required
age
​integer | null · required
yearsToSave
​integer | null · required
​required
​required
​required

Col09Request

Inputs for the col09 calculation.
numApplications
​integer · min: 1 · max: 100 · required
Default: 10
avgApplicationFee
​number · required
Default: 60
examFees
​number · required
Default: 100
numCollegeVisits
​integer · min: 1 · max: 20 · required
Default: 5
avgVisitCost
​number · required
Default: 200
laptopCost
​number · required
Default: 600
dormFurnitureCost
​number · required
Default: 600

Col09Result

Result of the col09 calculation.
totalApplicationCosts
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCollegeVisitCosts
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalEquipmentCosts
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalPreEducationCosts
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Cus106Request

Inputs for the cus106 calculation.
loanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.05
currentTerm
​integer · min: 1 · max: 480 · required
Default: 360
refinanceRate
​number · min: 0 · max: 0.4 · required
Default: 0.035
refinanceTerm
​integer · min: 1 · max: 480 · required
Default: 360
originationFee
​number · min: 0 · max: 0.05 · required
Default: 0.01
discountPoints
​number · min: 0 · max: 0.05 · required
Default: 0
refinanceFees
​number · required
Default: 2500

Cus106Result

Result of the cus106 calculation.
currentTerm
​number · required
traditionalTerm
​number · required
currentPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
traditionalPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
traditionalBreakeven
​string · required
currentInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
traditionalInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Cus14Request

Inputs for the cus14 calculation.
currentAge
​integer · min: 1 · max: 120 · required
Default: 25
clientIncome
​number · required
Default: 0
retirementSavings
​number · required
Default: 0
savingsPercent
​number · min: 0 · max: 1 · required
Default: 0

Cus14Result

Result of the cus14 calculation.
yearsToRetirement
​number · required
yearsOfRetirement
​number · required
amtNeededAtRetirement
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualAmtToSave
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
recommendSavings
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
currSavingsToRetirement
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalNeededAtRetirement
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currSavingsProvides
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
light
​Light · enum · required
Enum values:
beforetax401k
roth401k
roth401ksamenetpay

Light

string · enum
Enum values:
beforetax401k
roth401k
roth401ksamenetpay

Cus15Request

Inputs for the cus15 calculation.
currentAge
​integer · min: 1 · max: 99 · required
Default: 40
clientIncome
​number · required
Default: 0
salaryIncreases
​number · min: 0 · max: 0.2 · required
Default: 0
compounding
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 26
yearsToRetirement
​integer · min: 1 · max: 40 · required
Default: 20
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.24
taxBracketState
​number · min: 0 · max: 0.75 · required
Default: 0.03
projectedTaxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.24
projectedTaxBracketState
​number · min: 0 · max: 0.75 · required
Default: 0.03
currentContribution
​number · min: 0 · max: 1 · required
Default: 0
maximumMatch
​number · min: 0 · max: 0.2 · required
Default: 0
employerMatch
​number · min: 0 · max: 3 · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0

Cus15Result

Result of the cus15 calculation.
light
​Light · enum · required
Enum values:
beforetax401k
roth401k
roth401ksamenetpay
accountRetirement
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
accountRetirementRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualTaxSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualTaxSavingsRoth
​string · required
contAmt
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contAmtPeriod
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contAtAmt
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contATAmtPeriod
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contAtRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
contRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
fvTaxSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvTaxSavingsRoth
​string · required
netBt401
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netBtRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
subTotalBt401
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
subTotalBtRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxesBt401
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxesBtRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxImpactBt401
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxImpactBtRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxRatesCurrent
​string · required
taxRatesRetirement
​string · required

Det01Request

Inputs for the det01 calculation.
ccBalance
​number · required
Default: 0
ccRate
​number · min: 0 · max: 0.4 · required
Default: 0.18
minpaymentRate
​number · min: 0.001 · max: 0.1 · required
Default: 0.03
minpaymentAmount
​number · required
Default: 35
additionalPayment
​number · required
Default: 0
amortization
​integer · enum · required
Enum values:
1
2
Default: 2

Det01Result

Result of the det01 calculation.
totalPayments
​integer · required
totalYears
​number · required
yearsSavings
​number · required
totalInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Det01YearRow[] · required

Det01YearRow

year
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestCurrent
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
payment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Det02Request

Inputs for the det02 calculation.
loanBalance
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.18
monthlyPayment
​number · required
Default: 0

Det02Result

Result of the det02 calculation.
numPayments
​integer · required
yearsToPayoff
​number · required
interestPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Det02YearRow[] · required

Det02YearRow

year
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
payment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Det03Request

Inputs for the det03 calculation.
loanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0
termMonths
​integer · min: 1 · max: 360 · required
Default: 60
amortization
​integer · enum · required
Enum values:
1
2
3
Default: 2

Det03Result

Result of the det03 calculation.
monthlyPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Det03YearRow[] · required

Det03YearRow

period
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
payment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Det04Request

Inputs for the det04 calculation.
expectedIncome
​number · required
Default: 0
mortgage
​number · required
Default: 0
loanAmount
​number · required
Default: 0

Det04Result

Result of the det04 calculation.
takeHomePay
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
mortgagePayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
consumerPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
disposableIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
shortTermPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
mortgagePaymentPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
remainingPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
debtRatio
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
trafficLight
​TrafficLight · enum · required
Enum values:
green
red
yellow

Det05Request

Inputs for the det05 calculation.
paymentAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0
termMonths
​integer · min: 1 · max: 360 · required
Default: 60
amortization
​integer · enum · required
Enum values:
1
2
Default: 2

Det05Result

Result of the det05 calculation.
loanBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Det05YearRow[] · required

Det05YearRow

period
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
payment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Det06Request

Inputs for the det06 calculation.
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.06
termYears
​integer · min: 1 · max: 40 · required
Default: 15
​object[] · minItems: 1 · maxItems: 4 · required
​object[] · minItems: 1 · maxItems: 2 · required
rvBalance
​number · required
Default: 0
rvPayment
​number · required
Default: 0
rvRate
​number · min: 0 · max: 0.4 · required
Default: 0
​object[] · minItems: 1 · maxItems: 3 · required

Det06Result

Result of the det06 calculation.
debtPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
debtInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
debtTerm
​integer · required
consBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
consPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
consInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
consTerm
​integer · required
recommendSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
recommendTerm
​integer · required
recommendInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
recommendYears
​number · required
interestSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
debtBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Det06YearRow[] · required

Det06YearRow

year
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
payment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Det07Request

Inputs for the det07 calculation.
creditor1
​string · required
Default: Creditor 1
balance1
​number · required
Default: 0
minimumPayment1
​number · required
Default: 0
actualPayment1
​number · required
Default: 0
rate1
​number · min: 0 · max: 0.4 · required
Default: 0
creditor2
​string · required
Default: Creditor 2
balance2
​number · required
Default: 0
minimumPayment2
​number · required
Default: 0
actualPayment2
​number · required
Default: 0
rate2
​number · min: 0 · max: 0.4 · required
Default: 0
creditor3
​string · required
Default: Creditor 3
balance3
​number · required
Default: 0
minimumPayment3
​number · required
Default: 0
actualPayment3
​number · required
Default: 0
rate3
​number · min: 0 · max: 0.4 · required
Default: 0
creditor4
​string · required
Default: Creditor 4
balance4
​number · required
Default: 0
minimumPayment4
​number · required
Default: 0
actualPayment4
​number · required
Default: 0
rate4
​number · min: 0 · max: 0.4 · required
Default: 0
creditor5
​string · required
Default: Creditor 5
balance5
​number · required
Default: 0
minimumPayment5
​number · required
Default: 0
actualPayment5
​number · required
Default: 0
rate5
​number · min: 0 · max: 0.4 · required
Default: 0
creditor6
​string · required
Default: Creditor 6
balance6
​number · required
Default: 0
minimumPayment6
​number · required
Default: 0
actualPayment6
​number · required
Default: 0
rate6
​number · min: 0 · max: 0.4 · required
Default: 0
creditor7
​string · required
Default: Creditor 7
balance7
​number · required
Default: 0
minimumPayment7
​number · required
Default: 0
actualPayment7
​number · required
Default: 0
rate7
​number · min: 0 · max: 0.4 · required
Default: 0
creditor8
​string · required
Default: Creditor 8
balance8
​number · required
Default: 0
minimumPayment8
​number · required
Default: 0
actualPayment8
​number · required
Default: 0
rate8
​number · min: 0 · max: 0.4 · required
Default: 0
creditor9
​string · required
Default: Creditor 9
balance9
​number · required
Default: 0
minimumPayment9
​number · required
Default: 0
actualPayment9
​number · required
Default: 0
rate9
​number · min: 0 · max: 0.4 · required
Default: 0
creditor10
​string · required
Default: Creditor 10
balance10
​number · required
Default: 0
minimumPayment10
​number · required
Default: 0
actualPayment10
​number · required
Default: 0
rate10
​number · min: 0 · max: 0.4 · required
Default: 0
creditor11
​string · required
Default: Creditor 11
balance11
​number · required
Default: 0
minimumPayment11
​number · required
Default: 0
actualPayment11
​number · required
Default: 0
rate11
​number · min: 0 · max: 0.4 · required
Default: 0
creditor12
​string · required
Default: Creditor 12
balance12
​number · required
Default: 0
minimumPayment12
​number · required
Default: 0
actualPayment12
​number · required
Default: 0
rate12
​number · min: 0 · max: 0.4 · required
Default: 0
creditor13
​string · required
Default: Creditor 13
balance13
​number · required
Default: 0
minimumPayment13
​number · required
Default: 0
actualPayment13
​number · required
Default: 0
rate13
​number · min: 0 · max: 0.4 · required
Default: 0
creditor14
​string · required
Default: Creditor 14
balance14
​number · required
Default: 0
minimumPayment14
​number · required
Default: 0
actualPayment14
​number · required
Default: 0
rate14
​number · min: 0 · max: 0.4 · required
Default: 0
creditor15
​string · required
Default: Creditor 15
balance15
​number · required
Default: 0
minimumPayment15
​number · required
Default: 0
actualPayment15
​number · required
Default: 0
rate15
​number · min: 0 · max: 0.4 · required
Default: 0
creditor16
​string · required
Default: Creditor 16
balance16
​number · required
Default: 0
minimumPayment16
​number · required
Default: 0
actualPayment16
​number · required
Default: 0
rate16
​number · min: 0 · max: 0.4 · required
Default: 0
creditor17
​string · required
Default: Creditor 17
balance17
​number · required
Default: 0
minimumPayment17
​number · required
Default: 0
actualPayment17
​number · required
Default: 0
rate17
​number · min: 0 · max: 0.4 · required
Default: 0
creditor18
​string · required
Default: Creditor 18
balance18
​number · required
Default: 0
minimumPayment18
​number · required
Default: 0
actualPayment18
​number · required
Default: 0
rate18
​number · min: 0 · max: 0.4 · required
Default: 0
creditor19
​string · required
Default: Creditor 19
balance19
​number · required
Default: 0
minimumPayment19
​number · required
Default: 0
actualPayment19
​number · required
Default: 0
rate19
​number · min: 0 · max: 0.4 · required
Default: 0
creditor20
​string · required
Default: Creditor 20
balance20
​number · required
Default: 0
minimumPayment20
​number · required
Default: 0
actualPayment20
​number · required
Default: 0
rate20
​number · min: 0 · max: 0.4 · required
Default: 0
creditor21
​string · required
Default: Creditor 21
balance21
​number · required
Default: 0
minimumPayment21
​number · required
Default: 0
actualPayment21
​number · required
Default: 0
rate21
​number · min: 0 · max: 0.4 · required
Default: 0
creditor22
​string · required
Default: Creditor 22
balance22
​number · required
Default: 0
minimumPayment22
​number · required
Default: 0
actualPayment22
​number · required
Default: 0
rate22
​number · min: 0 · max: 0.4 · required
Default: 0
creditor23
​string · required
Default: Creditor 23
balance23
​number · required
Default: 0
minimumPayment23
​number · required
Default: 0
actualPayment23
​number · required
Default: 0
rate23
​number · min: 0 · max: 0.4 · required
Default: 0
creditor24
​string · required
Default: Creditor 24
balance24
​number · required
Default: 0
minimumPayment24
​number · required
Default: 0
actualPayment24
​number · required
Default: 0
rate24
​number · min: 0 · max: 0.4 · required
Default: 0
creditor25
​string · required
Default: Creditor 25
balance25
​number · required
Default: 0
minimumPayment25
​number · required
Default: 0
actualPayment25
​number · required
Default: 0
rate25
​number · min: 0 · max: 0.4 · required
Default: 0
creditor26
​string · required
Default: Creditor 26
balance26
​number · required
Default: 0
minimumPayment26
​number · required
Default: 0
actualPayment26
​number · required
Default: 0
rate26
​number · min: 0 · max: 0.4 · required
Default: 0
creditor27
​string · required
Default: Creditor 27
balance27
​number · required
Default: 0
minimumPayment27
​number · required
Default: 0
actualPayment27
​number · required
Default: 0
rate27
​number · min: 0 · max: 0.4 · required
Default: 0
creditor28
​string · required
Default: Creditor 28
balance28
​number · required
Default: 0
minimumPayment28
​number · required
Default: 0
actualPayment28
​number · required
Default: 0
rate28
​number · min: 0 · max: 0.4 · required
Default: 0
creditor29
​string · required
Default: Creditor 29
balance29
​number · required
Default: 0
minimumPayment29
​number · required
Default: 0
actualPayment29
​number · required
Default: 0
rate29
​number · min: 0 · max: 0.4 · required
Default: 0
creditor30
​string · required
Default: Creditor 30
balance30
​number · required
Default: 0
minimumPayment30
​number · required
Default: 0
actualPayment30
​number · required
Default: 0
rate30
​number · min: 0 · max: 0.4 · required
Default: 0
creditor31
​string · required
Default: Creditor 31
balance31
​number · required
Default: 0
minimumPayment31
​number · required
Default: 0
actualPayment31
​number · required
Default: 0
rate31
​number · min: 0 · max: 0.4 · required
Default: 0
creditor32
​string · required
Default: Creditor 32
balance32
​number · required
Default: 0
minimumPayment32
​number · required
Default: 0
actualPayment32
​number · required
Default: 0
rate32
​number · min: 0 · max: 0.4 · required
Default: 0
creditor33
​string · required
Default: Creditor 33
balance33
​number · required
Default: 0
minimumPayment33
​number · required
Default: 0
actualPayment33
​number · required
Default: 0
rate33
​number · min: 0 · max: 0.4 · required
Default: 0
creditor34
​string · required
Default: Creditor 34
balance34
​number · required
Default: 0
minimumPayment34
​number · required
Default: 0
actualPayment34
​number · required
Default: 0
rate34
​number · min: 0 · max: 0.4 · required
Default: 0
creditor35
​string · required
Default: Creditor 35
balance35
​number · required
Default: 0
minimumPayment35
​number · required
Default: 0
actualPayment35
​number · required
Default: 0
rate35
​number · min: 0 · max: 0.4 · required
Default: 0
creditor36
​string · required
Default: Creditor 36
balance36
​number · required
Default: 0
minimumPayment36
​number · required
Default: 0
actualPayment36
​number · required
Default: 0
rate36
​number · min: 0 · max: 0.4 · required
Default: 0
creditor37
​string · required
Default: Creditor 37
balance37
​number · required
Default: 0
minimumPayment37
​number · required
Default: 0
actualPayment37
​number · required
Default: 0
rate37
​number · min: 0 · max: 0.4 · required
Default: 0
creditor38
​string · required
Default: Creditor 38
balance38
​number · required
Default: 0
minimumPayment38
​number · required
Default: 0
actualPayment38
​number · required
Default: 0
rate38
​number · min: 0 · max: 0.4 · required
Default: 0
creditor39
​string · required
Default: Creditor 39
balance39
​number · required
Default: 0
minimumPayment39
​number · required
Default: 0
actualPayment39
​number · required
Default: 0
rate39
​number · min: 0 · max: 0.4 · required
Default: 0
creditor40
​string · required
Default: Creditor 40
balance40
​number · required
Default: 0
minimumPayment40
​number · required
Default: 0
actualPayment40
​number · required
Default: 0
rate40
​number · min: 0 · max: 0.4 · required
Default: 0
creditor41
​string · required
Default: Creditor 41
balance41
​number · required
Default: 0
minimumPayment41
​number · required
Default: 0
actualPayment41
​number · required
Default: 0
rate41
​number · min: 0 · max: 0.4 · required
Default: 0
creditor42
​string · required
Default: Creditor 42
balance42
​number · required
Default: 0
minimumPayment42
​number · required
Default: 0
actualPayment42
​number · required
Default: 0
rate42
​number · min: 0 · max: 0.4 · required
Default: 0
creditor43
​string · required
Default: Creditor 43
balance43
​number · required
Default: 0
minimumPayment43
​number · required
Default: 0
actualPayment43
​number · required
Default: 0
rate43
​number · min: 0 · max: 0.4 · required
Default: 0
creditor44
​string · required
Default: Creditor 44
balance44
​number · required
Default: 0
minimumPayment44
​number · required
Default: 0
actualPayment44
​number · required
Default: 0
rate44
​number · min: 0 · max: 0.4 · required
Default: 0
creditor45
​string · required
Default: Creditor 45
balance45
​number · required
Default: 0
minimumPayment45
​number · required
Default: 0
actualPayment45
​number · required
Default: 0
rate45
​number · min: 0 · max: 0.4 · required
Default: 0
creditor46
​string · required
Default: Creditor 46
balance46
​number · required
Default: 0
minimumPayment46
​number · required
Default: 0
actualPayment46
​number · required
Default: 0
rate46
​number · min: 0 · max: 0.4 · required
Default: 0
creditor47
​string · required
Default: Creditor 47
balance47
​number · required
Default: 0
minimumPayment47
​number · required
Default: 0
actualPayment47
​number · required
Default: 0
rate47
​number · min: 0 · max: 0.4 · required
Default: 0
creditor48
​string · required
Default: Creditor 48
balance48
​number · required
Default: 0
minimumPayment48
​number · required
Default: 0
actualPayment48
​number · required
Default: 0
rate48
​number · min: 0 · max: 0.4 · required
Default: 0
creditor49
​string · required
Default: Creditor 49
balance49
​number · required
Default: 0
minimumPayment49
​number · required
Default: 0
actualPayment49
​number · required
Default: 0
rate49
​number · min: 0 · max: 0.4 · required
Default: 0
creditor50
​string · required
Default: Creditor 50
balance50
​number · required
Default: 0
minimumPayment50
​number · required
Default: 0
actualPayment50
​number · required
Default: 0
rate50
​number · min: 0 · max: 0.4 · required
Default: 0
creditor51
​string · required
Default: Creditor 51
balance51
​number · required
Default: 0
minimumPayment51
​number · required
Default: 0
actualPayment51
​number · required
Default: 0
rate51
​number · min: 0 · max: 0.4 · required
Default: 0
creditor52
​string · required
Default: Creditor 52
balance52
​number · required
Default: 0
minimumPayment52
​number · required
Default: 0
actualPayment52
​number · required
Default: 0
rate52
​number · min: 0 · max: 0.4 · required
Default: 0
creditor53
​string · required
Default: Creditor 53
balance53
​number · required
Default: 0
minimumPayment53
​number · required
Default: 0
actualPayment53
​number · required
Default: 0
rate53
​number · min: 0 · max: 0.4 · required
Default: 0
creditor54
​string · required
Default: Creditor 54
balance54
​number · required
Default: 0
minimumPayment54
​number · required
Default: 0
actualPayment54
​number · required
Default: 0
rate54
​number · min: 0 · max: 0.4 · required
Default: 0
creditor55
​string · required
Default: Creditor 55
balance55
​number · required
Default: 0
minimumPayment55
​number · required
Default: 0
actualPayment55
​number · required
Default: 0
rate55
​number · min: 0 · max: 0.4 · required
Default: 0
creditor56
​string · required
Default: Creditor 56
balance56
​number · required
Default: 0
minimumPayment56
​number · required
Default: 0
actualPayment56
​number · required
Default: 0
rate56
​number · min: 0 · max: 0.4 · required
Default: 0
creditor57
​string · required
Default: Creditor 57
balance57
​number · required
Default: 0
minimumPayment57
​number · required
Default: 0
actualPayment57
​number · required
Default: 0
rate57
​number · min: 0 · max: 0.4 · required
Default: 0
creditor58
​string · required
Default: Creditor 58
balance58
​number · required
Default: 0
minimumPayment58
​number · required
Default: 0
actualPayment58
​number · required
Default: 0
rate58
​number · min: 0 · max: 0.4 · required
Default: 0
creditor59
​string · required
Default: Creditor 59
balance59
​number · required
Default: 0
minimumPayment59
​number · required
Default: 0
actualPayment59
​number · required
Default: 0
rate59
​number · min: 0 · max: 0.4 · required
Default: 0
creditor60
​string · required
Default: Creditor 60
balance60
​number · required
Default: 0
minimumPayment60
​number · required
Default: 0
actualPayment60
​number · required
Default: 0
rate60
​number · min: 0 · max: 0.4 · required
Default: 0
creditor61
​string · required
Default: Creditor 61
balance61
​number · required
Default: 0
minimumPayment61
​number · required
Default: 0
actualPayment61
​number · required
Default: 0
rate61
​number · min: 0 · max: 0.4 · required
Default: 0
creditor62
​string · required
Default: Creditor 62
balance62
​number · required
Default: 0
minimumPayment62
​number · required
Default: 0
actualPayment62
​number · required
Default: 0
rate62
​number · min: 0 · max: 0.4 · required
Default: 0
creditor63
​string · required
Default: Creditor 63
balance63
​number · required
Default: 0
minimumPayment63
​number · required
Default: 0
actualPayment63
​number · required
Default: 0
rate63
​number · min: 0 · max: 0.4 · required
Default: 0
creditor64
​string · required
Default: Creditor 64
balance64
​number · required
Default: 0
minimumPayment64
​number · required
Default: 0
actualPayment64
​number · required
Default: 0
rate64
​number · min: 0 · max: 0.4 · required
Default: 0
creditor65
​string · required
Default: Creditor 65
balance65
​number · required
Default: 0
minimumPayment65
​number · required
Default: 0
actualPayment65
​number · required
Default: 0
rate65
​number · min: 0 · max: 0.4 · required
Default: 0
creditor66
​string · required
Default: Creditor 66
balance66
​number · required
Default: 0
minimumPayment66
​number · required
Default: 0
actualPayment66
​number · required
Default: 0
rate66
​number · min: 0 · max: 0.4 · required
Default: 0
creditor67
​string · required
Default: Creditor 67
balance67
​number · required
Default: 0
minimumPayment67
​number · required
Default: 0
actualPayment67
​number · required
Default: 0
rate67
​number · min: 0 · max: 0.4 · required
Default: 0
creditor68
​string · required
Default: Creditor 68
balance68
​number · required
Default: 0
minimumPayment68
​number · required
Default: 0
actualPayment68
​number · required
Default: 0
rate68
​number · min: 0 · max: 0.4 · required
Default: 0
creditor69
​string · required
Default: Creditor 69
balance69
​number · required
Default: 0
minimumPayment69
​number · required
Default: 0
actualPayment69
​number · required
Default: 0
rate69
​number · min: 0 · max: 0.4 · required
Default: 0
creditor70
​string · required
Default: Creditor 70
balance70
​number · required
Default: 0
minimumPayment70
​number · required
Default: 0
actualPayment70
​number · required
Default: 0
rate70
​number · min: 0 · max: 0.4 · required
Default: 0
creditor71
​string · required
Default: Creditor 71
balance71
​number · required
Default: 0
minimumPayment71
​number · required
Default: 0
actualPayment71
​number · required
Default: 0
rate71
​number · min: 0 · max: 0.4 · required
Default: 0
creditor72
​string · required
Default: Creditor 72
balance72
​number · required
Default: 0
minimumPayment72
​number · required
Default: 0
actualPayment72
​number · required
Default: 0
rate72
​number · min: 0 · max: 0.4 · required
Default: 0
creditor73
​string · required
Default: Creditor 73
balance73
​number · required
Default: 0
minimumPayment73
​number · required
Default: 0
actualPayment73
​number · required
Default: 0
rate73
​number · min: 0 · max: 0.4 · required
Default: 0
creditor74
​string · required
Default: Creditor 74
balance74
​number · required
Default: 0
minimumPayment74
​number · required
Default: 0
actualPayment74
​number · required
Default: 0
rate74
​number · min: 0 · max: 0.4 · required
Default: 0
creditor75
​string · required
Default: Creditor 75
balance75
​number · required
Default: 0
minimumPayment75
​number · required
Default: 0
actualPayment75
​number · required
Default: 0
rate75
​number · min: 0 · max: 0.4 · required
Default: 0
creditor76
​string · required
Default: Creditor 76
balance76
​number · required
Default: 0
minimumPayment76
​number · required
Default: 0
actualPayment76
​number · required
Default: 0
rate76
​number · min: 0 · max: 0.4 · required
Default: 0
creditor77
​string · required
Default: Creditor 77
balance77
​number · required
Default: 0
minimumPayment77
​number · required
Default: 0
actualPayment77
​number · required
Default: 0
rate77
​number · min: 0 · max: 0.4 · required
Default: 0
creditor78
​string · required
Default: Creditor 78
balance78
​number · required
Default: 0
minimumPayment78
​number · required
Default: 0
actualPayment78
​number · required
Default: 0
rate78
​number · min: 0 · max: 0.4 · required
Default: 0
creditor79
​string · required
Default: Creditor 79
balance79
​number · required
Default: 0
minimumPayment79
​number · required
Default: 0
actualPayment79
​number · required
Default: 0
rate79
​number · min: 0 · max: 0.4 · required
Default: 0
creditor80
​string · required
Default: Creditor 80
balance80
​number · required
Default: 0
minimumPayment80
​number · required
Default: 0
actualPayment80
​number · required
Default: 0
rate80
​number · min: 0 · max: 0.4 · required
Default: 0
creditor81
​string · required
Default: Creditor 81
balance81
​number · required
Default: 0
minimumPayment81
​number · required
Default: 0
actualPayment81
​number · required
Default: 0
rate81
​number · min: 0 · max: 0.4 · required
Default: 0
creditor82
​string · required
Default: Creditor 82
balance82
​number · required
Default: 0
minimumPayment82
​number · required
Default: 0
actualPayment82
​number · required
Default: 0
rate82
​number · min: 0 · max: 0.4 · required
Default: 0
creditor83
​string · required
Default: Creditor 83
balance83
​number · required
Default: 0
minimumPayment83
​number · required
Default: 0
actualPayment83
​number · required
Default: 0
rate83
​number · min: 0 · max: 0.4 · required
Default: 0
creditor84
​string · required
Default: Creditor 84
balance84
​number · required
Default: 0
minimumPayment84
​number · required
Default: 0
actualPayment84
​number · required
Default: 0
rate84
​number · min: 0 · max: 0.4 · required
Default: 0
creditor85
​string · required
Default: Creditor 85
balance85
​number · required
Default: 0
minimumPayment85
​number · required
Default: 0
actualPayment85
​number · required
Default: 0
rate85
​number · min: 0 · max: 0.4 · required
Default: 0
creditor86
​string · required
Default: Creditor 86
balance86
​number · required
Default: 0
minimumPayment86
​number · required
Default: 0
actualPayment86
​number · required
Default: 0
rate86
​number · min: 0 · max: 0.4 · required
Default: 0
creditor87
​string · required
Default: Creditor 87
balance87
​number · required
Default: 0
minimumPayment87
​number · required
Default: 0
actualPayment87
​number · required
Default: 0
rate87
​number · min: 0 · max: 0.4 · required
Default: 0
creditor88
​string · required
Default: Creditor 88
balance88
​number · required
Default: 0
minimumPayment88
​number · required
Default: 0
actualPayment88
​number · required
Default: 0
rate88
​number · min: 0 · max: 0.4 · required
Default: 0
creditor89
​string · required
Default: Creditor 89
balance89
​number · required
Default: 0
minimumPayment89
​number · required
Default: 0
actualPayment89
​number · required
Default: 0
rate89
​number · min: 0 · max: 0.4 · required
Default: 0
creditor90
​string · required
Default: Creditor 90
balance90
​number · required
Default: 0
minimumPayment90
​number · required
Default: 0
actualPayment90
​number · required
Default: 0
rate90
​number · min: 0 · max: 0.4 · required
Default: 0
creditor91
​string · required
Default: Creditor 91
balance91
​number · required
Default: 0
minimumPayment91
​number · required
Default: 0
actualPayment91
​number · required
Default: 0
rate91
​number · min: 0 · max: 0.4 · required
Default: 0
creditor92
​string · required
Default: Creditor 92
balance92
​number · required
Default: 0
minimumPayment92
​number · required
Default: 0
actualPayment92
​number · required
Default: 0
rate92
​number · min: 0 · max: 0.4 · required
Default: 0
creditor93
​string · required
Default: Creditor 93
balance93
​number · required
Default: 0
minimumPayment93
​number · required
Default: 0
actualPayment93
​number · required
Default: 0
rate93
​number · min: 0 · max: 0.4 · required
Default: 0
creditor94
​string · required
Default: Creditor 94
balance94
​number · required
Default: 0
minimumPayment94
​number · required
Default: 0
actualPayment94
​number · required
Default: 0
rate94
​number · min: 0 · max: 0.4 · required
Default: 0
creditor95
​string · required
Default: Creditor 95
balance95
​number · required
Default: 0
minimumPayment95
​number · required
Default: 0
actualPayment95
​number · required
Default: 0
rate95
​number · min: 0 · max: 0.4 · required
Default: 0
creditor96
​string · required
Default: Creditor 96
balance96
​number · required
Default: 0
minimumPayment96
​number · required
Default: 0
actualPayment96
​number · required
Default: 0
rate96
​number · min: 0 · max: 0.4 · required
Default: 0
creditor97
​string · required
Default: Creditor 97
balance97
​number · required
Default: 0
minimumPayment97
​number · required
Default: 0
actualPayment97
​number · required
Default: 0
rate97
​number · min: 0 · max: 0.4 · required
Default: 0
creditor98
​string · required
Default: Creditor 98
balance98
​number · required
Default: 0
minimumPayment98
​number · required
Default: 0
actualPayment98
​number · required
Default: 0
rate98
​number · min: 0 · max: 0.4 · required
Default: 0
creditor99
​string · required
Default: Creditor 99
balance99
​number · required
Default: 0
minimumPayment99
​number · required
Default: 0
actualPayment99
​number · required
Default: 0
rate99
​number · min: 0 · max: 0.4 · required
Default: 0
creditor100
​string · required
Default: Creditor 100
balance100
​number · required
Default: 0
minimumPayment100
​number · required
Default: 0
actualPayment100
​number · required
Default: 0
rate100
​number · min: 0 · max: 0.4 · required
Default: 0
extraPayment
​number · required
Default: 0
oneTimePaymentAmount
​number · required
Default: 0
oneTimePaymentMonth
​string · enum · required
Enum values:
1
2
3
4
5
6
7
8
Default: 1
oneTimePaymentYear
​integer · min: 2026 · max: 2050 · required
Default: 2027
startMonth
​string · enum · required
Enum values:
1
2
3
4
5
6
7
8
Default: 1
startYear
​integer · min: 2026 · max: 2050 · required
Default: 2027
debtOrderMethod
​integer · enum · required
Enum values:
1
2
3
Default: 2
savingsRate
​number · min: -0.12 · max: 0.12 · required
Default: 0.05

Det07Result

Result of the det07 calculation.
currentPayoffMonths
​integer · required
rollupPayoffMonths
​integer · required
currentPayoffYears
​number · required
rollupPayoffYears
​number · required
currentInterestPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollupInterestPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalMonthlyPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalRollupMonthlyPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCurrentDebtPayments
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalRollupDebtPayments
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
savings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Det07DebtRow[] · required

Det07DebtRow

creditor
​string · required
balance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
minimumPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
actualPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Det08Request

Inputs for the det08 calculation.
lumpSum
​number · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
frequency
​integer · enum · required
Enum values:
0
1
Default: 1
paymentAmount
​number · required
Default: 0
growth
​number · min: -0.12 · max: 0.12 · required
Default: 0
term
​integer · min: 1 · max: 480 · required
Default: 1

Det08Result

Result of the det08 calculation.
cashUpFront
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
paymentsOverTime
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Det09Request

Inputs for the det09 calculation.
loanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0
termMonths
​integer · min: 1 · max: 360 · required
Default: 360
paymentsMade
​integer · min: 0 · max: 999 · required
Default: 24
additionalPayment
​number · required
Default: 0

Det09Result

Result of the det09 calculation.
initialPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
remainingTerm
​integer · required
remainingPrincipal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
newPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentYears
​number · required
proposedYears
​number · required
savedYears
​number · required
currentInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
proposedInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Det09YearRow[] · required

Det09YearRow

year
​number | null · required
​required
​required
​required
​required
​required

Det10Request

Inputs for the det10 calculation.
debtInterestRate
​number · min: 0 · max: 0.4 · required
Default: 0.08
interestDeductible
​string · enum · required
Enum values:
N
Y
Default: N
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
interestTaxable
​string · enum · required
Enum values:
N
Y
Default: N
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0

Det10Result

Result of the det10 calculation.
afterTaxDebt
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
afterTaxReturn
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Det11Request

Inputs for the det11 calculation.
currentBalance1
​number · required
Default: 0
currentRate1
​number · min: 0 · max: 0.4 · required
Default: 0
currentBalance2
​number · required
Default: 0
currentRate2
​number · min: 0 · max: 0.4 · required
Default: 0
currentBalance3
​number · required
Default: 0
currentRate3
​number · min: 0 · max: 0.4 · required
Default: 0
currentBalance4
​number · required
Default: 0
currentRate4
​number · min: 0 · max: 0.4 · required
Default: 0
introRate
​number · min: 0 · max: 0.4 · required
Default: 0
introTerm
​integer · min: 0 · max: 120 · required
Default: 0
regularRate
​number · min: 0 · max: 0.4 · required
Default: 0
annualFee
​number · required
Default: 0
transferFeePercent
​number · min: 0 · max: 1 · required
Default: 0
transferFeeMaximum
​number · required
Default: 0

Det11Result

Result of the det11 calculation.
introSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
introFees
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
regularSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentCardInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
newCardInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
newCardFees
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Det12Request

Inputs for the det12 calculation.
creditReportAvail
​string · enum · required
Enum values:
N
Y
Default: Y
creditLength
​integer · required
Default: 0
creditTypes
​string · required
appliedCredit
​integer · enum · required
Enum values:
0
2
5
8
9
Default: 0
missedPayment
​integer · enum · required
Enum values:
0
3
6
12
24
25
Default: 0
totalCreditLimit
​number · required
Default: 0
totalCreditBalance
​number · required
Default: 0
negativeReport
​string · enum · required
Enum values:
N
Y
Default: N
negativeReportTime
​integer · enum · required
Enum values:
0
3
6
12
24
36
48
60
Default: 0

Det12Result

Result of the det12 calculation.
lowerRange
​integer · required
upperRange
​integer · required
creditScore
​integer · required

Det13Request

Inputs for the det13 calculation.
recurringPayments
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.12 · required
Default: 0
termMonths
​integer · min: 1 · max: 360 · required
Default: 120

Det13Result

Result of the det13 calculation.
totalInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
borrowAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Det13MonthRow[] · required

Det13MonthRow

month
​integer | null · required
​required
​required
​required
​required

Det16Request

Inputs for the det16 calculation.
loanAmount
​number · required
Default: 0
recurringPayments
​number · required
Default: 0
termMonths
​integer · min: 1 · max: 360 · required
Default: 120

Det16Result

Result of the det16 calculation.
totalDeposits
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
​Det16MonthRow[] · required

Det16MonthRow

month
​integer | null · required
​required
​required
​required
​required

Det17Request

Inputs for the det17 calculation.
loanBalance
​number · required
Default: 0
currentMonthlyPayment
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0
desiredMonths
​integer · min: 1 · max: 360 · required
Default: 5

Det17Result

Result of the det17 calculation.
totalCurrentInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalProposedInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestDifference
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
newPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
paymentDifference
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
previousMonths
​number · required
​Det17YearRow[] · required

Det17YearRow

period
​integer | null · required
​required
​required
​required
​required

Hom01Request

Inputs for the hom01 calculation.
combinedIncome
​number · required
Default: 0
childSupport
​number · required
Default: 0
autoPayments
​number · required
Default: 0
ccPayments
​number · required
Default: 0
associationFees
​number · required
Default: 0
otherObligations
​number · required
Default: 0
mortgageRate
​number · min: 0 · max: 0.4 · required
Default: 0.05
mortgageTerm
​integer · enum · required
Enum values:
15
20
30
40
Default: 30
downPayment
​number · required
Default: 0
propertyTaxes
​number · required
Default: 0
hazardInsurance
​number · required
Default: 0
frontRatio
​number · enum · required
Enum values:
1
2
3
Default: 1
backRatio
​number · enum · required
Enum values:
1
2
3
Default: 1

Hom01Result

Result of the hom01 calculation.
monthlyIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
front
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
frontPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherDebts
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherPercentage
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
back
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
backPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
minimumPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxesInsurance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
maximumPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
mortgageAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
homeValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Hom02Request

Inputs for the hom02 calculation.
loanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.05
currentTerm
​integer · min: 1 · max: 480 · required
Default: 360
monthlyMortgage
​number · required
Default: 0
refinanceRate
​number · min: 0 · max: 0.4 · required
Default: 0.035
refinanceTerm
​integer · min: 1 · max: 480 · required
Default: 360
originationFee
​number · min: 0 · max: 0.05 · required
Default: 0.01
discountPoints
​number · min: 0 · max: 0.05 · required
Default: 0
refinanceFees
​number · required
Default: 2500
includeClosingCosts
​string · enum · required
Enum values:
N
Y
Default: Y

Hom02Result

Result of the hom02 calculation.
currentTermO
​number · required
traditionalTerm
​number · required
enhancedTerm
​number · required
currentPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
traditionalPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
enhancedPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
traditionalBreakeven
​number | null · required
enhancedBreakeven
​number | null · required
currentInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
traditionalInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
enhancedInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Hom03Request

Inputs for the hom03 calculation.
loanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.05
termMonths
​integer · min: 1 · max: 480 · required
Default: 360
amortization
​integer · enum · required
Enum values:
1
2
Default: 2
propertyValue
​number · required
Default: 0
estimateTipmi
​string · enum · required
Enum values:
N
Y
Default: N
propertyTaxes
​number · required
Default: 0
hazardInsurance
​number · required
Default: 0
pmi
​number · required
Default: 0

Hom03Result

Result of the hom03 calculation.
pandi
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyTaxes
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyInsurance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyPmi
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
pandiTipmi
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Hom03YearRow[] · required

Hom03YearRow

period
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
principal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
payment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Hom04Request

Inputs for the hom04 calculation.
loanAmount
​number · required
Default: 0
termYears1
​integer · min: 1 · max: 40 · required
Default: 15
termYears2
​integer · min: 1 · max: 40 · required
Default: 20
termYears3
​integer · min: 1 · max: 40 · required
Default: 30
interestRate1
​number · min: 0 · max: 0.4 · required
Default: 0.06
interestRate2
​number · min: 0 · max: 0.4 · required
Default: 0.0625
interestRate3
​number · min: 0 · max: 0.4 · required
Default: 0.065
comparisonRate
​number · enum · required
Enum values:
0
0.035
0.99
Default: 0
overrideRate
​number · min: 0 · max: 0.4 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
comparisonYear
​integer · min: 1 · max: 30 · required
Default: 30

Hom04Result

Result of the hom04 calculation.
monthlyPayment1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyPayment2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyPayment3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
pvLoan1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
pvLoan2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
pvLoan3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
remainingBalance1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
remainingBalance2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
remainingBalance3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCost1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCost2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCost3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
investmentReturn
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Hom05Request

Inputs for the hom05 calculation.
loanAmount
​number · required
Default: 0
termYears
​integer · min: 1 · max: 40 · required
Default: 30
interestRate1
​number · min: 0 · max: 0.4 · required
Default: 0.055
interestRate2
​number · min: 0 · max: 0.4 · required
Default: 0.0525
discountPoints1
​number · min: 0 · max: 0.05 · required
Default: 0
discountPoints2
​number · min: 0 · max: 0.05 · required
Default: 0.01

Hom05Result

Result of the hom05 calculation.
monthlyPayment1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyPayment2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
discountSpread
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlySavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
breakeven
​number · required
discountPoints1Amount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
discountPoints2Amount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Hom06Request

Inputs for the hom06 calculation.
rent
​number · required
Default: 0
fees
​number · required
Default: 0
rentIns
​number · required
Default: 0
rentIncr
​number · min: 0 · max: 0.1 · required
Default: 0
purchase
​number · required
Default: 0
growth
​number · min: 0 · max: 0.1 · required
Default: 0.05
realtorFees
​number · min: 0 · max: 1 · required
Default: 0
loan
​number · required
Default: 0
rate
​number · min: 0 · max: 0.4 · required
Default: 0.05
term
​integer · min: 1 · max: 40 · required
Default: 30
closingCosts
​number · required
Default: 0
homeowners
​number · required
Default: 0
taxes
​number · required
Default: 0
maint
​number · required
Default: 0
analysis
​integer · min: 1 · max: 30 · required
Default: 30
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
inf
​number · min: 0 · max: 0.1 · required
Default: 0.035
standardDeduction
​string · enum · required
Enum values:
N
Y
Default: N

Hom06Result

Result of the hom06 calculation.
rentTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
paymentsTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
insuranceTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxesTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
maintenanceTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
oppcostTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxsavingsTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
appreciationTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
principalTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalcostRent
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalcostBuy
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
pvtotalcostRent
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
pvtotalcostBuy
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
difference
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
closingCostsTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
realtorFeesTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Hom06YearRow[] · required

Hom06YearRow

yearNumber
​integer | null · required
​required
​required
​required
​required
​required
​required
​required
​required

Hom07Request

Inputs for the hom07 calculation.
loanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.05
termMonths
​integer · min: 1 · max: 480 · required
Default: 360
paymentMade
​integer · min: 0 · max: 999 · required
Default: 0

Hom07Result

Result of the hom07 calculation.
​Hom07YearRow[] · required

Hom07YearRow

year
​number | null · required
​required
​required
​required
​required
​required

Hom08Request

Inputs for the hom08 calculation.
loanAmount
​number · required
Default: 0
termYears
​integer · min: 1 · max: 40 · required
Default: 30
nocostRate
​number · min: 0 · max: 0.4 · required
Default: 0.055
traditionalRate
​number · min: 0 · max: 0.4 · required
Default: 0.05
discount
​number · min: 0 · max: 0.05 · required
Default: 0
origination
​number · min: 0 · max: 0.05 · required
Default: 0.01
lender
​number · required
Default: 600
credit
​number · required
Default: 50
appraisal
​number · required
Default: 300
titleInsurance
​number · required
Default: 800
reconveyance
​number · required
Default: 75
recording
​number · required
Default: 45
wire
​number · required
Default: 55
endorsement
​number · required
Default: 75
closing
​number · required
Default: 125
docprep
​number · required
Default: 30
other
​number · required
Default: 0
payCosts
​string · enum · required
Enum values:
roll
closing
Default: roll
comparisonRate
​number · enum · required
Enum values:
0
0.035
0.99
Default: 0
overrideRate
​number · min: 0 · max: 0.4 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
comparisonYear
​integer · min: 1 · max: 40 · required
Default: 30

Hom08Result

Result of the hom08 calculation.
monthlyPayment1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyPayment2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
pvLoan1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
pvLoan2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
remainingBalance1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
remainingBalance2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
closingCosts
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCost1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCost2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
investmentReturn
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
​Hom08YearRow[] · required

Hom08YearRow

yearNumber
​integer | null · required
​required
​required
​required
​required
​required
​required
​required
​required

Hom09Request

Inputs for the hom09 calculation.
loanAmount
​number · min: 0 · max: 750000 · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.05
termMonths
​integer · min: 1 · max: 480 · required
Default: 360
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
amortization
​integer · enum · required
Enum values:
1
2
Default: 2

Hom09Result

Result of the hom09 calculation.
taxesSaved
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Hom09YearRow[] · required

Hom09YearRow

period
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
payment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Hom10Request

Inputs for the hom10 calculation.
loanAmount
​number · required
Default: 0
interestRate1
​number · min: 0 · max: 0.4 · required
Default: 0.05
interestRate2
​number · min: 0 · max: 0.4 · required
Default: 0.04
termYears1
​integer · min: 1 · max: 40 · required
Default: 30
termYears2
​integer · min: 1 · max: 40 · required
Default: 30
indexRate
​number · min: 0 · max: 0.4 · required
Default: 0.02
lendersMargin
​number · min: 0 · max: 0.4 · required
Default: 0.0225
indexAdjustment
​number · min: 0 · max: 2 · required
Default: 0.0025
indexMonths
​integer · min: 1 · max: 480 · required
Default: 12
ratesForecast
​integer · enum · required
Enum values:
0
1
2
Default: 1
adjustment
​number · min: 0 · max: 2 · required
Default: 0.005
absminRate
​number · min: 0 · max: 0.4 · required
Default: 0.04
absmaxRate
​number · min: 0 · max: 0.4 · required
Default: 0.12
monthsBeforeadj
​integer · min: 1 · max: 360 · required
Default: 12
monthsBetweenadj
​integer · min: 1 · max: 480 · required
Default: 12
comparisonRate
​number · enum · required
Enum values:
0
0.035
0.99
Default: 0
overrideRate
​number · min: 0 · max: 0.4 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
comparisonYear
​integer · min: 1 · max: 40 · required
Default: 30

Hom10Result

Result of the hom10 calculation.
monthlyPayment1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
pvLoan1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
remainingBalance1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCost1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyPayment2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
pvLoan2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
remainingBalance2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCost2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
investmentReturn
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
costDifference
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Hom10YearRow[] · required

Hom10YearRow

month
​integer · required
fixedPandi
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fixedBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
adjustableRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
adjustablePandi
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
adjustableBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Hom11Request

Inputs for the hom11 calculation.
loanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.05
termMonths
​integer · min: 1 · max: 480 · required
Default: 360
absminRate
​number · min: 0 · max: 0.4 · required
Default: 0.04
absmaxRate
​number · min: 0 · max: 0.4 · required
Default: 0.12
monthsBeforeadj
​integer · min: 1 · max: 360 · required
Default: 12
monthsBetweenadj
​integer · min: 1 · max: 480 · required
Default: 12
ratesForecast
​integer · enum · required
Enum values:
0
1
2
Default: 1
adjustment
​number · min: 0 · max: 2 · required
Default: 0.0025

Hom11Result

Result of the hom11 calculation.
totalPayments
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Hom11YearRow[] · required

Hom11YearRow

period
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
payment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Hom12Request

Inputs for the hom12 calculation.
loanAmount
​number · required
Default: 0
termYears
​integer · min: 1 · max: 40 · required
Default: 30
statedRate
​number · min: 0 · max: 0.1 · required
Default: 0.05
discount
​number · min: 0 · max: 1 · required
Default: 0
origination
​number · min: 0 · max: 1 · required
Default: 0.01
lender
​number · required
Default: 600
creditReport
​number · required
Default: 50
appraisal
​number · required
Default: 300
titleIns
​number · required
Default: 800
reconveyance
​number · required
Default: 75
recording
​number · required
Default: 45
wire
​number · required
Default: 55
endorsement
​number · required
Default: 75
titleClosing
​number · required
Default: 125
documentPrep
​number · required
Default: 30
other
​number · required
Default: 0

Hom12Result

Result of the hom12 calculation.
totalFees
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
apr
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
moPaymentsWith
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
moPaymentsWithout
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Hom13Request

Inputs for the hom13 calculation.
loanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0.05
termYears
​integer · min: 1 · max: 30 · required
Default: 30
termInterestOnly
​integer · min: 1 · max: 30 · required
Default: 15

Hom13Result

Result of the hom13 calculation.
initialMonthlyPaymentIO
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
remainingTermIO
​number · required
newMonthlyPaymentIO
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyPaymentTrad
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalInterestTrad
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalInterestIO
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestDiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Hom13YearRow[] · required

Hom13YearRow

period
​integer | null · required
​required
​required
​required
​required
​required
​required
​required
​required

Hom14Request

Inputs for the hom14 calculation.
homeValue
​number · required
Default: 0
mortgageBalance
​number · required
Default: 0
ltv
​number · min: 0 · max: 0.9 · required
Default: 0.7

Hom14Result

Result of the hom14 calculation.
ltvCol1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ltvCol2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ltvCol3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ltvCol4
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ltvCol5
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
lineCol1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
lineCol2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
lineCol3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
lineCol4
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
lineCol5
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Hom15Request

Inputs for the hom15 calculation.
loanAmount1
​number · required
Default: 0
loanAmount2
​number · required
Default: 0
loanAmount3
​number · required
Default: 0
termYears1
​integer · min: 1 · max: 40 · required
Default: 30
termYears2
​integer · min: 1 · max: 40 · required
Default: 30
termYears3
​integer · min: 1 · max: 40 · required
Default: 30
statedRate1
​number · min: 0 · max: 0.4 · required
Default: 0.04
statedRate2
​number · min: 0 · max: 0.4 · required
Default: 0.045
statedRate3
​number · min: 0 · max: 0.4 · required
Default: 0.05
discount1
​number · min: 0 · max: 0.05 · required
Default: 0
discount2
​number · min: 0 · max: 0.05 · required
Default: 0
discount3
​number · min: 0 · max: 0.05 · required
Default: 0
origination1
​number · min: 0 · max: 0.05 · required
Default: 0.01
origination2
​number · min: 0 · max: 0.05 · required
Default: 0.01
origination3
​number · min: 0 · max: 0.05 · required
Default: 0.01
lender1
​number · required
Default: 600
lender2
​number · required
Default: 600
lender3
​number · required
Default: 600
title1
​number · required
Default: 50
title2
​number · required
Default: 50
title3
​number · required
Default: 50
other1
​number · required
Default: 300
other2
​number · required
Default: 300
other3
​number · required
Default: 300

Hom15Result

Result of the hom15 calculation.
moPaymentsWithout1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
moPaymentsWithout2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
moPaymentsWithout3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
moPaymentsWith1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
moPaymentsWith2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
moPaymentsWith3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
apr1
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
apr2
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
apr3
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Hom16Request

Inputs for the hom16 calculation.
homeValue
​number · required
Default: 0
homeAppreciation
​number · min: 0 · max: 0.12 · required
Default: 0.03
months
​integer · min: 1 · max: 360 · required
Default: 120
reverseLoanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.12 · required
Default: 0.05

Hom16Result

Result of the hom16 calculation.
futureEquity
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Hom16MonthRow[] · required

Hom16MonthRow

month
​integer | null · required
​required
​required
​required
​required
​required

Hom17Request

Inputs for the hom17 calculation.
loanAmount
​number · required
Default: 0
rate
​number · min: 0 · max: 0.4 · required
Default: 0
termInterestOnly
​integer · min: 0 · max: 15 · required
Default: 5
termAmortization
​integer · min: 0 · max: 25 · required
Default: 15

Hom17Result

Result of the hom17 calculation.
amortizedPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestOnlyPayment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Hom17YearRow[] · required

Hom17YearRow

period
​integer | null · required
​required
​required
​required
​required

Hom20Request

Inputs for the hom20 calculation.
loanAmount
​number · required
Default: 0
term
​string · enum · required
Enum values:
1
2
Default: 1
rate
​number · min: 0 · max: 0.12 · required
Default: 0.045

Hom20Result

Result of the hom20 calculation.
estimatedMonthlyPayment
​number · required
calculatedYearlyPayment
​number · required
balloonPayment
​number · required
totalInterestPaid
​number · required

Hom39Request

Inputs for the hom39 calculation.
loanAmount
​number · required
Default: 0
termYears1
​integer · min: 1 · max: 40 · required
Default: 15
termYears2
​integer · min: 1 · max: 40 · required
Default: 20
interestRate1
​number · min: 0 · max: 0.4 · required
Default: 0.04
interestRate2
​number · min: 0 · max: 0.4 · required
Default: 0.045

Hom39Result

Result of the hom39 calculation.
monthlyPayment1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyPayment2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestDifference
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
paymentDifference
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Inc01Request

Inputs for the inc01 calculation.
personalAssets
​number · required
Default: 0
personalGrowth
​number · min: 0 · max: 5 · required
Default: 0
personalDebts
​number · required
Default: 0
investmentAssets
​number · required
Default: 0
investmentGrowth
​number · min: 0 · max: 5 · required
Default: 0
investmentDebts
​number · required
Default: 0
businessAssets
​number · required
Default: 0
businessGrowth
​number · min: 0 · max: 5 · required
Default: 0
businessDebts
​number · required
Default: 0
charitableDonations
​number · required
Default: 0
probate
​number · min: 0 · max: 1 · required
Default: 0.03
growthYears
​integer · min: 0 · max: 120 · required
Default: 0

Inc01Result

Result of the inc01 calculation.
futurePersonal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
futureInvestment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
futureBusiness
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
futureEstate
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
estateExpenses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
charitableTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
futureNetEstate
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
tentativeTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
unifiedCredit
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
estateTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
estateReduction
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Inc03Request

Inputs for the inc03 calculation.
taxStatus
​string · enum · required
Enum values:
S
H
MS
MJ
T
Default: MJ
clientIncome
​number · min: 0 · max: 99999999 · required
Default: 0
qualifiedSavings
​number · min: 0 · max: 99999999 · required
Default: 0
itemizedDeductions
​number · min: 0 · max: 99999999 · required
Default: 0
dependents
​integer · min: 0 · max: 15 · required
Default: 0
notQualifiedDependents
​integer · min: 0 · max: 15 · required
Default: 2
unearnedIncome
​number · min: 0 · max: 99999999 · required
Default: 0
taxesStateLocal
​number · min: 0 · max: 99999999 · required
Default: 0
qualifiedTips
​number · min: 0 · max: 99999999 · required
Default: 0
qualifiedOvertime
​number · min: 0 · max: 99999999 · required
Default: 0
qualifiedCarInterest
​number · min: 0 · max: 99999999 · required
Default: 0
additionalDeduction
​string · enum · required
Enum values:
0
1
2
Default: 0
additionalAgeDeduction
​string · enum · required
Enum values:
0
1
2
Default: 0
passThrough
​number · min: -999999999 · max: 999999999 · required
Default: 0
ownershipPercentage
​number · min: 0 · max: 1 · required
Default: 1
totalAssets
​number · min: 0 · max: 99999999 · required
Default: 0
totalBusinessWages
​number · min: 0 · max: 99999999 · required
Default: 0
taxWithheld
​number · min: 0 · max: 99999999 · required
Default: 0
taxesLastPaycheck
​number · required
Default: 0
payperiod
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 24

Inc03Result

Result of the inc03 calculation.
avgTaxRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
marginalRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
adjGrossIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
deductions
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
exemptions
​string · required
taxableIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxLiabBeforeCredit
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
childTaxCredit
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
estimatedTaxLiability
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
curTaxesWithheld
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
futTaxesWithheld
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalWithheld
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
shortfallSurplus
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
yearlyWithholdings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Inc04Request

Inputs for the inc04 calculation.
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
dividend
​number · required
Default: 0
interest
​number · required
Default: 0
stCapGain
​number · required
Default: 0
margin
​number · required
Default: 0
other
​number · required
Default: 0

Inc04Result

Result of the inc04 calculation.
interestEarned
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestDeductible
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
carryOver
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Inc05Request

Inputs for the inc05 calculation.
selfEmployedIncome
​number · required
Default: 0
employerIncome
​number · required
Default: 0
taxStatus
​string · enum · required
Enum values:
S
H
MS
MJ
Default: MJ

Inc05Result

Result of the inc05 calculation.
ssEarnings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ssDeduction
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ssTaxable
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ssTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
medicareEarnings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
medicareDeduction
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
medicareTaxable
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
medicareTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalSETax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Inc06Request

Inputs for the inc06 calculation.
filingStatus
​integer · enum · required
Enum values:
1
2
3
4
Default: 2
taxableIncome
​number · required
Default: 0
purchasePrice1
​number · required
Default: 0
salesPrice1
​number · required
Default: 0
purchasePrice2
​number · required
Default: 0
salesPrice2
​number · required
Default: 0
purchasePrice3
​number · required
Default: 0
salesPrice3
​number · required
Default: 0
purchasePrice4
​number · required
Default: 0
salesPrice4
​number · required
Default: 0

Inc06Result

Result of the inc06 calculation.
ltCapLosses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ltNetGain
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ltTaxesDue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ltCapGains
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Inc07Request

Inputs for the inc07 calculation.
initialBalance
​number · required
Default: 0
annualSavings
​number · required
Default: 0
years
​integer · min: 1 · max: 50 · required
Default: 20
btReturnTaxable
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
btReturnDeferred
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
btReturnFree
​number · min: -0.12 · max: 0.12 · required
Default: 0.05
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25

Inc07Result

Result of the inc07 calculation.
atReturnTaxable
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
fvTaxable
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvDeferred
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvFree
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvatTaxable
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvatDeferred
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvatFree
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Inc07YearRow[] · required

Inc07YearRow

yearNumber
​integer | null · required
fullyTaxable
​number | null · required
taxDeferred
​number | null · required
taxFree
​number | null · required

Inc08Request

Inputs for the inc08 calculation.
taxStatus
​string · enum · required
Enum values:
1
2
3
4
Default: 1
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
ltCapGains
​number · min: -999999999 · max: 999999999 · required
Default: 0
stCapGains
​number · min: -999999999 · max: 999999999 · required
Default: 0
dividends
​number · required
Default: 0
taxableInterest
​number · required
Default: 0
taxFreeInterest
​number · required
Default: 0
pension
​number · required
Default: 0
ira
​number · required
Default: 0
other
​number · required
Default: 0
wages
​number · required
Default: 0
seIncome
​number · min: -999999999 · max: 999999999 · required
Default: 0
deductibleIRA
​number · required
Default: 0
ssBenefits
​number · required
Default: 0

Inc08Result

Result of the inc08 calculation.
line1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line3
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line4
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line5
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line6
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line7
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line8
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line9
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line10
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line11
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line12
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line13
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line14
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line15
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line16
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line17
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
line18
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxableSSBenefit
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
percentTaxable
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
taxesDue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Inc09Request

Inputs for the inc09 calculation.
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
firstMortgage
​number · required
Default: 0
secondMortgage
​number · required
Default: 0
homeEquity
​number · required
Default: 0
investmentPaid
​number · required
Default: 0
investmentReceived
​number · required
Default: 0
stCapGains
​number · min: -999999999 · max: 999999999 · required
Default: 0
business
​number · required
Default: 0
creditCard
​number · required
Default: 0
auto
​number · required
Default: 0
other
​number · required
Default: 0

Inc09Result

Result of the inc09 calculation.
mortgageTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
mortgageDeductible
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
mortgageSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
investmentTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
investmentDeductible
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
investmentSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
businessTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
businessDeductible
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
businessSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
personalTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
personalDeductible
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
personalSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestDeductible
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interestSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Inc10Request

Inputs for the inc10 calculation.
agi
​number · required
Default: 0
taxStatus
​string · enum · required
Enum values:
1
2
3
4
Default: 2
blind
​integer · min: 0 · max: 10 · required
Default: 0
senior
​integer · min: 0 · max: 10 · required
Default: 0
medical
​number · required
Default: 0
dental
​number · required
Default: 0
stateTaxes
​number · required
Default: 0
realEstateTaxes
​number · required
Default: 0
propertyTaxes
​number · required
Default: 0
otherTaxes
​number · required
Default: 0
mortgageInterest
​number · required
Default: 0
interestReceived
​number · required
Default: 0
interestPaid
​number · required
Default: 0
charityCash
​number · required
Default: 0
charityInKind
​number · required
Default: 0
charityCarryOver
​number · required
Default: 0

Inc10Result

Result of the inc10 calculation.
itemizeMedical
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
itemizeTaxes
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
itemizeInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
itemizeCharity
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
itemizeTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
standard
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Inc11Request

Inputs for the inc11 calculation.
taxFree
​number · min: -0.12 · max: 0.12 · required
Default: 0.05
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.05
stateTaxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.07

Inc11Result

Result of the inc11 calculation.
totTaxRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
teyFed
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
teyFedState
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Ins01Request

Inputs for the ins01 calculation.
clientAge
​integer · min: 1 · max: 120 · required
Default: 1
clientIncome
​number · required
Default: 0
spouseIncome
​number · required
Default: 0
spouseAge
​integer · min: 0 · max: 100 · required
Default: 0
spouseRetAge
​integer · min: 0 · max: 100 · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.05
inflation
​number · min: 0 · max: 0.1 · required
Default: 0.02
funeral
​number · required
Default: 0
finalExpenses
​number · required
Default: 0
mortgageBalance
​number · required
Default: 0
otherDebts
​number · required
Default: 0
desiredIncome
​number · required
Default: 0
term
​integer · min: 1 · max: 70 · required
Default: 20
collegeNeeds
​number · required
Default: 0
investmentAssets
​number · required
Default: 0
lifeInsurance
​number · required
Default: 0
includeSocsec
​string · enum · required
Enum values:
N
Y
Default: N
​object[] · minItems: 1 · maxItems: 4 · required

Ins01Result

Result of the ins01 calculation.
immediateNeeds
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
longtermNeeds
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalNeeds
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
spousesEarnings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
socialSecurity
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalResources
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
shortfall
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
lifeInsuranceNeeded
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ins01YearRow[] · required

Ins01YearRow

yearNumber
​integer | null · required
spouseAge
​integer | null · required
​required
​required
​required
​required
​required
​required
​required

Ins02Request

Inputs for the ins02 calculation.
gender
​string · enum · required
Enum values:
M
F
Default: M
currentAge
​integer · min: 1 · max: 120 · required
Default: 35

Ins02Result

Result of the ins02 calculation.
yearsToDeath
​number · required
deathAge
​number · required

Ins03Request

Inputs for the ins03 calculation.
basicServices
​number · required
Default: 650
embalming
​number · required
Default: 690
preparations
​number · required
Default: 385
viewing
​number · required
Default: 900
cemetary
​number · required
Default: 600
transfer
​number · required
Default: 195
hearse
​number · required
Default: 250
limousine
​number · required
Default: 175
casket
​number · required
Default: 3500
vault
​number · required
Default: 2500
memorial
​number · required
Default: 1000
clothing
​number · required
Default: 0
floral
​number · required
Default: 300
food
​number · required
Default: 0
airfare
​number · required
Default: 0
other
​number · required
Default: 0

Ins03Result

Result of the ins03 calculation.
totalExpenses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
facilitiesStaff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
merchandise
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
otherExpenses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
professionalServices
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
transportationServices
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Ins04Request

Inputs for the ins04 calculation.
spouseAftertaxIncome
​number · required
Default: 0
investmentIncome
​number · required
Default: 0
disabilityIncome
​number · required
Default: 0
otherIncome
​number · required
Default: 0
mortgage
​number · required
Default: 0
loans
​number · required
Default: 0
utilities
​number · required
Default: 0
food
​number · required
Default: 0
clothing
​number · required
Default: 0
transportation
​number · required
Default: 0
education
​number · required
Default: 0
medical
​number · required
Default: 0
insurance
​number · required
Default: 0
otherExpenses
​number · required
Default: 0

Ins04Result

Result of the ins04 calculation.
disabilityShortfall
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyExpenses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlySurplusShortfall
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Ins05Request

Inputs for the ins05 calculation.
age
​integer · min: 25 · max: 64 · required
Default: 30

Ins05Result

Result of the ins05 calculation.
odds
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
odds2
​string · required

Ins06Request

Inputs for the ins06 calculation.
clientAge
​integer · min: 1 · max: 120 · required
Default: 60
ltcAge
​integer · min: 1 · max: 120 · required
Default: 65
ltcCost
​number · required
Default: 50000
ltcInflation
​number · min: 0 · max: 0.1 · required
Default: 0.03
ltcYears
​integer · min: 1 · max: 40 · required
Default: 3
ltcAssets
​number · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
ltcIncreases
​number · min: 0 · max: 0.1 · required
Default: 0

Ins06Result

Result of the ins06 calculation.
legacy
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ltcTotalCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
neededSavingsLumpsum
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
neededSavingsYear
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ins06YearRow[] · required

Ins06YearRow

year
​integer | null · required
​required
​required
​required
​required
​required
​required

Ins07Request

Inputs for the ins07 calculation.
currentAge
​integer · min: 1 · max: 120 · required
Default: 35
retirementAge
​integer · min: 1 · max: 120 · required
Default: 65
currentIncome
​number · required
Default: 0
salaryIncreases
​number · min: 0 · max: 0.1 · required
Default: 0.05

Ins07Result

Result of the ins07 calculation.
lifetimeEarnings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
yearsLeft
​integer · required
​Ins07YearRow[] · required

Ins07YearRow

age
​integer | null · required
​required
​required

Ins08Request

Inputs for the ins08 calculation.
initialBalance
​number · required
Default: 0
annualSavings
​number · required
Default: 0
savingsIncrease
​number · min: 0 · max: 0.1 · required
Default: 0
numYears
​integer · min: 1 · max: 50 · required
Default: 20
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.04
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
taxBracketRetirement
​number · min: 0 · max: 0.75 · required
Default: 0.22

Ins08Result

Result of the ins08 calculation.
afterTaxSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxableSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annuitySavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
difference
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ins08YearRow[] · required

Ins08YearRow

yearNumber
​integer | null · required
​required
​required
​required
​required
​required
​required
​required
​required

Ins09Request

Inputs for the ins09 calculation.
lifeInsurance
​number · required
Default: 0
survivorNeeds
​number · required
Default: 0
inflation
​number · min: 0 · max: 0.1 · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
amortization
​integer · enum · required
Enum values:
1
2
Default: 2

Ins09Result

Result of the ins09 calculation.
period
​integer · required
yearsLast
​number · required
totalWithdrawals
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ins09YearRow[] · required

Ins09YearRow

month
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxes
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
withdrawal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Ins10Request

Inputs for the ins10 calculation.
initialBalance
​number · required
Default: 0
annualSavings
​number · required
Default: 0
savingsIncrease
​number · min: 0 · max: 0.1 · required
Default: 0
​object[] · minItems: 1 · maxItems: 10 · required
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25
taxBracketRetirement
​number · min: 0 · max: 0.75 · required
Default: 0.25
introRate
​number · min: -0.12 · max: 0.12 · required
Default: 0
introRateYears
​integer · min: 1 · max: 50 · required
Default: 1
annuityRate
​number · min: -0.12 · max: 0.12 · required
Default: 0
annuityRateMinimum
​number · min: -0.12 · max: 0.12 · required
Default: 0

Ins10Result

Result of the ins10 calculation.
taxableSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
accumulationExpected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
accumulationMinimum
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
accumulationExpectedSurrender
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
accumulationMinimumSurrender
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxFutureValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
guaranteedSurrenderValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ins10YearRow[] · required

Ins10YearRow

yearNumber
​integer | null · required
​required
​required
​required
​required
​required
​required
​required

Ins11Request

Inputs for the ins11 calculation.
chpDeductible
​number · required
Default: 500
chpCoinsurance
​number · min: 0 · max: 1 · required
Default: 0.2
chpMaxOop
​number · required
Default: 3000
chpPremium
​number · required
Default: 1200
hdpDeductible
​number · required
Default: 7500
hdpCoinsurance
​number · min: 0 · max: 1 · required
Default: 0
hdpMaxOop
​number · required
Default: 4500
hdpPremium
​number · required
Default: 1000
yearlyMedicalCosts
​number · required
Default: 10000
totalTaxRate
​number · min: 0 · max: 0.75 · required
Default: 0.3
planType
​string · enum · required
Enum values:
S
F
Default: S
employerContribution
​number · required
Default: 0

Ins11Result

Result of the ins11 calculation.
chpOopStated
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
chpMedExpensesMaximum
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
hdpOopStated
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
hdpMedExpensesMaximum
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
insurancePremiumSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ins11AmountRow[] · required

Ins11AmountRow

yearlyExpense
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
chpOop
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
hdpBeforeHsa
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
hsa
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
hdpWithHsa
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Ins12Request

Inputs for the ins12 calculation.
currentAge
​integer · min: 30 · max: 99 · required
Default: 40
initialBalance
​number · required
Default: 0
annualSavings
​number · required
Default: 0
savingsIncrease
​number · min: 0 · max: 2 · required
Default: 0
distributionAge
​integer · min: 30 · max: 99 · required
Default: 65
distributionYears
​integer · min: 1 · max: 40 · required
Default: 20
withdrawal
​number · required
Default: 0
distributionsIncrease
​number · min: 0 · max: 1 · required
Default: 0
taxBracketWithdrawals
​number · min: 0 · max: 0.75 · required
Default: 0.25
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.06
beforeTaxReturnAnnuity
​number · min: -0.12 · max: 0.12 · required
Default: 0.06
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25
qualified
​string · enum · required
Enum values:
N
Y
Default: N

Ins12Result

Result of the ins12 calculation.
yearsUntilWithdrawal
​integer · required
totalYearsOfAnalysis
​integer · required
cumulativeBasis
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxableAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxAdvantagedAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxableRunsOut
​number · required
taxAdvantagedRunsOut
​number · required
​Ins12YearRow[] · required

Ins12YearRow

age
​integer | null · required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required

Ins13Request

Inputs for the ins13 calculation.
initialInvestment
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.1 · required
Default: 0.05
paymentMonths
​integer · min: 1 · max: 120 · required
Default: 120

Ins13Result

Result of the ins13 calculation.
paymentAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalPayout
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
payoutYears
​number · required

Inv01Request

Inputs for the inv01 calculation.
timeHorizon
​string · enum · required
Enum values:
A
B
C
D
E
Default: A
withdrawalPeriod
​string · enum · required
Enum values:
A
B
C
D
E
Default: A
emergencyReserve
​string · enum · required
Enum values:
A
B
C
D
E
Default: A
incomeStability
​string · enum · required
Enum values:
A
B
C
D
E
Default: A
guaranteedIncomeShare
​string · enum · required
Enum values:
A
B
C
D
E
Default: A
goalFlexibility
​string · enum · required
Enum values:
A
B
C
D
E
Default: A
drawdownResponse
​string · enum · required
Enum values:
A
B
C
D
E
Default: A
priorDownturnBehavior
​string · enum · required
Enum values:
A
B
C
D
E
Default: A
returnRangePreference
​string · enum · required
Enum values:
A
B
C
D
E
Default: A
steadyGrowthPreference
​string · enum · required
Enum values:
A
B
C
D
E
Default: A

Inv01Result

Result of the inv01 calculation.
cash
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
fixed
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
equity
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
realAssets
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
shortTermBonds
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
coreBonds
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
inflationProtected
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
internationalBonds
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
usLargeCap
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
usSmallMidCap
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
internationalEquity
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
emergingMarkets
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
recommendedProfile
​RecommendedProfile · enum · required
Enum values:
aggressive
conservative
defensive
moderate
moderately_aggressive
very_aggressive
very_defensive
recommendedProfileType
​integer · required
capacityIndex
​integer · required
toleranceIndex
​integer · required
toleranceProfile
​RecommendedProfile · enum · required
Enum values:
aggressive
conservative
defensive
moderate
moderately_aggressive
very_aggressive
very_defensive
toleranceProfileType
​integer · required
governingIndex
​integer · required
riskGap
​integer · required
bindingConstraint
​BindingConstraint · enum · required
Enum values:
ability
balanced
willingness
toleranceEvidence
​ToleranceEvidence · enum · required
Enum values:
observed
stated

RecommendedProfile

string · enum
Enum values:
aggressive
conservative
defensive
moderate
moderately_aggressive
very_aggressive
very_defensive

BindingConstraint

string · enum
Enum values:
ability
balanced
willingness

ToleranceEvidence

string · enum
Enum values:
observed
stated

Inv02Request

Inputs for the inv02 calculation.
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
stateTaxBracket
​number · min: 0 · max: 0.75 · required
Default: 0
itemize
​string · enum · required
Enum values:
N
Y
Default: N

Inv02Result

Result of the inv02 calculation.
fedTaxes
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
stateTaxes
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
itemizeAdjust
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
afterTaxReturn
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
​Inv02YieldRow[] · required

Inv02YieldRow

beforeTax
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
fullyTaxable
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
stateOnly
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
fedOnly
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
notTaxable
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Inv03Request

Inputs for the inv03 calculation.
bondFace
​number · required
Default: 0
mostomaturity
​integer · min: 1 · max: 40 · required
Default: 5
couponRate
​number · min: -0.12 · max: 0.12 · required
Default: 0
marketRate
​number · min: -0.12 · max: 0.12 · required
Default: 0
desiredYield
​number · min: -0.12 · max: 0.12 · required
Default: 0

Inv03Result

Result of the inv03 calculation.
coupon
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
marketPrice
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
yieldPrice
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Inv04Request

Inputs for the inv04 calculation.
purchasePrice
​number · required
Default: 0
marketValue
​number · required
Default: 0
cash
​number · required
Default: 0
realEstate
​number · min: 0 · max: 3 · required
Default: 0.8
interestOnly
​string · enum · required
Enum values:
N
Y
Default: N
loanAmount
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.4 · required
Default: 0
loanTerm
​integer · min: 1 · max: 50 · required
Default: 5
closingCosts
​number · required
Default: 0
rentalIncome
​number · required
Default: 0
incomeFrequency
​integer · enum · required
Enum values:
0
1
Default: 0
rentIncreases
​number · min: 0 · max: 0.1 · required
Default: 0
occupancyRate
​number · min: 0 · max: 1 · required
Default: 1
propertyTax
​number · required
Default: 0
insurance
​number · required
Default: 0
maintenance
​number · required
Default: 0
hoa
​number · required
Default: 0
expenseIncreases
​number · min: 0 · max: 0.1 · required
Default: 0
analysisYears
​integer · min: 0 · max: 20 · required
Default: 20
realtorFees
​number · min: 0 · max: 0.4 · required
Default: 0
appreciation
​number · min: 0 · max: 0.75 · required
Default: 0
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
capitalGains
​number · min: 0 · max: 0.75 · required
Default: 0.15

Inv04Result

Result of the inv04 calculation.
​Inv04YearRow[] · required

Inv04YearRow

year
​integer | null · required
​required
​required
​required
​required

Inv05Request

Inputs for the inv05 calculation.
initialBalance
​number · required
Default: 0
annualSavings
​number · required
Default: 0
savingsIncrease
​number · min: 0 · max: 0.1 · required
Default: 0
numYears
​integer · min: 1 · max: 50 · required
Default: 20
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08

Inv05Result

Result of the inv05 calculation.
​Inv05YearRow[] · required

Inv05YearRow

yearNumber
​number | null · required
​required
​required
​required
​required

Inv06Request

Inputs for the inv06 calculation.
callPut
​integer · enum · required
Enum values:
1
2
Default: 1
purchasePrice
​number · required
Default: 0
totalShares
​integer · required
Default: 0
strikePrice
​number · required
Default: 0
currentPrice
​number · required
Default: 0

Inv06Result

Result of the inv06 calculation.
shareValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
exercisePrice
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
grossValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
optionStatus
​OptionStatus · enum · required
Enum values:
in the money
out of the money

OptionStatus

string · enum
Enum values:
in the money
out of the money

Inv07Request

Inputs for the inv07 calculation.
initialBalance
​number · required
Default: 0
annualSavings
​number · required
Default: 0
savingsIncrease
​number · min: 0 · max: 1 · required
Default: 0
years
​integer · min: 1 · max: 50 · required
Default: 30
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25
compounding
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 1

Inv07Result

Result of the inv07 calculation.
taxableAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxAdvantagedAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Inv07YearRow[] · required

Inv07YearRow

year
​integer | null · required
​required
​required
​required
​required
​required
​required
​required
​required

Inv08Request

Inputs for the inv08 calculation.
drawdownResponse
​string · enum · required
Enum values:
A
B
C
D
E
Default: A
priorDownturnBehavior
​string · enum · required
Enum values:
A
B
C
D
E
Default: A
returnRangePreference
​string · enum · required
Enum values:
A
B
C
D
E
Default: A
steadyGrowthPreference
​string · enum · required
Enum values:
A
B
C
D
E
Default: A

Inv08Result

Result of the inv08 calculation.
toleranceIndex
​integer · required
toleranceProfileType
​integer · required
toleranceProfile
​string · required
toleranceEvidence
​ToleranceEvidence · enum · required
Enum values:
observed
stated

Inv09Request

Inputs for the inv09 calculation.
initialBalance
​number · required
Default: 0
annualContributions
​number · required
Default: 0
projectionYears
​integer · min: 1 · max: 40 · required
Default: 20
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25

Inv09Result

Result of the inv09 calculation.
currentReturn
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
returnPlusOne
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
returnPlusTwo
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
returnPlusThree
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
afterTaxRatePlusOne
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
afterTaxRatePlusTwo
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
afterTaxRatePlusThree
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
​Inv09YearRow[] · required

Inv09YearRow

year
​integer | null · required
​required
​required
​required
​required

Inv10Request

Inputs for the inv10 calculation.
initialBalance
​number · required
Default: 0
months
​integer · min: 1 · max: 120 · required
Default: 60
cdRate
​number · min: -0.12 · max: 0.12 · required
Default: 0.02
compoundingFrequency
​integer · enum · required
Enum values:
365
12
4
2
1
Default: 12
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25

Inv10Result

Result of the inv10 calculation.
frequency
​Frequency · enum · required
Enum values:
annually
daily
monthly
quarterly
semiannual
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
apy
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
​Inv10YearRow[] · required

Inv10YearRow

yearNumber
​integer | null · required
​required
​required
​required
​required

Frequency

string · enum
Enum values:
annually
daily
monthly
quarterly
semiannual

Inv11Request

Inputs for the inv11 calculation.
sharePrice
​number · required
Default: 0
sharesOwned
​integer · required
Default: 0
dividend
​number · required
Default: 0
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22

Inv11Result

Result of the inv11 calculation.
preTaxYield
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
afterTaxYield
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
quarterlyReturn
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
quarterlyTaxes
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Inv12Request

Inputs for the inv12 calculation.
initialDeposit
​number · required
Default: 0
frontLoad
​number · min: 0 · max: 1 · required
Default: 0
backLoad
​number · min: 0 · max: 1 · required
Default: 0
operatingExpenses
​number · min: 0 · max: 1 · required
Default: 0
otherFees
​number · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
holdingPeriod
​integer · min: 1 · max: 30 · required
Default: 30

Inv12Result

Result of the inv12 calculation.
frontLoadAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
backLoadAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
operatingExpensesAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
opportunityCost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalExpenses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Inv12YearRow[] · required

Inv12YearRow

year
​integer | null · required
​required
​required
​required
​required

Inv13Request

Inputs for the inv13 calculation.
initialBalance
​number · required
Default: 0
compoundingFrequency
​integer · enum · required
Enum values:
365
12
4
2
1
Default: 12
years
​integer · min: 1 · max: 5 · required
Default: 5
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0
cdRate
​number · min: 0 · max: 0.12 · required
Default: 0.0275
cdRate2
​number · min: 0 · max: 0.12 · required
Default: 0.03
cdRate3
​number · min: 0 · max: 0.12 · required
Default: 0.0325
cdRate4
​number · min: 0 · max: 0.12 · required
Default: 0.035
cdRate5
​number · min: 0 · max: 0.12 · required
Default: 0.0375

Inv13Result

Result of the inv13 calculation.
frequency
​Frequency · enum · required
Enum values:
annually
daily
monthly
quarterly
semiannual
totalSingleCd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCdLaddering
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
additionalAfterTaxSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
initialInvestments
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Inv13YearRow[] · required

Inv13YearRow

year
​integer | null · required
​required
​required
​required
​required
​required

Inv16Request

Inputs for the inv16 calculation.
futureValue
​number · required
Default: 5000
percentLoss
​number · min: 0 · max: 0.99 · required
Default: 0.15
presentValue
​number · required
Default: 0

Inv16Result

Result of the inv16 calculation.
percentLossReturn
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
balanceLossReturn
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
balanceReduction
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
reduction
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Pay01Request

Inputs for the pay01 calculation.
bonus
​number · min: 0 · max: 99999999 · required
Default: 0
payperiod
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 26
pay1
​number · min: 0 · max: 99999999 · required
Default: 0
file1
​string · enum · required
Enum values:
M
S
Default: M
allow1
​integer · min: 0 · max: 25 · required
Default: 2
pretax1
​number · min: 0 · max: 99999999 · required
Default: 0
cont1
​number · min: 0 · max: 1 · required
Default: 0
posttax1
​number · min: 0 · max: 99999999 · required
Default: 0
reimb1
​number · min: 0 · max: 99999999 · required
Default: 0

Pay01Result

Result of the pay01 calculation.
fedtax1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fedtaxdiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fica1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ficadiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ficahi1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ficahidiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
cont1dollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contdollardiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totdeduct1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totdeductdiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
takehome1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
takehomediff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Pay02Request

Inputs for the pay02 calculation.
payperiod
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 26
pay1
​number · min: 0 · max: 99999999 · required
Default: 0
pay2
​number · min: 0 · max: 99999999 · required
Default: 0
file1
​string · enum · required
Enum values:
M
S
Default: M
file2
​string · enum · required
Enum values:
M
S
Default: M
allow1
​integer · min: 0 · max: 25 · required
Default: 2
allow2
​integer · min: 0 · max: 25 · required
Default: 2
pretax1
​number · min: 0 · max: 99999999 · required
Default: 0
pretax2
​number · min: 0 · max: 99999999 · required
Default: 0
cont1
​number · min: 0 · max: 1 · required
Default: 0
cont2
​number · min: 0 · max: 1 · required
Default: 0
posttax1
​number · min: 0 · max: 99999999 · required
Default: 0
posttax2
​number · min: 0 · max: 99999999 · required
Default: 0
reimb1
​number · min: 0 · max: 99999999 · required
Default: 0
reimb2
​number · min: 0 · max: 99999999 · required
Default: 0

Pay02Result

Result of the pay02 calculation.
paydiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
allowdiff
​number · required
fedtax1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fedtax2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fedtaxdiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
pretaxdiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fica1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fica2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ficadiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ficahi1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ficahi2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ficahidiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contdiff
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
cont1dollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
cont2dollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contdollardiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
posttaxdiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
reimbdiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totdeduct1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totdeduct2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totdeductdiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
takehome1
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
takehome2
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
takehomediff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Pay03Request

Inputs for the pay03 calculation.
annualSalary
​number · required
Default: 0
hoursPerWeek
​integer · min: 1 · max: 80 · required
Default: 40
weeksPerYear
​integer · min: 1 · max: 52 · required
Default: 52

Pay03Result

Result of the pay03 calculation.
monthlyPay
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
weeklyPay
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
hourlyPay
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Pay04Request

Inputs for the pay04 calculation.
hourlyWage
​number · required
Default: 0
hoursPerWeek
​integer · min: 1 · max: 80 · required
Default: 40
weeksPerYear
​integer · min: 1 · max: 52 · required
Default: 52

Pay04Result

Result of the pay04 calculation.
weeklyPay
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlyPay
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
yearlyPay
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Pay05Request

Inputs for the pay05 calculation.
exDate
​integer · min: 0 · max: 20 · required
Default: 0
totalShares
​integer · min: 0 · max: 999999 · required
Default: 0
currentPrice
​number · min: 0 · max: 9999 · required
Default: 0
strikePrice
​number · min: 0 · max: 9999 · required
Default: 0
expectedReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08

Pay05Result

Result of the pay05 calculation.
​Pay05YearRow[] · required

Pay05YearRow

return
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
futureValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
strike
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
gain
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Pay06Request

Inputs for the pay06 calculation.
exDate
​integer · min: 0 · max: 20 · required
Default: 0
totalShares
​integer · min: 0 · max: 999999 · required
Default: 0
currentPrice
​number · min: 0 · max: 9999 · required
Default: 0
strikePrice
​number · min: 0 · max: 9999 · required
Default: 0
expectedReturn
​number · min: -0.5 · max: 0.5 · required
Default: 0.08
dividends
​number · min: 0 · max: 9999 · required
Default: 0
alternativeReturn
​number · min: -0.5 · max: 0.5 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
capgainsRate
​number · min: 0 · max: 0.75 · required
Default: 0.15

Pay06Result

Result of the pay06 calculation.
exerciseHold
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
exerciseSell
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
exerciseDefer
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Pay06YearRow[] · required

Pay06YearRow

text
​string · required
hold
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
sell
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
defer
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Pay07Request

Inputs for the pay07 calculation.
yrstoretirement
​integer · min: 1 · max: 50 · required
Default: 30
clientIncome
​number · required
Default: 0
salaryIncreases
​number · min: 0 · max: 0.1 · required
Default: 0.03
planBalance
​number · required
Default: 0
compounding
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 26
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
employerMatch
​number · min: 0 · max: 3 · required
Default: 1
maximumMatch
​number · min: 0 · max: 0.2 · required
Default: 0.03
currentContribution
​number · min: 0 · max: 0.5 · required
Default: 0.04

Pay07Result

Result of the pay07 calculation.
yourcontDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
empmatchDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
empmaxmatchDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvYourcont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvEmpcont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contributionCapped
​number · required
currentYear
​number · required
maxContribution
​number · required
totalValueText
​string · required
​Pay07YearRow[] · required

Pay07YearRow

yearNumber
​integer | null · required
​required
​required
​required
​required
​required

Pay08Request

Inputs for the pay08 calculation.
yrstoretirement
​integer · min: 1 · max: 50 · required
Default: 30
clientIncome
​number · required
Default: 0
salaryIncreases
​number · min: 0 · max: 0.1 · required
Default: 0.05
planBalance
​number · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
compounding
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 26
employerMatch
​number · min: 0 · max: 3 · required
Default: 1
maximumMatch
​number · min: 0 · max: 0.2 · required
Default: 0.03
currentContribution
​number · min: 0 · max: 1 · required
Default: 0.04
proposedContribution
​number · min: 0 · max: 1 · required
Default: 0.06

Pay08Result

Result of the pay08 calculation.
currcontTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
propcontTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
ercurrcontTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
erpropcontTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvCurrcont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvPropcont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
increase
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
outofpocket
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contributionCapped
​number · required
increaseContribution
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
currentYear
​number · required
maxContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Pay08YearRow[] · required

Pay08YearRow

yearNumber
​integer | null · required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required

Pay11Request

Inputs for the pay11 calculation.
yrstoretirement
​integer · min: 1 · max: 50 · required
Default: 30
clientIncome
​number · required
Default: 0
salaryIncreases
​number · min: 0 · max: 0.1 · required
Default: 0.03
planBalance
​number · required
Default: 0
compounding
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 26
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
employerMatch
​number · min: 0 · max: 3 · required
Default: 1
maximumMatch
​number · min: 0 · max: 0.2 · required
Default: 0.03
currentContribution
​number · min: 0 · max: 0.2 · required
Default: 0.04

Pay11Result

Result of the pay11 calculation.
yourcontDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
empmatchDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
empmaxmatchDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvYourcont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvEmpcont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contributionCapped
​number · required
maxContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentYear
​number · required
​Pay11YearRow[] · required

Pay11YearRow

yearNumber
​integer | null · required
​required
​required
​required
​required
​required

Pay13Request

Inputs for the pay13 calculation.
planBalance
​number · required
Default: 0
employeeHSAContribution
​number · required
Default: 0
employerHSAContribution
​number · required
Default: 0
annualHSAExpenses
​number · required
Default: 0
yrstoretirement
​integer · min: 1 · max: 50 · required
Default: 30
compounding
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 26
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08

Pay13Result

Result of the pay13 calculation.
yourContDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
empMatchDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvYourCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvEmpCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contributionCapped
​number · required
maxContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentYear
​number · required
​Pay13YearRow[] · required

Pay13YearRow

yearNumber
​integer | null · required
​required
​required
​required
​required
endBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Pay14Request

Inputs for the pay14 calculation.
yrstoretirement
​integer · min: 1 · max: 50 · required
Default: 30
clientIncome
​number · required
Default: 0
salaryIncreases
​number · min: 0 · max: 0.1 · required
Default: 0.03
planBalance
​number · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
currentContribution
​number · min: 0 · max: 3 · required
Default: 0

Pay14Result

Result of the pay14 calculation.
empContDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvEmpCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Pay14YearRow[] · required

Pay14YearRow

yearNumber
​integer | null · required
​required
​required
​required
endBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Pay15Request

Inputs for the pay15 calculation.
clientIncome
​number · required
Default: 0
employeeContribution
​number · min: 0 · max: 1 · required
Default: 0.04
employerMatch
​number · min: 0 · max: 1 · required
Default: 0.5
maximumMatch
​number · min: 0 · max: 1 · required
Default: 0.06

Pay15Result

Result of the pay15 calculation.
currentEEContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentERContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
additionalERMatch
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
additionalEEMatch
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Qua01Request

Inputs for the qua01 calculation.
singleLifePension
​number · required
Default: 0
jointLifePension
​number · required
Default: 0
payoutIncrease
​number · min: 0 · max: 0.1 · required
Default: 0
age
​integer · min: 1 · max: 120 · required
Default: 35
spouseAge
​integer · min: 1 · max: 120 · required
Default: 35
retirementAge
​integer · min: 1 · max: 120 · required
Default: 65
death
​integer · min: 1 · max: 120 · required
Default: 80
spouseDeath
​integer · min: 1 · max: 120 · required
Default: 80
beforeTaxReturn
​number · min: 0 · max: 0.12 · required
Default: 0.08

Qua01Result

Result of the qua01 calculation.
breakEven
​integer · required
spouseBreakEven
​integer · required
singleLifeTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
jointLifeTotal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Qua01YearRow[] · required

Qua01YearRow

yearNumber
​integer | null · required
clientAge
​integer · required
spouseAge
​integer · required
​required
​required
​required
​required
​required

Qua02Request

Inputs for the qua02 calculation.
taxYear
​string · enum · required
Enum values:
2025
2026
Default: 2025
magi
​number · required
Default: 0
taxStatus
​integer · enum · required
Enum values:
1
2
3
Default: 2
clientParticipate
​string · enum · required
Enum values:
N
Y
Default: Y
spouseParticipate
​string · enum · required
Enum values:
N
Y
Default: N
clientEarnedIncome
​number · required
Default: 0
spouseEarnedIncome
​number · required
Default: 0
clientAge
​integer · min: 1 · max: 120 · required
Default: 30
spouseAge
​integer · min: 0 · max: 120 · required
Default: 0

Qua02Result

Result of the qua02 calculation.
taxStatusOutput
​FilingStatus · enum · required
Enum values:
single_or_head_of_household
married_filing_jointly
married_filing_separately
nondedClientElig
​YesNo · enum · required
Enum values:
yes
no
dedClientElig
​YesNo · enum · required
Enum values:
yes
no
rothClientElig
​YesNo · enum · required
Enum values:
yes
no
nondedClientCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
dedClientCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rothClientCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
nondedSpouseElig
​YesNoNotApplicable · enum · required
Enum values:
yes
no
not_applicable
dedSpouseElig
​YesNoNotApplicable · enum · required
Enum values:
yes
no
not_applicable
rothSpouseElig
​YesNoNotApplicable · enum · required
Enum values:
yes
no
not_applicable
nondedSpouseCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
dedSpouseCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rothSpouseCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

FilingStatus

string · enum
Enum values:
single_or_head_of_household
married_filing_jointly
married_filing_separately

YesNo

string · enum
Enum values:
yes
no

YesNoNotApplicable

string · enum
Enum values:
yes
no
not_applicable

Qua03Request

Inputs for the qua03 calculation.
currentAge
​integer · min: 1 · max: 120 · required
Default: 35
retirementAge
​integer · min: 1 · max: 120 · required
Default: 65
yearsNeeded
​integer · min: 1 · max: 120 · required
Default: 20
accBeforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
distBeforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
accTaxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25
distTaxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25
annualContribution
​number · required
Default: 0
option
​integer · enum · required
Enum values:
1
2
Default: 1

Qua03Result

Result of the qua03 calculation.
adjustmentTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
adjustmentTradNon
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
adjustmentTrad
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
adjustmentRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxContTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxContTradNon
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxContTrad
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxContRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
accIntRateTax
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
accIntRateTradNon
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
accIntRateTrad
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
accIntRateRoth
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
accTermTax
​integer · required
accTermTradNon
​integer · required
accTermTrad
​integer · required
accTermRoth
​integer · required
valueTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
valueTradNon
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
valueTrad
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
valueRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distTermTax
​integer · required
distTermTradNon
​integer · required
distTermTrad
​integer · required
distTermRoth
​integer · required
distIntRateTax
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
distIntRateTradNon
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
distIntRateTrad
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
distIntRateRoth
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
beforeTaxAnnIncTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforeTaxAnnIncTradNon
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforeTaxAnnIncTrad
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beforeTaxAnnIncRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxTradNon
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxTrad
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxAnnIncTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxAnnIncTradNon
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxAnnIncTrad
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxAnnIncRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxMoIncTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxMoIncTradNon
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxMoIncTrad
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
afterTaxMoIncRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Qua04Request

Inputs for the qua04 calculation.
currentAge
​integer · min: 1 · max: 120 · required
Default: 35
retirementAge
​integer · min: 1 · max: 120 · required
Default: 65
yearsNeeded
​integer · min: 1 · max: 30 · required
Default: 20
accBeforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
distBeforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
accTaxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
distTaxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
iraBalance
​number · required
Default: 0
nondedIra
​number · required
Default: 0
option
​integer · enum · required
Enum values:
1
2
Default: 2

Qua04Result

Result of the qua04 calculation.
convIraBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
convSideAccount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxesFees
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
adjustedIra
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
adjustedRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projIraDed
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projIraNonded
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projSideAccount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projRetIra
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projRetRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distIraDed
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distIraNonded
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distSideAccount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distAnnualIraIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distAnnualRothIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distMoIraIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distMoRothIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
delayTaxPmtTaxable
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
delayTaxPmtRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Qua05Request

Inputs for the qua05 calculation.
yrsToRetirement
​integer · min: 1 · max: 50 · required
Default: 30
clientIncome
​number · required
Default: 0
salaryIncreases
​number · min: 0 · max: 0.2 · required
Default: 0.05
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
employeePlanBalance
​number · required
Default: 0
employeePlanContribution
​number · min: 0 · max: 0.25 · required
Default: 0.04
employerMatch
​number · min: 0 · max: 3 · required
Default: 1
maximumMatch
​number · min: 0 · max: 0.2 · required
Default: 0.03
individualPlanBalance
​number · required
Default: 0
individualPlanContribution
​number · required
Default: 0
individualPlanIncreases
​number · min: 0 · max: 3 · required
Default: 0

Qua05Result

Result of the qua05 calculation.
existingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalYourContributions
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalEmployerContributions
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalGrowth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contributionCapped
​number · required
maxContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentYear
​number · required
​Qua05YearRow[] · required

Qua05YearRow

yearNumber
​integer | null · required
​required
​required
​required
​required
​required

Qua06Request

Inputs for the qua06 calculation.
yyyyRmd
​integer · min: 2010 · max: 2040 · required
Default: 2026
dobMmOwner
​integer · min: 1 · max: 12 · required
Default: 12
dobDdOwner
​integer · min: 1 · max: 31 · required
Default: 1
dobYyyyOwner
​integer · min: 1920 · max: 2024 · required
Default: 1950
dobMmBeneficiary
​integer · min: 1 · max: 12 · required
Default: 12
dobDdBeneficiary
​integer · min: 1 · max: 31 · required
Default: 1
dobYyyyBeneficiary
​integer · min: 1920 · max: 2024 · required
Default: 1948
spouseBeneficiary
​string · enum · required
Enum values:
N
Y
Default: Y
accountBalance
​number · required
Default: 0
planType
​string · enum · required
Enum values:
1
2
3
4
5
6
7
8
Default: 1

Qua06Result

Result of the qua06 calculation.
ageOwner
​integer · required
ageBeneficiary
​integer · required
tableUsed
​RmdTable · enum · required
Enum values:
uniform_lifetime
single_life
distributionFactor
​number · required
minimumDistribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

RmdTable

string · enum
Enum values:
uniform_lifetime
single_life

Qua07Request

Inputs for the qua07 calculation.
yyyyRmd
​integer · min: 2010 · max: 2040 · required
Default: 2026
dobMmOwner
​integer · min: 1 · max: 12 · required
Default: 12
dobDdOwner
​integer · min: 1 · max: 31 · required
Default: 31
dobYyyyOwner
​integer · min: 1920 · max: 2024 · required
Default: 1950
dobMmBeneficiary
​integer · min: 1 · max: 12 · required
Default: 12
dobDdBeneficiary
​integer · min: 1 · max: 31 · required
Default: 31
dobYyyyBeneficiary
​integer · min: 1950 · max: 2024 · required
Default: 1950
spouseBeneficiary
​string · enum · required
Enum values:
N
Y
Default: Y
accountBalance
​number · required
Default: 0
returnRate
​number · min: 0 · max: 0.1 · required
Default: 0
planType
​string · enum · required
Enum values:
1
2
3
4
5
6
7
8
Default: 1

Qua07Result

Result of the qua07 calculation.
ageOwner
​integer · required
ageBeneficiary
​integer · required
tableUsed
​RmdTable · enum · required
Enum values:
uniform_lifetime
single_life
​Qua07YearRow[] · required

Qua07YearRow

yearNumber
​integer | null · required
age
​integer | null · required
​required
​required
divisor
​number | null · required
​required
​required

Qua08Request

Inputs for the qua08 calculation.
clientAge
​integer · min: 1 · max: 120 · required
Default: 35
participationYear
​integer · min: 1950 · max: 2024 · required
Default: 2000
distributionAmount
​number · required
Default: 0
entireBalance
​string · enum · required
Enum values:
N
Y
Default: Y
disability
​string · enum · required
Enum values:
N
Y
Default: N
services
​string · enum · required
Enum values:
N
Y
Default: Y
taxStatus
​string · enum · required
Enum values:
1
2
3
4
Default: 1
taxableIncome
​number · required
Default: 0
retirementAge
​integer · min: 1 · max: 120 · required
Default: 65
retirementYears
​integer · min: 1 · max: 40 · required
Default: 20
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
retBeforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
federalTaxRate
​number · min: 0 · max: 0.75 · required
Default: 0.25
retFederalTaxRate
​number · min: 0 · max: 0.75 · required
Default: 0.25
stateTaxRate
​number · min: 0 · max: 0.75 · required
Default: 0
retStateTaxRate
​number · min: 0 · max: 0.75 · required
Default: 0

Qua08Result

Result of the qua08 calculation.
eligibleOrd
​string · required
eligibleIra
​string · required
eligibleRoth
​string · required
incomeOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
incomeIra
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
incomeRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollTaxableOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollTaxableIra
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollTaxableRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollWithheldOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollWithheldIra
​string · required
rollWithheldRoth
​string · required
rollAdditionalOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollAdditionalIra
​string · required
rollAdditionalRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollStateOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollStateIra
​string · required
rollStateRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollPenaltyOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollPenaltyIra
​string · required
rollPenaltyRoth
​string · required
rollInvestableOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollInvestableIra
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
rollInvestableRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
accBalanceOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
accBalanceIra
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
accBalanceRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
accReturnOrd
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
accReturnIra
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
accReturnRoth
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
accTaxOrd
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
accTaxIra
​number · required
accTaxRoth
​number · required
accYearsOrd
​integer · required
accYearsIra
​integer · required
accYearsRoth
​integer · required
accValueOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
accValueIra
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
accValueRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distValueOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distValueIra
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distValueRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distReturnOrd
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
distReturnIra
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
distReturnRoth
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
distTaxOrd
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
distTaxIra
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
distTaxRoth
​number · required
distPaymentsOrd
​integer · required
distPaymentsIra
​integer · required
distPaymentsRoth
​integer · required
distAnnualOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distAnnualIra
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distAnnualRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distTaxesOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distTaxesIra
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distTaxesRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distNetOrd
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distNetIra
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
distNetRoth
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Qua09Request

Inputs for the qua09 calculation.
payPeriod
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 26
clientIncome
​number · required
Default: 0
clientAge
​integer · min: 1 · max: 120 · required
Default: 30
employerMatch
​number · min: 0 · max: 3 · required
Default: 1
maximumMatch
​number · min: 0 · max: 0.2 · required
Default: 0.03
employerMatch2
​number · min: 0 · max: 3 · required
Default: 0.5
maximumMatch2
​number · min: 0 · max: 0.2 · required
Default: 0

Qua09Result

Result of the qua09 calculation.
optimum
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
totalContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Qua09ContributionRow[] · required

Qua09ContributionRow

yourContPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
yourContDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
empContPercent
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
empContDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
empContPercentTotal
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Qua10Request

Inputs for the qua10 calculation.
loanAmount401k
​number · required
Default: 0
loanRate401k
​number · min: 0 · max: 0.4 · required
Default: 0.06
yearsToRetirement
​integer · min: 1 · max: 70 · required
Default: 20
loanTerm401k
​integer · min: 1 · max: 20 · required
Default: 5
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
debtPayoff
​string · enum · required
Enum values:
N
Y
Default: N
debtInterestRate
​number · min: 0 · max: 0.4 · required
Default: 0.18
interestDeductible
​string · enum · required
Enum values:
N
Y
Default: N
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25

Qua10Result

Result of the qua10 calculation.
interestSpread
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
retirementSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
adjCostBorrowing
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
opportunityCost
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
​Qua10YearRow[] · required

Qua10YearRow

yearNumber
​integer | null · required
​required
​required
​required

Qua11Request

Inputs for the qua11 calculation.
yrsToRetirement
​integer · min: 1 · max: 50 · required
Default: 30
clientIncome
​number · required
Default: 0
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25
earlyWithdrawal
​number · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
suspension
​string · enum · required
Enum values:
N
Y
Default: Y
currentContribution
​number · min: 0 · max: 1 · required
Default: 0.04
employerMatch
​number · min: 0 · max: 3 · required
Default: 1
maximumMatch
​number · min: 0 · max: 0.2 · required
Default: 0.03

Qua11Result

Result of the qua11 calculation.
contributionLost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
retirementLost
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
penalty
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxes
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
netAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Qua11YearRow[] · required

Qua11YearRow

yearNumber
​integer | null · required
​required
​required
​required

Qua12Request

Inputs for the qua12 calculation.
type
​string · enum · required
Enum values:
S
C
Default: S
taxYear
​string · enum · required
Enum values:
2025
2026
Default: 2025
clientAge
​integer · min: 1 · max: 120 · required
Default: 30
netProfit
​number · required
Default: 0

Qua12Result

Result of the qua12 calculation.
a
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
b
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
c
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
d
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
e
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
f
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
g
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
h
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
i
​number · required
j
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
k
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
l
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
m
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
n
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
o
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
p
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
q
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
r
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
s
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
t
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
u
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
v
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
sepcont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
simpleIRACont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
max401KCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Qua13Request

Inputs for the qua13 calculation.
balance
​number · required
Default: 0
basis
​number · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
holdingYears
​integer · min: 0 · max: 30 · required
Default: 10
holdingMonths
​integer · min: 0 · max: 11 · required
Default: 0
taxRate
​number · min: 0 · max: 0.75 · required
Default: 0.4
capRate
​number · min: 0 · max: 0.75 · required
Default: 0.15
separation
​string · enum · required
Enum values:
N
Y
Default: N
initialDistribution
​string · enum · required
Enum values:
N
Y
Default: N
finalDistribution
​string · enum · required
Enum values:
N
Y
Default: N

Qua13Result

Result of the qua13 calculation.
taxSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentNBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentIBalance
​string · required
currentNImmediate
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentIImmediate
​string · required
currentNPenalty
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentIPenalty
​string · required
currentNTotalImmediate
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentITotalImmediate
​string · required
finalNBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
finalIBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
finalNCapGains
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
finalICapGains
​string · required
finalNCapGainsAddnl
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
finalICapGainsAddnl
​string · required
finalNTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
finalITax
​string · required
finalNPenalty
​string · required
finalIPenalty
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
finalNDistributionTax
​string · required
finalIDistributionTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
finalNTotalFutureTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
finalITotalFutureTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
nuaTotalTaxesPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
iraTotalTaxesPaid
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Qua14Request

Inputs for the qua14 calculation.
yyyyRmd
​integer · min: 2010 · max: 2040 · required
Default: 2026
dobMmOwner
​integer · min: 1 · max: 12 · required
Default: 1
dobDdOwner
​integer · min: 1 · max: 31 · required
Default: 1
dobYyyyOwner
​integer · min: 1900 · max: 2024 · required
Default: 1950
dodMmOwner
​integer · min: 1 · max: 12 · required
Default: 1
dodDdOwner
​integer · min: 1 · max: 31 · required
Default: 1
dodYyyyOwner
​integer · min: 1920 · max: 2040 · required
Default: 1950
dobMmBeneficiary
​integer · min: 1 · max: 12 · required
Default: 1
dobDdBeneficiary
​integer · min: 1 · max: 31 · required
Default: 1
dobYyyyBeneficiary
​integer · min: 1920 · max: 2024 · required
Default: 1950
planBalance
​number · required
Default: 0
returnRate
​number · min: 0 · max: 0.1 · required
Default: 0.05
planType
​string · enum · required
Enum values:
1
2
3
4
5
6
7
8
Default: 1
beneficiaryType
​string · enum · required
Enum values:
1
2
3
4
5
Default: 1
spouseOption
​string · enum · required
Enum values:
1
2
Default: 1

Qua14Result

Result of the qua14 calculation.
accountBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalDistributions
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
tableUsed
​RmdTable · enum · required
Enum values:
uniform_lifetime
single_life
​Qua14YearRow[] · required

Qua14YearRow

yearNumber
​integer | null · required
age
​string · required
​required
​required
divisor
​number | null · required
​required
​required

Qua15Request

Inputs for the qua15 calculation.
accountBalance
​number · required
Default: 0
clientAge
​integer · min: 35 · max: 59 · required
Default: 50
beneficiaryAge
​integer · min: 35 · max: 70 · required
Default: 50
beneficiarySpouse
​string · enum · required
Enum values:
N
Y
Default: Y
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.06
distributionRate
​number · min: 0 · max: 0.12 · required
Default: 0.0455

Qua15Result

Result of the qua15 calculation.
singleFactor
​number · required
singleAmortization
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
singleRMD
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
jointFactor
​number · required
jointAmortization
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
jointRMD
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
uniformFactor
​number · required
uniformAmortization
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
uniformRMD
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
mortalityFactor
​number · required
mortalityAnnuitization
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
maximumAmortization
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
maximumAnnuitization
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
maximumRMD
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Qua15YearRow[] · required

Qua15YearRow

age
​integer | null · required
​required
​required
​required
​required
​required
​required

Ret01Request

Inputs for the ret01 calculation.
mode
​integer · enum · required
Enum values:
0
1
Default: 1
wages
​number · required
Default: 0
wagesret
​number · required
Default: 0
alimony
​number · required
Default: 0
alimonyret
​number · required
Default: 0
dividends
​number · required
Default: 0
dividendsret
​number · required
Default: 0
interest
​number · required
Default: 0
interestret
​number · required
Default: 0
socialsecurity
​number · required
Default: 0
socialsecurityret
​number · required
Default: 0
pensions
​number · required
Default: 0
pensionsret
​number · required
Default: 0
otherincome
​number · required
Default: 0
otherincomeret
​number · required
Default: 0
mortgage
​number · required
Default: 0
mortgageret
​number · required
Default: 0
vacation
​number · required
Default: 0
vacationret
​number · required
Default: 0
autoloan
​number · required
Default: 0
autoloanret
​number · required
Default: 0
persloan
​number · required
Default: 0
persloanret
​number · required
Default: 0
cc
​number · required
Default: 0
ccret
​number · required
Default: 0
fedtaxes
​number · required
Default: 0
fedtaxesret
​number · required
Default: 0
statetaxes
​number · required
Default: 0
statetaxesret
​number · required
Default: 0
fica
​number · required
Default: 0
ficaret
​number · required
Default: 0
retaxes
​number · required
Default: 0
retaxesret
​number · required
Default: 0
othertaxes
​number · required
Default: 0
othertaxesret
​number · required
Default: 0
utilities
​number · required
Default: 0
utilitiesret
​number · required
Default: 0
repairs
​number · required
Default: 0
repairsret
​number · required
Default: 0
food
​number · required
Default: 0
foodret
​number · required
Default: 0
clothing
​number · required
Default: 0
clothingret
​number · required
Default: 0
education
​number · required
Default: 0
educationret
​number · required
Default: 0
childcare
​number · required
Default: 0
childcareret
​number · required
Default: 0
autoexp
​number · required
Default: 0
autoexpret
​number · required
Default: 0
transexp
​number · required
Default: 0
transexpret
​number · required
Default: 0
lifeins
​number · required
Default: 0
lifeinsret
​number · required
Default: 0
homeowners
​number · required
Default: 0
homeownersret
​number · required
Default: 0
autoins
​number · required
Default: 0
autoinsret
​number · required
Default: 0
medical
​number · required
Default: 0
medicalret
​number · required
Default: 0
entertain
​number · required
Default: 0
entertainret
​number · required
Default: 0
travel
​number · required
Default: 0
travelret
​number · required
Default: 0
club
​number · required
Default: 0
clubret
​number · required
Default: 0
hobbies
​number · required
Default: 0
hobbiesret
​number · required
Default: 0
gifts
​number · required
Default: 0
giftsret
​number · required
Default: 0
homeimp
​number · required
Default: 0
homeimpret
​number · required
Default: 0
services
​number · required
Default: 0
servicesret
​number · required
Default: 0
charity
​number · required
Default: 0
charityret
​number · required
Default: 0
other
​number · required
Default: 0
otherret
​number · required
Default: 0

Ret01Result

Result of the ret01 calculation.
totalIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalIncomeRet
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalIncomeDiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalExpenses
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalExpensesRet
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalExpensesDiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalNetIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalNetIncomeRet
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalNetIncomeDiff
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ret01YearRow[] · required

Ret01YearRow

category
​string · required
current
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
projected
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
change
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Ret02Request

Inputs for the ret02 calculation.
clientAge
​integer · min: 1 · max: 120 · required
Default: 35
clientIncome
​number · required
Default: 0
spouseIncome
​number · required
Default: 0
retirementSavings
​number · required
Default: 0
clientRetAge
​integer · min: 1 · max: 120 · required
Default: 65
retirementYears
​integer · min: 1 · max: 40 · required
Default: 20
inflation
​number · min: 0 · max: 0.1 · required
Default: 0.03
retirementReplacement
​number · min: 0 · max: 3 · required
Default: 0.75
preRetirementReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
postRetirementReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
includeSocsec
​string · enum · required
Enum values:
N
Y
Default: N
maritalStatus
​string · enum · required
Enum values:
M
S
Default: S
ssOverrideAmount
​number · required
Default: 0

Ret02Result

Result of the ret02 calculation.
percentSaveAmount
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
annualSaveAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlySaveAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
waitPercentSaveAmount
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
waitSaveAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalSaveAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ret02YearRow[] · required

Ret02YearRow

age
​integer · required
salary
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
begBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
requiredSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
desiredIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
socialSecurity
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
withdrawals
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Ret03Request

Inputs for the ret03 calculation.
clientAge
​integer · min: 1 · max: 120 · required
Default: 35
clientIncome
​number · required
Default: 0
spouseIncome
​number · required
Default: 0
currentRetirementSavings
​number · required
Default: 0
annualRetSavings
​number · required
Default: 0
annualSavingsIncrease
​number · min: 0 · max: 0.1 · required
Default: 0
annualPension
​number · required
Default: 0
pensionIncrease
​string · enum · required
Enum values:
N
Y
Default: N
inflation
​number · min: 0 · max: 0.1 · required
Default: 0.03
clientRetAge
​integer · min: 1 · max: 120 · required
Default: 65
retirementYears
​integer · min: 1 · max: 40 · required
Default: 20
retirementReplacement
​number · min: 0 · max: 3 · required
Default: 0.75
preRetirementReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
postRetirementReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
includeSocsec
​string · enum · required
Enum values:
N
Y
Default: N
maritalStatus
​string · enum · required
Enum values:
M
S
Default: S
ssOverrideAmount
​number · required
Default: 0

Ret03Result

Result of the ret03 calculation.
ageMoneyRunsOut
​integer · required
annualSaveAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
monthlySaveAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endRetireAge
​integer · required
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
neededRetirementSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ret03YearRow[] · required

Ret03YearRow

age
​integer · required
salary
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
begBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
currentSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
desiredIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
socialSecurity
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
pensionIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
withdrawals
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Ret04Request

Inputs for the ret04 calculation.
clientIncome
​number · required
Default: 0
clientAge
​integer · min: 0 · max: 120 · required
Default: 0
clientSsage
​integer · min: 62 · max: 70 · required
Default: 67
spouseIncome
​number · required
Default: 0
spouseAge
​integer · min: 0 · max: 120 · required
Default: 0
spouseSsage
​integer · min: 62 · max: 70 · required
Default: 67
ssInflation
​number · min: 0 · max: 0.1 · required
Default: 0.025

Ret04Result

Result of the ret04 calculation.
percentReplaced
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
combinedIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ret04YearRow[] · required

Ret04YearRow

id
​string · required
nra
​number | null · required
ssBeginage
​number | null · required
​required
​required
​required

Ret05Request

Inputs for the ret05 calculation.
currentAge
​integer · min: 1 · max: 120 · required
Default: 30
retirementAge
​integer · min: 1 · max: 120 · required
Default: 65
lifeAge
​integer · min: 1 · max: 120 · required
Default: 85
clientIncome
​number · required
Default: 0
incomeReplacement
​number · min: 0 · max: 3 · required
Default: 0.75
inflation
​number · min: 0 · max: 0.1 · required
Default: 0.03

Ret05Result

Result of the ret05 calculation.
incomeToday
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
incomeRetirement
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
incomeFinal
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Ret06Request

Inputs for the ret06 calculation.
income
​number · required
Default: 0
increase
​number · min: 0 · max: 0.1 · required
Default: 0.03
ssIncome
​number · required
Default: 0
ssIncrease
​number · min: 0 · max: 0.1 · required
Default: 0.03
pension
​number · required
Default: 0
pensionIncrease
​number · min: 0 · max: 0.1 · required
Default: 0.03
otherIncome
​number · required
Default: 0
otherIncrease
​number · min: 0 · max: 0.1 · required
Default: 0.03
balance
​number · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.04
amortization
​integer · enum · required
Enum values:
1
2
Default: 2

Ret06Result

Result of the ret06 calculation.
yearsMoneyLasts
​number · required
totalWithdrawals
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ret06PeriodRow[] · required

Ret06PeriodRow

period
​integer · required
desiredIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fixedIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
shortfall
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
neededWithdrawals
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Ret07Request

Inputs for the ret07 calculation.
currentAge
​integer · min: 1 · max: 120 · required
Default: 35
retirementAge
​integer · min: 1 · max: 120 · required
Default: 65
annualSavings
​number · required
Default: 0
savingIncreases
​number · min: 0 · max: 0.1 · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
compounding
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 1

Ret07Result

Result of the ret07 calculation.
waitOneYearAmount
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ret07YearRow[] · required

Ret07YearRow

yearsToWait
​integer | null · required
age
​integer | null · required
yearsToSave
​integer | null · required
​required
​required
​required

Ret08Request

Inputs for the ret08 calculation.
costLumpSum
​number · required
Default: 0
costRecurring
​number · required
Default: 0
perMonth
​integer · required
Default: 0
inflation
​number · min: 0 · max: 0.1 · required
Default: 0.03
yearsToRetirement
​integer · min: 1 · max: 50 · required
Default: 20
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25

Ret08Result

Result of the ret08 calculation.
accumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Ret08YearRow[] · required

Ret08YearRow

year
​integer | null · required
​required
​required
​required
​required
​required

Ret09Request

Inputs for the ret09 calculation.
yrsToRetirement
​integer · min: 1 · max: 50 · required
Default: 30
clientIncome
​number · required
Default: 0
salaryIncreases
​number · min: 0 · max: 0.2 · required
Default: 0.05
planBalance
​number · required
Default: 0
currentContribution
​number · min: 0 · max: 1 · required
Default: 0.03
compounding
​integer · enum · required
Enum values:
52
26
24
12
1
Default: 26
employerMatch
​number · min: 0 · max: 0.2 · required
Default: 0.03
beforeTaxReturnCon
​number · min: -0.12 · max: 0.12 · required
Default: 0.05
beforeTaxReturnMod
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
beforeTaxReturnAgg
​number · min: -0.12 · max: 0.12 · required
Default: 0.11
yrsWithdrawals
​integer · min: 1 · max: 50 · required
Default: 30
retirementReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
inflation
​number · min: 0 · max: 0.1 · required
Default: 0.03

Ret09Result

Result of the ret09 calculation.
yourContDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
empMatchDollar
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvYourCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
fvEmpCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
conFv
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
modFv
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
aggFv
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
conRetIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
modRetIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
aggRetIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
conPv
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
modPv
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
aggPv
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contributionCapped
​number · required
currentYear
​number · required
maxContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Ret10Request

Inputs for the ret10 calculation.
currentAge
​integer · min: 1 · max: 120 · required
Default: 35
retirementAge
​integer · min: 1 · max: 120 · required
Default: 65
yearsNeeded
​integer · min: 1 · max: 70 · required
Default: 20
accBeforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
distBeforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
accTaxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25
distTaxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25
annualContribution
​number · required
Default: 0
option
​integer · enum · required
Enum values:
1
2
Default: 1

Ret10Result

Result of the ret10 calculation.
nonAccBtCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
tradAccBtCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
nonAdjustment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
tradAdjustment
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
nonAtContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
tradAtContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
nonAccRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
tradAccRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
nonAccTerm
​number · required
tradAccTerm
​number · required
nonValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
tradValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
nonDistTerm
​number · required
tradDistTerm
​number · required
nonDistRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
tradDistRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
nonBtIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
tradBtIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
nonTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
tradTax
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
nonAtIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
tradAtIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
nonAtMonthlyIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
tradAtMonthlyIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Ret11Request

Inputs for the ret11 calculation.
currentAge
​integer · min: 50 · max: 67 · required
Default: 50
annualSavings
​number · min: 0 · max: 8000 · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08

Ret11Result

Result of the ret11 calculation.
additionalAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
selectedAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
yearsForAnalysis
​number · required
​Ret11YearRow[] · required

Ret11YearRow

age
​number | null · required
​required
​required
​required
​required
​required

Sav01Request

Inputs for the sav01 calculation.
currentAge
​integer · min: 1 · max: 100 · required
Default: 35
retirementAge
​integer · min: 1 · max: 100 · required
Default: 65
initialBalance
​number · required
Default: 0
savingsIncrease
​number · min: -0.12 · max: 0.12 · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
inflationRate
​number · min: 0 · max: 0.1 · required
Default: 0.03

Sav01Result

Result of the sav01 calculation.
yearsUntilNeeded
​integer · required
desiredValueInflation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualCont
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualContInflation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
contributionIncrease
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
​Sav01YearRow[] · required

Sav01YearRow

age
​integer | null · required
​required
​required
​required
​required
​required

Sav02Request

Inputs for the sav02 calculation.
currentAge
​integer · min: 1 · max: 120 · required
Default: 35
retirementAge
​integer · min: 1 · max: 120 · required
Default: 65
yearsNeeded
​integer · min: 1 · max: 40 · required
Default: 20
initialBalance
​number · required
Default: 0
annualSavings
​number · required
Default: 0
savingsIncrease
​number · min: 0 · max: 0.1 · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22

Sav02Result

Result of the sav02 calculation.
accumulationYears
​integer · required
annualIncome
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Sav02AgeRow[] · required

Sav02AgeRow

age
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
annualSavings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
income
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Sav03Request

Inputs for the sav03 calculation.
initialBalance
​number · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22

Sav03Result

Result of the sav03 calculation.
periods
​number · required
futureValue
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Sav03YearRow[] · required

Sav03YearRow

year
​number | null · required
​required
​required
​required
​required

Sav04Request

Inputs for the sav04 calculation.
initialBalance
​number · required
Default: 0
savingsGoal
​number · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22

Sav04Result

Result of the sav04 calculation.
numPeriods
​number | null · required
​Sav04YearRow[] · required

Sav04YearRow

year
​number | null · required
​required
​required
​required
​required

Sav05Request

Inputs for the sav05 calculation.
currentAge
​integer · min: 1 · max: 120 · required
Default: 35
retirementAge
​integer · min: 1 · max: 120 · required
Default: 65
amountNeeded
​number · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.25

Sav05Result

Result of the sav05 calculation.
difference
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
waitYears
​number · required
​Sav05YearRow[] · required

Sav05YearRow

age
​integer | null · required
yearsToWait
​integer | null · required
​required
​required
​required
​required

Sav06Request

Inputs for the sav06 calculation.
initialBalance
​number · required
Default: 0
amountNeeded
​number · required
Default: 0
numYears
​integer · min: 1 · max: 120 · required
Default: 20
annualIncrease
​number · min: 0 · max: 0.1 · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.1
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22

Sav06Result

Result of the sav06 calculation.
annualContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Sav06YearRow[] · required

Sav06YearRow

yearNumber
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
savings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxes
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Sav07Request

Inputs for the sav07 calculation.
initialBalance
​number · required
Default: 0
annualSavings
​number · required
Default: 0
savingsIncrease
​number · min: 0 · max: 0.1 · required
Default: 0
numYears
​integer · min: 1 · max: 30 · required
Default: 20
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22

Sav07Result

Result of the sav07 calculation.
totalAccumulation
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Sav07YearRow[] · required

Sav07YearRow

yearNumber
​integer | null · required
beginningBalance
​number | null · required
annualSavings
​number | null · required
interest
​number | null · required
taxes
​number | null · required
endingBalance
​number | null · required

Sav08Request

Inputs for the sav08 calculation.
term
​integer · min: 1 · max: 120 · required
Default: 5
initialDeposit
​number · required
Default: 0
depositsWithdrawals
​number · required
Default: 0
endingBalance
​number · required
Default: 0

Sav08Result

Result of the sav08 calculation.
irr
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
computable
​boolean · required
​Sav08YearRow[] · required

Sav08YearRow

period
​integer · required
cashFlow
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Sav09Request

Inputs for the sav09 calculation.
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.08
stateTaxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.05
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22
itemize
​string · enum · required
Enum values:
N
Y
Default: N
inflation
​number · min: 0 · max: 0.1 · required
Default: 0.03

Sav09Result

Result of the sav09 calculation.
tenYearBTValue
​number | null · required
tenYearAdjustedValue
​number | null · required
annualizedReturn
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06
​Sav09YearRow[] · required

Sav09YearRow

yearNumber
​integer | null · required
​required
​required
​required

Sav10Request

Inputs for the sav10 calculation.
nominalRate
​number · min: 0 · max: 0.4 · required
Default: 0.1
compounding
​integer · enum · required
Enum values:
365
12
4
2
1
Default: 12

Sav10Result

Result of the sav10 calculation.
effectiveRate
​Rate · required

A rate or percentage as a decimal fraction (e.g. 0.06 means 6%). May be negative (e.g. a negative rate of return). Field-level bounds, where the contract declares them, ride as minimum/maximum siblings on the referencing property.

Example: 0.06

Sav11Request

Inputs for the sav11 calculation.
initialDeposit
​number · required
Default: 0
recurringDeposit
​number · required
Default: 0
depositFrequency
​string · enum · required
Enum values:
1
3
6
12
Default: 1
termMonths
​integer · min: 1 · max: 360 · required
Default: 120
interestRate
​number · min: -0.12 · max: 0.12 · required
Default: 0.03
compoundingFrequency
​string · enum · required
Enum values:
1
3
6
12
Default: 1

Sav11Result

Result of the sav11 calculation.
totalDeposits
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
totalInterest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Sav11MonthRow[] · required

Sav11MonthRow

month
​integer | null · required
​required
​required
​required
​required

Sav12Request

Inputs for the sav12 calculation.
recurringDeposit
​number · required
Default: 0
interestRate
​number · min: 0 · max: 0.12 · required
Default: 0
goal
​number · required
Default: 0
termMonths
​integer · min: 1 · max: 360 · required
Default: 120

Sav12Result

Result of the sav12 calculation.
totalDeposits
​integer · required
totalInterest
​integer · required
endingBalance
​integer · required
initialDeposit
​number · required
​Sav12MonthRow[] · required

Sav12MonthRow

month
​integer | null · required
​required
​required
​required
​required

Sav13Request

Inputs for the sav13 calculation.
incomeType
​string · enum · required
Enum values:
Hourly
Salary
Default: Hourly
salary
​number · required
Default: 0
hourlyPay
​number · required
Default: 0
purchaseCost
​number · required
Default: 0

Sav13Result

Result of the sav13 calculation.
hourEquivalent
​number · required
daysEquivalent
​number · required
calculatedHourly
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00

Sav36Request

Inputs for the sav36 calculation.
initialBalance
​number · required
Default: 0
amountNeeded
​number · required
Default: 0
numYears
​integer · min: 1 · max: 120 · required
Default: 12
annualIncrease
​number · min: 0 · max: 0.1 · required
Default: 0
beforeTaxReturn
​number · min: -0.12 · max: 0.12 · required
Default: 0.1
taxBracket
​number · min: 0 · max: 0.75 · required
Default: 0.22

Sav36Result

Result of the sav36 calculation.
annualContribution
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
​Sav36YearRow[] · required

Sav36YearRow

yearNumber
​integer · required
beginningBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
savings
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
interest
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
taxes
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
endingBalance
​MonetaryAmount · pattern: ^-?\d+(\.\d{1,2})?$ · required

A monetary value as an exact decimal string with up to two fraction digits. Outputs are normalized to two fraction digits. Raw amount only — currency symbol, grouping, and locale formatting are the client's concern.

Example: 89500.00
On this page
  • MonetaryAmount
  • Rate
  • Problem
  • Adv01Request
  • Adv01Result
  • Adv01YearRow
  • Adv02Request
  • Adv02Result
  • Adv02DependentRow
  • Adv02StrategyRow
  • Adv02DependentCostRow
  • Adv02AnnualTaxableYearRow
  • Adv02AnnualAdvantagedYearRow
  • Adv02LumpSumTaxableYearRow
  • Adv02LumpSumAdvantagedYearRow
  • Adv03Request
  • Adv03Result
  • Adv03YearRow
  • Adv03ClientYearRow
  • Adv03SpouseYearRow
  • MaritalStatus
  • Adv04Request
  • Adv04Result
  • Adv04LtcYearRow
  • Adv04YearRow
  • Adv05Request
  • Adv05Result
  • Adv05YearRow
  • Aut01Request
  • Aut01Result
  • Aut02Request
  • Aut02Result
  • Aut02YearRow
  • Aut03Request
  • Aut03Result
  • Aut03YearRow
  • Aut04Request
  • Aut04Result
  • Aut05Request
  • Aut05Result
  • Aut05YearRow
  • Aut06Request
  • Aut06Result
  • Aut06YearRow
  • Aut07Request
  • Aut07Result
  • Aut08Request
  • Aut08Result
  • Aut09Request
  • Aut09Result
  • Aut10Request
  • Aut10Result
  • Aut10YearRow
  • Aut11Request
  • Aut11Result
  • Aut12Request
  • Aut12Result
  • Bud01Request
  • Bud01Result
  • Bud01YearRow
  • Bud02Request
  • Bud02Result
  • Bud02YearRow
  • Bud03Request
  • Bud03Result
  • Bud03YearRow
  • Bud04Request
  • Bud04Result
  • Bud05Request
  • Bud05Result
  • Bud05YearRow
  • Bud06Request
  • Bud06Result
  • Bud07Request
  • Bud07Result
  • Bud08Request
  • Bud08Result
  • Bud09Request
  • Bud09Result
  • Bud09YearRow
  • Bud10Request
  • Bud10Result
  • Bud10YearRow
  • Bud11Request
  • Bud11Result
  • Bud12Request
  • Bud12Result
  • Bud12YearRow
  • Bud13Request
  • Bud13Result
  • Bud14Request
  • Bud14Result
  • Bus01Request
  • Bus01Result
  • Bus02Request
  • Bus02Result
  • Bus03Request
  • Bus03Result
  • Bus03YearRow
  • Bus04Request
  • Bus04Result
  • Bus04YearRow
  • Bus05Request
  • Bus05Result
  • Bus05YearRow
  • Bus06Request
  • Bus06Result
  • Bus07Request
  • Bus07Result
  • Bus08Request
  • Bus08Result
  • Bus09Request
  • Bus09Result
  • Bus10Request
  • Bus10Result
  • Bus11Request
  • Bus11Result
  • Bus11YearRow
  • Col01Request
  • Col01Result
  • Col01YearRow
  • Col02Request
  • Col02Result
  • TrafficLight
  • Col03Request
  • Col03Result
  • Col03YearRow
  • Col04Request
  • Col04Result
  • Col04YearRow
  • Col05Request
  • Col05Result
  • Col05YearRow
  • Col06Request
  • Col06Result
  • Col06YearRow
  • Col07Request
  • Col07Result
  • Col08Request
  • Col08Result
  • Col08YearRow
  • Col09Request
  • Col09Result
  • Cus106Request
  • Cus106Result
  • Cus14Request
  • Cus14Result
  • Light
  • Cus15Request
  • Cus15Result
  • Det01Request
  • Det01Result
  • Det01YearRow
  • Det02Request
  • Det02Result
  • Det02YearRow
  • Det03Request
  • Det03Result
  • Det03YearRow
  • Det04Request
  • Det04Result
  • Det05Request
  • Det05Result
  • Det05YearRow
  • Det06Request
  • Det06Result
  • Det06YearRow
  • Det07Request
  • Det07Result
  • Det07DebtRow
  • Det08Request
  • Det08Result
  • Det09Request
  • Det09Result
  • Det09YearRow
  • Det10Request
  • Det10Result
  • Det11Request
  • Det11Result
  • Det12Request
  • Det12Result
  • Det13Request
  • Det13Result
  • Det13MonthRow
  • Det16Request
  • Det16Result
  • Det16MonthRow
  • Det17Request
  • Det17Result
  • Det17YearRow
  • Hom01Request
  • Hom01Result
  • Hom02Request
  • Hom02Result
  • Hom03Request
  • Hom03Result
  • Hom03YearRow
  • Hom04Request
  • Hom04Result
  • Hom05Request
  • Hom05Result
  • Hom06Request
  • Hom06Result
  • Hom06YearRow
  • Hom07Request
  • Hom07Result
  • Hom07YearRow
  • Hom08Request
  • Hom08Result
  • Hom08YearRow
  • Hom09Request
  • Hom09Result
  • Hom09YearRow
  • Hom10Request
  • Hom10Result
  • Hom10YearRow
  • Hom11Request
  • Hom11Result
  • Hom11YearRow
  • Hom12Request
  • Hom12Result
  • Hom13Request
  • Hom13Result
  • Hom13YearRow
  • Hom14Request
  • Hom14Result
  • Hom15Request
  • Hom15Result
  • Hom16Request
  • Hom16Result
  • Hom16MonthRow
  • Hom17Request
  • Hom17Result
  • Hom17YearRow
  • Hom20Request
  • Hom20Result
  • Hom39Request
  • Hom39Result
  • Inc01Request
  • Inc01Result
  • Inc03Request
  • Inc03Result
  • Inc04Request
  • Inc04Result
  • Inc05Request
  • Inc05Result
  • Inc06Request
  • Inc06Result
  • Inc07Request
  • Inc07Result
  • Inc07YearRow
  • Inc08Request
  • Inc08Result
  • Inc09Request
  • Inc09Result
  • Inc10Request
  • Inc10Result
  • Inc11Request
  • Inc11Result
  • Ins01Request
  • Ins01Result
  • Ins01YearRow
  • Ins02Request
  • Ins02Result
  • Ins03Request
  • Ins03Result
  • Ins04Request
  • Ins04Result
  • Ins05Request
  • Ins05Result
  • Ins06Request
  • Ins06Result
  • Ins06YearRow
  • Ins07Request
  • Ins07Result
  • Ins07YearRow
  • Ins08Request
  • Ins08Result
  • Ins08YearRow
  • Ins09Request
  • Ins09Result
  • Ins09YearRow
  • Ins10Request
  • Ins10Result
  • Ins10YearRow
  • Ins11Request
  • Ins11Result
  • Ins11AmountRow
  • Ins12Request
  • Ins12Result
  • Ins12YearRow
  • Ins13Request
  • Ins13Result
  • Inv01Request
  • Inv01Result
  • RecommendedProfile
  • BindingConstraint
  • ToleranceEvidence
  • Inv02Request
  • Inv02Result
  • Inv02YieldRow
  • Inv03Request
  • Inv03Result
  • Inv04Request
  • Inv04Result
  • Inv04YearRow
  • Inv05Request
  • Inv05Result
  • Inv05YearRow
  • Inv06Request
  • Inv06Result
  • OptionStatus
  • Inv07Request
  • Inv07Result
  • Inv07YearRow
  • Inv08Request
  • Inv08Result
  • Inv09Request
  • Inv09Result
  • Inv09YearRow
  • Inv10Request
  • Inv10Result
  • Inv10YearRow
  • Frequency
  • Inv11Request
  • Inv11Result
  • Inv12Request
  • Inv12Result
  • Inv12YearRow
  • Inv13Request
  • Inv13Result
  • Inv13YearRow
  • Inv16Request
  • Inv16Result
  • Pay01Request
  • Pay01Result
  • Pay02Request
  • Pay02Result
  • Pay03Request
  • Pay03Result
  • Pay04Request
  • Pay04Result
  • Pay05Request
  • Pay05Result
  • Pay05YearRow
  • Pay06Request
  • Pay06Result
  • Pay06YearRow
  • Pay07Request
  • Pay07Result
  • Pay07YearRow
  • Pay08Request
  • Pay08Result
  • Pay08YearRow
  • Pay11Request
  • Pay11Result
  • Pay11YearRow
  • Pay13Request
  • Pay13Result
  • Pay13YearRow
  • Pay14Request
  • Pay14Result
  • Pay14YearRow
  • Pay15Request
  • Pay15Result
  • Qua01Request
  • Qua01Result
  • Qua01YearRow
  • Qua02Request
  • Qua02Result
  • FilingStatus
  • YesNo
  • YesNoNotApplicable
  • Qua03Request
  • Qua03Result
  • Qua04Request
  • Qua04Result
  • Qua05Request
  • Qua05Result
  • Qua05YearRow
  • Qua06Request
  • Qua06Result
  • RmdTable
  • Qua07Request
  • Qua07Result
  • Qua07YearRow
  • Qua08Request
  • Qua08Result
  • Qua09Request
  • Qua09Result
  • Qua09ContributionRow
  • Qua10Request
  • Qua10Result
  • Qua10YearRow
  • Qua11Request
  • Qua11Result
  • Qua11YearRow
  • Qua12Request
  • Qua12Result
  • Qua13Request
  • Qua13Result
  • Qua14Request
  • Qua14Result
  • Qua14YearRow
  • Qua15Request
  • Qua15Result
  • Qua15YearRow
  • Ret01Request
  • Ret01Result
  • Ret01YearRow
  • Ret02Request
  • Ret02Result
  • Ret02YearRow
  • Ret03Request
  • Ret03Result
  • Ret03YearRow
  • Ret04Request
  • Ret04Result
  • Ret04YearRow
  • Ret05Request
  • Ret05Result
  • Ret06Request
  • Ret06Result
  • Ret06PeriodRow
  • Ret07Request
  • Ret07Result
  • Ret07YearRow
  • Ret08Request
  • Ret08Result
  • Ret08YearRow
  • Ret09Request
  • Ret09Result
  • Ret10Request
  • Ret10Result
  • Ret11Request
  • Ret11Result
  • Ret11YearRow
  • Sav01Request
  • Sav01Result
  • Sav01YearRow
  • Sav02Request
  • Sav02Result
  • Sav02AgeRow
  • Sav03Request
  • Sav03Result
  • Sav03YearRow
  • Sav04Request
  • Sav04Result
  • Sav04YearRow
  • Sav05Request
  • Sav05Result
  • Sav05YearRow
  • Sav06Request
  • Sav06Result
  • Sav06YearRow
  • Sav07Request
  • Sav07Result
  • Sav07YearRow
  • Sav08Request
  • Sav08Result
  • Sav08YearRow
  • Sav09Request
  • Sav09Result
  • Sav09YearRow
  • Sav10Request
  • Sav10Result
  • Sav11Request
  • Sav11Result
  • Sav11MonthRow
  • Sav12Request
  • Sav12Result
  • Sav12MonthRow
  • Sav13Request
  • Sav13Result
  • Sav36Request
  • Sav36Result
  • Sav36YearRow