---
title: "Update Ledger Account Settlement"
method: PATCH
path: "/ledger_account_settlements/{id}"
---

# Update Ledger Account Settlement

`PATCH /ledger_account_settlements/{id}`

## Path parameters

- `id` string, required

## Request body

- object
  - `description` string — Maximum of 1000 characters allowed.
  - `status` string — To post a pending ledger account settlement, use `posted`. To archive a pending ledger account settlement, use `archived`.
  - `metadata` string, json — Additional data in the form of key-value pairs. Pairs can be removed by passing an empty string or null as the value.
  - `skip_settlement_ledger_transaction` boolean — It is set to `false` by default. It should be set to `true` when migrating existing settlements.

## Response `200`

200

- object
  - `id` string
  - `object` string
  - `live_mode` boolean
  - `description` string
  - `payout_ledger_account_id` string
  - `funding_ledger_account_id` string
  - `effective_at_upper_bound` string
  - `status` string
  - `amount` integer
  - `currency` string
  - `ledger_transaction_id` string
  - `metadata` object
  - `created_at` string
  - `updated_at` string

---

[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/revisions/ed0431a2dcd0/schema)