Represents a company's pay obligations for a payroll period.
Contains the total amount of money to withdraw from the company's account as part of paying employees and each employee’s compensation components.
Use the payroll object to tell Check about wages earned by employees in a given pay period for a specific payday. Preview the payroll to see employee net pay, after taxes, benefit deductions, and post tax deductions. Approve the payroll to confirm the calculations, and transition the payroll into the pending
status. For more details, check out the Life of a Payroll guide.
{
"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",
"processing_period": "four_day",
"off_cycle_options": null,
"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.0,
"type": "regular",
"workplace": "wrk_cxcG4vjGKcSXZk1fgKai",
"code": null,
"description": null
}
],
"reimbursements": [],
"taxes": [
{
"tax": "tax_I1Z9zqbBGWIbvlZpN2Vq",
"description": "New York SDI",
"amount": "0.60",
"payer": "employee"
},
{
"tax": "tax_ImvSF9CTuMdokf0uwx5x",
"description": "Employer FICA Tax",
"amount": "59.62",
"payer": "company"
},
{
"tax": "tax_yjNkKk061BTipYv7G4Ti",
"description": "New York City Tax",
"amount": "31.04",
"payer": "employee"
},
{
"tax": "tax_S1krAkh75RzdWu5J53HA",
"description": "New York State Tax",
"amount": "44.20",
"payer": "employee"
},
{
"tax": "tax_UJrIQbtVErbdez0bYTVN",
"description": "New York Family Leave Benefits",
"amount": "1.47",
"payer": "employee"
},
{
"tax": "tax_1XHqR9Qf5t18SD2sfYEe",
"description": "Medicare",
"amount": "13.94",
"payer": "employee"
},
{
"tax": "tax_8L3JLfsH4X6dp0maBWfW",
"description": "Federal Income Tax",
"amount": "98.36",
"payer": "employee"
},
{
"tax": "tax_ibU8cGhC5OlpOjoQFIXV",
"description": "FICA",
"amount": "59.62",
"payer": "employee"
},
{
"tax": "tax_O3f21hkS1cvHBZTa61BO",
"description": "Employer Medicare Tax",
"amount": "13.94",
"payer": "company"
}
],
"benefits": [],
"benefit_overrides": [],
"post_tax_deductions": [],
"warnings": []
}
],
"contractor_payments": [
{
"contractor": "ctr_90QzaH9xPRI7JRLXnRoU",
"payment_method": "manual",
"amount": "100.00",
"reimbursement_amount": "15.00"
}
],
"is_void": false,
"metadata": {}
}
Attribute | Description |
---|---|
id | Unique identifier for the payroll. |
company | ID of the company that the payroll relates to. |
period_start | Start of the date range that the payroll covers. |
period_end | End of the date range that the payroll covers. |
approval_deadline | Datetime by which the payroll must be approved. |
approved_at | Datetime at which the payroll was approved.
|
payday | Date on which employees will be paid for the payroll. A list of valid paydays for payrolls paid via direct deposit is available in the |
status | Status of the payroll in its lifecycle. One of |
type | Indicates whether the payroll is a regular or off-cycle payroll. One of |
pay_frequency | Frequency by which employees get paid. One of |
pay_schedule | ID of the pay schedule that the payroll relates to. |
processing_period | The historical processing period from the associated company at the time of this payroll's creation. Company processing period may change over time, but the processing period for a payroll will remain constant. |
off_cycle_options | Additional configuration options controlling off-cycle payroll behavior.
|
managed | Indicates whether the payroll's lifecycle is being managed by Check. |
totals | Calculated totals for various payroll categories.
|
items | The set of payroll items associated with the payroll. |
contractor_payments | The set of contractor payments associated with the payroll. |
is_void | Indicates whether a payroll is a void. |
metadata | Additional loosely structured information to associate with the payroll. |