Cancel a pay statement

post

https://api.wingspan.app/v3/payments/pay-statements/{payStatementId}/cancel

Payer-only. Valid only while the pay statement is Draft and its payroll run is still Draft. Cancelling detaches the statement's work logs (back to InReview) and removes the statement; the payroll run's totals are recalculated. A Paid or Failed statement, or one on a finalized run, rejects with 409. Returns the pay statement as it was at cancellation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payStatementId

string

required

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

200Pay statement cancelled

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict