GET
/
deliver
/
reports
/
balances
Get a balance statement summary report
curl --request GET \
  --url https://api-sandbox.orum.io/deliver/reports/balances \
  --header 'Authorization: Bearer <token>'
{
  "balance_statement_summary_report": {
    "start_time": "2023-07-13T00:00:00.000Z",
    "end_time": "2023-07-13T00:00:00.000Z",
    "account_balances": {
      "opening": {
        "pending_amount": 4295,
        "available_amount": 4295
      },
      "closing": {
        "pending_amount": 4295,
        "available_amount": 4295
      }
    },
    "ledger_entry_balances": [
      {
        "type": "rtp",
        "debit": 4295,
        "credit": 4295
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
start_time
string
required

The start time of the report range in ISO-8601 format.

Example:

"2023-07-13T00:00:00.000Z"

​
end_time
string
required

The end time of the report range in ISO-8601 format.

Example:

"2023-07-13T00:00:00.000Z"

​
report_scope
enum<string>
default:total

The scope of the report.

Available options:
total,
enterprise,
subledger
​
subledger_reference_id
string

Unique reference id for the subledger resource. Generated by you.

Required string length: 1 - 255

Response

200
application/json

200 response.

The response is of type object.