Get contractor payments report

Returns the specified contractor payments report.

get/companies/{company}/reports/contractor_payments (COPY)

Request

Base URL
https://sandbox.checkhq.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/checkhq/apis/check-api/docs/companies/:company/reports/contractor_payments%20(COPY)/get.ts
A function with typed inputs. Its response is checked against the schema.

companystring required

ID of the company with the contractor report to return

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

Acceptstring

Either application/json or text/csv

200