API Reference

Create an off-cycle payroll run

post
https://api.wingspan.app/v3/payments/payroll-runs

Create an off-cycle payroll run in Draft status. type is required and sets the body: an Employee run takes the payPeriodId it pays; a Contractor run takes a currency and the payables to pay (selection).

A pay period can have only one open off-cycle Employee run (Draft, PendingApprovals, Finalized, or Processing); creating a second returns 409 ResourceConflict.

Sending an externalId that another run already uses creates a new run; it is not an upsert and does not update the existing one. Send an Idempotency-Key to retry the request safely.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Allowed:
string
required

The pay period this run pays.

string
enum

Optional. Employee runs are in USD; any other value returns 422.

Allowed:
string

Your own stable key for the run. It is not used to detect duplicate creates; send an Idempotency-Key for that.

string

Customer's own id for reconciliation.

metadata
object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers
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
^(?:[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

Updated 14 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 14 days ago

Did this page help you?