Skip to main content
GET
/
reports#getPayPeriod
getPayPeriod
curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getPayPeriod' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "getPayPeriod",
  "companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
  "workerType": "W2"
}
'
{
  "payPeriodId": "9BF440AF-9BE8-49B7-8F5E-0673E35CB5B3",
  "payPeriod": "10/01/2025 - 10/31/2025",
  "payBeginDate": "2025-10-01",
  "payEndDate": "2025-10-31",
  "payDate": "2025-10-31",
  "deadLineToRunPayroll": "2025-10-29",
  "payPeriodStatus": "submitted",
  "payrollAmount": 2763663.09
}

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
​
workerType
enum<string>
required
Available options:
W2,
1099-NEC

Response

​
payPeriodId
string
required
​
payPeriod
string
required
​
payBeginDate
string
required
​
payEndDate
string
required
​
payDate
string
required
​
deadLineToRunPayroll
string
required
​
payPeriodStatus
enum<string>
required
Available options:
new,
submitted,
cancelled,
inProcess,
processed,
failed,
returned,
skipped
​
payrollAmount
number
required