v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

List Ledger Transaction Versions

get/ledger_transactions/{id}/versions

Path parameters

idstring required

The ID of the ledger transaction.

Query parameters

ledger_account_statement_idstring

The ID of the ledger account statement.

created_atstring date

Use "gt" (>), "gte" (>=), "'lt" (<), "lte" (<=), or "eq" (=) to filter by the created at timestamp of the version. For example, for all times after Jan 1 2000 12:00 UTC, use created_at%5Bgt%5D=2000-01-01T12:00:00Z.

versioninteger

Use "gt" (>), "gte" (>=), "lt" (<), "lte" (<=), or "eq" (=) to filter by the version. For example, for all versions after 2, use version%5Bgt%5D=2

after_cursorstring

per_pageinteger

Response

200

idstring

objectstring

live_modeboolean

ledger_transaction_idstring

external_idstring

{"stackTrail":"paths:/ledger_transactions/{id}/versions:get:responses:200:content:application/json:schema:items:properties:ledgerable_type","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/ledger_transactions/{id}/versions:get:responses:200:content:application/json:schema:items:properties:ledgerable_id","oasType":"schema","type":"unknown"}

ledger_idstring

{"stackTrail":"paths:/ledger_transactions/{id}/versions:get:responses:200:content:application/json:schema:items:properties:description","oasType":"schema","type":"unknown"}

statusstring

{"stackTrail":"paths:/ledger_transactions/{id}/versions:get:responses:200:content:application/json:schema:items:properties:archived_reason","oasType":"schema","type":"unknown"}

posted_atstring

effective_datestring

effective_atstring

metadataobject

versioninteger

created_atstring

Example response

[
  {
    "id": "08a8f85e-5e51-465d-abda-338c3392ec04",
    "object": "ledger_transaction_version",
    "ledger_transaction_id": "7f973ee9-597c-46e3-bcf1-359e0115d560",
    "external_id": "ecfbad72-c438-49f7-8198-d4bdf1e169bf",
    "ledger_id": "fe96565f-4b9c-4871-8fb0-e6f02683458e",
    "status": "posted",
    "ledger_entries": [
      {
        "id": "6f285fc2-7259-40e8-bfa9-3be8ae802f1f",
        "object": "ledger_entry",
        "amount": 100,
        "direction": "debit",
        "status": "posted",
        "ledger_account_id": "6168628a-05a6-4d30-80ca-4080ea699179",
        "ledger_account_currency": "USD",
        "ledger_account_currency_exponent": 2,
        "ledger_account_lock_version": 3,
        "ledger_transaction_id": "7f973ee9-597c-46e3-bcf1-359e0115d560",
        "created_at": "2022-11-01T21:29:56Z"
      }
    ],
    "posted_at": "2022-11-01T21:29:56Z",
    "effective_date": "2022-11-01",
    "effective_at": "2022-11-01T00:00:00.000000Z",
    "version": 1,
    "created_at": "2022-11-01T21:29:56Z"
  }
]