SIsignalshq
CLIENT

Correct one prior-year figure

Corrects the firm's READ of a filed return — not the return, which is a historical fact, and not the extraction, which stays on record as what the machine saw. Returns the recomputed comparison so the caller never has to patch a row itself.

post/internal/api/clients/{client_identifier}/year-over-year/overrides

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Path parameters

client_identifierstring required

Query parameters

tax_yearinteger required

The engagement year being prepared

Request body

line_keystring required

Which headline line — a HeadlineConcept value, the same key the comparison row and the intake panel's FIGURE fact carry.

value_textstring required

The corrected figure, as TEXT. Sent and stored as text so a float round-trip cannot turn $76,333.00 into $76,332.99 on a table whose entire value is that it agrees with the paper.

extracted_value_textstring nullable

What was on screen when the preparer decided — the value they disagreed with. Ignored on a re-correction, where the ORIGINAL machine read is carried forward instead: recording the previous correction here would erase the only account of what the run saw.

reasonstring nullable

Required only where the extraction was CONFIDENT about this line and still wrong. From a closed list — 'it looks wrong' is not on it, because a preparer who believes the prior RETURN is wrong has a different and legitimate path and a free-text box would collect that case as a correction and lose it.

observed_source_pageinteger nullable

The page they read it off, if they said. Never inferred.

supersedes_override_idstring uuid nullable

Advisory. The server retires whatever is CURRENT for the line rather than trusting this: a stale id from a panel that has not reloaded would otherwise retire a row that is no longer live and leave two corrections standing, which the unique index then refuses with an error naming neither.

Response

Successful Response

Changes

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