CLIENT

Year-over-year headline comparison

This year against the prior year, line by line, in the 1040's own order. The same digest the assistant narrates, so the two can never disagree.

get/internal/api/clients/{client_identifier}/year-over-year

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

Response

Successful Response

prior_year_availableboolean
current_yearinteger
prior_yearinteger

The year actually compared against — not always current_year - 1. A client whose most recent return is 2022 is compared against 2022, and the table must say so.

summarystring
prior_sourcestring nullable

Where the prior figures came from, and HOW: as_filed:TEXT_LAYER is a read of the return's text layer, as_filed:SCRIBE a full extraction, engine_computed a year we prepared ourselves. The tier is part of it because a preparer decides whether to check a figure against the paper on exactly that.

prior_unavailable_reasonstring nullable

WHY there is no comparison, when there is none. no_return — nothing uploaded. never_read — a return is on file and its figures were never read, because the run predates headline capture; nothing is wrong with the file. unreadable — we read it and could not get the figures off it, and the run recorded a refusal saying which guard fired. The middle one exists because without it the panel diagnoses an old-flow return as a bad scan and tells a preparer to replace a file that is perfectly good.

current_computed_atstring date-time nullable

When this year's figures were last calculated by the engine — the newest calculated_at across the headline lines. The prior column already says where it came from; without this the current column says nothing at all, and a preparer cannot tell a figure computed a minute ago from one computed before the last three questionnaire answers.

current_staleboolean

At least one headline line is flagged dirty: the engine's answer no longer reflects the inputs. Dirtiness is tracked PER LINE, so this is an any() over the headline set rather than a property of the return — a return can be clean everywhere the table does not look.

compared_countinteger

How many headline lines were actually compared against the prior year. With not_compared_count this is an exhaustive partition of headlines — the two always sum to its length, asserted at the source. Defined as a partition rather than a filter because a filter silently drops a direction added later, and the symptom is not an exception but a printed count whose numbers stop accounting for each other on a document somebody has signed.

not_compared_countinteger

How many could not be compared, for any of the three reasons the direction vocabulary distinguishes.

stale_line_keysstring[]

Which headline concepts are dirty, so the table can mark the affected rows rather than hedging the whole comparison. A banner over thirteen rows when one moved teaches a preparer to ignore it.

corrected_countinteger

How many prior figures a person has corrected. Counted from the overrides actually applied to THIS digest, never from what a client happens to be holding — a second preparer's correction has to show up here for the first preparer on the next read.

Changes

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