Get Current Due Amount

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

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

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

	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/getcurrentdue")

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",
  "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
}

GET

accounting

getcurrentdue

Get Current Due Amount

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

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

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

	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/getcurrentdue")

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",
  "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 Authorization:

Required role: admin or higher

Query Parameters:

Parameter	Type	Description
q	string	Search query to filter users by name
page	integer	Page number for pagination (default: 1)
size	integer	Number of items per page (default: 10)
sort	string	Field to sort by (default: due)
order	string	Sort 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);

import requests

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

data = response.json()
print(data)

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

Authorizations

Authorization

string

header

required

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

Query Parameters

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

Show child attributes

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

​Description

​Code Examples

Authorizations

Query Parameters

Response

Description

Code Examples