Preview the Account's pay periods across a window

post

https://api.wingspan.app/v3/payments/payroll-schedules/{type}/preview-pay-periods

Project the effective Account's pay periods across a date window. Employee PayPeriods are only ever materialized one at a time, and Contractor occurrences only a bounded distance ahead, so for both types the window is filled by continuing the schedule with the same date math the generator uses. Nothing is persisted; this is a pure projection, and materialized and projected periods are returned in the same shape.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

type

string

enum

required

Which of the Account's two schedules to address. There is no separate schedule identifier to mint, so this plus the effective Account names the resource.

Allowed:

Body Params

Project the Account's pay periods across a window. Employee PayPeriods are only ever materialized one at a time, and Contractor occurrences only a bounded distance ahead, so for both types the window is filled by continuing the schedule with the same date math the generator uses. Nothing is persisted; this is a pure projection.

fromDate

date

required

Inclusive window start. A period is returned when it OVERLAPS the window, not only when fully contained by it — a window falling inside one long period would otherwise return nothing.

toDate

date

required

Inclusive window end.

count

integer

1 to 120

Defaults to 12

Maximum periods to return. Defaults to 12; capped at 120 so an open-ended window cannot drive an unbounded projection.

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

200Projected pay periods

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

422Validation error