Skip to main content
POST
/
split
/
Create split
curl --request POST \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/split/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "asset": "d1c5b49e-95fa-4aed-930e-cf314c16a53d",
  "product": "b53230c5-2110-40ce-abe5-2112724ffb53",
  "type": "Publishing",
  "startDate": "2022-01-01",
  "endDate": "2022-01-31",
  "name": "Nigerian split train",
  "split": [
    {
      "user": "cf960b5a-37cd-484a-b461-0b191b09bed1",
      "share": 60
    },
    {
      "user": "4e39b347-7db0-417d-a5bc-3d8493c9ce19",
      "share": 40
    }
  ]
}'
{
  "id": "8a8f3ee8-8855-4749-9649-897f9e0e6c6b",
  "AssetId": "2e0d9f94-59eb-4ef8-adc6-9f3ddebf49fc",
  "ProductId": "76293a6e-6c0a-4842-84b5-6bffbe1ea538",
  "type": "Publishing",
  "startDate": "2022-01-01T00:00:00.000Z",
  "endDate": "2022-01-31T00:00:00.000Z",
  "name": "Nigerian split train",
  "contract": null,
  "ContractId": null,
  "conditions": null,
  "TenantId": 2
}
Create Revenue Split The Split Revenue endpoint allows you to split revenue generated from a specific asset and product among multiple users. This endpoint calculates the revenue shares based on the provided split percentages for each user. Method:
POST
Parameters:
ParameterTypeRequiredDescription
assetstringYesThe UUID of the asset related to the revenue
productstringYesThe UUID of the product related to the revenue
typestringNoThe type of revenue (e.g., Publishing, YouTube, Live)
startDatestringNoThe start date of the split period (inclusive)
endDatestringNoThe end date of the split period (exclusive)
namestringNoThe name or description of the revenue split
conditionsarrayNoArray of condition objects for split matching
contractstringNoContract details
ContractIdstringNoContract ID
memostringNoAdditional notes
splitarrayYesAn array of objects containing user shares

Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

Request Body

Request Schema

FieldTypeRequiredDescription
assetstringThe UUID of the asset related to the revenue
productstringThe UUID of the product related to the revenue
typestringThe type of revenue (e.g., Publishing, YouTube, Live)
startDatestringThe start date of the split period (inclusive)
endDatestringThe end date of the split period (exclusive)
namestringThe name or description of the revenue split
splitarrayAn array of objects containing user shares
conditionsarrayConditions for split matching
contractstring
ContractIdstring
memostring

Responses

✅ 201 - Split created successfully

⚠️ 400 - Split condition error

⚠️ 401 - Unauthorized

⚠️ 404 - Not Found

❌ 500 - Internal Server Error

Tags

Splits

Authorizations

Authorization
string
header
required

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

Body

application/json
split
object[]
required

An array of objects containing user shares

asset
string<uuid>

The UUID of the asset related to the revenue

product
string<uuid>

The UUID of the product related to the revenue

type
string | null

The type of revenue (e.g., Publishing, YouTube, Live)

startDate
string<date> | null

The start date of the split period (inclusive)

endDate
string<date> | null

The end date of the split period (exclusive)

name
string | null

The name or description of the revenue split

conditions
object[] | null

Conditions for split matching

contract
string | null
ContractId
string<uuid> | null
memo
string | null

Response

Split created successfully

id
string<uuid>
AssetId
string<uuid>
ProductId
string<uuid>
type
string
startDate
string<date-time> | null
endDate
string<date-time> | null
name
string
contract
string | null
ContractId
string | null
conditions
string | null
TenantId
integer
I