tools

compare_filing_statuses

Compute the answer under every filing status for the same facts — e.g. to answer 'should we file jointly or separately?'. Statuses that need more facts report their error instead of guessing.

post/v1/tools/compare_filing_statuses

Request

  • Base URL: https://opentax.invaro.ai
  • URL: https://opentax.invaro.ai/v1/tools/compare_filing_statuses
  • Auth: one of:
    • HTTP bearer
    • none

Headers

X-OpenTax-Return-Idstring

Your identifier for the taxpayer-year this call belongs to; the billing unit. Stored hashed.

Request body

factsobject required

facts for the computation: either flat corpus fact ids (see list_input_facts) or the same group objects calculate_tax accepts (filing, income, retirement, …), plus optional target and asOf. Business/fiduciary/dependent facts are accepted flat. Unknown keys are rejected by name — nothing is ever silently dropped.

Response

ok:true with the computed value, line set or lookup hits; ok:false with error.code when the engine refuses (NEEDS_FACTS, NO_APPLICABLE_RULE, UNHANDLED_ENUM_CASE)

okboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.