List corrections

Returns a paginated list of corrections.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

In preview

The Correction API is currently in limited preview, and is not yet generally available.

Returns a paginated list of correction list entries. Each page contains up to 25 results by default. Use the limit query parameter to request a smaller page; the maximum value is 100.

Filters

  • company — return corrections for a single company ID.
  • year — return corrections for a single tax year.
  • status — return corrections with this status (draft, pending, processing, settled, or failed).
  • payroll — return corrections that include the given payroll as a member. This is the read side of a payroll's corrected_by lineage.
Query Params
string

Filter to corrections belonging to a single company.

int32

Filter to corrections for a single tax year.

string
enum

Filter to corrections with this status.

Allowed:
string

Filter to corrections that include the given payroll as a member.

int32

Number of corrections returned per page. The maximum value is 100.

id
array of strings

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

id
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json