{"openapi":"3.1.0","info":{"title":"HUD CNA Reserve for Replacement Financial Factors (v30.3)","version":"30.3.0","description":"Test reserve deposits and mortgage debt service against the pinned HUD CNA example, with annual reserve balances and minimum-balance diagnostics. selectCells reads at most 256 cells per request (including repeated cells). For licenseClass reference-only, cellOverrides, selectCells and trace may address only declared fio.yaml input/output port cells; trace traversal stops at that boundary. Verification level: scenario-independent-arithmetic.","x-formualizer-Provenance":{"publisher":"U.S. Department of Housing and Urban Development (HUD — Multifamily CNA e-Tool)","publisherPageUrl":"https://www.hud.gov/hud-partners/multifamily-cna","sourceUrl":"https://www.hud.gov/sites/dfiles/Housing/documents/RfR_Financial_Factors_Analysis_Tool_v30_3.xlsx","publishedDate":null,"workbookFilename":"hud-cna-reserve-factors-v30-3.xlsx","workbookSha256":"ef9e2408e617820fa098fb719e5efe0389d11178e414223c30008b40af2b4348","workbookBytes":745577,"format":"xlsx","licenseClass":"public-domain-gov"},"x-formualizer-VerificationLevel":"scenario-independent-arithmetic","x-formualizer-WorkbookDownload":{"mode":"catalog-bytes","sourceUrl":"https://www.hud.gov/sites/dfiles/Housing/documents/RfR_Financial_Factors_Analysis_Tool_v30_3.xlsx","sha256":"ef9e2408e617820fa098fb719e5efe0389d11178e414223c30008b40af2b4348","bytes":745577},"x-formualizer-Flows":[{"id":"quick_reserve_analysis","title":"Quick reserve analysis","kind":"single","inputPorts":["initial_reserve","annual_deposit_per_unit","initial_deposit_escalation","deposit_change_year","new_deposit_escalation","mortgage_amount","mortgage_coupon","mortgage_years","annual_mip","assumed_dscr"],"outputPorts":["year1_reserve","year10_reserve","year20_reserve","annual_debt_service","assumed_case_dscr","first10_result"]},{"id":"full_reserve_analysis","title":"Full reserve analysis","kind":"single","inputPorts":["initial_reserve","annual_deposit_per_unit","initial_deposit_escalation","deposit_change_year","new_deposit_escalation","mortgage_amount","mortgage_coupon","mortgage_years","annual_mip","assumed_dscr","amortization_mitigation_fraction","required_minimum_year1","needs_year_1","needs_year_2","needs_year_3","needs_year_4","needs_year_5","needs_year_6","needs_year_7","needs_year_8","needs_year_9","needs_year_10","needs_year_11","needs_year_12","needs_year_13","needs_year_14","needs_year_15","needs_year_16","needs_year_17","needs_year_18","needs_year_19","needs_year_20"],"outputPorts":["year1_reserve","year10_reserve","year20_reserve","annual_debt_service","assumed_case_dscr","first10_result","later_result","mitigation_result","monthly_payment","debt_service_per_unit","annual_deposit_total","risk_additional_deposit_per_unit"]}]},"paths":{"/evaluate":{"post":{"operationId":"evaluateWorkbook","parameters":[{"name":"tablePort","in":"query","description":"Table input port receiving NDJSON rows or Arrow IPC; omit for scenario envelopes","schema":{"type":"string","enum":[]}},{"name":"flow","in":"query","description":"Named input/output flow (default: quick_reserve_analysis)","schema":{"type":"string","enum":["quick_reserve_analysis","full_reserve_analysis"],"default":"quick_reserve_analysis"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"inputs":{"$ref":"#/components/schemas/Inputs"}},"required":["inputs"]}},"application/x-ndjson":{"schema":{"type":"string","description":"Table rows with tablePort, otherwise scenario envelopes"}},"application/vnd.apache.arrow.stream":{"schema":{"type":"string","format":"binary"}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Workbook outputs","content":{"application/json":{"schema":{"type":"object","properties":{"outputs":{"$ref":"#/components/schemas/Outputs"}}}},"application/x-ndjson":{"schema":{"type":"string","description":"Scenario results, one JSON envelope per line"}}}}}}},"/evaluate-batch":{"post":{"operationId":"evaluateWorkbookBatch","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scenarios":{"type":"array","items":{"type":"object","properties":{"id":{},"inputs":{"$ref":"#/components/schemas/Inputs"}},"required":["inputs"]}}},"required":["scenarios"]}},"application/x-ndjson":{"schema":{"type":"string","description":"Scenario envelopes, one per line"}}}},"responses":{"200":{"description":"Scenario results (including per-scenario errors)","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{},"outputs":{"$ref":"#/components/schemas/Outputs"},"error":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}},"application/x-ndjson":{"schema":{"type":"string"}}}}}}},"/ports":{"get":{"operationId":"describePorts","responses":{"200":{"description":"Workbook manifest and ports","content":{"application/json":{"schema":{"type":"object","properties":{"manifest":{"type":"object"},"ports":{"type":"array","items":{"type":"object"}}}}}}}}}},"/types.d.ts":{"get":{"operationId":"typeDeclarations","responses":{"200":{"description":"TypeScript Inputs, Outputs and Client declarations","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/v1/models/{slug}/{edition}/workbook.xlsx":{"get":{"summary":"Download catalog workbook or follow publisher redirect","description":"Download mode: catalog-bytes. Reference-only workbooks redirect to the publisher. The sha256 and bytes metadata pin the catalog file, which may be a sanitized derivative. When present, upstreamArtifact separately pins the publisher file. fio.yaml remains downloadable.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","enum":["hud-cna-reserve-factors"]}},{"name":"edition","in":"path","required":true,"schema":{"type":"string","enum":["v30.3"]}}],"responses":{"200":{"description":"Catalog workbook bytes; upstreamArtifact separately identifies publisher bytes when sanitized","headers":{"x-workbook-sha256":{"schema":{"type":"string"},"description":"ef9e2408e617820fa098fb719e5efe0389d11178e414223c30008b40af2b4348"},"x-workbook-bytes":{"schema":{"type":"integer"},"description":"745577"}}}}}}},"components":{"schemas":{"Inputs":{"type":"object","properties":{"initial_reserve":{"type":"number","minimum":0,"description":"USD, nonnegative initial reserve deposit. Default 466925. Replaces source formula with trial value. Source default: 466925.","default":466925},"annual_deposit_per_unit":{"type":"number","minimum":0,"description":"USD/unit/year, nonnegative first-year deposit. Default 556; source example has 456 units. Source default: 556.","default":556},"initial_deposit_escalation":{"type":"number","minimum":0,"maximum":1,"description":"Decimal fraction per year (0.02 = 2%). Default 0; first year uses this rate. Source default: 0.","default":0},"deposit_change_year":{"type":"number","minimum":1,"maximum":20,"description":"Relative year, integer 1..20. Default 1; from year 2, new rate applies when year >= this value. Source default: 1.","default":1},"new_deposit_escalation":{"type":"number","minimum":0,"maximum":1,"description":"Decimal fraction per year. Default 0.02; applies from change year, except year 1 uses initial rate. Source default: 0.02.","default":0.02},"mortgage_amount":{"type":"number","minimum":0.000001,"description":"USD principal, positive. Default 20000000. Affects amortization mitigation and debt service. Source default: 20000000.","default":20000000},"mortgage_coupon":{"type":"number","minimum":0,"description":"Decimal annual coupon, 0.025 = 2.5%. Default 0.025. Source default: 0.025.","default":0.025},"mortgage_years":{"type":"number","minimum":0.000001,"description":"Years, positive amortizing mortgage term. Default 35. Source default: 35.","default":35},"annual_mip":{"type":"number","minimum":0,"description":"Decimal annual mortgage insurance premium. Default 0.0065. Source default: 0.0065.","default":0.0065},"assumed_dscr":{"type":"number","description":"Dimensionless assumed debt service coverage ratio. Default 1.2; this is an assumed NOI case, not an underwritten actual NOI. Source default: 1.2.","default":1.2},"amortization_mitigation_fraction":{"type":"number","minimum":0,"maximum":1,"description":"Decimal fraction 0..1 of cumulative principal allowed for mitigation. Default 0.5. Source default: 0.5.","default":0.5},"required_minimum_year1":{"type":"number","minimum":0,"description":"USD, year-1 required minimum reserve. Default 335249.58; trial engine escalates this base with source capital-needs inflation. Source default: 335249.58.","default":335249.58},"needs_year_1":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 1. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 0.","default":0},"needs_year_2":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 2. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 0.","default":0},"needs_year_3":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 3. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 345094.42.","default":345094.42},"needs_year_4":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 4. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 287848.42.","default":287848.42},"needs_year_5":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 5. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 514096.82.","default":514096.82},"needs_year_6":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 6. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 473399.52.","default":473399.52},"needs_year_7":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 7. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 425964.13.","default":425964.13},"needs_year_8":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 8. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 273292.93.","default":273292.93},"needs_year_9":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 9. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 223601.16.","default":223601.16},"needs_year_10":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 10. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 357422.04.","default":357422.04},"needs_year_11":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 11. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 860042.46.","default":860042.46},"needs_year_12":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 12. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 815520.15.","default":815520.15},"needs_year_13":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 13. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 728117.64.","default":728117.64},"needs_year_14":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 14. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 276499.39.","default":276499.39},"needs_year_15":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 15. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 709668.05.","default":709668.05},"needs_year_16":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 16. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 670075.82.","default":670075.82},"needs_year_17":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 17. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 634855.55.","default":634855.55},"needs_year_18":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 18. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 308527.36.","default":308527.36},"needs_year_19":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 19. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 169510.22.","default":169510.22},"needs_year_20":{"type":"number","minimum":0,"description":"USD positive inflated withdrawal in year 20. Default is publisher example. This is the already inflated schedule; do not apply inflation twice. Source default: 154090.56.","default":154090.56}},"required":[],"additionalProperties":false},"Outputs":{"type":"object","properties":{"year1_reserve":{"type":"number","description":"USD end-year-1 reserve; signed, negative means deficit."},"year10_reserve":{"type":"number","description":"USD end-year-10 reserve; signed."},"year20_reserve":{"type":"number","description":"USD end-year-20 reserve; signed."},"annual_debt_service":{"type":"number","description":"USD/year principal and interest plus annual MIP."},"assumed_case_dscr":{"type":"number","description":"Dimensionless resulting coverage at assumed_dscr; DSC adjustment remains source zero."},"first10_result":{"type":"string","description":"Enum PASS or FAIL for first-ten-year required-minimum test."},"later_result":{"type":"string","description":"Enum PASS or FAIL for year-11+ required-minimum test."},"mitigation_result":{"type":"string","description":"Enum PASS or FAIL for amortization mitigation; source trial test references original eTool balances in C65:C74."},"monthly_payment":{"type":"number","description":"USD/month amortizing principal and interest."},"debt_service_per_unit":{"type":"number","description":"USD/unit/year debt service including MIP."},"annual_deposit_total":{"type":"number","description":"USD/year first-year trial reserve deposit, 456 times per-unit amount."},"risk_additional_deposit_per_unit":{"type":"number","description":"USD/unit/year approximate additional year-1 deposit to address later shortfall; retains publisher heuristic."}},"required":["year1_reserve","year10_reserve","year20_reserve","annual_debt_service","assumed_case_dscr","first10_result","later_result","mitigation_result","monthly_payment","debt_service_per_unit","annual_deposit_total","risk_additional_deposit_per_unit"],"additionalProperties":false}}}}