Get payroll journal

get

https://sandbox.checkhq.com/companies/{company}/reports/payroll_journal

Returns the specified payroll journal.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company

string

required

ID of the company with the payroll journal to return

Query Params

start

date

Return payrolls with a payday on or after this date.

end

date

Return payrolls with a payday before or on this date.

payroll

string

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

include_taxable_wages

boolean

Defaults to false

Return payrolls with taxable wages.

include_gross_taxable_wages

boolean

Defaults to false

Return payrolls with gross taxable wages (wages subject to a tax before pre-tax deductions, irrespective of wage base).

include_employee_id

boolean

Defaults to false

Return employees with their ID.

include_contractors

boolean

Defaults to false

Return payments made to contractors on payrolls

group_by

string

enum

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

Allowed:

Headers

string

Either application/json or text/csv

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400