Tax Export

Download a ProSeries fill plan for the chosen documents and questionnaire groups

Compile a plan limited to what the preparer chose, and stream it as a download.

☠ THE GET ABOVE IS UNTOUCHED AND STAYS THE FULL EXPORT. Every existing caller keeps working with no selection concept at all; this is an addition, not a migration. A POST with an empty body is identical to that GET.

post/internal/api/tax-export/{client_id}/proseries/plan

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_yearinteger

Request body

document_idsstring[] nullable

App document ids to include. Omit or null for every document.

questionnaire_groupsstring[] nullable

Questionnaire group keys to include — the first segment of a question code, e.g. 'basic_info'. Omit or null for every group.

acknowledge_warningsboolean

Proceed even though the plan carries warnings a preparer should see first. Send false (the default) to be told about them; send true only after a human has read them and chosen to continue.

Response

The fill artifact as a file download (application/json).

unknown required

Changes

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