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

Get Write-off Analysis Report

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

Time written off (or on) against fees over the window, grouped by reason, team member or client. The cohort is every time allocation recorded in the window, dated by when the disposal was recorded. Recovery is measured against Sodium's billing lines, not the invoice the accounting platform issued. Requires time tracking to be in use.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

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

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