Generate tax filings in bulk for a payer

post

https://api.wingspan.app/v3/compliance/tax-filings/bulk-generate

Generates tax filings in bulk for the payer account — one filing per in-scope payee for the given form type and year. Subject to the one-filing-per-(payer, payee, type, year) rule, a payee that already has a filing for that key is refreshed in place rather than duplicated. Each generated filing produces and calculates its forms automatically. Omit payeeIds to target every eligible payee on the payer account. Long-running; returns 202 with an async operation to poll.
Available in 1099 phase 2

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payer-level request to generate tax filings in bulk for a single form type and year. One TaxFiling is generated per in-scope payee, subject to the one-filing-per-(payer, payee, type, year) rule; a payee that already has a filing for that key is refreshed in place, not duplicated. Each generated filing produces and calculates its forms automatically. Omit payeeIds to target every eligible payee on the payer account.

type

string

enum

required

The kind of form a payee-scoped filing produces and files. A filing produces forms of a single type; collected forms (W-9, W-4, W-8 BEN) are not filed and have no TaxFiling. Form generation and reportability resolve from the payee's tax identity and classification history at calculation time.

Allowed:

year

integer

required

channel

string

enum

Whether the filing is submitted through Wingspan rails or recorded as filed elsewhere.

Allowed:

payeeIds

array of strings

Optional subset of payees to target. Omit to target every eligible payee on the payer account.

payeeIds

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

202Bulk generation accepted

400Malformed request syntax

401Unauthenticated

403Forbidden

422Validation error

501This operation is not yet available

503A downstream dependency is temporarily unavailable; retryable. Body carries code: ServiceUnavailable and may include extensions.retryAfter.