GET
/
reports#getPayPeriod
curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getPayPeriod' \
  --header 'Content-Type: application/json' \
  --data '{
  "method": "getPayPeriod",
  "companyId": "28fcb32e-29fe-4269-8aa3-011e7276ef5e",
  "workerType": "W2"
}'
{
  "summary": "Success",
  "value": {
    "payPeriodId": "5D001432-D5E4-4EF3-80E1-BB4388ADC43B",
    "payPeriod": "11/01/2023 - 11/30/2023",
    "payBeginDate": "2023-11-01",
    "payEndDate": "2023-11-30",
    "payDate": "2023-11-30",
    "deadLineToRunPayroll": "2023-11-28"
  }
}

Body

application/json
method
string
required
companyId
string
required
workerType
enum<string>
required
Available options:
W2,
1099-NEC

Response

200 - application/json
payPeriodId
string
payPeriod
string
deadLineToRunPayroll
string
payDate
string
payEndDate
string
payBeginDate
string