CHcheckhq

List payrolls

Changed on

Returns a list of payrolls.

get/payrolls

Request

Query parameters

companystring

Return payrolls for this company ID.

typestring[]

Return payrolls of these types. Repeat the parameter to match any of multiple values (for example, ?type=regular&type=off_cycle).

is_voidboolean

Filter to void payrolls (true) or non-void payrolls (false).

managedboolean

Return payrolls of this managed status.

limitinteger

Number of payrolls returned per page. The maximum value is 25.

payday_afterstring date

Return payrolls whose payday is on or after the provided date (format: YYYY-MM-DD)

payday_beforestring date

Return payrolls whose payday is on or before the provided date (format: YYYY-MM-DD)

statusstring[]

Return payrolls in a given status. Repeat the parameter to match any of multiple values (for example, ?status=paid&status=partially_paid).

approvedboolean

Filter payrolls based on their approval status

pay_schedulestring

Return payrolls for this pay schedule

idstring

Filter the list to a specific set of payroll IDs

include_itemsboolean

Return related payroll items directly on each payroll.

include_contractor_paymentsboolean

Return related contractor payments directly on each payroll.

Response

200

idstring
companystring
period_startstring
period_endstring
approval_deadlinestring
approved_atstring
paydaystring
statusstring
typestring
pay_frequencystring
processing_periodstring
off_cycle_optionsunknown
managedboolean
correctionstring nullable

ID of the correction this payroll is an operation of. null if the payroll is not attached to a correction.

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",
    "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

  • 5a54f5eb888bRevision changes
    • breaking

      removed the enum value amendment from the query request parameter type

    • breaking

      removed the enum value balancing from the query request parameter type

    • breaking

      removed the enum value draft from the query request parameter status

    • breaking

      removed the enum value failed from the query request parameter status

    • breaking

      removed the enum value off_cycle from the query request parameter type

    • breaking

      removed the enum value paid from the query request parameter status

    • breaking

      removed the enum value partially_paid from the query request parameter status

    • breaking

      removed the enum value pending from the query request parameter status

    • breaking

      removed the enum value processing from the query request parameter status

    • breaking

      removed the enum value regular from the query request parameter type

    • info

      added the new optional query request parameter is_void

    • info

      for the query request parameter status, the type was generalized from string to array

    • info

      for the query request parameter type, the type was generalized from string to array

    • info

      added the optional property / to the response with the status