Create Revenue

curl --request POST \
  --url https://api.royalti.io/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"
}
'

import requests

url = "https://api.royalti.io/revenue/"

payload = {
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.royalti.io/revenue/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/revenue/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/revenue/"

	payload := strings.NewReader("{\n  \"title\": \"Streaming Revenue - January 2024\",\n  \"amount\": 2500.5,\n  \"currency\": \"USD\",\n  \"source\": \"streaming\",\n  \"transactionDate\": \"2024-01-15T10:30:00Z\",\n  \"artist\": \"artist-uuid-123\",\n  \"asset\": \"asset-uuid-456\",\n  \"splits\": [\n    {\n      \"user\": \"user-uuid-1\",\n      \"percentage\": 60,\n      \"amount\": 1500.3\n    },\n    {\n      \"user\": \"user-uuid-2\",\n      \"percentage\": 40,\n      \"amount\": 1000.2\n    }\n  ],\n  \"metadata\": {\n    \"platform\": \"Spotify\",\n    \"region\": \"US\",\n    \"period\": \"2024-01\"\n  },\n  \"memo\": \"Monthly streaming revenue distribution\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.royalti.io/revenue/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Streaming Revenue - January 2024\",\n  \"amount\": 2500.5,\n  \"currency\": \"USD\",\n  \"source\": \"streaming\",\n  \"transactionDate\": \"2024-01-15T10:30:00Z\",\n  \"artist\": \"artist-uuid-123\",\n  \"asset\": \"asset-uuid-456\",\n  \"splits\": [\n    {\n      \"user\": \"user-uuid-1\",\n      \"percentage\": 60,\n      \"amount\": 1500.3\n    },\n    {\n      \"user\": \"user-uuid-2\",\n      \"percentage\": 40,\n      \"amount\": 1000.2\n    }\n  ],\n  \"metadata\": {\n    \"platform\": \"Spotify\",\n    \"region\": \"US\",\n    \"period\": \"2024-01\"\n  },\n  \"memo\": \"Monthly streaming revenue distribution\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/revenue/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"Streaming Revenue - January 2024\",\n  \"amount\": 2500.5,\n  \"currency\": \"USD\",\n  \"source\": \"streaming\",\n  \"transactionDate\": \"2024-01-15T10:30:00Z\",\n  \"artist\": \"artist-uuid-123\",\n  \"asset\": \"asset-uuid-456\",\n  \"splits\": [\n    {\n      \"user\": \"user-uuid-1\",\n      \"percentage\": 60,\n      \"amount\": 1500.3\n    },\n    {\n      \"user\": \"user-uuid-2\",\n      \"percentage\": 40,\n      \"amount\": 1000.2\n    }\n  ],\n  \"metadata\": {\n    \"platform\": \"Spotify\",\n    \"region\": \"US\",\n    \"period\": \"2024-01\"\n  },\n  \"memo\": \"Monthly streaming revenue distribution\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

{
  "status": "error",
  "message": "Unauthorized"
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

POST

revenue

Create Revenue

curl --request POST \
  --url https://api.royalti.io/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"
}
'

import requests

url = "https://api.royalti.io/revenue/"

payload = {
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.royalti.io/revenue/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/revenue/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/revenue/"

	payload := strings.NewReader("{\n  \"title\": \"Streaming Revenue - January 2024\",\n  \"amount\": 2500.5,\n  \"currency\": \"USD\",\n  \"source\": \"streaming\",\n  \"transactionDate\": \"2024-01-15T10:30:00Z\",\n  \"artist\": \"artist-uuid-123\",\n  \"asset\": \"asset-uuid-456\",\n  \"splits\": [\n    {\n      \"user\": \"user-uuid-1\",\n      \"percentage\": 60,\n      \"amount\": 1500.3\n    },\n    {\n      \"user\": \"user-uuid-2\",\n      \"percentage\": 40,\n      \"amount\": 1000.2\n    }\n  ],\n  \"metadata\": {\n    \"platform\": \"Spotify\",\n    \"region\": \"US\",\n    \"period\": \"2024-01\"\n  },\n  \"memo\": \"Monthly streaming revenue distribution\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.royalti.io/revenue/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Streaming Revenue - January 2024\",\n  \"amount\": 2500.5,\n  \"currency\": \"USD\",\n  \"source\": \"streaming\",\n  \"transactionDate\": \"2024-01-15T10:30:00Z\",\n  \"artist\": \"artist-uuid-123\",\n  \"asset\": \"asset-uuid-456\",\n  \"splits\": [\n    {\n      \"user\": \"user-uuid-1\",\n      \"percentage\": 60,\n      \"amount\": 1500.3\n    },\n    {\n      \"user\": \"user-uuid-2\",\n      \"percentage\": 40,\n      \"amount\": 1000.2\n    }\n  ],\n  \"metadata\": {\n    \"platform\": \"Spotify\",\n    \"region\": \"US\",\n    \"period\": \"2024-01\"\n  },\n  \"memo\": \"Monthly streaming revenue distribution\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/revenue/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"Streaming Revenue - January 2024\",\n  \"amount\": 2500.5,\n  \"currency\": \"USD\",\n  \"source\": \"streaming\",\n  \"transactionDate\": \"2024-01-15T10:30:00Z\",\n  \"artist\": \"artist-uuid-123\",\n  \"asset\": \"asset-uuid-456\",\n  \"splits\": [\n    {\n      \"user\": \"user-uuid-1\",\n      \"percentage\": 60,\n      \"amount\": 1500.3\n    },\n    {\n      \"user\": \"user-uuid-2\",\n      \"percentage\": 40,\n      \"amount\": 1000.2\n    }\n  ],\n  \"metadata\": {\n    \"platform\": \"Spotify\",\n    \"region\": \"US\",\n    \"period\": \"2024-01\"\n  },\n  \"memo\": \"Monthly streaming revenue distribution\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

{
  "status": "error",
  "message": "Unauthorized"
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

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. Authorization:

Required role: admin or higher

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

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);

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)

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"}'

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json

title

string

required

Title/description of the revenue

amount

number

required

Revenue amount

currency

string

default:USD

required

Currency code (e.g., USD, EUR)

source

enum<string>

required

Source of the revenue

Available options:

streaming,

sales,

licensing,

sync,

merchandise,

live_performance,

other

transactionDate

string<date-time>

required

Date of the revenue transaction

artist

string

Associated artist ID

asset

string

Associated asset ID

product

string

Associated product ID

splits

object[]

Revenue split information

Show child attributes

metadata

object

Additional metadata

memo

string

Additional notes

Response

Success

message

string

revenue

object

Show child attributes

​Description

​Code Examples

Authorizations

Body

Response

Description

Code Examples