tools

explain_rule

Get a tax rule in full: statutory citation with its verbatim excerpt, validity window, parameters, the formula and applicability guard (the rule IR — rules are data), the rules and facts it depends on, and its content hash. Use to quote and explain the actual law behind an answer. Pass asOf to see only the version in force on that date.

post/v1/tools/explain_rule

Request

  • Base URL: https://opentax.invaro.ai
  • URL: https://opentax.invaro.ai/v1/tools/explain_rule
  • 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

ruleIdstring required

e.g. "us.federal.standard_deduction" — list via calculate_tax proof, search_tax_rules, or the corpus

asOfstring

ISO date; when given, only the version valid on that date is returned (omit for every version)

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.