Skip to main content
GET
Summarize successful payments and refunds

Authorizations

Authorization
string
header
required

Existing Breezy API key. Grants all published reads in its associated company. No app permission scopes.

Query Parameters

limit
integer
default:50

Maximum parent records or report rows. Complete children are always included.

Required range: 1 <= x <= 100
cursor
string | null

Repeat the original filters; any valid page size may continue. Foreign-company, tampered or mismatched cursors return INVALID_CURSOR.

Minimum string length: 1
start_date
string<date>
required

Inclusive company-local date.

end_date
string<date>
required

Exclusive company-local date; must be after start_date.

bucket
enum<string>
default:month
Available options:
day,
week,
month,
quarter,
year
account_id
string<uuid> | null
method
enum<string> | null
Available options:
CARD,
ACH,
CASH,
CHECK,
PAYPAL,
VENMO,
CASHAPP,
OTHER,
WISETACK_LOAN,
null
collected_by_id
string<uuid> | null
group_by
enum<string> | null
Available options:
account,
payment_method,
collector,
null

Response

Successful read. Clients ignore unrecognized response fields.

data
object[]
required
pagination
object
required
meta
object
required

Generation time and company timezone. generated_at is not a snapshot or synchronization token.

report
object
required