Skip to main content
GET
Get a payroll run
Preview. A contract we are building with design partners. It is not callable yet, and fields can still change. See Availability.

Authorizations

Authorization
string
header
required

Your partner secret key, mk_live_… for real companies or mk_test_… for test companies. Keep it on your servers. See Authentication.

Path Parameters

company_id
string<uuid>
required

The company's ID. Every company-scoped call works in exactly this company.

payroll_run_id
string<uuid>
required

Response

The run.

id
string<uuid>
required
period
string
required
kind
enum<string>
required
Available options:
ordinary,
extra,
supplementary
status
enum<string>
required

validated: usable for the settlement and the returns. rejected: see issues. settled: the month's contribution settlement is confirmed.

Available options:
received,
validated,
rejected,
settled
created_at
string<date-time>
required
external_id
string | null
totals
object
issues
object[]
settlement_id
string<uuid> | null
tax_return_ids
string<uuid>[]

The 111 (and, in January, the 190) this run feeds.