# Payroll export

> Payroll runs that collect the hours worked, the approved leave and optionally the scheduled shifts of a period into lines per person, locked by an export through a versioned PayrollExportFormat port.

- Category: People
- Module: `payroll-export`
- Modes: `managed`, `custom`
- Docs: https://bettersupabase.com/docs/blocks/payroll-export
- Page: https://bettersupabase.com/blocks/payroll-export

## Install

```bash
npx better-supabase add payroll-export
```

The command also installs `updated-at`, `memberships`, `permissions`.

## Configure

Add the block to `better-supabase.config.ts`:

```ts
import { defineConfig } from "better-supabase/config";

export default defineConfig({
  blocks: {
    // Required by payroll-export; add installs them too.
    "updated-at": {},
    memberships: {},
    permissions: {},
    // Modes: "managed", "custom". The default is "managed".
    "payroll-export": { mode: "managed" },
  },
});
```

## Client

The block has no React entry yet. Its server-side TypeScript is in `better-supabase/blocks/payroll-export`.

## Events

- `payroll_run.created`
- `payroll_run.exported`

## Related blocks

Requires: [memberships](https://bettersupabase.com/blocks/memberships.md), [permissions](https://bettersupabase.com/blocks/permissions.md)

Works with: [time-tracking](https://bettersupabase.com/blocks/time-tracking.md), [leave](https://bettersupabase.com/blocks/leave.md), [shifts](https://bettersupabase.com/blocks/shifts.md), [employees](https://bettersupabase.com/blocks/employees.md), [outbox](https://bettersupabase.com/blocks/outbox.md), [audit](https://bettersupabase.com/blocks/audit.md)

## Recipes

- [Payroll runs](https://bettersupabase.com/recipes/payroll-runs.md): The organization's payroll runs, newest period first, with their line count, export format and whether they are locked.