v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Get Preview

get/preview

Query parameters

job_idstring required

The job_id of the Payroll Preview generated by the Preview Payroll by CheckID or Preview Payroll by Check Date endpoints

Response

200

statusinteger
successboolean

Example response

{
  "status": 200,
  "success": true,
  "data": {
    "job_id": "8a60333360ff-36ef-47a8-a6e4-f4d7351da9ee",
    "status": "complete",
    "code": 200,
    "created_at": "2023-04-12T14:56:23.366Z",
    "request_body": {
      "checks": [
        "b97eecccece0f22a0a9423d9a47543b8fa8b680"
      ],
      "companyID": "eee343432243434c59c913c59c913",
      "test_mode": true,
      "job_type": "preview-checks"
    },
    "payload": {
      "success": true,
      "result": {
        "checks": [
          {
            "employeeCheckID": "b97eecccece0f22a0a9423d9a47543b8fa8b680",
            "gross_pay": "1360.00",
            "net_pay": "1097.94",
            "employer_taxes": "198.81",
            "employee_taxes": "162.06",
            "employee_deductions": "100.00",
            "employer_deductions": "0.00",
            "taxes": [
              {
                "name": "Federal Income Tax",
                "codename": "FIT",
                "amount": "20.58",
                "paidBy": "EMPLOYEE_WITHHOLDING"
              }
            ],
            "deductions": [
              {
                "deduction_type": "401k",
                "employee_calculated_contribution": "100.00",
                "employer_calculated_contribution": "0.00"
              }
            ]
          }
        ],
        "total_flsa_transformed": 1,
        "total_employer_taxes": "388.82",
        "total_employee_taxes": "565.28",
        "total_employee_deductions": "128.50",
        "total_employer_deductions": "0.00"
      }
    }
  }
}