# LuckPanda Payroll API

**Canonical:** https://apis.io/apis/luckpanda-app/luckpanda-app-payroll-api/  
**Provider:** LuckPanda — https://apis.io/providers/luckpanda-app/  
**Base URL:** https://luckpanda.app/api/v1  
**Documentation:** https://luckpanda.app/modules/workspace/developers

LuckPanda Payroll API is one of 21 APIs that [LuckPanda](https://apis.io/providers/luckpanda-app/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Payroll. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

UK, US federal and Canada (outside Québec) payroll; journal import elsewhere. Never holds or moves money (D109).

## Operations (29)

| Method | Path | Summary |
|---|---|---|
| GET | `/payroll/settings` | Payroll setup of a legal entity with its setup issues and rule version |
| PUT | `/payroll/settings` | Human-only (payroll.settings). |
| GET | `/payroll/billing` | Active employees this billing period, the 5 the module covers, extra employees… |
| GET | `/payroll/rules` | Rule versions with sources, verification status and test-vector results |
| GET | `/payroll/employees` | Employees (identifiers and bank details masked) |
| POST | `/payroll/employees` | Create an employee (action create). Bank details and identifiers are human-only |
| GET | `/payroll/employees/{employeeId}` | One employee with items, payslips and year to date; reveal=true… |
| POST | `/payroll/employees/{employeeId}` | update, terminate, rehire, set_item, end_item |
| GET | `/payroll/runs` | Pay runs, newest first |
| POST | `/payroll/runs` | Create a draft run and compute every payslip (agents may draft) |
| POST | `/payroll/runs/preview` | Compute without saving, or preview a draft run: payslips, review seals, journal… |
| GET | `/payroll/runs/{runId}` | One run with payslips, review diff, liabilities and bank files |
| PATCH | `/payroll/runs/{runId}` | Change inputs of a draft (hours, one-off items) and recompute, or discard it |
| GET | `/payroll/runs/{runId}/preview` | Preview a saved run |
| POST | `/payroll/runs/{runId}/approve` | Human-only (payroll.approve). |
| POST | `/payroll/runs/{runId}/post` | Human-only (payroll.post). |
| POST | `/payroll/runs/{runId}/reverse` | Human-only (payroll.post), reason required. |
| GET | `/payroll/runs/{runId}/payslips/{employeeId}/pdf` | The payslip as a PDF (NOT POSTED watermark before posting) |
| GET | `/payroll/liabilities` | What is owed to each authority, grouped by due date, with due seals, the… |
| POST | `/payroll/liabilities/settle` | Human-only (payroll.pay). |
| GET | `/payroll/filings` | Generated filings with validation results |
| POST | `/payroll/filings` | Build FPS, EPS, P60, P45, 941, 940, W-2, EFW2, T4, ROE or PD7A from posted… |
| GET | `/payroll/filings/{filingId}` | One filing |
| POST | `/payroll/filings/{filingId}/submit` | Human-only (payroll.file). |
| GET | `/payroll/filings/{filingId}/download` | The file (XML, EFW2 text, JSON worksheet); as=pdf gives W-2 or P60 employee… |
| GET | `/payroll/bank-files` | Generated net-pay files |
| POST | `/payroll/bank-files` | NACHA PPD, Bacs Standard 18, UK CSV, CPA-005, ABA or SEPA pain.001 for a posted… |
| POST | `/payroll/bank-files/{bankFileId}/release` | Human-only (payroll.bank_release). |
| POST | `/payroll/journal-import` | Post payroll journals from another payroll system (CSV, mapped columns); agents… |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/luckpanda-app/openapi/luckpanda-app-payroll-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/luckpanda-app/json-schema/luckpanda-app-create-invoice-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/luckpanda-app/json-schema/luckpanda-app-invoice-result-schema.json
- **JSONSchema** — https://artifacts.apis.io/luckpanda-app/json-schema/luckpanda-app-record-payment-receipt-schema.json
- **JSONSchema** — https://artifacts.apis.io/luckpanda-app/json-schema/luckpanda-app-document-schema.json
- **JSONSchema** — https://artifacts.apis.io/luckpanda-app/json-schema/luckpanda-app-webhook-delivery-schema.json
- **JSONSchema** — https://artifacts.apis.io/luckpanda-app/json-schema/luckpanda-app-api-key-input-schema.json

## Other LuckPanda APIs (12)

- [LuckPanda Access API](https://apis.io/apis/luckpanda-app/luckpanda-app-access-api/)
- [LuckPanda API keys API](https://apis.io/apis/luckpanda-app/luckpanda-app-api-keys-api/)
- [LuckPanda Approvals API](https://apis.io/apis/luckpanda-app/luckpanda-app-approvals-api/)
- [LuckPanda Banking API](https://apis.io/apis/luckpanda-app/luckpanda-app-banking-api/)
- [LuckPanda Books API](https://apis.io/apis/luckpanda-app/luckpanda-app-books-api/)
- [LuckPanda Chatbot API](https://apis.io/apis/luckpanda-app/luckpanda-app-chatbot-api/)
- [LuckPanda Connectors API](https://apis.io/apis/luckpanda-app/luckpanda-app-connectors-api/)
- [LuckPanda Context API](https://apis.io/apis/luckpanda-app/luckpanda-app-context-api/)
- [LuckPanda Documents API](https://apis.io/apis/luckpanda-app/luckpanda-app-documents-api/)
- [LuckPanda Guest Access Grants API](https://apis.io/apis/luckpanda-app/luckpanda-app-guest-access-grants-api/)
- [LuckPanda Invoices API](https://apis.io/apis/luckpanda-app/luckpanda-app-invoices-api/)
- [LuckPanda Members API](https://apis.io/apis/luckpanda-app/luckpanda-app-members-api/)

## Tags

Payroll

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/luckpanda-app/luckpanda-app-payroll-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/luckpanda-app/.