Preview a pay statement (gross-to-net)

post

https://api.wingspan.app/v3/payments/pay-statements/preview

Payer-only. Models the gross-to-net result for one payee's UNPAID work in a pay period — every work log not yet paid (unconverted, or attached to a still-Draft statement). Nothing is persisted. The response echoes the config the modeling used (payDate, payPeriodsPerYear, payPeriodNumber).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Inputs for a payer-only gross-to-net preview of one payee's pay statement for a pay period.

payPeriodId

string

required

The pay period to model.

payeeAccountId

string

required

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

The employee whose pay statement is being previewed.

workLogIds

array of strings

Optional. Restrict the preview to these work logs — each must be one of the payee's eligible unpaid work logs for the period, or the request is rejected with the offending ids. Omit to model over all eligible unpaid work logs.

workLogIds

Headers

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).

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.

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

200Modeled gross-to-net preview

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found