API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- User Portal
- Payroll
- Benefits
- Reports
- GETGetBusinessUserInfo
- GETGetUserTask
- GETGetUsersByCompanyName
- GETGetCompanies
- GETGetPaidEmployeesCountBasedOnDateRange
- GETGetPayPeriodDetails
- GETGetPayPeriod
- GETGetCompanyInfo
- GETGetCompanyLocationInfo
- GETGetActiveUsers
- GETGetTerminatedUsers
- GETGetDeactivatedUsers
- GETGetPayrollHistoryBasedOnPayPeriod
- GETGetPayrollHistoryBasedOnDateRange
- GETGetPayRun
- GETGetPaySchedule
- GETGetPayStub
- GETGetTransactionBasedOnReference
- GETGetTransactions
- GETGetTransactionsBasedOnName
- GETGetBusinessUserDetails
- GETGetStateW4FormFeilds
- GETGetPayrollJournalReport
- GETGetUser
- GETGetPayBeginDates
- GETGetStateRegistration
- GETGetIndividualPayrollHistory
- GET
- Webhooks
Reports
GetUser
GET
/
reports#getUser
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getUser' \
--header 'Content-Type: application/json' \
--data '{
"method": "getUser",
"userId": "F89BA57D-FBCF-4DBF-921D-E133AB76245C",
"companyId": "0BD1DCDE-64CF-440F-A552-9C4AA356BAAF"
}'
{
"summary": "Success",
"value": {
"user": [
{
"user": "Kim James",
"userId": "4E80FBFB-7FFC-406F-B0E0-8F78CA7A29C8",
"companyId": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"status": {
"userStatus": "Active"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Kim",
"lastName": "James",
"middleName": "",
"phoneNumber": "9889890089",
"kycStatus": "passed",
"jobTitle": "Manager",
"dateOfJoin": "2000-01-01",
"email": "kim000@mailsac.com",
"userWages": [
{
"WageRate": 80,
"WageBasis": {
"WageBasis": "Per Week"
},
"paymentMethod": {
"PaymentMethod": "Direct Deposit"
},
"employeeRefTaxExempt": "Yes, as an owner/corporate officer",
"employeeType": "Salary/Eligible for overtime",
"differentialPay": "No",
"employmentStatus": "Full Time (30+ Hours per week)"
}
],
"userAddress": {
"address1": "650 Capitol Mall",
"address2": "",
"city": "Sacramento",
"state": "CA",
"zipcode": "95814-4708",
"country": "US"
},
"companyLocationCategory": {
"companyLocationCategory": "Office"
},
"companyLocation": {
"companyLocation": "22 Main",
"address": "8435 Colard Ln, Lyons, CO, 80540",
"companyLocationId": "889F5A0D-CBC5-4495-A09B-D98B63490C1C"
},
"stateId": "5A7E7326-D1E4-4D3D-BD1B-61C5487FC71B",
"ssn": "120520000"
}
]
}
}
Response
200
application/json
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getUser' \
--header 'Content-Type: application/json' \
--data '{
"method": "getUser",
"userId": "F89BA57D-FBCF-4DBF-921D-E133AB76245C",
"companyId": "0BD1DCDE-64CF-440F-A552-9C4AA356BAAF"
}'
{
"summary": "Success",
"value": {
"user": [
{
"user": "Kim James",
"userId": "4E80FBFB-7FFC-406F-B0E0-8F78CA7A29C8",
"companyId": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"status": {
"userStatus": "Active"
},
"WorkerType": {
"WorkerType": "W2"
},
"firstName": "Kim",
"lastName": "James",
"middleName": "",
"phoneNumber": "9889890089",
"kycStatus": "passed",
"jobTitle": "Manager",
"dateOfJoin": "2000-01-01",
"email": "kim000@mailsac.com",
"userWages": [
{
"WageRate": 80,
"WageBasis": {
"WageBasis": "Per Week"
},
"paymentMethod": {
"PaymentMethod": "Direct Deposit"
},
"employeeRefTaxExempt": "Yes, as an owner/corporate officer",
"employeeType": "Salary/Eligible for overtime",
"differentialPay": "No",
"employmentStatus": "Full Time (30+ Hours per week)"
}
],
"userAddress": {
"address1": "650 Capitol Mall",
"address2": "",
"city": "Sacramento",
"state": "CA",
"zipcode": "95814-4708",
"country": "US"
},
"companyLocationCategory": {
"companyLocationCategory": "Office"
},
"companyLocation": {
"companyLocation": "22 Main",
"address": "8435 Colard Ln, Lyons, CO, 80540",
"companyLocationId": "889F5A0D-CBC5-4495-A09B-D98B63490C1C"
},
"stateId": "5A7E7326-D1E4-4D3D-BD1B-61C5487FC71B",
"ssn": "120520000"
}
]
}
}