tools

search_tax_rules

Full-text search over the encoded tax-law corpus ('kiddie tax', 'NIIT threshold', 'california renters credit'). Returns matching rules: id, title, statutory citation, effective window, and a verbatim excerpt of the law text. A hit means the engine computes this; zero hits means it is outside the corpus — say so rather than guessing. Follow up with explain_rule for a hit's full formula, or lookup_tax_parameter for its dollar amounts.

post/v1/tools/search_tax_rules

Request

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

querystring required

plain-English search, e.g. 'kiddie tax'

asOfstring
limitinteger

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.