Skip to main content
GET
/
accounting
/
transactions
/
monthly
Get Monthly Transaction Breakdown
curl --request GET \
  --url https://api.royalti.io/accounting/transactions/monthly \
  --header 'Authorization: Bearer <token>'
[
  {
    "month": "2024-08-01",
    "transactions": {
      "payment": 5000,
      "revenue": 12500.5,
      "expense": 1500.25,
      "net": 6000.25
    }
  },
  {
    "month": "2024-07-01",
    "transactions": {
      "payment": 4500,
      "revenue": 11000,
      "expense": 1200,
      "net": 5300
    }
  }
]
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Get Monthly Transaction Breakdown Retrieve transaction data aggregated by month with breakdown by transaction type (payment, revenue, expense) and net amount calculation. Method: GET Query Parameters:
ParameterTypeDescription
startstringStart date for filtering (ISO format YYYY-MM-DD)
stopstringEnd date for filtering (ISO format YYYY-MM-DD)
Note: Returns data grouped by month with transaction type breakdown.

Code Examples

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

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

Authorizations

Authorization
string
header
required

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

Query Parameters

start
string<date>

Start date for filtering transactions (ISO format YYYY-MM-DD)

stop
string<date>

End date for filtering transactions (ISO format YYYY-MM-DD)

Response

Monthly transaction breakdown retrieved successfully

month
string<date>

Month in YYYY-MM-DD format (first day of month)

Example:

"2024-08-01"

transactions
object