Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zeal Reports API

The Reports API from Zeal — 4 operation(s) for reports.

Zeal Reports API is one of 10 APIs that Zeal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.zeal.com.

4 operations 4 paths 2 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.zeal.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Zeal Reports API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Provide your Zeal API key as a Bearer token: Authorization: Bearer . Use a test key for Test Mode and a live key for production. Requests are additionally scop…

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Reports 4
POST
/reports/payrollJournal
Create a payroll journal report
createPayrollJournalReport body → 200
POST
/reports/cashRequirements
Create a cash requirements report
createCashRequirementsReport body → 200
GET
/reports/status
Get report job status
getReportJobStatus 1 param → 200
GET
/reports/download
Retrieve a finished report download
retrieveReportDownload 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ReportJob (3 properties), ReportRequest (3 properties). Each schema is shown below with its type and property counts.

ReportRequest
object
3 properties 1 required
ReportJob
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeal-hq-reports-api-openapi.yml Raw ↑

Other APIs Zeal publishes across the network.

Zeal Companies API
Zeal Contractor Payments API
Zeal Contractors API
Zeal Employee Check API
Zeal Employees API
Zeal Funding API
Zeal Onboarding API
Zeal Pay Schedules API
Zeal Tax API