| Time | Status | User Agent |  |
| :-- | :-- | :-- | :-- |
| Make a request to see history. |

#### URL Expired

The URL for this request expired after 30 days.

Creates a Customized Payroll Journal Report with different fields, which can be downloaded as a CSV or PDF. Payroll information will only be taken into account for reports from checks that are in a processed state.

This endpoint will return a `job_id` instead of the raw data itself. As the data returned from this endpoint can be large, we utilize a job queue to process this data instead of an immediate synchronous response. Once the [job status](https://docs.zeal.com/reference/get-job-status) is marked as **complete**, the report can be downloaded using the [Download Report](https://docs.zeal.com/reference/retrieve-report-download) endpoint.

## Returns

| attribute | type | description |
| --- | --- | --- |
| success | boolean | Response status |
| data | object | `job_id` for Custom Payroll Journal Report |
| errors | array | Contains a list of error objects which consists of:<br>`message`: Error message<br>`code`: Error code as described in [Error codes](https://docs.zeal.com/reference/error-codes) |

### companyID

string

required

Zeal Company ID

### media_type

string

enum

required

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

Allowed:

`csv``pdf`

### start_date

date

required

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

### end_date

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

array of strings

Filter by customer account(s) (Early Access)

### Example Request

```
curl --request POST \
     --url https://api.zeal.com/reports/custom-payroll-journal \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"media_type":"csv"}'
```

### Example Responses

- `200 - Result`
- `400 - Result`

Updated 7 months ago.