ledger_account_statement

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
ledger_id	string	The id of the ledger that this ledger account statement belongs to.
description	string	The description of the ledger account statement.
ledger_account_id	string	The id of the ledger account whose ledger entries are queried against, and its balances are computed as a result.
ledger_account_lock_version	integer	Lock version of the ledger account at the time of statement generation.
ledger_account_normal_balance	string	The normal balance of the ledger account.
effective_at_lower_bound	string	The inclusive lower bound of the effective_at timestamp of the ledger entries to be included in the ledger account statement.
effective_at_upper_bound	string	The exclusive upper bound of the effective_at timestamp of the ledger entries to be included in the ledger account statement.
starting_balance	object	The pending, posted, and available balances for this ledger account at the `effective_at_lower_bound`. The posted balance is the sum of all posted entries on the account. The pending balance is the su
ending_balance	object	The pending, posted, and available balances for this ledger account at the `effective_at_upper_bound`. The posted balance is the sum of all posted entries on the account. The pending balance is the su
metadata	object	Additional data represented as key-value pairs. Both the key and value must be strings.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ledger_account_statement",
  "title": "ledger_account_statement",
  "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"
    },
    "ledger_id": {
      "type": "string",
      "format": "uuid",
      "description": "The id of the ledger that this ledger account statement belongs to."
    },
    "description": {
      "type": "string",
      "description": "The description of the ledger account statement.",
      "nullable": true
    },
    "ledger_account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The id of the ledger account whose ledger entries are queried against, and its balances are computed as a result."
    },
    "ledger_account_lock_version": {
      "type": "integer",
      "description": "Lock version of the ledger account at the time of statement generation."
    },
    "ledger_account_normal_balance": {
      "type": "string",
      "enum": [
        "credit",
        "debit"
      ],
      "description": "The normal balance of the ledger account.",
      "_x-stainless-modelDefPath": "$shared.transaction_direction"
    },
    "effective_at_lower_bound": {
      "type": "string",
      "format": "date-time",
      "description": "The inclusive lower bound of the effective_at timestamp of the ledger entries to be included in the ledger account statement."
    },
    "effective_at_upper_bound": {
      "type": "string",
      "format": "date-time",
      "description": "The exclusive upper bound of the effective_at timestamp of the ledger entries to be included in the ledger account statement."
    },
    "starting_balance": {
      "$ref": "#/components/schemas/ledger_balances",
      "description": "The pending, posted, and available balances for this ledger account at the `effective_at_lower_bound`. The posted balance is the sum of all posted entries on the account. The pending balance is the sum of all pending and posted entries on the account. The available balance is the posted incoming entries minus the sum of the pending and posted outgoing amounts."
    },
    "ending_balance": {
      "$ref": "#/components/schemas/ledger_balances",
      "description": "The pending, posted, and available balances for this ledger account at the `effective_at_upper_bound`. The posted balance is the sum of all posted entries on the account. The pending balance is the sum of all pending and posted entries on the account. The available balance is the posted incoming entries minus the sum of the pending and posted outgoing amounts."
    },
    "metadata": {
      "type": "object",
      "description": "Additional data represented as key-value pairs. Both the key and value must be strings.",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value",
        "foo": "bar",
        "modern": "treasury"
      }
    }
  },
  "additionalProperties": false,
  "minProperties": 15,
  "required": [
    "id",
    "object",
    "live_mode",
    "created_at",
    "updated_at",
    "ledger_id",
    "description",
    "ledger_account_id",
    "ledger_account_lock_version",
    "ledger_account_normal_balance",
    "effective_at_lower_bound",
    "effective_at_upper_bound",
    "starting_balance",
    "ending_balance",
    "metadata"
  ]
}