Skip to main content
POST
Create Deduction Summary Report

Authorizations

Authorization
string
header
required

Body

application/json
companyID
string
required

ID of the company.

media_type
string
default:csv
required

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

start_date
string<date>
required

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

end_date
string<date>
required

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

customer_account_ids
string[]

Filter by customer account(s) (Early Access)

Response

200

success
boolean
default:true
Example:

true

data
object
created_at
string
Example:

"2024-12-18T22:15:08.977Z"