Skip to main content
GET
Get User Accounting Statistics
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Get User Accounting Statistics Retrieve detailed accounting statistics for a specific user, including royalty shares, amounts paid and due. Optionally includes detailed royalty summary data. Method: GET Authorization:
  • Required role: user or higher
Path Parameters: Query Parameters:

Code Examples

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

TenantUser ID

Query Parameters

include
enum<string>

Include additional data (use 'royalty' for detailed royalty breakdown)

Available options:
royalty
forceRefresh
boolean
default:false

Force recalculation even if cached data exists

Response

User accounting statistics retrieved successfully

Royalty_Share
number<float>

Total royalty share amount for this user

Example:

1135.28

paid
number<float>

Amount already paid to the user

Example:

100

due
number<float>

Amount currently due to the user

Example:

1035.28

royaltySummary
object | null

Detailed royalty breakdown (included when include=royalty)

metadata
object | null

Calculation metadata from enhanced accounting calculator