Skip to main content
Beyond calculating a paycheck, the API can generate predefined reports. Check tops, pay stubs, earnings summaries, as a base64-encoded PDF you render on your side.

​
Two ways to get a report

  • On a calculation: add report=<type> to a calculator POST; the response includes the report(s) under reporting.reports as base64-encoded PDFs.
  • Directly: GET/POST the print endpoint:

​
Report types

type accepts: all, checktop, checkmiddle, checkbottom, earnings, paystub (for the final pay calculator), or omitted.

​
The print object

Populate the print object on your request to control what appears on the report: employee and company name/address, check number and date, remarks, and emailReports. See the full list in Object model and default properties.

​
Rendering

The report arrives base64-encoded inside the JSON response (not raw bytes). Decode it to bytes and write a .pdf (or stream it to the browser as a Blob).
Widgets can also print or email reports directly. Those settings are enabled by Symmetry in the admin console. See Special features.