GET
/
reports#getPayrollHistoryBasedOnDateRange
curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getPayrollHistoryBasedOnDateRange' \
  --header 'Content-Type: application/json' \
  --data '{
  "method": "getPayrollHistoryBasedOnDateRange",
  "companyId": "32cef965-3a70-4ee0-b943-ad2fb876a839",
  "startDate": "2023-01-01",
  "endDate": "2023-12-31"
}'
{
  "1": {
    "summary": "Success",
    "value": {
      "payPeriod": [
        {
          "payPeriodId": "EFAB1DAB-5646-4DF5-8EA2-C4D42C37811E",
          "payPeriod": "11/16/2023 - 11/30/2023",
          "deadLineToRunPayroll": "2023-11-28",
          "total": 2910,
          "employeeTaxSum": 574.18,
          "employerTaxSum": 493.73,
          "isProcessed": true,
          "payDate": "2023-11-30",
          "payEndDate": "2023-11-30",
          "payBeginDate": "2023-11-16",
          "workerType": {
            "workerType": "W2"
          },
          "payrollLineItems": [
            {
              "userId": "50070F09-2923-499A-850B-F12ED4C2FD69",
              "baseTotal": 960,
              "numberOfLeaveDays": 0,
              "lop": 0,
              "retroAmount": 0,
              "grossTotal": 940,
              "netTotal": 810.01,
              "userName": {
                "employee": "Ron  Wood"
              },
              "employeeTax": {
                "employeeTax": 129.99
              },
              "Deductions": [
                {
                  "vertexDeductionIdentifier": {
                    "deductionDescription": "Qualified Parking Sup"
                  },
                  "amount": 120
                }
              ],
              "payDetails": [
                {
                  "payPercentage": 0,
                  "amount": 0,
                  "employeePayAccount": {
                    "accountName": "savings ... 1111"
                  }
                },
                {
                  "payPercentage": 100,
                  "amount": 810.01,
                  "employeePayAccount": {
                    "accountName": null
                  }
                }
              ],
              "OverTimes": [],
              "AdditionalCompensations": [
                {
                  "payrollLineItemAdditionalCompensation_VertexCompensationIdentifier": {
                    "compensationDescription": "Cash"
                  },
                  "amount": 100
                }
              ]
            },
            {
              "userId": "9E3CBA77-9035-471F-AA1E-F77A13AFE5C2",
              "baseTotal": 2000,
              "numberOfLeaveDays": 0,
              "lop": 0,
              "retroAmount": 0,
              "grossTotal": 1970,
              "netTotal": 1540.26,
              "userName": {
                "employee": "Mark sazav Steve"
              },
              "employeeTax": {
                "employeeTax": 429.74
              },
              "Deductions": [
                {
                  "vertexDeductionIdentifier": {
                    "deductionDescription": "Qualified Parking Sup"
                  },
                  "amount": 150
                }
              ],
              "payDetails": [
                {
                  "payPercentage": 100,
                  "amount": 1540.26,
                  "employeePayAccount": {
                    "accountName": "checking ... 0000"
                  }
                }
              ],
              "OverTimes": [],
              "AdditionalCompensations": [
                {
                  "payrollLineItemAdditionalCompensation_VertexCompensationIdentifier": {
                    "compensationDescription": "Cash"
                  },
                  "amount": 120
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

Body

application/json
method
string
default: getPayrollHistoryBasedOnDateRangerequired
companyId
string
required
startDate
string
required
endDate
string
required

Response

200 - application/json
payPeriod
object[]
required