Skip to main content
GET
/
accounting
/
transactions
/
summary
Get Transactions Summary
curl --request GET \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/accounting/transactions/summary \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "totalAmount": 123,
    "currency": "<string>",
    "count": 123,
    "byType": [
      {
        "totalAmount": 123,
        "currency": "<string>",
        "count": 123,
        "byType": [
          {
            "type": "<string>",
            "amount": 123,
            "count": 123
          }
        ]
      }
    ],
    "timeSeries": [
      {
        "period": "<string>",
        "amount": 123,
        "count": 123
      }
    ]
  }
}
Get Transactions Summary Get a summary of transactions with aggregated data. Method: GET Query Parameters:
ParameterTypeDescription
startDatestringFilter by start date (ISO format)
endDatestringFilter by end date (ISO format)
groupBystringGroup results by time period

Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

Query Parameters

ParameterTypeInRequiredDescription
startDatestringqueryāŒFilter by start date (ISO format)
endDatestringqueryāŒFilter by end date (ISO format)
groupBystringqueryāŒGroup results by time period

Responses

āœ… 200 - Transactions summary retrieved successfully

āš ļø 400 - undefined

āš ļø 401 - undefined

āŒ 500 - undefined

Tags

Accounting

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

startDate
string<date-time>

Filter by start date (ISO format)

endDate
string<date-time>

Filter by end date (ISO format)

groupBy
enum<string>
default:month

Group results by time period

Available options:
day,
week,
month,
year

Response

Transactions summary retrieved successfully

success
boolean
Example:

true

data
object
⌘I