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 |
curl --request POST \
--url https://server26-dot-royalti-project.uc.r.appspot.com/revenue/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"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"
}'
{
"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"
}
}
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Success
The response is of type object
.
curl --request POST \
--url https://server26-dot-royalti-project.uc.r.appspot.com/revenue/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"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"
}'
{
"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"
}
}