Skip to main content
POST
Create Custom Payroll Journal Report

Authorizations

Authorization
string
header
required

Body

application/json
companyID
string
required

Zeal Company ID

media_type
enum<string>
required

The type of format this report can be downloaded as. Payroll Journals currently support "csv" and "pdf".

Available options:
csv,
pdf
start_date
string<date>
required

The first check date this report should retrieve checks for. Date should be in ISO-8601 format (YYYY-MM-DD).

end_date
string<date>
required

The last check date this report should retrieve checks for. Date should be in ISO-8601 format (YYYY-MM-DD).

fields
object

Optional fields and parameters for Custom Payroll Journal

customer_account_ids
string[]

Filter by customer account(s) (Early Access)

Response

200

success
boolean
default:true
Example:

true

data
object