Skip to main content
GET
/
v1
/
payroll-connections
/
{payroll_connection}
/
payroll-records
/
{payroll_record}
/
payroll-data
List payroll record data
curl --request GET \
  --url https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/payroll-records/{payroll_record}/payroll-data \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
        }
      ]
    },
    {
      "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": {
    "limit": 10,
    "offset": 0,
    "sort": "employeeId",
    "currentCount": 2,
    "totalCount": 2
  }
}

Pagination & Sorting

Limit
  • Default: 20
  • Maximum: 100
Sort Fields
  • employeeId (Default)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payroll_connection
string<uuid>
required
payroll_record
string<uuid>
required

Response

List of payroll data

data
object[]
required
meta
object
required