Get a user's advance standing
curl --request GET \
--url https://api.royalti.io/advance/user/{tenantUserId}/balance \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.royalti.io/advance/user/{tenantUserId}/balance"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.royalti.io/advance/user/{tenantUserId}/balance', 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/advance/user/{tenantUserId}/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.royalti.io/advance/user/{tenantUserId}/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.royalti.io/advance/user/{tenantUserId}/balance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/advance/user/{tenantUserId}/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {
"encumbrance": {
"outstandingTotalUsd": 123,
"unsweptBaseUsd": 123,
"holdbackUsd": 123,
"payableUsd": 123,
"maxWithdrawableUsd": 123,
"engineTenant": true,
"advances": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"captureRate": 123,
"outstandingUsd": 123
}
]
},
"advances": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"TenantId": 123,
"TenantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "draft",
"principalDisbursedUsd": "<string>",
"multiple": "<string>",
"totalRepayableUsd": "<string>",
"outstandingUsd": "<string>",
"captureRate": "<string>",
"disbursementCurrency": "NGN",
"disbursedAmount": "<string>",
"fxRate": "<string>",
"fxDate": "2023-12-25",
"termMonths": 24,
"firstSweptAt": "2023-11-07T05:31:56Z",
"activatedAt": "2023-11-07T05:31:56Z",
"recoupedAt": "2023-11-07T05:31:56Z",
"writtenOffAt": "2023-11-07T05:31:56Z",
"writtenOffUsd": "<string>",
"cancelledAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"approvedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"memo": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"sweeps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"TenantId": 123,
"AdvanceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"TenantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"periodRef": "2023-12-25",
"periodStart": "2023-11-07T05:31:56Z",
"periodEnd": "2023-11-07T05:31:56Z",
"earningsBaseUsd": "<string>",
"captureRateSnapshot": "<string>",
"capturedUsd": "<string>",
"outstandingAfterUsd": "<string>",
"reportedIncomeUsd": "<string>",
"coverage": "<string>",
"ledgerTransactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"StatementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
}{
"status": "error",
"message": "Unauthorized"
}Advance
Get a user's advance standing
Get user advance balance
GET
/
advance
/
user
/
{tenantUserId}
/
balance
Get a user's advance standing
curl --request GET \
--url https://api.royalti.io/advance/user/{tenantUserId}/balance \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.royalti.io/advance/user/{tenantUserId}/balance"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.royalti.io/advance/user/{tenantUserId}/balance', 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/advance/user/{tenantUserId}/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.royalti.io/advance/user/{tenantUserId}/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.royalti.io/advance/user/{tenantUserId}/balance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/advance/user/{tenantUserId}/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {
"encumbrance": {
"outstandingTotalUsd": 123,
"unsweptBaseUsd": 123,
"holdbackUsd": 123,
"payableUsd": 123,
"maxWithdrawableUsd": 123,
"engineTenant": true,
"advances": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"captureRate": 123,
"outstandingUsd": 123
}
]
},
"advances": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"TenantId": 123,
"TenantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "draft",
"principalDisbursedUsd": "<string>",
"multiple": "<string>",
"totalRepayableUsd": "<string>",
"outstandingUsd": "<string>",
"captureRate": "<string>",
"disbursementCurrency": "NGN",
"disbursedAmount": "<string>",
"fxRate": "<string>",
"fxDate": "2023-12-25",
"termMonths": 24,
"firstSweptAt": "2023-11-07T05:31:56Z",
"activatedAt": "2023-11-07T05:31:56Z",
"recoupedAt": "2023-11-07T05:31:56Z",
"writtenOffAt": "2023-11-07T05:31:56Z",
"writtenOffUsd": "<string>",
"cancelledAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"approvedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"memo": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"sweeps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"TenantId": 123,
"AdvanceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"TenantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"periodRef": "2023-12-25",
"periodStart": "2023-11-07T05:31:56Z",
"periodEnd": "2023-11-07T05:31:56Z",
"earningsBaseUsd": "<string>",
"captureRateSnapshot": "<string>",
"capturedUsd": "<string>",
"outstandingAfterUsd": "<string>",
"reportedIncomeUsd": "<string>",
"coverage": "<string>",
"ledgerTransactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"StatementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
}{
"status": "error",
"message": "Unauthorized"
}Description
Get user advance balance Every advance (any status) for the user, the sweep journal (coverage history), and the current netting encumbrance. Backs the artist dashboard’s advance card. Self-or-admin: callers may request their own balance (tenantUserId === req.user.id); admins/owners may request any
user’s balance in the tenant. This route is deliberately NOT
requireAdmin at the route layer — the self-access check is enforced
in the controller.
Authorization:
- Own resource: any authenticated user (self-access)
- Other resources:
adminor higher
Code Examples
const response = await fetch('https://api.royalti.io/advance/user/example-id/balance', {
method: 'GET',
});
const data = await response.json();
console.log(data);
import requests
response = requests.get(
'https://api.royalti.io/advance/user/example-id/balance',
)
data = response.json()
print(data)
curl -X GET https://api.royalti.io/advance/user/example-id/balance \
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Path Parameters
⌘I