---
title: "Create Ledger Account Settlement"
method: POST
path: "/ledger_account_settlements"
---

# Create Ledger Account Settlement

`POST /ledger_account_settlements`

## Request body

- object
  - `description` string
  - `status` string — It is set to `pending` by default. To post a ledger account settlement at creation, use `posted`. To have the ability to manually attach ledger entries to the settlement use `drafting`.
  - `settled_ledger_account_id` string, required — The ledger account whose ledger entries are queried against, and its balance is reduced as a result.
  - `contra_ledger_account_id` string, required — The ledger account that sends to or receives funds from the settled ledger account.
  - `effective_at_upper_bound` string, date — The maximum effective_at timestamp of the ledger entries to be included in the ledger account settlement. The default value is the created_at timestamp of the ledger account settlement.
  - `allow_either_direction` boolean — If true, the settlement amount and settlement_entry_direction will bring the settled ledger account’s balance closer to zero, even if the balance is negative.
  - `metadata` string, json — Metadata to be added to the ledger account settlement. Must be a JSON object.
  - `skip_settlement_ledger_transaction` boolean — It is set to `false` by default. It should be set to `true` when migrating existing settlements.

## Response `201`

201

- object
  - `id` string
  - `object` string
  - `live_mode` boolean
  - `description` string
  - `settled_ledger_account_id` string
  - `contra_ledger_account_id` string
  - `effective_at_upper_bound` string
  - `status` string
  - `amount` unknown
  - `currency` string
  - `ledger_transaction_id` unknown
  - `metadata` object
    - `foo` string
  - `created_at` string
  - `updated_at` string

## Other responses

- `422` — 422

---

[API](https://skmtc.net/modern-treasury/apis/modern-treasury-api.md) · [All operations](https://skmtc.net/modern-treasury/apis/modern-treasury-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modern-treasury/modern-treasury-api/versions/ed0431a2dcd0/schema)