Pay run history

The employer's admin sees past and current pay runs by financial year, opens one to read its figures as Payroo calculated them, and opens payslips and the payment file. Read only.

The pay run list with a draft and a published run
Session employer; payruns:read, documents:read (payslips and payment file)
Component id payrun-history
React export PayrunHistory
Guide Payslips and documents

Try it live on synthetic data, natively and in Payroo's frame: in the gallery, or the outcomes in Results.

Mount it

<PayrunHistory financialYear={2027} />
<PayrooFrame component="payrun-history" />

Props

Prop Meaning
financialYear the Australian financial year by the calendar year it ends in (2027 is July 2026 to June 2027)
state show only runs in this state
onOpen(summary) a run was opened
detail inline (default) opens the read-only detail here; none keeps the list only, for a page that shows PayrunReview itself on onOpen
onOpenDocument(payslip) a payslip was opened from the detail

Events

Event When
document.opened a payslip or the payment file was opened

Errors it can show

Code Meaning Next action
not_found the document does not exist yet wait for the run to be published