Skip to main content
GET
/
reports#getPayrollHistoryBasedOnDateRange
getPayrollHistoryBasedOnDateRange
curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getPayrollHistoryBasedOnDateRange' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "getPayrollHistoryBasedOnDateRange",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "<string>",
  "endDate": "<string>"
}
'
{
  "payPeriod": [
    {
      "payPeriodId": "<string>",
      "payPeriod": "<string>",
      "deadLineToRunPayroll": "<string>",
      "total": 123,
      "employeeTaxSum": 123,
      "employerTaxSum": 123,
      "isProcessed": true,
      "payDate": "<string>",
      "payEndDate": "<string>",
      "payBeginDate": "<string>",
      "workerType": {
        "workerType": "<string>"
      },
      "payrollLineItems": [
        {
          "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "baseTotal": 123,
          "numberOfLeaveDays": 123,
          "lop": 123,
          "retroAmount": 123,
          "grossTotal": 123,
          "netTotal": 123,
          "userName": {
            "employee": "<string>"
          },
          "employeeTax": {
            "employeeTax": 123
          },
          "Deductions": [
            {
              "vertexDeductionIdentifier": {
                "deductionDescription": "<string>"
              },
              "amount": 123
            }
          ],
          "payDetails": [
            {
              "payPercentage": 123,
              "amount": 123,
              "employeePayAccount": {
                "accountName": "<string>"
              }
            }
          ],
          "OverTimes": [
            "<string>"
          ],
          "AdditionalCompensations": [
            {
              "payrollLineItemAdditionalCompensation_VertexCompensationIdentifier": {
                "compensationDescription": "<string>"
              },
              "amount": 123
            }
          ]
        }
      ]
    }
  ]
}

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:

"getPayrollHistoryBasedOnDateRange"

companyId
string<uuid>
required
startDate
string
required
Maximum string length: 10
endDate
string
required
Maximum string length: 10

Response

200 - application/json
payPeriod
object[]
required