> ## 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 Tenant Transactions
> **Get Tenant Transactions**
This endpoint requires authentication. Include your Bearer token in the Authorization header.
## Description
**Get Tenant Transactions**
Retrieve a list of all transactions for the tenant, including payments, revenues,
expenses, and payment requests. Supports pagination and date filtering.
**Method:** GET
**Query Parameters:**
| Parameter | Type | Description |
| --------- | ------- | ----------------------------------------- |
| page | integer | Page number for pagination (default: 1) |
| size | integer | Number of items per page (default: 10) |
| start | string | Start date filter (ISO format YYYY-MM-DD) |
| end | string | End date filter (ISO format YYYY-MM-DD) |
## Code Examples
```javascript Node.js theme={null}
const response = await fetch('https://api.royalti.io/accounting/transactions', {
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',
headers={
'Authorization': f'Bearer {token}'
},
)
data = response.json()
print(data)
```
```bash cURL theme={null}
curl -X GET https://api.royalti.io/accounting/transactions \
-H "Authorization: Bearer YOUR_TOKEN" \
```
## OpenAPI
````yaml get /accounting/transactions
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:
get:
tags:
- Accounting
summary: Get Tenant Transactions
description: >-
**Get Tenant Transactions**
Retrieve a list of all transactions for the tenant, including payments,
revenues,
expenses, and payment requests. Supports pagination and date filtering.
**Method:** GET
**Query Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| page | integer | Page number for pagination (default: 1) |
| size | integer | Number of items per page (default: 10) |
| start | string | Start date filter (ISO format YYYY-MM-DD) |
| end | string | End date filter (ISO format YYYY-MM-DD) |
parameters:
- name: page
in: query
required: false
description: Page number for pagination
schema:
type: integer
default: 1
minimum: 1
example: 1
- name: size
in: query
required: false
description: Number of items per page
schema:
type: integer
default: 10
minimum: 1
maximum: 100
example: 10
- 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: end
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: Transactions retrieved successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: success
transaction:
type: array
description: >-
Array of transaction objects (payments, revenues,
expenses, paymentRequests)
items:
type: object
properties:
type:
type: string
enum:
- payment
- revenue
- expense
- paymentRequest
description: Transaction type
transactionDate:
type: string
format: date-time
description: Date of the transaction
TenantUser:
type: object
description: Associated user information (if applicable)
nullable: true
currentPage:
type: integer
description: Current page number
example: 1
filteredItem:
type: integer
description: Number of items on current page
example: 10
totalItem:
type: integer
description: Total number of transactions matching filters
example: 125
totalPages:
type: integer
description: Total number of pages
example: 13
examples:
success:
value:
message: success
transaction:
- type: payment
transactionDate: '2024-08-11T10:30:00Z'
amount: 1500
status: completed
TenantUser:
id: 123e4567-e89b-12d3-a456-426614174000
fullName: John Doe
- type: revenue
transactionDate: '2024-08-10T15:45:00Z'
amount: 250.5
currentPage: 1
filteredItem: 2
totalItem: 125
totalPages: 63
'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}"
````