Skip to main content
GET
/
reports#getPayPeriodDetails
getPayPeriodDetails
curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getPayPeriodDetails' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "getPayPeriodDetails",
  "payPeriodId": "7BF6D637-9E8C-4AF6-A8B0-A24F36CA2F53"
}
'
{
  "payPeriod": [
    {
      "payPeriodId": "EDD9F5D2-BED4-4337-A80C-4DDD33EDFF91",
      "payPeriod": "11/01/2025 - 11/30/2025",
      "deadLineToRunPayroll": "2025-11-25",
      "PayPeriodStatus": "new",
      "total": 10426.56,
      "employeeTaxSum": 879.35,
      "employerTaxSum": 898.9,
      "isProcessed": false,
      "payDate": "2025-11-28",
      "payEndDate": "2025-11-30",
      "payBeginDate": "2025-11-01",
      "workerType": {
        "workerType": "W2"
      },
      "payPeriodType": {
        "payPeriodType": "Regular"
      },
      "payrollLineItems": [
        {
          "userId": "4DF5A79A-3735-4588-95A6-B80D15CB5A5E",
          "userName": "Dalary  Beil",
          "baseTotal": 4000,
          "numberOfLeaveDays": 0,
          "lop": 0,
          "retroAmount": 4,
          "grossTotal": 5236.56,
          "netTotal": 4879.39,
          "payHours": 173,
          "payRate": 4000,
          "standardWorkingHours": 8,
          "employeeTax": {
            "employeeTax": 417.17
          },
          "employeeTaxDetails": [
            {
              "taxName": "Federal Withholding Tax",
              "taxAmount": 0,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            },
            {
              "taxName": "Medicare",
              "taxAmount": 67.96,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            },
            {
              "taxName": "Social Security",
              "taxAmount": 290.57,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            },
            {
              "taxName": "Cares Fund EE",
              "taxAmount": 27.47,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            },
            {
              "taxName": "WA - State paid family medical leave EE",
              "taxAmount": 31.17,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            }
          ],
          "employerTaxDetails": [
            {
              "taxName": "FUTA",
              "taxAmount": 18,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "Medicare",
              "taxAmount": 67.96,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "Social Security",
              "taxAmount": 290.57,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "WA - State Unemployment Insurance",
              "taxAmount": 47.37,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "WA - State employment admin fund",
              "taxAmount": 0,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "WA - State paid family medical leave ER",
              "taxAmount": 0,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            }
          ],
          "miscellaneousStateTaxes": [],
          "overTimes": [
            {
              "type": "Compensatory Time Off",
              "amount": 232.56,
              "numberOfHours": 10
            }
          ],
          "additionalCompensations": [
            {
              "payrollLineItemAdditionalCompensationVertexCompensationIdentifier": {
                "compensationDescription": "Group Term Life Over $50000"
              },
              "amount": 500
            },
            {
              "payrollLineItemAdditionalCompensationVertexCompensationIdentifier": {
                "compensationDescription": "Van Pool & Transit Passes"
              },
              "amount": 500
            }
          ],
          "deductions": [
            {
              "vertexDeductionIdentifier": {
                "deductionDescription": "125DC Reg"
              },
              "amount": 50
            },
            {
              "vertexDeductionIdentifier": {
                "deductionDescription": "403B CU 15 year Reg"
              },
              "amount": 10
            }
          ],
          "reimbursements": [
            {
              "reimbursementType": "GYM",
              "amount": 120
            }
          ],
          "timeOffs": [],
          "payDetails": [
            {
              "payPercentage": 100,
              "amount": 4879.39,
              "employeePayAccount": {
                "accountName": "savings ... 2500"
              }
            }
          ]
        },
        {
          "userId": "37C3B7D0-0B5B-4B48-BB76-B18DECE19994",
          "userName": "Yahir  Greene",
          "baseTotal": 1200,
          "numberOfLeaveDays": 0,
          "lop": 0,
          "retroAmount": 0,
          "grossTotal": 1250,
          "netTotal": 1303.34,
          "payHours": 0,
          "basePay": [
            {
              "payCode": "Deductions",
              "payHours": 0,
              "payRate": 10,
              "multiplier": 0,
              "amount": 10
            },
            {
              "payCode": "Training Hours",
              "payHours": 6,
              "payRate": 200,
              "multiplier": 1,
              "amount": 1200
            },
            {
              "payCode": "AdditionalCompensation",
              "payHours": 0,
              "payRate": 50,
              "multiplier": 0,
              "amount": 50
            },
            {
              "payCode": "Reimbursements",
              "payHours": 0,
              "payRate": 160,
              "multiplier": 0,
              "amount": 160
            }
          ],
          "payRate": 0,
          "standardWorkingHours": 0,
          "employeeTax": {
            "employeeTax": 106.66
          },
          "employeeTaxDetails": [
            {
              "taxName": "Federal Withholding Tax",
              "taxAmount": 0,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            },
            {
              "taxName": "Medicare",
              "taxAmount": 17.4,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            },
            {
              "taxName": "Social Security",
              "taxAmount": 74.4,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            },
            {
              "taxName": "Cares Fund EE",
              "taxAmount": 6.96,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            },
            {
              "taxName": "WA - State paid family medical leave EE",
              "taxAmount": 7.9,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            }
          ],
          "employerTaxDetails": [
            {
              "taxName": "FUTA",
              "taxAmount": 7.2,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "Medicare",
              "taxAmount": 17.4,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "Social Security",
              "taxAmount": 74.4,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "WA - State Unemployment Insurance",
              "taxAmount": 12,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "WA - State employment admin fund",
              "taxAmount": 0,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "WA - State paid family medical leave ER",
              "taxAmount": 0,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            }
          ],
          "miscellaneousStateTaxes": [],
          "overTimes": [],
          "additionalCompensations": [
            {
              "payrollLineItemAdditionalCompensationVertexCompensationIdentifier": {
                "compensationDescription": "Van Pool & Transit Passes"
              },
              "amount": 50
            }
          ],
          "deductions": [],
          "reimbursements": [
            {
              "reimbursementType": "GYM",
              "amount": 160
            }
          ],
          "timeOffs": [],
          "payDetails": [
            {
              "payPercentage": 100,
              "amount": 1303.34,
              "employeePayAccount": null
            }
          ]
        },
        {
          "userId": "4BF5464F-0C20-465C-974D-9490770EC374",
          "userName": "Eve  Bravo",
          "baseTotal": 4000,
          "numberOfLeaveDays": 0,
          "lop": 0,
          "retroAmount": 0,
          "grossTotal": 4000,
          "netTotal": 3644.48,
          "payHours": 172,
          "payRate": 4000,
          "standardWorkingHours": 8,
          "employeeTax": {
            "employeeTax": 355.52
          },
          "employeeTaxDetails": [
            {
              "taxName": "Federal Withholding Tax",
              "taxAmount": 0,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            },
            {
              "taxName": "Medicare",
              "taxAmount": 58,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            },
            {
              "taxName": "Social Security",
              "taxAmount": 248,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            },
            {
              "taxName": "Cares Fund EE",
              "taxAmount": 23.2,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            },
            {
              "taxName": "WA - State paid family medical leave EE",
              "taxAmount": 26.32,
              "taxAmountYtd": 0,
              "isEmployerTax": false
            }
          ],
          "employerTaxDetails": [
            {
              "taxName": "FUTA",
              "taxAmount": 18,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "Medicare",
              "taxAmount": 58,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "Social Security",
              "taxAmount": 248,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "WA - State Unemployment Insurance",
              "taxAmount": 40,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "WA - State employment admin fund",
              "taxAmount": 0,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            },
            {
              "taxName": "WA - State paid family medical leave ER",
              "taxAmount": 0,
              "taxAmountYtd": 0,
              "isEmployerTax": true
            }
          ],
          "miscellaneousStateTaxes": [],
          "overTimes": [],
          "additionalCompensations": [],
          "deductions": [],
          "reimbursements": [],
          "timeOffs": [],
          "payDetails": [
            {
              "payPercentage": 100,
              "amount": 3644.48,
              "employeePayAccount": null
            }
          ]
        }
      ]
    }
  ]
}

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
Example:

"getPayPeriodDetails"

payPeriodId
string<uuid>
required

Response

payPeriod
object[]
required