CHcheckhq

Get contractor payments report

Changed on

Returns the specified contractor payments report.

get/companies/{company}/reports/contractor_payments

Request

Path parameters

companystring required

ID of the company with the contractor report to return

Query parameters

startstring date

Filter on payrolls with a payday on or after this date.

endstring date

Filter on payrolls with a payday before or on this date.

payrollstring

Filter on payroll(s) with this ID. To specify multiple payrolls, repeat this query parameter. (For example: "&payroll=pay_123&payroll=pay_456&...")

previewboolean

Include to show the report for contractor payments on draft payrolls

Headers

Acceptstring

Either application/json or text/csv

Response

200

nextstring
previousstring

Example response

{
  "results": [
    {
      "amount": "50.00",
      "business_name": "Defiance",
      "first_name": "Slade",
      "last_name": "Wilson",
      "payday": "2021-11-27",
      "payroll": "pay_qeArodmFoLJY8pxQD18J",
      "period_end": "2021-11-27",
      "period_start": "2021-11-14",
      "reimbursement_amount": "15.00",
      "net_pay": "35.00"
    }
  ]
}

Changes