> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rollfi.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Pay Period Status

> Emitted when a pay period is created or its status changes.

### Events

- `payperiod.payperiodstatus.insert` — emitted when a pay period is created. The initial `PayPeriodStatus` is `new`.
- `payperiod.payperiodstatus.update` — emitted when an existing pay period changes to `submitted`, `cancelled`, `inProcess`, `processed`, `failed`, `returned`, or `skipped`.

When payroll initiation is cancelled, the status moves from `submitted` to `cancelled`; it does not return to `new`.




## OpenAPI

````yaml webhook payPeriodStatus
openapi: 3.1.0
info:
  title: Default module
  description: |
    Webhook events emitted when a company's KYB status is created or changes.

    Rollfi sends these requests to the webhook URL configured for the client.
    Consumers should return a successful 2xx response after accepting the event.
  version: 1.0.0
servers: []
security: []
tags:
  - name: Pay Schedule Webhooks
  - name: Pay Period Webhooks
  - name: Employee Bank Account Webhooks
  - name: Employee KYC Webhooks
  - name: Company Bank Account Webhooks
  - name: Company Webhooks
  - name: Employee Status Webhooks
paths: {}

````