Skip to main content
GET
/
accounting
/
gettotaldue
Get Total Due Amount
curl --request GET \
  --url https://api.royalti.io/accounting/gettotaldue \
  --header 'Authorization: Bearer <token>'
{
  "message": "success",
  "totalGross": 150000.5,
  "totalPaid": 100000,
  "totalDue": 50000.5,
  "userCount": 125,
  "metadata": {
    "calculationMethod": "cached",
    "calculationTime": 45,
    "dataAvailability": "complete",
    "fallbackReason": null
  }
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt

Use this file to discover all available pages before exploring further.

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 Query Parameters:
ParameterTypeDescription
methodstringCalculation 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);

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