Apply a data-driven adjustment to a filing

post

https://api.wingspan.app/v3/compliance/tax-filings/{taxFilingId}/adjust

Applies a dated input change to a managed filing and records it as an immutable adjustment. For Add and Reduce, effectiveDate and reason are required — the "add this amount on this date for this reason" shape — and the filing regenerates its forms, matching the effective date to the entity-window split it touches. A full box-value override is not done here; that is manual mode only, by editing the form's data after switching to manual. 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…

Path Params

taxFilingId

string

required

Unique identifier of the tax filing

Body Params

Applies a dated input change to a managed filing. For Add and Reduce, both effectiveDate and reason are required — the "add this amount on this date for this reason" shape. Recalculate re-pulls the authoritative data and takes no amount or date. A full box-value override is manual mode only.

mode

string

enum

required

The kind of input change an adjustment records. Add and Reduce apply a dated amount delta. Recalculate re-pulls the authoritative payment data with no amount or date.

Allowed:

amount

double

Signed delta for Add/Reduce.

effectiveDate

date

Selects the entity-window split to touch. Required for Add and Reduce; omit for Recalculate.

boundaryType

string

enum

Allowed:

reason

string

Required for Add and Reduce.

sourceInvoiceIds

array of strings

sourceInvoiceIds

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

202Adjustment accepted

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error

501This operation is not yet available

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