Skip to main content
GET
/
accounting
/
getcurrentdue
Get Current Due Amount
curl --request GET \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/accounting/getcurrentdue \
  --header 'Authorization: Bearer <token>'
{
  "message": "success",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantUserId": "456e7890-e89b-12d3-a456-426614174001",
      "userId": "789e0123-e89b-12d3-a456-426614174002",
      "fullName": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "country": "US",
      "gross": 2500.75,
      "net": 2250.68,
      "paid": 1500,
      "due": 750.68,
      "lastCalculatedAt": "2024-08-11T10:30:00Z",
      "calculationMethod": "cached",
      "hasPendingPaymentRequest": false,
      "hasPaymentSettings": true
    }
  ],
  "totalCount": 125,
  "page": 1,
  "totalPages": 13
}
Get Current Due Amount Retrieve a list of users with their current due amounts (excluding the tenant owner). Supports pagination and sorting by various accounting fields. Method: GET Query Parameters:
ParameterTypeDescription
qstringSearch query to filter users by name
pageintegerPage number for pagination (default: 1)
sizeintegerNumber of items per page (default: 10)
sortstringField to sort by (default: due)
orderstringSort order: ASC or DESC (default: DESC)
Sortable Fields:
  • gross - Total gross earnings
  • net - Net earnings after deductions
  • paid - Amount already paid
  • due - Amount currently due (default)
  • lastCalculatedAt - When accounting was last calculated

​
Authentication

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

​
Query Parameters

ParameterTypeInRequiredDescription
qstringquery❌Search query to filter users by name or nickname
pageintegerquery❌Page number for pagination
sizeintegerquery❌Number of items per page
sortstringquery❌Field to sort by
orderstringquery❌Sort order

​
Responses

​
✅ 200 - Current due amounts list retrieved successfully

​
defaultSort

{
  "message": "success",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantUserId": "456e7890-e89b-12d3-a456-426614174001",
      "userId": "789e0123-e89b-12d3-a456-426614174002",
      "fullName": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "country": "US",
      "gross": 2500.75,
      "net": 2250.68,
      "paid": 1500,
      "due": 750.68,
      "lastCalculatedAt": "2024-08-11T10:30:00Z",
      "calculationMethod": "cached",
      "hasPendingPaymentRequest": false,
      "hasPaymentSettings": true
    }
  ],
  "totalCount": 125,
  "page": 1,
  "totalPages": 13
}

​
grossSort

{
  "message": "success",
  "data": [
    {
      "id": "987e6543-e89b-12d3-a456-426614174003",
      "tenantUserId": "654e3210-e89b-12d3-a456-426614174004",
      "userId": "321e0987-e89b-12d3-a456-426614174005",
      "fullName": "Jane Smith",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com",
      "country": "CA",
      "gross": 125.5,
      "net": 112.95,
      "paid": 0,
      "due": 112.95,
      "lastCalculatedAt": "2024-08-10T15:45:00Z",
      "calculationMethod": "bigquery",
      "hasPendingPaymentRequest": true,
      "hasPaymentSettings": false
    }
  ],
  "totalCount": 125,
  "page": 1,
  "totalPages": 13
}

​
⚠️ 401 - Unauthorized

​
❌ 500 - Internal Server Error

​
Tags

Accounting

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
q
string

Search query to filter users by name or nickname

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
size
integer
default:10

Number of items per page

Required range: 1 <= x <= 100
​
sort
enum<string>
default:due

Field to sort by

Available options:
gross,
net,
paid,
due,
lastCalculatedAt
​
order
enum<string>
default:DESC

Sort order

Available options:
ASC,
DESC

Response

Current due amounts list retrieved successfully

​
message
string
Example:

"success"

​
data
object[]
​
totalCount
integer

Total number of records available

Example:

125

​
page
integer

Current page number

Example:

1

​
totalPages
integer

Total number of pages

Example:

13

⌘I