Explain a validation finding
explain_findingTurn a validation rule id into the invoice field to change and an example value.
Use after validate_invoice or a generate_invoice rule error, not to validate an invoice itself.
rule is trimmed and uppercased to select a guide entry. message/json_pointer must come from that
same finding: nonempty values override its generic context, but never change the selected fix or
example. Omit them to use guide defaults for known rules.
Returns rule, known, message, json_pointer, fix and example; known rules also include problem.
Selected BR-FR rules and BR-CO-17/BR-CO-26 have guidance.
Unknown ids return known=false and example=null with the supplied context, not an error; consult
the original finding. No key or document quota is needed; nothing is stored.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rule | Yes | Validation rule identifier, for example BR-FR-01 or BR-CO-26. | |
| message | No | Original finding's message text. | |
| json_pointer | No | Original finding's json_pointer field path. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||