Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rillet Reports API

The Reports API from Rillet — 7 operation(s) for reports.

Rillet Reports API is one of 28 APIs that Rillet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 7 paths, and defines 38 schemas. It is described by OpenAPI 3.1.0, at version v4.0.

Requests are made against 2 base URLs: https://api.rillet.com, https://sandbox.api.rillet.com.

7 operations 7 paths 38 schemas 7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v4.0
Base URL
https://api.rillet.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Rillet Reports API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

Reports 7
GET
/reports/arr-waterfall
Retrieves ARR waterfall report
retrieve-waterfall-report 6 params → 200default
GET
/reports/trial-balance
Retrieves trial balance report
retrieve-trial-balance-report 3 params → 200default
GET
/reports/balance-sheet
Retrieves balance sheet report
retrieve-balance-sheet-report 3 params → 200default
GET
/reports/income-statement
Retrieves income statement report
retrieve-income-statement-report 5 params → 200default
GET
/reports/cash-flow-statement
Retrieves cash flow statement report
retrieve-cash-flow-statement-report 5 params → 200default
GET
/reports/executive-pl
Retrieves executive P&L report
retrieve-executive-pl-report 5 params → 200default
GET
/reports/journal-entries
Lists journal entries with reporting currency amounts
list-reports-journal-entries 8 params → 200default

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are ReportingJournalEntryItem (10 properties), ReportAccountBalance (9 properties), ReportingJournalEntry (8 properties), ReportTotals (6 properties). Each schema is shown below with its type and property counts.

Revenue
object
2 properties 2 required
Breakdown
string
FieldAssignments
array
CashFlowItem
object
2 properties 2 required
ExecutivePLItem
object
3 properties 3 required
AccountCode
string
The account code found in the Chart of Accounts
ReportBreakdown
object
Describes a breakdown column in the report (subsidiary or custom field)
3 properties 2 required
RevenueWaterfall
object
2 properties 1 required
NamedCashFlowSection
object
A named cash flow section containing line items with totals per breakdown
3 properties 3 required
ReportingJournalEntryItem
object
10 properties 6 required
ExecutivePLReport
object
5 properties 5 required
NamedReportSection
object
A named section containing account groups with a total
4 properties 3 required
ReportBreakdownBy
string
How to break down the report columns. If not specified, returns a single total column.
ReportPeriod
object
2 properties 2 required
ReportSummaryLine
object
A named summary line item (e.g., gross profit, net income)
3 properties 2 required
CustomerRevenue
object
3 properties 3 required
ReportAccountGroupNested
object
3 properties 3 required
ReportingJournalEntry
object
8 properties 5 required
Error
object
4 properties 2 required
MonetaryAmount
object
2 properties 2 required
ReportAccountBalance
object
9 properties 7 required
BalanceSheetReport
object
4 properties 3 required
PageCursor
string
If defined, a cursor to retrieve the next page.
PageLimit
integer
ReportTotals
object
6 properties 4 required
IncomeStatementReport
object
5 properties 5 required
Status
string
RoundedMonetaryAmount
object
A monetary amount that must be rounded to the currency's default decimal places (e.g., 2 decimal places for USD).
2 properties 2 required
BreakdownBalance
object
2 properties 2 required
CurrencyCode
string
Currency code following ISO-4217
CashFlowStatementReport
object
5 properties 5 required
ReportAccountGroup
object
4 properties 3 required
JournalEntryRelatedEntity
object
2 properties 2 required
TrialBalanceReport
object
4 properties 4 required
NamedExecutivePLSection
object
A named executive P&L section containing line items with totals per breakdown
3 properties 3 required
ReportAccountEntry
object
4 properties 4 required
Pagination
object
1 property
BreakdownMargin
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rillet-reports-api-openapi.yml Raw ↑

Other APIs Rillet publishes across the network.

Rillet API Key API
Rillet Bank accounts API
Rillet Bank Transactions API
Rillet Bill Payments API
Rillet Bills API
Rillet Books periods API
Rillet Charges API
Rillet Chart of Accounts API
Rillet Contract Items API
Rillet Contracts API
Rillet Credit Memos API
Rillet Customer Payments API