Initialize the Account's Employee payroll schedule

post

https://api.wingspan.app/v3/payments/payroll-schedules/{type}/initialize

Set up the effective Account's Employee (W-2) schedule. This is a one-time step: it saves the cadence, sets the schedule Active, and creates the first PayPeriod with its Draft on-cycle PayrollRun, from which on-cycle runs continue. Change it afterwards with PATCH /payments/payroll-schedules/Employee.
Only Employee can be initialized — the Contractor schedule always exists and is configured with PATCH. Requires the Account's employer payroll profile (404 otherwise) and a payroll funding source (422 otherwise). A schedule that is already initialized is a 409.

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

One-time setup of the Account's Employee (W-2) schedule. Sets the schedule Active and creates the first PayPeriod with its Draft on-cycle PayrollRun. The in-period anchor is derived from frequency and startDate, so dayOfWeek and dayOfMonth are not accepted.
Only the cadences the W-2 engine implements are accepted: Weekly interval 1 or 2, or Monthly interval 1.

frequency

string

enum

required

Cadence in the shared recurrence vocabulary. There is no Biweekly member — biweekly is Weekly with interval 2, so a caller rendering a cadence must read both fields. Employee schedules accept only Weekly (interval 1 or 2) or Monthly (interval 1).

Allowed:

interval

integer

≥ 1

Defaults to 1

"Every N periods" multiplier. Biweekly is Weekly with interval 2.

startDate

date

required

The first day of the first pay period.

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

201Payroll schedule initialized

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error