deactivatePaySchedule

The deactivatePaySchedule API Deactivates an existing pay schedule (cannot be undone).

When to Use

• Changing pay frequency
• Company restructuring
• Ending contractor arrangements

Prerequisites

• All pending payrolls must be processed
• Cannot deactivate if active pay periods exist

Warning

⚠️ This action is permanent. Create new pay schedule if needed.

POST /payroll#deactivatePaySchedule

deactivatePaySchedule

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#deactivatePaySchedule' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "deactivatePaySchedule",
  "payScheduleId": "141D6357-CB56-42C9-951D-E80E10C5853A"
}
'

200

{
  "PaySchedule": {
    "PayScheduleID": "1F67BE13-4E3E-4578-AC25-5660DFDE9E39",
    "Status": "InActive",
    "Message": "The PaySchedule has been deactivated 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

paySchedule · object · required

Show child attributes

Response

200

application/json

PaySchedule · object · required

Show child attributes