CHcheckhq

Preview a payroll

Changed on

Returns a preview of an approved version of the input payroll

get/payrolls/{payroll}/preview (COPY)

Request

Path parameters

payrollstring required

ID of the payroll to preview.

Query parameters

itemstring

ID of a payroll item to preview instead of the whole payroll. Multiple of this param may be passed to preview multiple items. Please note that concurrent requests to this endpoint for the same payroll will complete sequentially.

Headers

Acceptstring

Either application/json or text/csv

Response

200

idstring
companystring
period_startstring
period_endstring
approval_deadlinestring
approved_atstring
paydaystring
statusstring
typestring
pay_frequencystring
funding_payment_methodstring
processing_periodstring
off_cycle_optionsunknown
managedboolean
is_voidboolean
metadataobject

Example response

{
  "id": "pay_Z26PNMC7Ky1wfFQzVqfF",
  "company": "com_sx3svU6K8c5ZkSFlOh5p",
  "period_start": "2019-06-16",
  "period_end": "2019-06-29",
  "approval_deadline": "2019-07-02T00:00:00.000000Z",
  "approved_at": "2019-06-29T18:26:56.848920Z",
  "payday": "2019-07-05",
  "status": "paid",
  "type": "regular",
  "pay_frequency": "biweekly",
  "funding_payment_method": "ach",
  "processing_period": "four_day",
  "managed": true,
  "totals": {
    "employee_gross": "961.54",
    "employee_reimbursements": "0.00",
    "employee_taxes": "249.23",
    "employee_benefits": "0.00",
    "post_tax_deductions": "0.00",
    "employee_net": "712.31",
    "contractor_gross": "100.00",
    "contractor_reimbursements": "15.00",
    "contractor_net": "115.00",
    "company_taxes": "73.56",
    "company_benefits": "0.00",
    "liability": "1150.10",
    "cash_requirement": "1150.10"
  },
  "items": [
    {
      "id": "itm_yvmmsVGFxLoBaMIkqzea",
      "payroll": "pay_Z26PNMC7Ky1wfFQzVqfF",
      "employee": "emp_zGGp6wYcxAeu1Ng8IA7v",
      "payment_method": "direct_deposit",
      "net_pay": "712.31",
      "earnings": [
        {
          "amount": "961.54",
          "hours": 40,
          "type": "regular",
          "workplace": "wrk_cxcG4vjGKcSXZk1fgKai"
        }
      ],
      "taxes": [
        {
          "tax": "tax_I1Z9zqbBGWIbvlZpN2Vq",
          "description": "New York SDI",
          "amount": "0.60",
          "payer": "employee"
        }
      ]
    }
  ],
  "contractor_payments": [
    {
      "contractor": "ctr_90QzaH9xPRI7JRLXnRoU",
      "payment_method": "manual",
      "amount": "100.00",
      "reimbursement_amount": "15.00"
    }
  ]
}

Changes