cURL
curl --request GET \
--url https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data', 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://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"payrollConnectionId": "00000000-0000-0000-0000-000000000000",
"employeeId": "dd0e8400-e29b-41d4-a716-446655440008",
"payPeriodGrossAmount": "1300.00",
"payPeriodTotalHours": "30.0000",
"payrollComponents": [
{
"payrollCode": "401K_EMPLOYEE",
"amount": "500.00",
"hours": "10.0000",
"loanIdentifier": null,
"classification": "EMPLOYEE_DEDUCTION",
"category": "PRETAX",
"subcategory": "401K_CATCHUP"
},
{
"payrollCode": "401K_EMPLOYER",
"amount": "250.00",
"hours": "5.0000",
"loanIdentifier": null,
"classification": "EMPLOYER_PAID_BENEFIT",
"category": "PLAN_INCLUDED_GROSS_COMPENSATION",
"subcategory": "PLAN_INCLUDED_GROSS_COMPENSATION"
},
{
"payrollCode": "ROTH_401K",
"amount": "300.00",
"hours": "6.0000",
"loanIdentifier": null,
"classification": "EMPLOYEE_DEDUCTION",
"category": "ROTH",
"subcategory": "ROTH"
},
{
"payrollCode": "LOAN_REPAYMENT",
"amount": "150.00",
"hours": "5.0000",
"loanIdentifier": "2",
"classification": "EMPLOYEE_DEDUCTION",
"category": "SAFE_HARBOR_MATCH",
"subcategory": "SAFE_HARBOR_MATCH"
},
{
"payrollCode": "CATCHUP_CONTRIB",
"amount": "100.00",
"hours": "4.0000",
"loanIdentifier": null,
"classification": "EMPLOYEE_DEDUCTION",
"category": "ROTH",
"subcategory": "ROTH"
}
]
},
{
"payrollConnectionId": "11111111-1111-1111-1111-111111111111",
"employeeId": "de0e8400-e29b-41d4-a716-446655440011",
"payPeriodGrossAmount": "1125.00",
"payPeriodTotalHours": "27.0000",
"payrollComponents": [
{
"payrollCode": "401K_EMPLOYEE",
"amount": "750.00",
"hours": "15.0000",
"loanIdentifier": null,
"classification": "EMPLOYEE_DEDUCTION",
"category": "PRETAX",
"subcategory": "401K_CATCHUP"
},
{
"payrollCode": "401K_EMPLOYER",
"amount": "375.00",
"hours": "12.0000",
"loanIdentifier": null,
"classification": "EMPLOYER_PAID_BENEFIT",
"category": "PLAN_INCLUDED_GROSS_COMPENSATION",
"subcategory": "PLAN_INCLUDED_GROSS_COMPENSATION"
}
]
}
],
"meta": {
"currentCount": 2,
"filters": {},
"limit": 10,
"offset": 0,
"sort": "employeeId",
"totalCount": 2
}
}{
"message": "<string>",
"errors": [
"<string>"
]
}{
"message": "<string>",
"errors": [
"<string>"
]
}{
"message": "<string>",
"errors": [
"<string>"
]
}{
"message": "<string>",
"errors": [
"<string>"
]
}{
"message": "<string>",
"errors": [
"<string>"
]
}{
"message": "<string>",
"errors": [
"<string>"
]
}Payroll Records
List Payroll Record Data
Returns payroll data for a specific payroll record
GET
/
v1
/
payroll-connections
/
{payroll_connection}
/
payroll-records
/
{payroll_record}
/
payroll-data
cURL
curl --request GET \
--url https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data', 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://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"payrollConnectionId": "00000000-0000-0000-0000-000000000000",
"employeeId": "dd0e8400-e29b-41d4-a716-446655440008",
"payPeriodGrossAmount": "1300.00",
"payPeriodTotalHours": "30.0000",
"payrollComponents": [
{
"payrollCode": "401K_EMPLOYEE",
"amount": "500.00",
"hours": "10.0000",
"loanIdentifier": null,
"classification": "EMPLOYEE_DEDUCTION",
"category": "PRETAX",
"subcategory": "401K_CATCHUP"
},
{
"payrollCode": "401K_EMPLOYER",
"amount": "250.00",
"hours": "5.0000",
"loanIdentifier": null,
"classification": "EMPLOYER_PAID_BENEFIT",
"category": "PLAN_INCLUDED_GROSS_COMPENSATION",
"subcategory": "PLAN_INCLUDED_GROSS_COMPENSATION"
},
{
"payrollCode": "ROTH_401K",
"amount": "300.00",
"hours": "6.0000",
"loanIdentifier": null,
"classification": "EMPLOYEE_DEDUCTION",
"category": "ROTH",
"subcategory": "ROTH"
},
{
"payrollCode": "LOAN_REPAYMENT",
"amount": "150.00",
"hours": "5.0000",
"loanIdentifier": "2",
"classification": "EMPLOYEE_DEDUCTION",
"category": "SAFE_HARBOR_MATCH",
"subcategory": "SAFE_HARBOR_MATCH"
},
{
"payrollCode": "CATCHUP_CONTRIB",
"amount": "100.00",
"hours": "4.0000",
"loanIdentifier": null,
"classification": "EMPLOYEE_DEDUCTION",
"category": "ROTH",
"subcategory": "ROTH"
}
]
},
{
"payrollConnectionId": "11111111-1111-1111-1111-111111111111",
"employeeId": "de0e8400-e29b-41d4-a716-446655440011",
"payPeriodGrossAmount": "1125.00",
"payPeriodTotalHours": "27.0000",
"payrollComponents": [
{
"payrollCode": "401K_EMPLOYEE",
"amount": "750.00",
"hours": "15.0000",
"loanIdentifier": null,
"classification": "EMPLOYEE_DEDUCTION",
"category": "PRETAX",
"subcategory": "401K_CATCHUP"
},
{
"payrollCode": "401K_EMPLOYER",
"amount": "375.00",
"hours": "12.0000",
"loanIdentifier": null,
"classification": "EMPLOYER_PAID_BENEFIT",
"category": "PLAN_INCLUDED_GROSS_COMPENSATION",
"subcategory": "PLAN_INCLUDED_GROSS_COMPENSATION"
}
]
}
],
"meta": {
"currentCount": 2,
"filters": {},
"limit": 10,
"offset": 0,
"sort": "employeeId",
"totalCount": 2
}
}{
"message": "<string>",
"errors": [
"<string>"
]
}{
"message": "<string>",
"errors": [
"<string>"
]
}{
"message": "<string>",
"errors": [
"<string>"
]
}{
"message": "<string>",
"errors": [
"<string>"
]
}{
"message": "<string>",
"errors": [
"<string>"
]
}{
"message": "<string>",
"errors": [
"<string>"
]
}Authorizations
Bearer token obtained from the /v1/auth/token endpoint. Send as: Authorization: Bearer .
Path Parameters
ID of the payroll connection
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ID of the payroll record
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Query Parameters
Maximum number of records to return
Required range:
1 <= x <= 4294967295Number of records to skip from the beginning
Required range:
0 <= x <= 4294967295Comma-separated list of fields to sort by. Prefix with - for descending order
Pattern:
^(-?\w{1,100})(?:,(-?\w{1,100})){0,2}$