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 |
Authentication
This endpoint requires authentication. Include your bearer token in the Authorization header.Request Body
Example Request
Request Schema
Field | Type | Required | 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 |
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 |
Responses
✅ 201 - Success
⚠️ 400 - Bad Request
⚠️ 401 - Unauthorized
⚠️ 404 - Not Found
❌ 500 - Internal Server Error
Tags
Revenue
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Body
application/json
Title/description of the revenue
Revenue amount
Currency code (e.g., USD, EUR)
Source of the revenue
Available options:
streaming
, sales
, licensing
, sync
, merchandise
, live_performance
, other
Date of the revenue transaction
Associated artist ID
Associated asset ID
Associated product ID
Revenue split information
Additional metadata
Additional notes