E-File Magic

PDFs

Generate filer PDFs

Generate or schedule PDFs for a filer using the requested filters.

POST
/api/v1/pdfs/print_jobs/schedule
Authentication
OAuth 2.0 access token
Required scopes
recipients.readforms.readdocuments.readtax_ids.read
Idempotency key
Required
Rate-limit cost
25 units

On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.

Response fields

11 fields
already_scheduledAlways returnedboolean

Type: boolean.

chunk_sizeAlways returnedinteger

Type: integer.

download_urlMay be omittedstring (uri)

Type: string (uri).

execution_modeAlways returnedstring

Allowed values: "immediate", "scheduled".

export_idAlways returnedstring (uuid)

Type: string (uuid).

filer_idAlways returnedstring (uuid)

Type: string (uuid).

form_idMay be omittedstring

Type: string.

modeAlways returnedstring

Allowed values: "all", "corrected", "uncorrected".

recipient_form_countAlways returnedinteger

Type: integer.

statusAlways returnedstring

Allowed values: "queued", "processing", "merging", "completed", "failed".

tax_yearAlways returnedinteger

Allowed values: 2022, 2023, 2024, 2025, 2026.

Complete response schema: SchedulePdfPrintJobResponse

Structure · HTTP 200
{
  "data": {
    "already_scheduled": "boolean",
    "chunk_size": "integer",
    "download_url": "string (uri)",
    "execution_mode": "string",
    "export_id": "string (uuid)",
    "filer_id": "string (uuid)",
    "form_id": "string",
    "mode": "string",
    "recipient_form_count": "integer",
    "status": "string",
    "tax_year": "integer"
  },
  "meta": {
    "api_version": "v1",
    "request_id": "string"
  }
}

Successful response structure. This outline shows field types, not a response to copy. Expand Response fields for nested properties and optional values.