Skip to main content
GET
/
v1-preview
/
connections
/
{connection}
/
payrolls
/
{payroll}
/
payroll-records
List payroll records (preview)
curl --request GET \
  --url https://demo1-api.payrollintegrationsdemo.com/v1-preview/connections/{connection}/payrolls/{payroll}/payroll-records \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "employeeId": "dd0e8400-e29b-41d4-a716-446655440008",
      "payrollComponents": [
        {
          "code": "401K_EMPLOYEE",
          "amount": "500.00",
          "description": "401(k) Employee Contribution"
        },
        {
          "code": "401K_EMPLOYER",
          "amount": "250.00",
          "description": "401(k) Employer Match"
        },
        {
          "code": "ROTH_401K",
          "amount": "300.00",
          "description": "Roth 401(k) Employee Contribution"
        },
        {
          "code": "LOAN_REPAYMENT",
          "amount": "150.00",
          "description": "401(k) Loan Repayment"
        },
        {
          "code": "CATCHUP_CONTRIB",
          "amount": "100.00",
          "description": "Catch-up Contribution"
        }
      ]
    },
    {
      "employeeId": "de0e8400-e29b-41d4-a716-446655440011",
      "payrollComponents": [
        {
          "code": "401K_EMPLOYEE",
          "amount": "750.00",
          "description": "401(k) Employee Contribution"
        },
        {
          "code": "401K_EMPLOYER",
          "amount": "375.00",
          "description": "401(k) Employer Match"
        }
      ]
    }
  ],
  "meta": {
    "limit": 10,
    "offset": 0,
    "sort": "employeeId",
    "currentCount": 2,
    "totalCount": 2
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

connection
string<uuid>
required
payroll
string<uuid>
required

Response

List of payroll records

data
object[]
required
meta
object
required