# Flow Payroll

> Flow Payroll documentation — product guides and the developer API reference for the UK payroll platform.

## Docs

- [Authentication](https://docs.flowpayroll.ai/api-reference/authentication.md): Flow Payroll uses token-based authentication. Exchange your client credentials for a short-lived access token, then send it on every request.
- [Download credit note PDF from provider](https://docs.flowpayroll.ai/api-reference/billing/accounting-sync/download-credit-note-pdf-from-provider.md)
- [Download invoice PDF from provider](https://docs.flowpayroll.ai/api-reference/billing/accounting-sync/download-invoice-pdf-from-provider.md)
- [Import selected account codes from connected provider](https://docs.flowpayroll.ai/api-reference/billing/accounting-sync/import-selected-account-codes-from-connected-provider.md)
- [Import selected contacts from connected provider](https://docs.flowpayroll.ai/api-reference/billing/accounting-sync/import-selected-contacts-from-connected-provider.md)
- [Import selected tax rates from connected provider](https://docs.flowpayroll.ai/api-reference/billing/accounting-sync/import-selected-tax-rates-from-connected-provider.md)
- [List account codes from connected provider (paginated, no import)](https://docs.flowpayroll.ai/api-reference/billing/accounting-sync/list-account-codes-from-connected-provider-paginated-no-import.md)
- [List contacts from connected provider (paginated, no import)](https://docs.flowpayroll.ai/api-reference/billing/accounting-sync/list-contacts-from-connected-provider-paginated-no-import.md)
- [List tax rates from connected provider (paginated, no import)](https://docs.flowpayroll.ai/api-reference/billing/accounting-sync/list-tax-rates-from-connected-provider-paginated-no-import.md)
- [Push client and contacts to accounting provider](https://docs.flowpayroll.ai/api-reference/billing/accounting-sync/push-client-and-contacts-to-accounting-provider.md)
- [Push credit note to accounting provider](https://docs.flowpayroll.ai/api-reference/billing/accounting-sync/push-credit-note-to-accounting-provider.md)
- [Push invoice to accounting provider](https://docs.flowpayroll.ai/api-reference/billing/accounting-sync/push-invoice-to-accounting-provider.md)
- [Create Client](https://docs.flowpayroll.ai/api-reference/billing/clients/create-client.md): Creates a new client. When the organisation has finance defaults set (default revenue account and default tax), defaultRevenueAccountCode and defaultTaxType may be omitted and are auto-filled from org defaults; otherwise both fields are required.
- [Delete Client](https://docs.flowpayroll.ai/api-reference/billing/clients/delete-client.md): Deletes a client by its unique identifier. If the client has invoices or credits, the client is archived (soft-delete). Otherwise the client is hard deleted. Returns the client in both cases (200 OK).
- [Get Client by Id](https://docs.flowpayroll.ai/api-reference/billing/clients/get-client-by-id.md): Retrieves a client by its unique identifier.
- [Get Client Finance Settings](https://docs.flowpayroll.ai/api-reference/billing/clients/get-client-finance-settings.md): Gets the client's finance settings. Seeds with defaults if none exist.
- [List Clients](https://docs.flowpayroll.ai/api-reference/billing/clients/list-clients.md): Lists all clients.
- [List Invoices for Client](https://docs.flowpayroll.ai/api-reference/billing/clients/list-invoices-for-client.md): Lists invoices for a client (REST: sub-resource under client).
- [Unarchive Client](https://docs.flowpayroll.ai/api-reference/billing/clients/unarchive-client.md): Sets client status back to Active. Returns 404 if client not found or not archived.
- [Update Client](https://docs.flowpayroll.ai/api-reference/billing/clients/update-client.md): Updates a client.
- [Update Client Finance Settings](https://docs.flowpayroll.ai/api-reference/billing/clients/update-client-finance-settings.md): Updates the client's finance settings.
- [Add Credit Note Attachments](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/add-credit-note-attachments.md): Creates attachment metadata and returns presigned upload URLs. Upload each file with PUT to the returned uploadUrl. Only draft credit notes.
- [Allocate Credit to Invoice](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/allocate-credit-to-invoice.md): Applies a credit note to an invoice. Validates amount <= remaining credit and <= invoice balance due. Updates both credit note and invoice atomically.
- [Authorise Credit Note](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/authorise-credit-note.md): Locks the credit note (status → AUTHORISED) and makes it available for allocation to invoices. Syncs to external accounting provider if connected.
- [Create Draft Credit Note](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/create-draft-credit-note.md): Creates a new credit note in DRAFT status with line items, tax calculations, and account codes.
- [Delete Credit Note Attachment](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/delete-credit-note-attachment.md): Deletes an attachment from a draft credit note.
- [Delete Draft Credit Note](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/delete-draft-credit-note.md): Deletes a credit note. Only DRAFT credit notes can be deleted.
- [Get Credit Note by ID](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/get-credit-note-by-id.md): Retrieves a credit note by its unique identifier, including all line items and allocations.
- [List Credit Note Line Items](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/list-credit-note-line-items.md): Returns paginated line items for a credit note. Use for credit notes with many lines (e.g. 10k+).
- [List Credit Notes for Client](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/list-credit-notes-for-client.md): Returns all credit notes for a specific client (DRAFT, AUTHORISED, PAID, VOIDED).
- [List Credit Notes for Organisation](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/list-credit-notes-for-organisation.md): Lists credit notes for the organisation with optional filters (client, status, type, amount range, date range). Paginated.
- [Remove Credit Allocation](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/remove-credit-allocation.md): Removes an allocation between a credit note and invoice. Restores credit to the credit note and increases invoice balance due.
- [Update Draft Credit Note](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/update-draft-credit-note.md): Updates a DRAFT credit note. Only DRAFT credit notes can be edited. Recalculates totals automatically.
- [Void Credit Note](https://docs.flowpayroll.ai/api-reference/billing/credit-notes/void-credit-note.md): Voids a credit note (status → VOIDED). Cannot void fully allocated credit notes. Remaining credit becomes 0.
- [Archive Account Code](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/archive-account-code.md): Archives an account code (status → ARCHIVED). Archived accounts are hidden from dropdowns but existing credit notes retain the account code.
- [Archive Tax Rate](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/archive-tax-rate.md): Archives a tax rate (status → ARCHIVED). Archived rates are hidden from dropdowns but existing credit notes retain the rate.
- [Create Account Code](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/create-account-code.md): Creates a custom account code for the organisation (e.g., '250 - Consulting Revenue'). Stored in DynamoDB.
- [Create Custom Tax Rate](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/create-custom-tax-rate.md): Creates a custom tax rate for the organisation (e.g., 'My Special 5% Tax'). Stored in DynamoDB.
- [Delete Account Code](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/delete-account-code.md): Permanently deletes an account code. Returns 409 if the code is in use by credit notes or client finance settings; archive it instead.
- [Delete Tax Rate](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/delete-tax-rate.md): Permanently deletes a tax rate. Returns 409 if the rate is in use by credit notes or client finance settings; archive it instead.
- [Get attachment limits for connected provider](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/get-attachment-limits-for-connected-provider.md): Returns attachment limits for the organisation's connected accounting provider (e.g. Xero: 50 per invoice, 50 per credit note). Used by the template UI.
- [Get invoice reference formula tokens for a given invoice format](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/get-invoice-reference-formula-tokens-for-a-given-invoice-format.md): Returns available tokens that can be used in the invoice reference formula for a given invoice format. Use the returned id in curly braces in the formula (e.g. {payrollConfigName}). Separators (space, dash, underscore, slash) are always available.
- [Get line item description formula placeholders](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/get-line-item-description-formula-placeholders.md): Returns placeholders that can be used in the line description formula (e.g. {description}, {employeeName}). Use the returned id in curly braces in the formula. When requiresTagGroup is true for a placeholder, set lineDescriptionTagGroupId on the invoice or credit note template when using that placeh…
- [Get organisation credit note template](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/get-organisation-credit-note-template.md): Returns organisation-level credit note template. Uses defaults when never set. Same structure as invoice template: grouping (subsection header, subtotal in subsection, VAT and quantity total), line description formula, optional tag group, attachment strategy.
- [Get organisation finance defaults](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/get-organisation-finance-defaults.md): Returns organisation-level default revenue account and default tax. When both are set, Create Client can omit these fields and they are auto-filled from org defaults. Returns nulls when never set.
- [Get organisation invoice template](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/get-organisation-invoice-template.md): Returns organisation-level invoice template. Uses defaults when never set. The template controls grouping (subsection header, subtotal in subsection, VAT and quantity total in subsection and in bottom subtotals), line description formula (placeholders from GET line-item-description-fields), optional…
- [Get organisation pay element mappings](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/get-organisation-pay-element-mappings.md): Returns organisation-level pay element mappings (global default). Clients without their own mapping use this.
- [List Account Codes](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/list-account-codes.md): Returns all account codes for the organisation (system defaults + custom accounts). Used for credit note line item dropdowns.
- [List Tax Rates](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/list-tax-rates.md): Returns all tax rates for the organisation (system defaults + custom rates). Used for credit note line item dropdowns.
- [Unarchive Account Code](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/unarchive-account-code.md): Restores an archived account code (status → Active). Returns 404 if not found or not archived.
- [Unarchive Tax Rate](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/unarchive-tax-rate.md): Restores an archived tax rate (status → Active). Returns 404 if not found or not archived.
- [Update Account Code](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/update-account-code.md): Updates a custom account code. System default accounts cannot be updated.
- [Update organisation credit note template](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/update-organisation-credit-note-template.md): Updates organisation-level credit note template (global default). Request body: same as invoice template (boolean flags for grouping, line description formula with placeholders from GET line-item-description-fields, optional lineDescriptionTagGroupId, attachment strategy).
- [Update organisation finance defaults](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/update-organisation-finance-defaults.md): Updates organisation-level default revenue account and default tax. Used by Billing settings and to auto-fill new client creation when omitted.
- [Update organisation invoice template](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/update-organisation-invoice-template.md): Updates organisation-level invoice template (global default). Request body uses boolean flags for grouping: show subsection header, show subtotal in subsection, show VAT and quantity total in subsection and in bottom subtotals; line description formula with placeholders from GET line-item-descriptio…
- [Update organisation pay element mappings](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/update-organisation-pay-element-mappings.md): Updates organisation-level pay element mappings (global default).
- [Update Tax Rate](https://docs.flowpayroll.ai/api-reference/billing/finance-settings/update-tax-rate.md): Updates a custom tax rate. System default rates cannot be updated.
- [Disconnect integration](https://docs.flowpayroll.ai/api-reference/billing/integrations/disconnect-integration.md): Removes the stored connection for the provider.
- [Exchange OAuth code for tokens](https://docs.flowpayroll.ai/api-reference/billing/integrations/exchange-oauth-code-for-tokens.md): Validates state and exchanges the authorization code for tokens, stores the connection. Used when redirect_uri is the frontend; frontend sends code and state after user returns from provider.
- [Get integration setup info](https://docs.flowpayroll.ai/api-reference/billing/integrations/get-integration-setup-info.md): Returns setup info (e.g. redirect URI) for the provider so the user can configure their app in the provider's developer portal.
- [Get OAuth login URI](https://docs.flowpayroll.ai/api-reference/billing/integrations/get-oauth-login-uri.md): Returns the provider OAuth login URI for the current organisation. Frontend redirects the user to this URI to start the connection flow.
- [List integration connections](https://docs.flowpayroll.ai/api-reference/billing/integrations/list-integration-connections.md): Returns connection status per provider for the current organisation (no tokens).
- [List integration tenants](https://docs.flowpayroll.ai/api-reference/billing/integrations/list-integration-tenants.md): Returns the list of tenants (organisations) available for the provider. Uses the current connection token; for Xero, calls GET https://api.xero.com/Connections.
- [OAuth callback](https://docs.flowpayroll.ai/api-reference/billing/integrations/oauth-callback.md): Handles the provider OAuth callback: exchanges code for tokens, stores the connection, and redirects the user to the frontend.
- [Save integration credentials](https://docs.flowpayroll.ai/api-reference/billing/integrations/save-integration-credentials.md): Stores the organisation's OAuth app credentials (client ID and secret) for the provider. Required before connecting.
- [Switch integration tenant](https://docs.flowpayroll.ai/api-reference/billing/integrations/switch-integration-tenant.md): Updates the active tenant (organisation) for the integration. Stores the selected tenantId and tenantName on the connection.
- [Test and save custom connection](https://docs.flowpayroll.ai/api-reference/billing/integrations/test-and-save-custom-connection.md): Validates client credentials with the provider (client_credentials grant), then stores the connection. Returns 400 with error details on failure.
- [Add Invoice Attachments](https://docs.flowpayroll.ai/api-reference/billing/invoices/add-invoice-attachments.md): Creates attachment metadata and returns presigned upload URLs. Upload each file with PUT to the returned uploadUrl.
- [Bulk invoice action](https://docs.flowpayroll.ai/api-reference/billing/invoices/bulk-invoice-action.md): Execute a bulk action (Issue) on multiple draft invoices. Each item is processed individually; successes and failures are aggregated.
- [Credit Entire Invoice](https://docs.flowpayroll.ai/api-reference/billing/invoices/credit-entire-invoice.md): Creates a matching credit note for the invoice, authorises it, allocates the full balance to the invoice (setting it to Paid). Only Issued invoices with balance due can be fully credited.
- [Delete Invoice Attachment](https://docs.flowpayroll.ai/api-reference/billing/invoices/delete-invoice-attachment.md): Deletes an attachment from an open invoice. Returns the updated invoice.
- [Email Invoice](https://docs.flowpayroll.ai/api-reference/billing/invoices/email-invoice.md): Sends the invoice via email through the connected accounting provider. Only Issued invoices that have been synced to the provider can be emailed. Marks the invoice as email sent.
- [Get Invoice by Id](https://docs.flowpayroll.ai/api-reference/billing/invoices/get-invoice-by-id.md): Retrieves an invoice by its unique identifier.
- [Get Invoice Line Items](https://docs.flowpayroll.ai/api-reference/billing/invoices/get-invoice-line-items.md): Retrieves line items for an invoice (paginated; default page size 100, max 1000 to stay under API Gateway 10 MB limit).
- [List Invoices for Organisation](https://docs.flowpayroll.ai/api-reference/billing/invoices/list-invoices-for-organisation.md): Lists invoices for the organisation with optional filters (client, status, invoice type, invoice format, grouping key value, amount range, invoice date range, has attachments). Paginated.
- [Refresh line item mappings](https://docs.flowpayroll.ai/api-reference/billing/invoices/refresh-line-item-mappings.md): Re-applies the current pay element mapping to draft invoice line items. Optionally filter by account code and/or tax type. Returns refreshed line count and updated invoice.
- [Update Invoice (e.g. close)](https://docs.flowpayroll.ai/api-reference/billing/invoices/update-invoice-eg-close.md): Updates an invoice. Use to close: sets status to Closed after in-flight line item processing completes (waits up to 2 minutes for sentinels to clear).
- [Update open invoice](https://docs.flowpayroll.ai/api-reference/billing/invoices/update-open-invoice.md): Updates an open invoice (e.g. tags). Only open invoices can be updated. Returns 400 when invoice is not found or is closed.
- [Void Invoice](https://docs.flowpayroll.ai/api-reference/billing/invoices/void-invoice.md): Voids an Issued invoice (status → Voided, balance due → 0). Only Issued invoices can be voided. Returns 400 if invoice is Draft or already Paid/Voided.
- [Delete orders](https://docs.flowpayroll.ai/api-reference/court-orders/court-orders/delete-orders.md)
- [Delete orders attachments](https://docs.flowpayroll.ai/api-reference/court-orders/court-orders/delete-orders-attachments.md)
- [Get orders](https://docs.flowpayroll.ai/api-reference/court-orders/court-orders/get-orders.md)
- [Get orders 1](https://docs.flowpayroll.ai/api-reference/court-orders/court-orders/get-orders-1.md)
- [Get ordersemployees](https://docs.flowpayroll.ai/api-reference/court-orders/court-orders/get-ordersemployees.md)
- [Post orders](https://docs.flowpayroll.ai/api-reference/court-orders/court-orders/post-orders.md)
- [Post orders attachments](https://docs.flowpayroll.ai/api-reference/court-orders/court-orders/post-orders-attachments.md)
- [Put orders](https://docs.flowpayroll.ai/api-reference/court-orders/court-orders/put-orders.md)
- [Delete payees](https://docs.flowpayroll.ai/api-reference/court-orders/payees/delete-payees.md)
- [Get payees](https://docs.flowpayroll.ai/api-reference/court-orders/payees/get-payees.md)
- [Get payees 1](https://docs.flowpayroll.ai/api-reference/court-orders/payees/get-payees-1.md)
- [Post payees](https://docs.flowpayroll.ai/api-reference/court-orders/payees/post-payees.md)
- [Put payees](https://docs.flowpayroll.ai/api-reference/court-orders/payees/put-payees.md)
- [Get all pagination states for the organization](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/get-all-pagination-states-for-the-organization.md): Retrieves pagination states for all supported HMRC DPS data types for the organization. Returns pagination information even for data types that haven't been initialized yet (with highWaterMark = 0). This endpoint is useful for building UI that shows which data types have pagination configured.
- [Get notifications](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/get-notifications.md)
- [Get notifications 1](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/get-notifications-1.md)
- [Get notificationscounts](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/get-notificationscounts.md)
- [Get notificationsjobs](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/get-notificationsjobs.md)
- [Get notificationsjobs status](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/get-notificationsjobs-status.md)
- [Get the last job of a specific type for the organisation](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/get-the-last-job-of-a-specific-type-for-the-organisation.md): Retrieves the most recent job of the specified type for the authenticated organisation. Valid job types: RetrieveAll, BulkApplyNotifications, BulkDismissNotifications
- [Initialize pagination states for all data types](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/initialize-pagination-states-for-all-data-types.md): Initializes pagination states for all supported HMRC DPS data types using date2index conversion. This endpoint can be used to set up pagination from a specific date for both PAYE and CIS services. Use the 'overwriteExisting' parameter to control whether existing pagination states should be replaced.
- [Post notifications apply](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/post-notifications-apply.md)
- [Post notifications ignore](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/post-notifications-ignore.md)
- [Post notificationsbulk apply async](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/post-notificationsbulk-apply-async.md)
- [Post notificationsbulk dismiss async](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/post-notificationsbulk-dismiss-async.md)
- [Post notificationsjobs cancel](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/post-notificationsjobs-cancel.md)
- [Post notificationsretrieve all](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/post-notificationsretrieve-all.md)
- [Post notificationsretry matching](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/post-notificationsretry-matching.md)
- [Put notifications employee](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/put-notifications-employee.md)
- [Put notifications status](https://docs.flowpayroll.ai/api-reference/hmrc-dps/dps-operations/put-notifications-status.md)
- [Get P45 form for an employee](https://docs.flowpayroll.ai/api-reference/hmrc-p-forms/p45-forms/get-p45-form-for-an-employee.md): Retrieves the P45 form data for a specific employee
- [Create employee holiday configuration](https://docs.flowpayroll.ai/api-reference/holiday/holiday-employee-configuration/create-employee-holiday-configuration.md): Creates a holiday configuration for an employee
- [Delete employee holiday configuration](https://docs.flowpayroll.ai/api-reference/holiday/holiday-employee-configuration/delete-employee-holiday-configuration.md): Deletes the holiday configuration for an employee
- [Get employee holiday configuration](https://docs.flowpayroll.ai/api-reference/holiday/holiday-employee-configuration/get-employee-holiday-configuration.md): Retrieves the holiday configuration for a specific employee
- [Update employee holiday configuration](https://docs.flowpayroll.ai/api-reference/holiday/holiday-employee-configuration/update-employee-holiday-configuration.md): Updates the holiday configuration for an employee
- [Get 52-week average rate for an employee](https://docs.flowpayroll.ai/api-reference/holiday/holiday-history/get-52-week-average-rate-for-an-employee.md): Returns the average hourly rate calculated from the last 52 weeks of accruals (looking back up to 104 weeks). This calculation is independent of any date filters and always uses the most recent accrual data.
- [Get holiday history for an employee](https://docs.flowpayroll.ai/api-reference/holiday/holiday-history/get-holiday-history-for-an-employee.md): Returns a unified view of holiday accruals, taken records, and balances with yearly summaries
- [Create a holiday configuration](https://docs.flowpayroll.ai/api-reference/holiday/holiday-organisation-configuration/create-a-holiday-configuration.md): Creates a new holiday configuration for the authenticated organisation
- [Delete the holiday configuration](https://docs.flowpayroll.ai/api-reference/holiday/holiday-organisation-configuration/delete-the-holiday-configuration.md): Deletes the holiday configuration for the authenticated organisation
- [Get the holiday configuration](https://docs.flowpayroll.ai/api-reference/holiday/holiday-organisation-configuration/get-the-holiday-configuration.md): Retrieves the holiday configuration for the authenticated organisation
- [Update the holiday configuration](https://docs.flowpayroll.ai/api-reference/holiday/holiday-organisation-configuration/update-the-holiday-configuration.md): Updates the holiday configuration for the authenticated organisation
- [Delete holiday taken record](https://docs.flowpayroll.ai/api-reference/holiday/holiday-taken/delete-holiday-taken-record.md): Deletes a holiday taken record
- [Get a holiday taken record](https://docs.flowpayroll.ai/api-reference/holiday/holiday-taken/get-a-holiday-taken-record.md): Retrieves a specific holiday taken record by ID
- [Record holiday taken](https://docs.flowpayroll.ai/api-reference/holiday/holiday-taken/record-holiday-taken.md): Creates a new holiday taken record for an employee
- [Update holiday taken record](https://docs.flowpayroll.ai/api-reference/holiday/holiday-taken/update-holiday-taken-record.md): Updates an existing holiday taken record
- [Create opening balance](https://docs.flowpayroll.ai/api-reference/holiday/opening-balance/create-opening-balance.md): Creates an opening balance for an employee
- [Delete opening balance](https://docs.flowpayroll.ai/api-reference/holiday/opening-balance/delete-opening-balance.md): Deletes the opening balance for an employee
- [Get opening balance](https://docs.flowpayroll.ai/api-reference/holiday/opening-balance/get-opening-balance.md): Retrieves the opening balance for an employee (if exists)
- [Update opening balance](https://docs.flowpayroll.ai/api-reference/holiday/opening-balance/update-opening-balance.md): Updates the opening balance for an employee
- [API reference](https://docs.flowpayroll.ai/api-reference/introduction.md): Automate UK payroll end to end — employees, pay runs, payslips, RTI, pensions, statutory pay, and billing — over a single REST API.
- [MCP server](https://docs.flowpayroll.ai/api-reference/mcp-server.md): Connect AI coding tools to the Flow Payroll API and docs through the Model Context Protocol.
- [List all available payment configurations](https://docs.flowpayroll.ai/api-reference/pay-api/availablepaymentconfig/list-all-available-payment-configurations.md)
- [Calculate gross to net values](https://docs.flowpayroll.ai/api-reference/pay-api/calculator/calculate-gross-to-net-values.md)
- [Add or update a tax code for an employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/add-or-update-a-tax-code-for-an-employee.md)
- [Add or update an NI category for an employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/add-or-update-an-ni-category-for-an-employee.md)
- [Create a new employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/create-a-new-employee.md)
- [Delete a specific NI category for an employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/delete-a-specific-ni-category-for-an-employee.md)
- [Delete a specific tax code for an employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/delete-a-specific-tax-code-for-an-employee.md)
- [Delete an existing employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/delete-an-existing-employee.md)
- [End a postgraduate loan for an employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/end-a-postgraduate-loan-for-an-employee.md)
- [End a student loan for an employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/end-a-student-loan-for-an-employee.md)
- [Find employee by National Insurance Number](https://docs.flowpayroll.ai/api-reference/pay-api/employees/find-employee-by-national-insurance-number.md)
- [Find employee by Payroll ID](https://docs.flowpayroll.ai/api-reference/pay-api/employees/find-employee-by-payroll-id.md)
- [Get all NI categories for an employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/get-all-ni-categories-for-an-employee.md)
- [Get all tax codes for an employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/get-all-tax-codes-for-an-employee.md)
- [Get employee data](https://docs.flowpayroll.ai/api-reference/pay-api/employees/get-employee-data.md)
- [Get the effective tax code and NI category for an employee on a specific date](https://docs.flowpayroll.ai/api-reference/pay-api/employees/get-the-effective-tax-code-and-ni-category-for-an-employee-on-a-specific-date.md)
- [List employees with pagination](https://docs.flowpayroll.ai/api-reference/pay-api/employees/list-employees-with-pagination.md)
- [Start a postgraduate loan for an employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/start-a-postgraduate-loan-for-an-employee.md)
- [Start a student loan for an employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/start-a-student-loan-for-an-employee.md)
- [Update an employee's National Insurance Number](https://docs.flowpayroll.ai/api-reference/pay-api/employees/update-an-employees-national-insurance-number.md)
- [Update an employee's payroll config assignment](https://docs.flowpayroll.ai/api-reference/pay-api/employees/update-an-employees-payroll-config-assignment.md): Updates the employee's payroll config. Removes the employee from open payroll runs of the old config, deletes all preview payslips, adds the employee to open runs of the new config, and pre-processes payslips for the new periods.
- [Update an employee's Payroll ID](https://docs.flowpayroll.ai/api-reference/pay-api/employees/update-an-employees-payroll-id.md): Updates the employee's Payroll ID (payId field used in HMRC FPS submissions). The previous Payroll ID is automatically saved for HMRC reporting purposes.
- [Update an existing employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/update-an-existing-employee.md)
- [Update the leaver details for a specific employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/update-the-leaver-details-for-a-specific-employee.md)
- [Update the opening balance for a specific employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/update-the-opening-balance-for-a-specific-employee.md): Sets the opening balance for this employment (e.g., when migrating from a different payroll system). Locked after any payslip has been finalized for the employee.
- [Update the starter details for a specific employee](https://docs.flowpayroll.ai/api-reference/pay-api/employees/update-the-starter-details-for-a-specific-employee.md)
- [Delete a PAYE payment for a specific tax year, period, and payment ID](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/delete-a-paye-payment-for-a-specific-tax-year-period-and-payment-id.md): Deletes an existing PAYE payment for the current organisation
- [Get month to date running balances by tax year and month](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/get-month-to-date-running-balances-by-tax-year-and-month.md): Retrieves the month to date running balances for the current organisation for a specific tax year and month
- [Get multiple organisation information](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/get-multiple-organisation-information.md): Get information for multiple organisations
- [Get organisation information](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/get-organisation-information.md): Get the organisation information for the current organisation
- [Get organisation opening balances by tax year](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/get-organisation-opening-balances-by-tax-year.md): Retrieves the opening balances for the current organisation for a specific tax year
- [Get PAYE liability summary by tax year](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/get-paye-liability-summary-by-tax-year.md): Retrieves the PAYE liability summary for the current organisation for a specific tax year, including monthly or quarterly breakdowns based on the organisation's HMRC settings
- [Get the HMRC settings for the current organisation](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/get-the-hmrc-settings-for-the-current-organisation.md): Retrieves the HMRC settings for the current organisation
- [Get year-to-date running balances by tax year](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/get-year-to-date-running-balances-by-tax-year.md): Retrieves the year-to-date running balances for the current organisation for a specific tax year
- [Record a PAYE payment for a specific tax year and period](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/record-a-paye-payment-for-a-specific-tax-year-and-period.md): Records a PAYE payment for the current organisation for a specific tax year and period (monthly or quarterly based on HMRC settings)
- [Update a PAYE payment for a specific tax year and payment ID](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/update-a-paye-payment-for-a-specific-tax-year-and-payment-id.md): Updates an existing PAYE payment for the current organisation, recalculating due dates, and payment status
- [Update organisation information](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/update-organisation-information.md): Update the organisation information for the current organisation
- [Update organisation opening balances by tax year](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/update-organisation-opening-balances-by-tax-year.md): Updates the opening balances for the current organisation for a specific tax year
- [Update the HMRC settings for the current organisation](https://docs.flowpayroll.ai/api-reference/pay-api/organisation/update-the-hmrc-settings-for-the-current-organisation.md): Updates the HMRC settings for the current organisation
- [Create payment configuration for an organisation](https://docs.flowpayroll.ai/api-reference/pay-api/organisationpaymentconfig/create-payment-configuration-for-an-organisation.md)
- [Delete payment configuration for an organisation](https://docs.flowpayroll.ai/api-reference/pay-api/organisationpaymentconfig/delete-payment-configuration-for-an-organisation.md)
- [Get payment configuration for an organisation](https://docs.flowpayroll.ai/api-reference/pay-api/organisationpaymentconfig/get-payment-configuration-for-an-organisation.md)
- [Update payment configuration for an organisation](https://docs.flowpayroll.ai/api-reference/pay-api/organisationpaymentconfig/update-payment-configuration-for-an-organisation.md)
- [Create a new pay element for the current organisation](https://docs.flowpayroll.ai/api-reference/pay-api/pay-elements/create-a-new-pay-element-for-the-current-organisation.md): Creates a new pay element for the current organisation
- [Delete a specific pay element by ID](https://docs.flowpayroll.ai/api-reference/pay-api/pay-elements/delete-a-specific-pay-element-by-id.md): Deletes a specific pay element by its ID for the current organisation
- [Get a specific pay element by ID](https://docs.flowpayroll.ai/api-reference/pay-api/pay-elements/get-a-specific-pay-element-by-id.md): Retrieves a specific pay element by its ID for the current organisation
- [Get the pay elements for the current organisation](https://docs.flowpayroll.ai/api-reference/pay-api/pay-elements/get-the-pay-elements-for-the-current-organisation.md): Retrieves the pay elements for the current organisation
- [Update a specific pay element by ID](https://docs.flowpayroll.ai/api-reference/pay-api/pay-elements/update-a-specific-pay-element-by-id.md): Updates a specific pay element by its ID for the current organisation
- [Get payment file for a pay run](https://docs.flowpayroll.ai/api-reference/pay-api/paymentfile/get-payment-file-for-a-pay-run.md)
- [Retry failed payment file generation with refreshed employee data](https://docs.flowpayroll.ai/api-reference/pay-api/paymentfile/retry-failed-payment-file-generation-with-refreshed-employee-data.md)
- [Add attachments to a payroll line item](https://docs.flowpayroll.ai/api-reference/pay-api/payroll-lines/add-attachments-to-a-payroll-line-item.md): Creates attachment metadata records for a payroll line item and returns pre-signed S3 URLs for uploading the files. The client should first send attachment metadata (filename, contentType, fileSize) in this request, then use the returned pre-signed URLs to upload files directly to S3.
- [Delete a payroll line](https://docs.flowpayroll.ai/api-reference/pay-api/payroll-lines/delete-a-payroll-line.md): Deletes a specific payroll line for an employee.
- [Delete an attachment from a payroll line item](https://docs.flowpayroll.ai/api-reference/pay-api/payroll-lines/delete-an-attachment-from-a-payroll-line-item.md): Deletes an attachment from a payroll line item. This removes the attachment from both S3 storage and DynamoDB metadata.
- [Upload payroll lines](https://docs.flowpayroll.ai/api-reference/pay-api/payroll-lines/upload-payroll-lines.md): Uploads a list of payroll lines to the system. The system will attempt to process each line and return a list of validation issues for any lines that fail. The successful lines will be returned in the response. The combination of employeeID and id must be unique. There's a hard limit of 100 items pe…
- [Create a payroll run](https://docs.flowpayroll.ai/api-reference/pay-api/payroll/create-a-payroll-run.md)
- [Create the next payroll run for a given payroll configuration](https://docs.flowpayroll.ai/api-reference/pay-api/payroll/create-the-next-payroll-run-for-a-given-payroll-configuration.md)
- [Get all employee IDs for a specific payroll run](https://docs.flowpayroll.ai/api-reference/pay-api/payroll/get-all-employee-ids-for-a-specific-payroll-run.md)
- [Get payroll run(lock) data](https://docs.flowpayroll.ai/api-reference/pay-api/payroll/get-payroll-runlock-data.md)
- [Get tax years with pay runs](https://docs.flowpayroll.ai/api-reference/pay-api/payroll/get-tax-years-with-pay-runs.md)
- [List payroll runs by tax year](https://docs.flowpayroll.ai/api-reference/pay-api/payroll/list-payroll-runs-by-tax-year.md)
- [Locks a payroll](https://docs.flowpayroll.ai/api-reference/pay-api/payroll/locks-a-payroll.md): Creates a new payroll run entry in locked state
- [Create a new payroll configuration](https://docs.flowpayroll.ai/api-reference/pay-api/payrollconfig/create-a-new-payroll-configuration.md)
- [Delete a payroll configuration](https://docs.flowpayroll.ai/api-reference/pay-api/payrollconfig/delete-a-payroll-configuration.md)
- [Read a payroll configuration](https://docs.flowpayroll.ai/api-reference/pay-api/payrollconfig/read-a-payroll-configuration.md)
- [Read all payroll configurations](https://docs.flowpayroll.ai/api-reference/pay-api/payrollconfig/read-all-payroll-configurations.md)
- [Update a payroll configuration](https://docs.flowpayroll.ai/api-reference/pay-api/payrollconfig/update-a-payroll-configuration.md)
- [Create or update payslip metadata such as notes and payment date overwrite](https://docs.flowpayroll.ai/api-reference/pay-api/payslip/create-or-update-payslip-metadata-such-as-notes-and-payment-date-overwrite.md): Creates or updates data for a specific employee's payslip in a given year and period. The data is associated with the specific payroll configuration.
- [Get all payslip data for an employee within a date range](https://docs.flowpayroll.ai/api-reference/pay-api/payslip/get-all-payslip-data-for-an-employee-within-a-date-range.md): Retrieves all payslip data for a specific employee within a specified date range. If no date range is provided, defaults to the last year from today.
- [Get all payslips by pay run](https://docs.flowpayroll.ai/api-reference/pay-api/payslip/get-all-payslips-by-pay-run.md): Retrieves all payslips for a specific pay run identified by payroll config ID, year, and period. The frequency is automatically determined from the payroll configuration. Supports pagination for large result sets. Supports gzip compression — send Accept: application/gzip header to receive compressed…
- [Get payslip data for an employee](https://docs.flowpayroll.ai/api-reference/pay-api/payslip/get-payslip-data-for-an-employee.md): Retrieves the payslip data for a specific employee in a given year and period
- [Send payslip notification emails to employees](https://docs.flowpayroll.ai/api-reference/pay-api/payslip/send-payslip-notification-emails-to-employees.md): Sends payslip notification emails to a list of employees for a specific pay run. The notification is sent asynchronously and the response indicates which employee IDs failed.
- [Get all EPS submissions by tax year](https://docs.flowpayroll.ai/api-reference/pay-api/rti/get-all-eps-submissions-by-tax-year.md): Retrieves all EPS submissions for the current organisation for a specific tax year with pagination support
- [Get EPS submission by tax year and submission ID](https://docs.flowpayroll.ai/api-reference/pay-api/rti/get-eps-submission-by-tax-year-and-submission-id.md): Retrieves a specific EPS submission for the current organisation by tax year and submission ID
- [Get HMRC RTI FPS for payroll run](https://docs.flowpayroll.ai/api-reference/pay-api/rti/get-hmrc-rti-fps-for-payroll-run.md): Retrieves the HMRC RTI FPS (Full Payment Submission) for a specific payroll run
- [Get tax years with EPS submissions](https://docs.flowpayroll.ai/api-reference/pay-api/rti/get-tax-years-with-eps-submissions.md)
- [Resubmit EPS manually](https://docs.flowpayroll.ai/api-reference/pay-api/rti/resubmit-eps-manually.md): Resubmit an EPS (Employer Payment Summary) to HMRC for a specific tax year and submission ID
- [Submit EPS from monthly balances](https://docs.flowpayroll.ai/api-reference/pay-api/rti/submit-eps-from-monthly-balances.md): Submit an EPS (Employer Payment Summary) to HMRC based on monthly balances for a specific tax year and month
- [Submit EPS manually](https://docs.flowpayroll.ai/api-reference/pay-api/rti/submit-eps-manually.md): Manually submit an EPS (Employer Payment Summary) to HMRC for a specific tax year
- [Trigger send HMRC RTI FPS for payroll run](https://docs.flowpayroll.ai/api-reference/pay-api/rti/trigger-send-hmrc-rti-fps-for-payroll-run.md): Triggers the sending of HMRC RTI FPS (Full Payment Submission) for a specific payroll run
- [Finalise year-end for a payroll configuration](https://docs.flowpayroll.ai/api-reference/pay-api/yearend/finalise-year-end-for-a-payroll-configuration.md)
- [List all year-end finalisations for an organisation in a tax year](https://docs.flowpayroll.ai/api-reference/pay-api/yearend/list-all-year-end-finalisations-for-an-organisation-in-a-tax-year.md)
- [Read year-end finalisation for a payroll configuration](https://docs.flowpayroll.ai/api-reference/pay-api/yearend/read-year-end-finalisation-for-a-payroll-configuration.md)
- [Delete employee pension](https://docs.flowpayroll.ai/api-reference/pensions-v1/employeepension/delete-employee-pension.md)
- [Get employee pension](https://docs.flowpayroll.ai/api-reference/pensions-v1/employeepension/get-employee-pension.md)
- [Get employee pensionbatch](https://docs.flowpayroll.ai/api-reference/pensions-v1/employeepension/get-employee-pensionbatch.md)
- [Post employee pension](https://docs.flowpayroll.ai/api-reference/pensions-v1/employeepension/post-employee-pension.md)
- [Get export file retrievalpension calculationyear period frequency payroll config](https://docs.flowpayroll.ai/api-reference/pensions-v1/exportfileretrieval/get-export-file-retrievalpension-calculationyear-period-frequency-payroll-config.md)
- [Get pension calculationby year by month](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensioncalculation/get-pension-calculationby-year-by-month.md)
- [Get pension calculationcsvyear period frequency payroll config](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensioncalculation/get-pension-calculationcsvyear-period-frequency-payroll-config.md)
- [Get pension calculationexportyear period frequency payroll config](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensioncalculation/get-pension-calculationexportyear-period-frequency-payroll-config.md)
- [Get pension calculationpension provider by year by month](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensioncalculation/get-pension-calculationpension-provider-by-year-by-month.md)
- [Post pension calculation](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensioncalculation/post-pension-calculation.md)
- [Post pension calculationexport](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensioncalculation/post-pension-calculationexport.md)
- [Delete pension group](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensiongroup/delete-pension-group.md)
- [Get pension group](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensiongroup/get-pension-group.md)
- [Get pension groupallowed bases](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensiongroup/get-pension-groupallowed-bases.md)
- [Post pension group](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensiongroup/post-pension-group.md)
- [Put pension group](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensiongroup/put-pension-group.md)
- [Delete pension provider](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensionprovider/delete-pension-provider.md)
- [Get pension provider](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensionprovider/get-pension-provider.md)
- [Get pension provider 1](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensionprovider/get-pension-provider-1.md)
- [Post pension provider](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensionprovider/post-pension-provider.md)
- [Put pension provider](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensionprovider/put-pension-provider.md)
- [Delete pension schema](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensionschema/delete-pension-schema.md)
- [Get pension schema](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensionschema/get-pension-schema.md)
- [Get pension schemaorganisation](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensionschema/get-pension-schemaorganisation.md)
- [Post pension schema](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensionschema/post-pension-schema.md)
- [Put pension schema](https://docs.flowpayroll.ai/api-reference/pensions-v1/pensionschema/put-pension-schema.md)
- [Get auto enrolmentassessmentspayrun  ](https://docs.flowpayroll.ai/api-reference/pensions-v2/autoenrolment/get-auto-enrolmentassessmentspayrun--.md)
- [Get auto enrolmentcompletepayrun  ](https://docs.flowpayroll.ai/api-reference/pensions-v2/autoenrolment/get-auto-enrolmentcompletepayrun--.md)
- [Get auto enrolmentnot auto enrolments](https://docs.flowpayroll.ai/api-reference/pensions-v2/autoenrolment/get-auto-enrolmentnot-auto-enrolments.md)
- [Get auto enrolmentnot complete](https://docs.flowpayroll.ai/api-reference/pensions-v2/autoenrolment/get-auto-enrolmentnot-complete.md)
- [Delete employee pension](https://docs.flowpayroll.ai/api-reference/pensions-v2/employeepensionassociation/delete-employee-pension.md)
- [Get employee pension](https://docs.flowpayroll.ai/api-reference/pensions-v2/employeepensionassociation/get-employee-pension.md)
- [Get employee pensionbatch](https://docs.flowpayroll.ai/api-reference/pensions-v2/employeepensionassociation/get-employee-pensionbatch.md)
- [Post employee pension](https://docs.flowpayroll.ai/api-reference/pensions-v2/employeepensionassociation/post-employee-pension.md)
- [Post employee pension enrolment letter](https://docs.flowpayroll.ai/api-reference/pensions-v2/employeepensionassociation/post-employee-pension-enrolment-letter.md)
- [Get export file retrievalpension calculationyear period frequency payroll config](https://docs.flowpayroll.ai/api-reference/pensions-v2/exportfileretrieval/get-export-file-retrievalpension-calculationyear-period-frequency-payroll-config.md)
- [Get organisation](https://docs.flowpayroll.ai/api-reference/pensions-v2/organisationpension/get-organisation.md)
- [Put organisationpension defaultauto enrolment settings](https://docs.flowpayroll.ai/api-reference/pensions-v2/organisationpension/put-organisationpension-defaultauto-enrolment-settings.md)
- [Put organisationpension defaultpostponement settings](https://docs.flowpayroll.ai/api-reference/pensions-v2/organisationpension/put-organisationpension-defaultpostponement-settings.md)
- [Get pension calculationby year by month](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensioncalculation/get-pension-calculationby-year-by-month.md)
- [Get pension calculationcsvyear period frequency payroll config](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensioncalculation/get-pension-calculationcsvyear-period-frequency-payroll-config.md)
- [Get pension calculationexportyear period frequency payroll config](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensioncalculation/get-pension-calculationexportyear-period-frequency-payroll-config.md)
- [Get pension calculationpension provider by year by month](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensioncalculation/get-pension-calculationpension-provider-by-year-by-month.md)
- [Post pension calculation](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensioncalculation/post-pension-calculation.md)
- [Post pension calculationexport](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensioncalculation/post-pension-calculationexport.md)
- [Delete pension group](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensiongroup/delete-pension-group.md)
- [Get pension group](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensiongroup/get-pension-group.md)
- [Get pension groupallowed bases](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensiongroup/get-pension-groupallowed-bases.md)
- [Post pension group](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensiongroup/post-pension-group.md)
- [Put pension group](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensiongroup/put-pension-group.md)
- [Get pension information](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensioninformation/get-pension-information.md)
- [Delete pension provider](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensionprovider/delete-pension-provider.md)
- [Get pension provider](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensionprovider/get-pension-provider.md)
- [Get pension provider 1](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensionprovider/get-pension-provider-1.md)
- [Get pension providerslug](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensionprovider/get-pension-providerslug.md)
- [Post pension provider](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensionprovider/post-pension-provider.md)
- [Put pension provider](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensionprovider/put-pension-provider.md)
- [Delete pension schema](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensionscheme/delete-pension-schema.md)
- [Get pension schema](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensionscheme/get-pension-schema.md)
- [Get pension schemaorganisation](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensionscheme/get-pension-schemaorganisation.md)
- [Post pension schema](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensionscheme/post-pension-schema.md)
- [Put pension schema](https://docs.flowpayroll.ai/api-reference/pensions-v2/pensionscheme/put-pension-schema.md)
- [Delete postponement](https://docs.flowpayroll.ai/api-reference/pensions-v2/postponement/delete-postponement.md)
- [Get postponement](https://docs.flowpayroll.ai/api-reference/pensions-v2/postponement/get-postponement.md)
- [Put postponement](https://docs.flowpayroll.ai/api-reference/pensions-v2/postponement/put-postponement.md)
- [Delete  employees](https://docs.flowpayroll.ai/api-reference/recurring-line-items/recurring-line-items/delete--employees.md)
- [Delete  employees periods ](https://docs.flowpayroll.ai/api-reference/recurring-line-items/recurring-line-items/delete--employees-periods-.md)
- [Get ](https://docs.flowpayroll.ai/api-reference/recurring-line-items/recurring-line-items/get-.md)
- [Get  1](https://docs.flowpayroll.ai/api-reference/recurring-line-items/recurring-line-items/get--1.md)
- [Get  employees periods](https://docs.flowpayroll.ai/api-reference/recurring-line-items/recurring-line-items/get--employees-periods.md)
- [Get  employees tax years](https://docs.flowpayroll.ai/api-reference/recurring-line-items/recurring-line-items/get--employees-tax-years.md)
- [Get employees](https://docs.flowpayroll.ai/api-reference/recurring-line-items/recurring-line-items/get-employees.md)
- [Patch  employees](https://docs.flowpayroll.ai/api-reference/recurring-line-items/recurring-line-items/patch--employees.md)
- [Patch  employees periods ](https://docs.flowpayroll.ai/api-reference/recurring-line-items/recurring-line-items/patch--employees-periods-.md)
- [Post ](https://docs.flowpayroll.ai/api-reference/recurring-line-items/recurring-line-items/post-.md)
- [Response format](https://docs.flowpayroll.ai/api-reference/response-format.md): Every Flow Payroll response uses the same envelope, so you can parse success and error responses with one shared model.
- [Get calculationsemployees history](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-calculations/get-calculationsemployees-history.md)
- [Post calculationsemployees](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-calculations/post-calculationsemployees.md)
- [Post calculationsemployees linking](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-calculations/post-calculationsemployees-linking.md)
- [Post calculationspreview](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-calculations/post-calculationspreview.md)
- [Delete paymentsemployees ](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/delete-paymentsemployees-.md)
- [Delete paymentsemployees attachments](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/delete-paymentsemployees-attachments.md)
- [Get paymentscalculationsemployees average earnings](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/get-paymentscalculationsemployees-average-earnings.md)
- [Get paymentsemployees](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/get-paymentsemployees.md)
- [Get paymentsemployees ](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/get-paymentsemployees-.md)
- [Get paymentsemployees alabaster detection](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/get-paymentsemployees-alabaster-detection.md)
- [Get paymentsemployees attachments](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/get-paymentsemployees-attachments.md)
- [Get paymentsemployees line items](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/get-paymentsemployees-line-items.md)
- [Get paymentsorganisations](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/get-paymentsorganisations.md)
- [Post paymentsemployees](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/post-paymentsemployees.md)
- [Post paymentsemployees alabaster recalculate](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/post-paymentsemployees-alabaster-recalculate.md)
- [Post paymentsemployees alabaster update line items](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/post-paymentsemployees-alabaster-update-line-items.md)
- [Post paymentsemployees attachments](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/post-paymentsemployees-attachments.md)
- [Post paymentsimport](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/post-paymentsimport.md)
- [Post paymentsreconcile](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/post-paymentsreconcile.md)
- [Put paymentsemployees ](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-payments/put-paymentsemployees-.md)
- [Get statutory rates](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-rates/get-statutory-rates.md)
- [Get statutory ratesavailable years](https://docs.flowpayroll.ai/api-reference/statutory-pay/statutory-rates/get-statutory-ratesavailable-years.md)
- [Use in Postman](https://docs.flowpayroll.ai/api-reference/use-in-postman.md): Download the entire Flow Payroll API as one OpenAPI file and import it into Postman, Insomnia, or any OpenAPI-aware tool.
- [Managing clients](https://docs.flowpayroll.ai/guides/bureau/clients.md): Add and configure the businesses you run payroll for — for example as a staffing agency or bureau.
- [Invoices and billing](https://docs.flowpayroll.ai/guides/bureau/invoices-and-billing.md): Raise invoices, issue credit notes, and sync billing records to your accounting provider.
- [Court orders and attachment of earnings](https://docs.flowpayroll.ai/guides/compliance/court-orders.md): Create and manage court orders (CMS DEO, AEO, DEA, CTAEO, EA, MCAEO) — Flow Payroll applies the correct deduction, respects protected earnings, and tracks the outstanding balance each pay run.
- [HMRC & RTI submissions](https://docs.flowpayroll.ai/guides/compliance/hmrc-rti.md): Submit your Full Payment Submission and Employer Payment Summary to HMRC, view submission history, and resubmit when needed.
- [Statutory payments](https://docs.flowpayroll.ai/guides/compliance/statutory-payments.md): Record SSP, SMP, SPP, SAP, ShPP, SPBP, and SNCP for employees; Flow Payroll calculates eligibility, weekly amounts, and includes them automatically in pay runs.
- [Getting started](https://docs.flowpayroll.ai/guides/getting-started.md): Go from a new account to your first completed pay run — set up your organisation, add people, and pay them.
- [Holiday and leave](https://docs.flowpayroll.ai/guides/holiday/holiday-and-leave.md): Record leave, manage holiday accrual, set opening balances, and feed holiday pay into payroll.
- [Key concepts](https://docs.flowpayroll.ai/guides/key-concepts.md): The building blocks of Flow Payroll — and how they fit together across a pay cycle.
- [Payslips](https://docs.flowpayroll.ai/guides/pay-runs/payslips.md): Preview, finalise, download, and send payslips to your employees.
- [Running a pay run](https://docs.flowpayroll.ai/guides/pay-runs/running-a-pay-run.md): Walk through the pay run wizard end to end — from opening a period to locking it and submitting your FPS to HMRC.
- [Auto-enrolment and workplace pensions](https://docs.flowpayroll.ai/guides/pensions/auto-enrolment.md): How Flow Payroll assesses workers, enrols eligible employees, applies contributions, and produces pension provider files every pay run.
- [Leavers](https://docs.flowpayroll.ai/guides/people/leavers.md): Record an employee's leaving date, process their final pay run, and issue a P45.
- [Managing people](https://docs.flowpayroll.ai/guides/people/managing-people.md): View your team, understand what an employee record contains, and keep details up to date.
- [Onboarding employees](https://docs.flowpayroll.ai/guides/people/onboarding-employees.md): Add a new employee individually through the onboarding wizard, or import multiple employees at once via CSV.
- [Reports](https://docs.flowpayroll.ai/guides/reports/reports.md): Reporting and insights are coming soon to Flow Payroll.
- [Organisation setup](https://docs.flowpayroll.ai/guides/setup/organisation-setup.md): Configure your company details, HMRC references, and opening balances so Flow Payroll can calculate and submit payroll correctly.
- [Pay run settings](https://docs.flowpayroll.ai/guides/setup/pay-run-settings.md): Create and configure pay schedules — frequency, pay date rules, and payment method — that drive every pay run.
- [Pension defaults](https://docs.flowpayroll.ai/guides/setup/pension-defaults.md): Set organisation-level auto-enrolment mode and postponement rules so every new employee inherits the right pension settings automatically.
- [Welcome to the guides](https://docs.flowpayroll.ai/guides/welcome.md): How to run UK payroll in Flow Payroll — set up your organisation, pay your people, stay compliant, and more.
- [Welcome to Flow Payroll](https://docs.flowpayroll.ai/index.md): Run accurate, HMRC-compliant UK payroll for one company or hundreds — in the dashboard, or over the API.

## OpenAPI Specs

- [flowpayroll-openapi](https://docs.flowpayroll.ai/api-reference/specs/flowpayroll-openapi.yaml)
- [statutory-pay](https://docs.flowpayroll.ai/api-reference/specs/statutory-pay.json)
- [recurring-line-items](https://docs.flowpayroll.ai/api-reference/specs/recurring-line-items.json)
- [pension-v2](https://docs.flowpayroll.ai/api-reference/specs/pension-v2.json)
- [pension-v1](https://docs.flowpayroll.ai/api-reference/specs/pension-v1.json)
- [pay-api](https://docs.flowpayroll.ai/api-reference/specs/pay-api.yaml)
- [holiday](https://docs.flowpayroll.ai/api-reference/specs/holiday.json)
- [hmrc-p-forms](https://docs.flowpayroll.ai/api-reference/specs/hmrc-p-forms.yaml)
- [hmrc-dps](https://docs.flowpayroll.ai/api-reference/specs/hmrc-dps.json)
- [court-orders](https://docs.flowpayroll.ai/api-reference/specs/court-orders.json)
- [billing](https://docs.flowpayroll.ai/api-reference/specs/billing.json)

## Optional

- [Dashboard](https://app.flowpayroll.ai)
- [Support](mailto:hello@flowpayroll.ai)