How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Orum Reports API

The Reports API from Orum — 5 operation(s) for reports.

Orum Reports API is one of 17 APIs that Orum 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.

This API exposes 6 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version v2022-09-21.

Requests are made against 2 base URLs: https://api-sandbox.orum.io, https://vault.api-sandbox.orum.io.

6 operations 5 paths 19 schemas 1 DELETE4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2022-09-21
Base URL
https://api.orum.io
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Orum Reports API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 29 scopes.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 DELETE, 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Reports 6
POST
/deliver/reports/recon
Create a reconciliation report
post-reports-recon body → 200400401403default
GET
/deliver/reports/recon
Get all reconciliation reports
get-reports-recon → 200400401403default
GET
/deliver/reports/recon/{id}
Get a reconciliation report
get-recon-report 1 param → 200400401403404default
DELETE
/deliver/reports/{id}
Delete a report
delete-report 1 param → 204400401403404default
GET
/deliver/reports/{id}/download
Download a report
get-report-download 1 param → 200400401403404default
GET
/deliver/reports/balances
Get a balance statement summary report
get-reports-balances 4 params → 200400401403default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are ReportResponseBase (7 properties), BalanceReportResponseBase (4 properties), ReconReportRequest (4 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

ReportStatusResponse
string
Status of the report.
CreatedAt
string
Timestamp when the resource was created.
BalanceReportResponseBase
object
4 properties 4 required
EndTime
string
The end time of the report range in ISO-8601 format.
ReportAccountBalances
object
Open and close balances for an account.
2 properties 2 required
Amount
integer
Amount in integral cents.
ReconReportRequest
object
4 properties 2 required
ReportsResponse
object
1 property 1 required
ReportBalanceAmounts
object
Pending and available amounts.
2 properties 2 required
BalanceReportResponse
object
1 property 1 required
ReportResponseBase
object
7 properties 6 required
LedgerEntryBalanceType
string
Type of ledger entry.
LedgerEntryBalance
object
Ledger entries with type and debit/credit balances.
3 properties 3 required
ReportScope
string
The scope of the report.
SubledgerReferenceId
string
Unique reference id for the subledger resource. Generated by you.
StartTime
string
The start time of the report range in ISO-8601 format.
OrumId
string
Orum generated unique id for the resource.
ErrorResponse
object
3 properties 2 required
ReconReportResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orum-reports-api-openapi.yml Raw ↑

Other APIs Orum publishes across the network.

Orum Authentication API
Orum Balance API
Orum Book Transfers API
Orum Businesses API
Orum Cards API
Orum Configure webhooks API
Orum Eligibility API
Orum External Accounts API
Orum Persons API
Orum Schedules API
Orum Secure webhooks API
Orum Subledgers API
Where this information came from

This is an independent, third-party profile of Orum Reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.