balance_report

FintechPaymentsACHWiresTreasury

Properties

Name	Type	Description
id	string
object	string
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.
created_at	string
updated_at	string
balance_report_type	string	The specific type of balance report. One of `intraday`, `previous_day`, `real_time`, or `other`.
as_of_date	string	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	An array of `Balance` objects.
internal_account_id	string	The ID of one of your organization's Internal Accounts.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/balance_report",
  "title": "balance_report",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "object": {
      "type": "string"
    },
    "live_mode": {
      "type": "boolean",
      "description": "This field will be true if this object exists in the live environment or false if it exists in the test environment."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "balance_report_type": {
      "type": "string",
      "enum": [
        "intraday",
        "other",
        "previous_day",
        "real_time"
      ],
      "description": "The specific type of balance report. One of `intraday`, `previous_day`, `real_time`, or `other`."
    },
    "as_of_date": {
      "type": "string",
      "format": "date",
      "description": "The date of the balance report in local time."
    },
    "as_of_time": {
      "type": "string",
      "nullable": true,
      "format": "time",
      "description": "The time (24-hour clock) of the balance report in local time."
    },
    "balances": {
      "type": "array",
      "description": "An array of `Balance` objects.",
      "items": {
        "$ref": "#/components/schemas/balance"
      }
    },
    "internal_account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of one of your organization's Internal Accounts."
    }
  },
  "additionalProperties": false,
  "minProperties": 10,
  "required": [
    "id",
    "object",
    "live_mode",
    "created_at",
    "updated_at",
    "balance_report_type",
    "as_of_date",
    "as_of_time",
    "balances",
    "internal_account_id"
  ]
}