Get Total Due Amount

curl --request GET \
  --url https://api.royalti.io/accounting/gettotaldue \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/accounting/gettotaldue', 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/accounting/gettotaldue",
  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/accounting/gettotaldue"

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

}

require 'uri'
require 'net/http'

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

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

{
  "message": "success",
  "totalGross": 150000.5,
  "totalPaid": 100000,
  "totalDue": 50000.5,
  "userCount": 125,
  "metadata": {
    "calculationMethod": "cached",
    "calculationTime": 45,
    "dataAvailability": "complete",
    "fallbackReason": null
  }
}

GET

accounting

gettotaldue

Get Total Due Amount

curl --request GET \
  --url https://api.royalti.io/accounting/gettotaldue \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/accounting/gettotaldue', 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/accounting/gettotaldue",
  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/accounting/gettotaldue"

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

}

require 'uri'
require 'net/http'

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

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

{
  "message": "success",
  "totalGross": 150000.5,
  "totalPaid": 100000,
  "totalDue": 50000.5,
  "userCount": 125,
  "metadata": {
    "calculationMethod": "cached",
    "calculationTime": 45,
    "dataAvailability": "complete",
    "fallbackReason": null
  }
}

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

Description

Get Total Due Amount Retrieve the total amount due across all tenant users (excluding the tenant owner). This endpoint now supports multiple calculation methods for optimal performance:

cache: Uses the UserAccounting table cache for fast retrieval (10-50ms)
bigquery: Uses BigQuery for comprehensive calculation (500-2000ms)
auto: Automatically tries cache first, falls back to BigQuery if needed (default)

Performance Note: The cache method provides 95% faster response times compared to BigQuery, making it ideal for real-time dashboards and frequent queries. Method: GET Authorization:

Required role: admin or higher

Query Parameters:

Parameter	Type	Description
method	string	Calculation method to use (cache, bigquery, auto)

Code Examples

const response = await fetch('https://api.royalti.io/accounting/gettotaldue', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
  'https://api.royalti.io/accounting/gettotaldue',
  headers={
    'Authorization': f'Bearer {token}'
  },
)

data = response.json()
print(data)

curl -X GET https://api.royalti.io/accounting/gettotaldue \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

Authorization

string

header

required

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

Query Parameters

method

enum<string>

default:auto

Calculation method to use for retrieving totals

Available options:

cache,

bigquery,

auto

Response

Total due amount retrieved successfully

message

string

Example:

"success"

totalGross

number<float>

Total gross earnings across all users

Example:

150000.5

totalPaid

number<float>

Total amount already paid to users

Example:

100000

totalDue

number<float>

Total amount currently due to users

Example:

50000.5

userCount

integer

Number of users included in the calculation

Example:

125

metadata

object

Additional information about the calculation

Show child attributes

unallocated

object | null

Stage-2 addition (attribution unallocated-revenue spec). Gross vs allocated (payable) vs unallocated (gap + unresolved) revenue from the tenant's latest committed attribution run. Absent/null when the tenant has never committed a run, or when the read failed (see unallocatedError) — the rest of the total-due figures are still returned in either case.

Show child attributes

unallocatedError

string | null

Set instead of unallocated when the Stage-2 read itself failed. Distinguishes "engine never ran for this tenant" (both fields absent) from "the read broke" (this field carries the error message).

​Description

​Code Examples

Authorizations

Query Parameters

Response

Description

Code Examples