API Reference

Get a payroll run

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

Retrieve a payroll run. Pass expand=Breakdown to include breakdown:

  • Employee run: gross pay, net pay, and the employer and employee tax amounts.
  • Contractor run: the payables' total amount and count, deductions, and how many
    payables (and how much) are in each payment status.

breakdown is null when it was not requested, or when the run has no breakdown.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
expand
array of objects
expand
Allowed:
Headers
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?