ledger_account_settlement_create_request

FintechPaymentsACHWiresTreasury

Properties

Name	Type	Description
description	string	The description of the ledger account settlement.
status	string	The status of the ledger account settlement. It is set to `pending` by default. To post a ledger account settlement at creation, use `posted`.
settled_ledger_account_id	string	The id of the settled ledger account whose ledger entries are queried against, and its balance is reduced as a result.
contra_ledger_account_id	string	The id of the contra ledger account that sends to or receives funds from the settled ledger account.
allow_either_direction	boolean	If true, the settlement amount and settlement_entry_direction will bring the settlement ledger account's balance closer to zero, even if the balance is negative.
effective_at_upper_bound	string	The exclusive upper bound of the 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 settl
metadata	object	Additional data represented as key-value pairs. Both the key and value must be strings.
skip_settlement_ledger_transaction	boolean	It is set to `false` by default. It should be set to `true` when migrating existing settlements.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ledger_account_settlement_create_request",
  "title": "ledger_account_settlement_create_request",
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "The description of the ledger account settlement.",
      "nullable": true
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "posted",
        "drafting"
      ],
      "description": "The status of the ledger account settlement. It is set to `pending` by default. To post a ledger account settlement at creation, use `posted`.",
      "nullable": true
    },
    "settled_ledger_account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The id of the settled ledger account whose ledger entries are queried against, and its balance is reduced as a result."
    },
    "contra_ledger_account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The id of the contra ledger account that sends to or receives funds from the settled ledger account."
    },
    "allow_either_direction": {
      "type": "boolean",
      "description": "If true, the settlement amount and settlement_entry_direction will bring the settlement ledger account's balance closer to zero, even if the balance is negative.",
      "nullable": true
    },
    "effective_at_upper_bound": {
      "type": "string",
      "format": "date-time",
      "description": "The exclusive upper bound of the 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.",
      "nullable": true
    },
    "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
    }
  },
  "required": [
    "settled_ledger_account_id",
    "contra_ledger_account_id"
  ]
}