Skip to main content
POST
Compare two paychecks and explain the differences

Authorizations

Authorization
string
header
required

Obtain a token by calling GET /authentication/login with your Symmetry API key in the api-key header. Paste the accessToken value here.

Body

application/json

Input for POST /v1/experimental/compare — two PayCalc contexts with 1-10 tax IDs.

taxIds
required

Tax ID(s) to compare. String for single tax, array for multiple (max 10)

context_a
PayCalcContext · object
required

First paycheck (earlier payDate becomes 'before')

context_b
PayCalcContext · object
required

Second paycheck (later payDate becomes 'after')

Response

Successful Response

Response for POST /v1/experimental/compare.

id
string
required

Request ID (ULID)

summary
string
required

Single flowing narrative explaining differences (≤200 words)

paycheck
Paycheck · object
required

Paycheck-level diff section (gross, net, wages, benefits)

results
TaxResult · object[]

Per-tax comparison results — one entry per requested tax that resolved in at least one context

usage
TokenUsage · object | null

Token usage statistics from the Bedrock call (None if the call did not complete)

ai_disclosure
string
default:This explanation is generated using AI and is provided for informational purposes only. It does not constitute tax, legal, or financial advice. AI can make mistakes.

Static AI-generated content disclaimer for client display