ledger_account_settlement_update_request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ledger_account_settlement_update_request",
  "title": "ledger_account_settlement_update_request",
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "The description of the ledger account settlement.",
      "nullable": true
    },
    "status": {
      "type": "string",
      "enum": [
        "posted",
        "archived"
      ],
      "description": "To post a pending ledger account settlement, use `posted`. To archive a pending ledger transaction, use `archived`."
    },
    "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"
      }
    },
    "skip_settlement_ledger_transaction": {
      "type": "boolean",
      "description": "It is set to `false` by default. It should be set to `true` when migrating existing settlements.",
      "nullable": true
    }
  }
}