Balance Reports

A balance_report is a collection of balances at a specific point in time for an internal account. intraday balance reports come throughout the business day and indicate the intra-business-day activity within the account. previous_day reports come at the end of the business day and will often indicate the final opening and closing balances.

Related Guides:

Attribute

Description

id
string

The unique identifier for the balance report.

balance_report_type
string

The specific type of balance report. One of intraday, previous_day, real_time, or other.

as_of_date
date

The date of the balance report in local time.

as_of_time
string

The time (24-hour clock) of the balance report in local time.

balances
array of balance objects

An array of Balance objects.

internal_account_id
string

The ID of one of your organization's Internal Accounts

live_mode
boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

{
  "id": "c570ac34-cade-48d2-87ff-28d7216a8af5",
  "object": "balance_report",
  "balance_report_type": "previous_day",
  "as_of_date": "2018-11-28",
  "as_of_time": "23:46",
  "internal_account_id": "0f8e3719-3dfd-4613-9bbf-c0333781b59f",
  "balances": [
    {
      "id": "1f4b0995-338e-41ed-93c4-a41ed8312312",
      "object": "balance",
      "amount": 1033236,
      "currency": "USD",
      "balance_type": "opening_ledger",
      "vendor_code": "010",
      "vendor_code_type": "bai2",
      "live_mode": true,
      "created_at": "2019-11-09T00:11:07Z",
      "updated_at": "2019-11-09T00:11:07Z"
    },
    {
      "id": "98326522-b74d-4332-a78a-68991d737015",
      "object": "balance",
      "amount": 1033236,
      "currency": "USD",
      "balance_type": "closing_ledger",
      "vendor_code": "015",
      "vendor_code_type": "bai2",
      "live_mode": true,
      "created_at": "2019-11-09T00:11:07Z",
      "updated_at": "2019-11-09T00:11:07Z"
    },
    {
      "id": "70bee3ea-6f2f-4764-ac1d-4e6b9fe4563a",
      "object": "balance",
      "amount": 1033236,
      "currency": "USD",
      "balance_type": "opening_available_next_business_day",
      "vendor_code": "040",
      "vendor_code_type": "bai2",
      "live_mode": true,
      "created_at": "2019-11-09T00:11:07Z",
      "updated_at": "2019-11-09T00:11:07Z"
    },
    {
      "id": "e8e7676a-05db-49b3-a82f-0368e4aed4ba",
      "object": "balance",
      "amount": 1033236,
      "currency": "USD",
      "balance_type": "closing_available",
      "vendor_code": "045",
      "vendor_code_type": "bai2",
      "live_mode": true,
      "created_at": "2019-11-09T00:11:07Z",
      "updated_at": "2019-11-09T00:11:07Z"
    },
    {
      "id": "156495cc-5483-4654-b4f2-863b6892c823",
      "object": "balance",
      "amount": 1032161,
      "currency": "USD",
      "balance_type": "other",
      "vendor_code": "050",
      "vendor_code_type": "bai2",
      "live_mode": true,
      "created_at": "2019-11-09T00:11:07Z",
      "updated_at": "2019-11-09T00:11:07Z"
    }
  ],
  "live_mode": true,
  "created_at": "2019-11-09T00:11:07Z",
  "updated_at": "2019-11-09T00:11:07Z"
}