Returns a summary of the total transactions, including the count and total amount.

GET /reports/transaction-summary
Oauth2

Returns a summary of the total transactions, including the count and total amount. By default, the report covers the previous twelve months, not including the current month.

Query parameters

  • startDate string(date-time)

    An optional start date of the report. If not specified, defaults to the first of the month, twelve months ago. If specified, end date is required and must be after the start date. For accuracy of reports which summarize by month, the start date should be the first day of the month. The range is inclusive of this date. Must be in ISO 8601 compliant format yyyy-MM-dd (for April first: 2025-04-01).

  • endDate string(date-time)

    An optional end date of the report. If not specified, defaults to the first day of the current month. If specified, start date is required and must be before the end date. For accuracy of reports which summarize by month, the end date should be the first day of the month after the last month in the report.
    The range is *EX*clusive of this date. Must be in ISO 8601 compliant format yyyy-MM-dd (for April first: 2025-04-01).

Responses

  • 200 application/json

    A summary of the total transactions.

    Hide response attributes Show response attributes object
    • count integer(int64)
    • totalAmount number
GET /reports/transaction-summary 
curl \
 --request GET 'https://usaapi02.cadencyservices.trintech.com/test/api/reports/transaction-summary' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "count": 42,
  "totalAmount": 42.0
}