getPayrollJournalReport
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getPayrollJournalReport' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getPayrollJournalReport",
"payPeriodId": "410C7053-4656-4C28-BA9D-727101406F30",
"companyId": "01A33366-EE1C-4E13-BCB9-E482AC3A4545"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports#getPayrollJournalReport"
payload = {
"method": "getPayrollJournalReport",
"payPeriodId": "410C7053-4656-4C28-BA9D-727101406F30",
"companyId": "01A33366-EE1C-4E13-BCB9-E482AC3A4545"
}
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: 'getPayrollJournalReport',
payPeriodId: '410C7053-4656-4C28-BA9D-727101406F30',
companyId: '01A33366-EE1C-4E13-BCB9-E482AC3A4545'
})
};
fetch('https://sandbox.rollfi.xyz/reports#getPayrollJournalReport', 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#getPayrollJournalReport",
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' => 'getPayrollJournalReport',
'payPeriodId' => '410C7053-4656-4C28-BA9D-727101406F30',
'companyId' => '01A33366-EE1C-4E13-BCB9-E482AC3A4545'
]),
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#getPayrollJournalReport"
payload := strings.NewReader("{\n \"method\": \"getPayrollJournalReport\",\n \"payPeriodId\": \"410C7053-4656-4C28-BA9D-727101406F30\",\n \"companyId\": \"01A33366-EE1C-4E13-BCB9-E482AC3A4545\"\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#getPayrollJournalReport")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getPayrollJournalReport\",\n \"payPeriodId\": \"410C7053-4656-4C28-BA9D-727101406F30\",\n \"companyId\": \"01A33366-EE1C-4E13-BCB9-E482AC3A4545\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports#getPayrollJournalReport")
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\": \"getPayrollJournalReport\",\n \"payPeriodId\": \"410C7053-4656-4C28-BA9D-727101406F30\",\n \"companyId\": \"01A33366-EE1C-4E13-BCB9-E482AC3A4545\"\n}"
response = http.request(request)
puts response.read_body{
"Employee": [
{
"employeeID": "4E80FBFB-7FFC-406F-B0E0-8F78CA7A29C8",
"companyID": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"report": {
"employeereportdetails": [
{
"employeeID": "4E80FBFB-7FFC-406F-B0E0-8F78CA7A29C8",
"companyID": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"employeeName": "Kim James",
"phoneNumber": "9889890089",
"custEmpID": "",
"jobTitle": "Manager",
"employeeWages": [
{
"wageRate": 80,
"DifferentialPay": "A52FFFA1-50E7-4579-B4A8-902C07EE51D5",
"PayrollRefPaymentMethodID": "46AD1353-0DAA-456A-BCBB-DE137736EC7E",
"wageBasis": {
"wageBasis": "Per Week"
}
}
],
"w4Informations": [
{
"w4FilingStatus": {
"w4FilingStatus": "Head of household"
},
"dependents": 3
}
],
"employeeAddress": {
"address": "650 Capitol Mall, Sacramento, CA, 95814-4708",
"address1": "650 Capitol Mall",
"address2": "",
"city": "Sacramento",
"state": "CA",
"zipcode": "95814-4708"
}
}
],
"EntityTax": [
{
"taxID": "120520000"
}
],
"PayrollLineItem": [
{
"payPeriodID": "410C7053-4656-4C28-BA9D-727101406F30",
"payrollLineItemID": "87BC8593-5D72-416C-BE6A-F8D7E6290A74",
"quantity": 40,
"retro": false,
"retroAmount": 0,
"payrollLineItemDetails": [
{
"checkNumber": null,
"amount": 96.44,
"payPercentage": 100,
"employeePayAccount": {
"payAccountTypeID": "DF7ED049-B678-42BC-9921-D7E193B0BA28",
"employeePayAccountEntities": [
{
"accountNumber": "1111222233331111",
"routingNumber": "011401533"
}
]
}
}
],
"payPeriod": {
"payPeriod_paySchedule": {
"standardWorkingHours": 8
},
"payPeriod": "01/10/2025 - 01/16/2025",
"payDate": "2025-02-07",
"payBeginDate": "2025-01-10",
"payEndDate": "2025-01-16",
"workerType": {
"workerType": "W2"
}
},
"baseTotal": 111,
"grossTotal": 111,
"netTotal": 96.44,
"PayrollLineItem_OverTimes": [],
"PayrollLineItemReimbursements": [],
"payrollLineItemDetailsEmployeeTax": [],
"payrollLineItemDetailsEmployerTax": [],
"payrollLineItemDeductions": [],
"payrollLineItemAdditionalCompensations": [],
"payrollLineItemYTDs": [
{
"baseTotalYTD": 111,
"grossTotalYTD": 111,
"netTotalYTD": 96.44
}
]
}
],
"payrollLineItemPrevious": []
}
},
{
"employeeID": "D8934854-20F7-4607-8007-A4B78254007F",
"companyID": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"report": {
"employeereportdetails": [
{
"employeeID": "D8934854-20F7-4607-8007-A4B78254007F",
"companyID": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"employeeName": "Regina Wise",
"phoneNumber": "2511630007",
"custEmpID": null,
"jobTitle": "HR",
"employeeWages": [],
"w4Informations": [],
"employeeAddress": {
"address": "102 Fallsgrove Blvd, Rockville, MD, 20850-4713",
"address1": "102 Fallsgrove Blvd",
"address2": "",
"city": "Rockville",
"state": "MD",
"zipcode": "20850-4713"
}
}
],
"EntityTax": [
{
"taxID": "587400936"
}
],
"PayrollLineItem": [],
"payrollLineItemPrevious": []
}
}
],
"Company": [
{
"company": "Torp Group",
"kybInformations": [
{
"phoneNumber": "8587458008"
}
]
}
],
"EntityTax": [
{
"taxID": "600800500"
}
],
"CompanyLocation": [
{
"address": "8435 Colard Ln, Lyons, CO, 80540",
"companyLocation": "22 Main",
"address1": "8435 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540"
}
],
"PayPeriod": [
{
"payDate": "2025-02-07",
"payBeginDate": "2025-01-10",
"payEndDate": "2025-01-16",
"payPeriod": "01/10/2025 - 01/16/2025",
"workerType": {
"workerType": "W2"
},
"isProcessed": true,
"isActive": true
}
]
}Reports
getPayrollJournalReport
The getPayrollJournalReport API generates accounting journal entries for payroll transactions.
What it does:
- Returns journal entry data for payroll transactions
- Encompasses a single pay period
- Provides highly detailed accounting information needed for accurate tax reporting
- Reports year-to-date measures for employees
Notes:
- Used for tax system integration and financial reporting
- Retrieves data for all employees within a company so should be used as an administrative function
GET
/
reports#getPayrollJournalReport
getPayrollJournalReport
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getPayrollJournalReport' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getPayrollJournalReport",
"payPeriodId": "410C7053-4656-4C28-BA9D-727101406F30",
"companyId": "01A33366-EE1C-4E13-BCB9-E482AC3A4545"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports#getPayrollJournalReport"
payload = {
"method": "getPayrollJournalReport",
"payPeriodId": "410C7053-4656-4C28-BA9D-727101406F30",
"companyId": "01A33366-EE1C-4E13-BCB9-E482AC3A4545"
}
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: 'getPayrollJournalReport',
payPeriodId: '410C7053-4656-4C28-BA9D-727101406F30',
companyId: '01A33366-EE1C-4E13-BCB9-E482AC3A4545'
})
};
fetch('https://sandbox.rollfi.xyz/reports#getPayrollJournalReport', 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#getPayrollJournalReport",
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' => 'getPayrollJournalReport',
'payPeriodId' => '410C7053-4656-4C28-BA9D-727101406F30',
'companyId' => '01A33366-EE1C-4E13-BCB9-E482AC3A4545'
]),
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#getPayrollJournalReport"
payload := strings.NewReader("{\n \"method\": \"getPayrollJournalReport\",\n \"payPeriodId\": \"410C7053-4656-4C28-BA9D-727101406F30\",\n \"companyId\": \"01A33366-EE1C-4E13-BCB9-E482AC3A4545\"\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#getPayrollJournalReport")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getPayrollJournalReport\",\n \"payPeriodId\": \"410C7053-4656-4C28-BA9D-727101406F30\",\n \"companyId\": \"01A33366-EE1C-4E13-BCB9-E482AC3A4545\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports#getPayrollJournalReport")
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\": \"getPayrollJournalReport\",\n \"payPeriodId\": \"410C7053-4656-4C28-BA9D-727101406F30\",\n \"companyId\": \"01A33366-EE1C-4E13-BCB9-E482AC3A4545\"\n}"
response = http.request(request)
puts response.read_body{
"Employee": [
{
"employeeID": "4E80FBFB-7FFC-406F-B0E0-8F78CA7A29C8",
"companyID": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"report": {
"employeereportdetails": [
{
"employeeID": "4E80FBFB-7FFC-406F-B0E0-8F78CA7A29C8",
"companyID": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"employeeName": "Kim James",
"phoneNumber": "9889890089",
"custEmpID": "",
"jobTitle": "Manager",
"employeeWages": [
{
"wageRate": 80,
"DifferentialPay": "A52FFFA1-50E7-4579-B4A8-902C07EE51D5",
"PayrollRefPaymentMethodID": "46AD1353-0DAA-456A-BCBB-DE137736EC7E",
"wageBasis": {
"wageBasis": "Per Week"
}
}
],
"w4Informations": [
{
"w4FilingStatus": {
"w4FilingStatus": "Head of household"
},
"dependents": 3
}
],
"employeeAddress": {
"address": "650 Capitol Mall, Sacramento, CA, 95814-4708",
"address1": "650 Capitol Mall",
"address2": "",
"city": "Sacramento",
"state": "CA",
"zipcode": "95814-4708"
}
}
],
"EntityTax": [
{
"taxID": "120520000"
}
],
"PayrollLineItem": [
{
"payPeriodID": "410C7053-4656-4C28-BA9D-727101406F30",
"payrollLineItemID": "87BC8593-5D72-416C-BE6A-F8D7E6290A74",
"quantity": 40,
"retro": false,
"retroAmount": 0,
"payrollLineItemDetails": [
{
"checkNumber": null,
"amount": 96.44,
"payPercentage": 100,
"employeePayAccount": {
"payAccountTypeID": "DF7ED049-B678-42BC-9921-D7E193B0BA28",
"employeePayAccountEntities": [
{
"accountNumber": "1111222233331111",
"routingNumber": "011401533"
}
]
}
}
],
"payPeriod": {
"payPeriod_paySchedule": {
"standardWorkingHours": 8
},
"payPeriod": "01/10/2025 - 01/16/2025",
"payDate": "2025-02-07",
"payBeginDate": "2025-01-10",
"payEndDate": "2025-01-16",
"workerType": {
"workerType": "W2"
}
},
"baseTotal": 111,
"grossTotal": 111,
"netTotal": 96.44,
"PayrollLineItem_OverTimes": [],
"PayrollLineItemReimbursements": [],
"payrollLineItemDetailsEmployeeTax": [],
"payrollLineItemDetailsEmployerTax": [],
"payrollLineItemDeductions": [],
"payrollLineItemAdditionalCompensations": [],
"payrollLineItemYTDs": [
{
"baseTotalYTD": 111,
"grossTotalYTD": 111,
"netTotalYTD": 96.44
}
]
}
],
"payrollLineItemPrevious": []
}
},
{
"employeeID": "D8934854-20F7-4607-8007-A4B78254007F",
"companyID": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"report": {
"employeereportdetails": [
{
"employeeID": "D8934854-20F7-4607-8007-A4B78254007F",
"companyID": "01A33366-EE1C-4E13-BCB9-E482AC3A4545",
"employeeName": "Regina Wise",
"phoneNumber": "2511630007",
"custEmpID": null,
"jobTitle": "HR",
"employeeWages": [],
"w4Informations": [],
"employeeAddress": {
"address": "102 Fallsgrove Blvd, Rockville, MD, 20850-4713",
"address1": "102 Fallsgrove Blvd",
"address2": "",
"city": "Rockville",
"state": "MD",
"zipcode": "20850-4713"
}
}
],
"EntityTax": [
{
"taxID": "587400936"
}
],
"PayrollLineItem": [],
"payrollLineItemPrevious": []
}
}
],
"Company": [
{
"company": "Torp Group",
"kybInformations": [
{
"phoneNumber": "8587458008"
}
]
}
],
"EntityTax": [
{
"taxID": "600800500"
}
],
"CompanyLocation": [
{
"address": "8435 Colard Ln, Lyons, CO, 80540",
"companyLocation": "22 Main",
"address1": "8435 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540"
}
],
"PayPeriod": [
{
"payDate": "2025-02-07",
"payBeginDate": "2025-01-10",
"payEndDate": "2025-01-16",
"payPeriod": "01/10/2025 - 01/16/2025",
"workerType": {
"workerType": "W2"
},
"isProcessed": true,
"isActive": true
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Response
200 - application/json
Show child attributes
Show child attributes
⌘I