Get workpaper evaluation status (poll by tax_return_id)

Returns evaluation job status for the given tax_return_id. Poll until status is "COMPLETED" or "FAILED"; then call GET workpaper to fetch the workpaper. Returns "IDLE" if no job.

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

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

Query parameters

tax_return_idstring uuid required

Tax return ID from evaluate/reevaluate response

Response

Successful Response

workpaper_status'COMPLETE' | 'PARTIAL' | 'ERROR'

Workpaper/form outcome. DB: core_schema.workpaper_status_outcome_enum.

completed_atstring date-time nullable

When the job finished (COMPLETED or FAILED).

error_messagestring nullable

Error details when status is FAILED.

Changes

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