List contractor tax statements

Returns a paginated list of contractor tax statements.

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

In preview

The Contractor Tax Statements API is currently in limited preview, and is not yet generally available.

Returns a paginated list of contractor tax statements. Each page contains up to 25 results by default. Use the limit query parameter to change the page size; the maximum value is 500. Follow the next and previous URLs to move between pages.

You must pass contractor, company, or both. A request with neither returns a 400 validation error.

Requires an API key with the contractor:read, contractor:write, or contractor:admin scope. Returns 404 unless contractor tax statements are enabled for your account.

Filters

  • contractor — return statements for a single contractor ID.
  • company — return statements for a single company ID.
  • year — return statements for a single tax year.
  • publication_status — draft returns statements that have not been published, and published returns statements that have. pending_correction is accepted but returns no results.
  • type — original returns every statement. amendment is accepted but returns no results.
Query Params
string

Return statements for this contractor. Required unless company is set.

string

Return statements for this company. Required unless contractor is set.

int32

Return statements for this tax year.

string
enum

draft returns unpublished statements and published returns published ones. pending_correction is accepted but returns no results.

Allowed:
string
enum

original returns every statement. amendment is accepted but returns no results.

Allowed:
int32
Defaults to 25

Number of statements returned per page. The maximum value is 500.

string

Pagination cursor from a next or previous response URL.

Responses

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