v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Paystub Report

Create paystub report.

post/reports/paystub

Request body

companyIDstring required

ID of the Company

start_datestring date required

Start date of the dates that span the Paystub Report. Date should be in ISO-8601 format (YYYY-MM-DD).

end_datestring date required

End date of the dates that span the Paystub Report (will default to today's date if left blank). Date should be in ISO-8601 format (YYYY-MM-DD).

media_typestring required

The media type of the report, only PDF is supported

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "job_id": "3088e25-115d-4c47-2224-05gh47843f0f",
    "status": "pending",
    "request_body": {
      "companyID": "0f2341ee141040acea333e132a3ccb462",
      "start_date": "2023-12-20",
      "end_date": "2023-12=06",
      "media_type": "pdf",
      "has_live_key": true,
      "report_format": "paystub"
    },
    "created_at": "2023-12-06T18:05:13.175Z"
  }
}