CHcheckhq

Get payroll journal

Changed on

Returns the specified payroll journal.

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

Request

Path parameters

companystring required

ID of the company with the payroll journal to return

Query parameters

startstring date

Return payrolls with a payday on or after this date.

endstring date

Return payrolls with a payday before or on this date.

payrollstring

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

include_taxable_wagesboolean

Return payrolls with taxable wages.

include_employee_idboolean

Return employees with their ID.

include_contractorsboolean

Return payments made to contractors on payrolls

include_contractor_idboolean

Return contractors with their ID.

group_by'workplace'

Determines how to breakdown pay. If workplace is provided, employees will have one line item per payroll and workplace combination.

Headers

Acceptstring

Either application/json or text/csv

Response

200

object required

Changes