> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Monthly Transaction Breakdown
> **Get Monthly Transaction Breakdown**
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:**
| Parameter | Type | Description |
| --------- | ------ | ------------------------------------------------ |
| start | string | Start date for filtering (ISO format YYYY-MM-DD) |
| stop | string | End date for filtering (ISO format YYYY-MM-DD) |
**Note:** Returns data grouped by month with transaction type breakdown.
## Code Examples
```javascript Node.js theme={null}
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);
```
```python Python theme={null}
import requests
response = requests.get(
'https://api.royalti.io/accounting/transactions/monthly',
headers={
'Authorization': f'Bearer {token}'
},
)
data = response.json()
print(data)
```
```bash cURL theme={null}
curl -X GET https://api.royalti.io/accounting/transactions/monthly \
-H "Authorization: Bearer YOUR_TOKEN" \
```
## OpenAPI
````yaml get /accounting/transactions/monthly
openapi: 3.0.0
info:
title: Royalti.io API
description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
version: 2.6.0
contact:
name: Royalti.io Support
email: support@royalti.io
url: https://royalti.io
license:
name: Proprietary
url: https://royalti.io/terms
servers:
- url: https://api.royalti.io
description: Production server
- url: https://api-dev.royalti.io
description: Development server
- url: http://localhost:8084
description: Local development
security:
- bearerAuth: []
tags:
- name: Accounting
description: Accounting and financial transaction operations
- name: DDEX
description: DDEX operations (ERN/MEAD, messages, delivery, providers)
- name: Label
description: Label management operations
- name: Internal Webhooks
description: Internal system webhooks for royalty processing and downloads
- name: Payment Webhooks
description: Payment processor webhook endpoints
- name: Billing Webhooks
description: Stripe billing and subscription webhooks
- name: Infrastructure Webhooks
description: Cloudflare domain and SSL webhooks
- name: Distribution Webhooks
description: Digital distribution platform webhooks (FUGA)
paths:
/accounting/transactions/monthly:
get:
tags:
- Accounting
summary: Get Monthly Transaction Breakdown
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:**
| Parameter | Type | Description |
| --- | --- | --- |
| start | string | Start date for filtering (ISO format YYYY-MM-DD) |
| stop | string | End date for filtering (ISO format YYYY-MM-DD) |
**Note:** Returns data grouped by month with transaction type breakdown.
parameters:
- name: start
in: query
required: false
description: Start date for filtering transactions (ISO format YYYY-MM-DD)
schema:
type: string
format: date
example: '2024-01-01'
- name: stop
in: query
required: false
description: End date for filtering transactions (ISO format YYYY-MM-DD)
schema:
type: string
format: date
example: '2024-12-31'
responses:
'200':
description: Monthly transaction breakdown retrieved successfully
content:
application/json:
schema:
type: array
description: Array of monthly transaction summaries
items:
type: object
properties:
month:
type: string
format: date
description: Month in YYYY-MM-DD format (first day of month)
example: '2024-08-01'
transactions:
type: object
properties:
payment:
type: number
format: float
description: Total payments made this month
example: 5000
revenue:
type: number
format: float
description: Total revenue received this month
example: 12500.5
expense:
type: number
format: float
description: Total expenses this month
example: 1500.25
net:
type: number
format: float
description: Net amount (revenue - payment - expense)
example: 6000.25
examples:
success:
value:
- 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
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/ServerError'
security:
- bearerAuth: []
components:
responses:
BadRequest:
description: Bad request
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: Invalid request parameters
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: Unauthorized
ServerError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
properties:
success:
type: boolean
example: false
error:
type: object
properties:
code:
type: string
message:
type: string
details:
type: array
items:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
JWT Authorization header using the Bearer scheme. Format: "Bearer
{token}"
````