initiatePayroll

Starts payroll calculation and processing for a specific pay period.

Pre-Execution Checklist

✅ Deductions/bonuses added
✅ Bank account verified
✅ Tax settings current
✅ Employee information updated

Process Flow

1. Validation: Checks all requirements
2. Calculation: Computes wages, taxes, deductions
3. Review: Generates preview for approval
4. Processing: Executes payments
5. Confirmation: Sends notifications

Response Status Values

• “Success” - The payPeriod has been initiated successfully.
• “Failed” - Failed to process the PayPeriod.

POST /payroll#initiatePayroll

initiatePayroll

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#initiatePayroll' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "initiatePayroll",
  "companyId": "8D728FCE-2993-42E0-8797-832C930506E1",
  "payPeriodId": "F4C96CCA-24D4-4DF4-B624-1544989F7D21"
}
'

200

{
  "payPeriod": {
    "payPeriodId": "3b51b98b-2915-4854-b87c-f7952ef086ec",
    "status": "New",
    "message": "The PayPeriod has been initiated successfully."
  }
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method · string · required

companyId · string<uuid> · required

payPeriodId · string<uuid> · required

Response

200

application/json

payPeriod · object · required

Show child attributes