The external payroll object

Represents a payroll paid outside of Check

{
  "id": "pay_Z26PNMC7Ky1wfFQzVqfF",
  "company": "com_sx3svU6K8c5ZkSFlOh5p",
  "period_start": "2019-06-16",
  "period_end": "2019-06-29",
  "approved_at": "2019-06-29T18:26:56.848920Z",
  "payday": "2019-07-05",
  "status": "paid",
  "pay_frequency": "biweekly",
  "items": [
    {
      "id": "itm_yvmmsVGFxLoBaMIkqzea",
      "payroll": "pay_Z26PNMC7Ky1wfFQzVqfF",
      "employee": "emp_zGGp6wYcxAeu1Ng8IA7v",
      "earnings": [
        {
          "amount": "961.54",
          "hours": 40.0,
          "type": "hourly",
          "workplace": "wrk_cxcG4vjGKcSXZk1fgKai"
        }
      ],
      "reimbursements": [],
      "taxes": [
        {
          "tax": "tax_I1Z9zqbBGWIbvlZpN2Vq",
          "amount": "0.60"
        },
        {
          "tax": "tax_ImvSF9CTuMdokf0uwx5x",
          "amount": "59.62"
        },
        {
          "tax": "tax_yjNkKk061BTipYv7G4Ti",
          "amount": "31.04"
        },
        {
          "tax": "tax_S1krAkh75RzdWu5J53HA",
          "amount": "44.20"
        },
        {
          "tax": "tax_UJrIQbtVErbdez0bYTVN",
          "amount": "1.47"
        },
        {
          "tax": "tax_1XHqR9Qf5t18SD2sfYEe",
          "amount": "13.94"
        },
        {
          "tax": "tax_8L3JLfsH4X6dp0maBWfW",
          "amount": "98.36"
        },
        {
          "tax": "tax_ibU8cGhC5OlpOjoQFIXV",
          "amount": "59.62"
        },
        {
          "tax": "tax_O3f21hkS1cvHBZTa61BO",
          "amount": "13.94"
        }
      ],
      "benefits": [],
      "post_tax_deductions": []
    }
  ],
  "contractor_payments": [
    {
      "contractor": "ctr_90QzaH9xPRI7JRLXnRoU",
      "amount": "100.00",
      "reimbursement_amount": "15.00"
    }
  ],
  "metadata": {}
}
AttributeDescription
id
string
Unique identifier for the payroll.
company
string
ID of the company that the payroll relates to.
period_start
YYYY-MM-DD
Start of the date range that the payroll covers.
period_end
YYYY-MM-DD
End of the date range that the payroll covers.
approved_at
datetime

Datetime at which the payroll was approved.

null for payrolls with a status of draft.

payday
YYYY-MM-DD

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 /paydays endpoint.

status
string

Status of the payroll in its lifecycle.

One of draft or paid if approved.

pay_frequency
string

Frequency by which employees get paid.

One of weekly, biweekly, semimonthly, monthly, quarterly, or annually.

pay_schedule
string
ID of the pay schedule that the payroll relates to.
items
array of external payroll item objects

The set of external payroll items associated with the payroll.

On List external payrolls, omitted when include_items is false.

contractor_payments
array of external contractor payment objects

The set of external contractor payments associated with the payroll.

On List external payrolls, omitted when include_items is false.

metadata
object
Additional loosely structured information to associate with the payroll.