Get Transactions Summary

curl --request GET \
  --url https://api.royalti.io/accounting/transactions/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/accounting/transactions/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/accounting/transactions/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/accounting/transactions/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/accounting/transactions/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "message": "success",
  "summary": {
    "totalPayments": 50000,
    "totalRevenues": 125000.5,
    "totalExpenses": 15000.25,
    "netAmount": 60000.25
  }
}

GET

accounting

transactions

summary

Get Transactions Summary

curl --request GET \
  --url https://api.royalti.io/accounting/transactions/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/accounting/transactions/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/accounting/transactions/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/accounting/transactions/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/accounting/transactions/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "message": "success",
  "summary": {
    "totalPayments": 50000,
    "totalRevenues": 125000.5,
    "totalExpenses": 15000.25,
    "netAmount": 60000.25
  }
}

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

Description

Get Transactions Summary Get an aggregated summary of all tenant transactions including total payments, revenues, expenses, and net amount. Method: GET Authorization:

Required role: admin or higher

Query Parameters:

Parameter	Type	Description
startDate (Optional)	string	Filter transactions from this date (inclusive)
endDate (Optional)	string	Filter transactions to this date (inclusive)
currency (Optional)	string	Filter by currency code
includePreviousPeriod (Optional)	string	Set to ‘true’ to include previous period comparison and deltas

When includePreviousPeriod=true: the response includes previousPeriod and deltas alongside summary. If startDate/endDate are provided, the previous period is the same duration shifted back. If no dates are provided, compares current month vs. the equivalent prior period.

Code Examples

const response = await fetch('https://api.royalti.io/accounting/transactions/summary', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
  'https://api.royalti.io/accounting/transactions/summary',
  headers={
    'Authorization': f'Bearer {token}'
  },
)

data = response.json()
print(data)

curl -X GET https://api.royalti.io/accounting/transactions/summary \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

Authorization

string

header

required

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

Query Parameters

startDate

string<date>

Filter transactions from this date (inclusive)

endDate

string<date>

Filter transactions to this date (inclusive)

currency

string

Filter by currency code (e.g., USD, EUR)

includePreviousPeriod

enum<string>

Include previous period comparison with percentage deltas

Available options:

true

Response

Transactions summary retrieved successfully

message

string

Example:

"success"

summary

object

Show child attributes

previousPeriod

object | null

Previous period summary (only when includePreviousPeriod=true)

Show child attributes

deltas

object | null

Period-over-period changes (only when includePreviousPeriod=true)

Show child attributes

​Description

​Code Examples

Authorizations

Query Parameters

Response

Description

Code Examples