Skip to main content
GET
/
accounting
/
transactions
Get Tenant Transactions
curl --request GET \
  --url https://api.royalti.io/accounting/transactions \
  --header 'Authorization: Bearer <token>'
{
  "message": "success",
  "transaction": [
    {
      "type": "payment",
      "transactionDate": "2024-08-11T10:30:00Z",
      "amount": 1500,
      "status": "completed",
      "TenantUser": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "fullName": "John Doe"
      }
    },
    {
      "type": "revenue",
      "transactionDate": "2024-08-10T15:45:00Z",
      "amount": 250.5
    }
  ],
  "currentPage": 1,
  "filteredItem": 2,
  "totalItem": 125,
  "totalPages": 63
}

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 Tenant Transactions Retrieve a list of all transactions for the tenant, including payments, revenues, expenses, and payment requests. Supports pagination and date filtering. Method: GET Query Parameters:
ParameterTypeDescription
pageintegerPage number for pagination (default: 1)
sizeintegerNumber of items per page (default: 10)
startstringStart date filter (ISO format YYYY-MM-DD)
endstringEnd date filter (ISO format YYYY-MM-DD)

​
Code Examples

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

​
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
​
start
string<date>

Start date for filtering transactions (ISO format YYYY-MM-DD)

​
end
string<date>

End date for filtering transactions (ISO format YYYY-MM-DD)

Response

Transactions retrieved successfully

​
message
string
Example:

"success"

​
transaction
object[]

Array of transaction objects (payments, revenues, expenses, paymentRequests)

​
currentPage
integer

Current page number

Example:

1

​
filteredItem
integer

Number of items on current page

Example:

10

​
totalItem
integer

Total number of transactions matching filters

Example:

125

​
totalPages
integer

Total number of pages

Example:

13