Skip to main content
GET
/
accounting
/
getcurrentdue
Get Current Due Amount
curl --request GET \
  --url https://api.royalti.io/accounting/getcurrentdue \
  --header 'Authorization: Bearer <token>'
{
  "message": "success",
  "Users": [
    {
      "id": "789e0123-e89b-12d3-a456-426614174002",
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "John Doe",
      "email": "john.doe@example.com",
      "country": "US",
      "TenantUserId": "456e7890-e89b-12d3-a456-426614174001",
      "Gross": 2500.75,
      "Net": 2250.68,
      "Paid": 1500,
      "Due": 750.68,
      "paymentRequested": false,
      "paymentRequestId": null,
      "metadata": {
        "lastCalculatedAt": "2024-08-11T10:30:00Z",
        "calculationMethod": "cached"
      }
    }
  ],
  "totalUsers": 125,
  "count": 1,
  "page": 1,
  "totalPages": 13
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

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

​
Code Examples

const response = await fetch('https://api.royalti.io/accounting/getcurrentdue', {
  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

​
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"

​
Users
object[]

Array of users with accounting data

​
totalUsers
integer

Total number of users available

Example:

125

​
count
integer

Number of users returned in this page

Example:

10

​
page
integer

Current page number

Example:

1

​
totalPages
integer

Total number of pages

Example:

13