v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Create Ledger Account Statement

post/ledger_account_statements

Request body

descriptionstring

The description of the ledger account statement.

ledger_account_idstring required

The id of the ledger account whose ledger entries are queried against, and its balances are computed as a result.

effective_at_lower_boundstring required

The inclusive lower bound of the effective_at timestamp of the ledger entries to be included in the ledger account statement.

effective_at_upper_boundstring required

The exclusive upper bound of the effective_at timestamp of the ledger entries to be included in the ledger account statement.

Response

201

idstring

objectstring

live_modeboolean

ledger_idstring

descriptionstring

ledger_account_idstring

ledger_account_lock_versioninteger

ledger_account_normal_balancestring

effective_at_lower_boundstring

effective_at_upper_boundstring

metadataobject

created_atstring

updated_atstring

Example response

{
  "id": "0542a9bc-0d11-43cb-912a-b61440172735",
  "object": "ledger_account_statement",
  "live_mode": true,
  "ledger_id": "18f19042-2dz6-453e-9453-41d830590165",
  "description": "March 2023 Statement",
  "ledger_account_id": "cffdb329-3469-4845-88c2-af1554a83e70",
  "ledger_account_lock_version": 93,
  "ledger_account_normal_balance": "debit",
  "effective_at_lower_bound": "2023-03-01T00:00:00.000000Z",
  "effective_at_upper_bound": "2023-04-01T00:00:00.000000Z",
  "starting_balance": {
    "pending_balance": {
      "debits": 33218,
      "amount": 33218,
      "currency": "USD",
      "currency_exponent": 2
    },
    "posted_balance": {
      "currency": "USD",
      "currency_exponent": 2
    },
    "available_balance": {
      "currency": "USD",
      "currency_exponent": 2
    }
  },
  "ending_balance": {
    "pending_balance": {
      "debits": 52851,
      "amount": 52851,
      "currency": "USD",
      "currency_exponent": 2
    },
    "posted_balance": {
      "currency": "USD",
      "currency_exponent": 2
    },
    "available_balance": {
      "currency": "USD",
      "currency_exponent": 2
    }
  },
  "created_at": "2023-06-01T15:43:24Z",
  "updated_at": "2023-06-01T15:43:24Z"
}