v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Deduction Summary Report

Create a summary report outlining deductions within a given timeframe

post/reports/deductions-summary

Request body

companyIDstring required

ID of the company.

media_typestring required

The type of format this report can be downloaded as. Deduction Summary currently only supports "csv".

start_datestring date required

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

end_datestring date required

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

customer_account_idsstring[]

Filter by customer account(s) (Early Access)

Response

200

successboolean

created_atstring

Example response

{
  "success": true,
  "data": {
    "job_id": "7282b13f-254f-4eb9-bt88-24f429be6aa0",
    "status": "pending",
    "request_body": {
      "companyID": "f3cc3ec1fb1e144bd39504ue80cf3e20612",
      "media_type": "csv",
      "start_date": "2024-04-01",
      "end_date": "2024-05-30"
    },
    "has_live_key": true,
    "report_format": "deductions-summary"
  },
  "created_at": "2024-12-18T22:15:08.977Z"
}