Evaluate Workpaper (first-time, async)

First-time evaluation: get-or-create draft tax return for this client and tax year. If one already exists, returns that same tax_return_id. Returns 202 + tax_return_id; frontend polls GET workpaper/status?tax_return_id= until COMPLETED or FAILED, then GET workpaper.

post/internal/api/clients/{client_id}/workpaper/evaluate

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_idstring uuid required

Client ID

Request body

tax_yearinteger required

Tax year for workpaper evaluation

triggered_by_user_idstring uuid nullable

User who triggered; defaults to current user when omitted.

Example request

{
  "tax_year": 2024
}

Response

Successful Response

tax_return_idstring uuid required

Tax return UUID; use in GET workpaper and future reevaluate requests.

status'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED'

Job lifecycle. DB: workpaper_regeneration_job_status_enum. API adds IDLE in core.

Changes

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