> ## 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 Expenses
> **Get Expenses**
This endpoint requires authentication. Include your Bearer token in the Authorization header.
## Description
**Get Expenses**
**Description:**\
The `/expense/` endpoint retrieves a list of expense records with filtering, pagination, and inclusion options.
**Method:**\
`GET`
**Query Parameters:**
| Parameter | Type | Description |
| -------------------- | ------- | -------------------------------------------------------------------- |
| q *(Optional)* | string | Search query to filter expenses |
| include *(Optional)* | string | Comma-separated related entities to include (Artist, Product, Asset) |
| page *(Optional)* | integer | Page number for pagination. Default: 1 |
| size *(Optional)* | integer | Number of expenses per page. Default: 10 |
## Code Examples
```javascript Node.js theme={null}
const response = await fetch('https://api.royalti.io/expense/', {
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/expense/',
headers={
'Authorization': f'Bearer {token}'
},
)
data = response.json()
print(data)
```
```bash cURL theme={null}
curl -X GET https://api.royalti.io/expense/ \
-H "Authorization: Bearer YOUR_TOKEN" \
```
## OpenAPI
````yaml get /expense/
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:
/expense/:
get:
tags:
- Expense
summary: Get Expenses
description: >-
**Get Expenses**
**Description:**
The `/expense/` endpoint retrieves a list of expense records with
filtering, pagination, and inclusion options.
**Method:**
`GET`
**Query Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| q _(Optional)_ | string | Search query to filter expenses |
| include _(Optional)_ | string | Comma-separated related entities to
include (Artist, Product, Asset) |
| page _(Optional)_ | integer | Page number for pagination. Default: 1 |
| size _(Optional)_ | integer | Number of expenses per page. Default: 10
|
parameters:
- name: include
in: query
required: false
description: Comma-separated related entities to include (Artist, Product, Asset)
schema:
type: string
- name: q
in: query
required: false
description: Search term to filter expenses by title or type
schema:
type: string
- name: page
in: query
required: false
description: Page number for pagination (1-based)
schema:
type: integer
default: 1
- name: size
in: query
required: false
description: Number of items per page
schema:
type: integer
default: 10
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
message:
type: string
expenses:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
type:
type: string
amount:
type: number
amountUSD:
type: number
currency:
type: string
transactionDate:
type: string
format: date
artist:
type: object
asset:
type: object
product:
type: object
split:
type: array
items:
type: object
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
total:
type: integer
page:
type: integer
size:
type: integer
totalPages:
type: integer
summary:
type: object
properties:
totalAmount:
type: number
totalAmountUSD:
type: number
totalCount:
type: integer
byCurrency:
type: object
byType:
type: object
example:
totalItems: 3,
Expenses:
- id: e980dd73-e902-4eda-9754-f8add109f712
expenseableId: 499d9b7d-1a37-4cf5-ba1f-0301b492d521
expenseableType: asset
title: Expense Oct
type: null
transactionDate: '2024-10-17'
currency: USD
amount: 10
amountUSD: 10
conversionRate: 1
memo: Memo
files:
- >-
https://storage.googleapis.com/royalti-uploads/Royalti
Demo/202410/Expense/undefined/Leonardo_Phoenix_Create_a_serene_and_organized_workspace_with_0
(1).jpg
createdAt: '2024-10-17T11:00:40.130Z'
updatedAt: '2024-10-17T11:00:40.130Z'
Artist: null
totalPages: 1
currentPage: 1
filteredItems: 3
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
components:
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}"
````