Get Workpaper (via tax-engine)

Returns workpaper (status, job, indeterminate_forms, forms) for the given client and tax year. Call after status is COMPLETED. Proxies to tax-engine.

get/internal/api/clients/{client_id}/workpaper

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

client_idstring uuid required

Client ID

tax_yearinteger required

Tax year (1900-2100)

Successful Response

tax_yearinteger required

Tax year (request context)

client_idstring uuid nullable

Client id (echo from path)

tax_return_idstring uuid nullable

Return id when return exists; null otherwise

return_status'DRAFT' | 'REVIEW' | 'FILED' | 'ACCEPTED'

Tax return lifecycle. DB: core_schema.tax_return_status_enum.

status'NO_RETURN' | 'EVALUATING' | 'STALE' | 'READY' | 'ERROR' required

Single display status for GET workpaper (UI branch). Backend-computed; frontend uses this only.

updated_atstring date-time nullable

When workpaper was last successfully updated

indeterminate_forms_countinteger required

Length of indeterminate_forms

eligible_forms_countinteger required

Length of forms

correlation_idstring nullable

Request correlation id when provided

workpaper_pdf_storage_keystring nullable

Storage key for full workpaper PDF; use with GET .../workpaper/pdf?storage_key= to get presigned URL.

return_diagnostics_countinteger

Length of return_diagnostics

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