API Docs / Operations / Reports / Export Write-off Analysis Report

Export Write-off Analysis Report

GET /tenants/{tenant}/reports/write-offs/csv

The breakdown table as a CSV download - same filters and grouping as the report endpoint, money to two decimal places.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

dateRange query string

Preset date range for when the write-offs were recorded (default Last30Days). If CustomDateRange, startDate and endDate are required.

Preset date range for when the write-offs were recorded (default Last30Days). If CustomDateRange, startDate and endDate are required.

startDate query string

Window start (inclusive). Only valid when dateRange=CustomDateRange

Window start (inclusive). Only valid when dateRange=CustomDateRange

endDate query string

Window end (inclusive). Only valid when dateRange=CustomDateRange

Window end (inclusive). Only valid when dateRange=CustomDateRange

groupBy query string

Breakdown dimension: Reason (default), User or Client

Breakdown dimension: Reason (default), User or Client

Responses

200 OK
400 Bad Request
401 Unauthorized – Invalid or missing API key
403 Forbidden

Try it