> ## 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.
# Create Revenue
> **Create Revenue**
This endpoint requires authentication. Include your Bearer token in the Authorization header.
## Description
**Create Revenue**
**Description:**\
The `/revenue/` endpoint allows creation of revenue records with detailed information including source, amount, splits, and associated metadata.
**Method:**\
`POST`
**Request Payload:**
| Parameter | Type | Description |
| --------------- | ------ | ---------------------------------------------- |
| title | string | Title/description of the revenue |
| amount | number | Revenue amount |
| currency | string | Currency code (e.g., USD, EUR) |
| source | string | Source of the revenue (e.g., streaming, sales) |
| transactionDate | string | Date of the revenue transaction |
| artist | string | Associated artist ID |
| asset | string | Associated asset ID |
| product | string | Associated product ID |
| splits | array | Revenue split information |
| metadata | object | Additional metadata |
| memo | string | Additional notes |
## Code Examples
```javascript Node.js theme={null}
const response = await fetch('https://api.royalti.io/revenue/', {
method: 'POST',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
"title": "sample-title",
"amount": 1,
"currency": "sample-currency",
"source": "sample-source",
"transactionDate": "2024-01-21T12:00:00Z",
"artist": "sample-artist",
"asset": "sample-asset",
"product": "sample-product",
"splits": [
{
"user": "sample-user",
"percentage": 1,
"amount": 1
}
],
"metadata": {},
"memo": "sample-memo"
})
});
const data = await response.json();
console.log(data);
```
```python Python theme={null}
import requests
response = requests.post(
'https://api.royalti.io/revenue/',
headers={
'Authorization': f'Bearer {token}'
},
json={"title":"sample-title","amount":1,"currency":"sample-currency","source":"sample-source","transactionDate":"2024-01-21T12:00:00Z","artist":"sample-artist","asset":"sample-asset","product":"sample-product","splits":[{"user":"sample-user","percentage":1,"amount":1}],"metadata":{},"memo":"sample-memo"}
)
data = response.json()
print(data)
```
```bash cURL theme={null}
curl -X POST https://api.royalti.io/revenue/ \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"sample-title","amount":1,"currency":"sample-currency","source":"sample-source","transactionDate":"2024-01-21T12:00:00Z","artist":"sample-artist","asset":"sample-asset","product":"sample-product","splits":[{"user":"sample-user","percentage":1,"amount":1}],"metadata":{},"memo":"sample-memo"}'
```
## OpenAPI
````yaml post /revenue/
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:
/revenue/:
post:
tags:
- Revenue
summary: Create Revenue
description: >-
**Create Revenue**
**Description:**
The `/revenue/` endpoint allows creation of revenue records with
detailed information including source, amount, splits, and associated
metadata.
**Method:**
`POST`
**Request Payload:**
| Parameter | Type | Description |
| --- | --- | --- |
| title | string | Title/description of the revenue |
| amount | number | Revenue amount |
| currency | string | Currency code (e.g., USD, EUR) |
| source | string | Source of the revenue (e.g., streaming, sales) |
| transactionDate | string | Date of the revenue transaction |
| artist | string | Associated artist ID |
| asset | string | Associated asset ID |
| product | string | Associated product ID |
| splits | array | Revenue split information |
| metadata | object | Additional metadata |
| memo | string | Additional notes |
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: Title/description of the revenue
amount:
type: number
description: Revenue amount
currency:
type: string
description: Currency code (e.g., USD, EUR)
default: USD
source:
type: string
description: Source of the revenue
enum:
- streaming
- sales
- licensing
- sync
- merchandise
- live_performance
- other
transactionDate:
type: string
format: date-time
description: Date of the revenue transaction
artist:
type: string
description: Associated artist ID
asset:
type: string
description: Associated asset ID
product:
type: string
description: Associated product ID
splits:
type: array
items:
type: object
properties:
user:
type: string
description: User ID for the split
percentage:
type: number
description: Percentage of revenue for this user
amount:
type: number
description: Calculated amount for this user
description: Revenue split information
metadata:
type: object
description: Additional metadata
memo:
type: string
description: Additional notes
required:
- title
- amount
- currency
- source
- transactionDate
example:
title: Streaming Revenue - January 2024
amount: 2500.5
currency: USD
source: streaming
transactionDate: '2024-01-15T10:30:00Z'
artist: artist-uuid-123
asset: asset-uuid-456
splits:
- user: user-uuid-1
percentage: 60
amount: 1500.3
- user: user-uuid-2
percentage: 40
amount: 1000.2
metadata:
platform: Spotify
region: US
period: 2024-01
memo: Monthly streaming revenue distribution
responses:
'201':
description: Success
content:
application/json:
schema:
type: object
properties:
message:
type: string
revenue:
type: object
properties:
id:
type: string
title:
type: string
amount:
type: number
currency:
type: string
source:
type: string
transactionDate:
type: string
format: date-time
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
example:
message: Revenue recorded with splits
revenue:
id: revenue-uuid-123
title: Streaming Revenue - January 2024
amount: 2500.5
currency: USD
source: streaming
transactionDate: '2024-01-15T10:30:00Z'
createdAt: '2024-01-15T10:30:00Z'
updatedAt: '2024-01-15T10:30:00Z'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
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}"
````