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": "32cef965-3a70-4ee0-b943-ad2fb876a839",
  "startDate": "2023-01-01",
  "endDate": "2023-12-31"
}
'
import requests

url = "https://sandbox.rollfi.xyz/reports/getPayrollHistoryBasedOnDateRange"

payload = {
"method": "getPayrollHistoryBasedOnDateRange",
"companyId": "32cef965-3a70-4ee0-b943-ad2fb876a839",
"startDate": "2023-01-01",
"endDate": "2023-12-31"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getPayrollHistoryBasedOnDateRange',
companyId: '32cef965-3a70-4ee0-b943-ad2fb876a839',
startDate: '2023-01-01',
endDate: '2023-12-31'
})
};

fetch('https://sandbox.rollfi.xyz/reports/getPayrollHistoryBasedOnDateRange', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/reports/getPayrollHistoryBasedOnDateRange",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getPayrollHistoryBasedOnDateRange',
'companyId' => '32cef965-3a70-4ee0-b943-ad2fb876a839',
'startDate' => '2023-01-01',
'endDate' => '2023-12-31'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sandbox.rollfi.xyz/reports/getPayrollHistoryBasedOnDateRange"

payload := strings.NewReader("{\n \"method\": \"getPayrollHistoryBasedOnDateRange\",\n \"companyId\": \"32cef965-3a70-4ee0-b943-ad2fb876a839\",\n \"startDate\": \"2023-01-01\",\n \"endDate\": \"2023-12-31\"\n}")

req, _ := http.NewRequest("GET", url, payload)

req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://sandbox.rollfi.xyz/reports/getPayrollHistoryBasedOnDateRange")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getPayrollHistoryBasedOnDateRange\",\n \"companyId\": \"32cef965-3a70-4ee0-b943-ad2fb876a839\",\n \"startDate\": \"2023-01-01\",\n \"endDate\": \"2023-12-31\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.rollfi.xyz/reports/getPayrollHistoryBasedOnDateRange")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getPayrollHistoryBasedOnDateRange\",\n \"companyId\": \"32cef965-3a70-4ee0-b943-ad2fb876a839\",\n \"startDate\": \"2023-01-01\",\n \"endDate\": \"2023-12-31\"\n}"

response = http.request(request)
puts response.read_body
{
  "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
            }
          ]
        }
      ]
    }
  ]
}
{
"error": {
"code": 400,
"message": "Invalid CompanyId"
}
}

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

payPeriod
object[]
required