Update one of the Account's payroll schedules

patch

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

Partially update the effective Account's cadence for type. Every field is an independent partial update: absent means unchanged, and clearing an already-set value is not supported here.
Fields are not uniformly valid across types — a field the target type's source document cannot store is a 422 naming the field and the type, never a silent no-op. Employee accepts only the cadences its engine implements (Weekly interval 1 or 2, or Monthly interval 1) and is editable only while the schedule is still fresh, which surfaces as 409.
Whether payroll is processed at all is owned by PATCH /payments/payer-settings; this operation configures cadence only.

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

PATCH semantics: omitted fields are left unchanged. Clearing an already-set value is not supported here.
Fields are not uniformly valid across types — a field the target type's source document cannot store is a 422 naming the field and the type, never a silent no-op. frequency, interval and startDate are valid for both types; endDate, dayOfWeek, dayOfMonth, processDaysBeforeDue, enableProcessDaysBeforeDue and scheduleDates are Contractor only. Employee accepts nothing beyond the shared three, because its in-period anchor is always derived server-side from frequency and startDate.
status is deliberately absent — whether an Account's payroll is processed is owned by PATCH /payments/payer-settings. This resource configures cadence only.
Employee additionally accepts only the cadences its engine implements — Weekly interval 1 or 2, or Monthly interval 1 — and is editable only while the schedule is still fresh (exactly one PayPeriod, its on-cycle run still Draft), which surfaces as 409.

frequency

string

enum

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

"Every N periods" multiplier. Requires frequency in the same request, since an interval alone cannot say what it multiplies.

startDate

date

endDate

date

dayOfWeek

string

enum

ISO weekday. Set only on a Weekly schedule, biweekly included.

Allowed:

dayOfMonth

integer

1 to 31

processDaysBeforeDue

integer

≥ 0

Sending a day count also sets enableProcessDaysBeforeDue to true, unless enableProcessDaysBeforeDue is sent in the same request.

enableProcessDaysBeforeDue

boolean

Turns "pay approved payables only when due" on or off. Leaves the stored processDaysBeforeDue unchanged. Contractor only.

scheduleDates

array of objects

Full-series echo of the Account's payroll runs; see PayrollScheduleDateUpdate. Contractor only — Employee materializes PayPeriods rather than occurrences and has no series to edit.
Mutually exclusive with every cadence field above: changing the cadence re-derives the whole series, so accepting both would discard the explicit dates. An empty array means "not editing the series", not "clear it" — clearing is what a cadence change does.

scheduleDates

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

200Payroll schedule updated

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error