Sign in

v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Preview Check Data

post/preview/checkData

Request body

companyIDstring required

The ID of the Company

employeeIDstring required

The ID of the employee

reportingPeriodIDstring required

ID of the reporting period

check_datestring date required

Check date for this employee

approval_requiredboolean

Determine if approval is required for the check, defaults to false

metadataobject

Custom object you can attach to the employee check object. This is useful for storing additional information about the object in a custom, structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata. Metadata

flsa_ot_recommendationboolean

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "success": true,
    "result": {
      "checks": [
        {
          "gross_pay": "2000.00",
          "net_pay": "1452.98",
          "employer_taxes": "368.31",
          "employee_taxes": "447.02",
          "employee_deductions": "100.00",
          "employer_deductions": "8.00",
          "taxes": [
            {
              "name": "Federal Income Tax",
              "codename": "FIT",
              "amount": "149.58",
              "paidBy": "EMPLOYEE_WITHHOLDING"
            }
          ],
          "deductions": [
            {
              "deduction_type": "401k",
              "employee_calculated_contribution": "100.00",
              "employer_calculated_contribution": "8.00"
            }
          ]
        }
      ],
      "total_employer_taxes": "368.31",
      "total_employee_taxes": "447.02",
      "total_employee_deductions": "100.00",
      "total_employer_deductions": "8.00"
    }
  }
}