API Reference

Create a tax filing

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

Creates the filing automation for a given payee, type, and year. At most one filing may exist per payer account, payee, type, and year; a duplicate returns 409 Conflict.

On creation the filing automatically generates and calculates its forms from the payee's payment history, advancing to Calculated, and keeps those amounts current as the underlying payment data moves. There is no separate calculate step.

If externalId is supplied and already used by another resource of this type for the owning Account, the request returns 409 ResourceConflict; create is not an upsert. Use filter[externalId][eq] on the list endpoint to retrieve the existing resource. Available in 1099 phase 2

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The payee whose tax-form workflow this filing manages.

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:
integer
required
string
enum

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

Allowed:
string
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
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.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago

Did this page help you?