← Tool reference

check_settlement_statement

Check settlement statement

Check escrow's settlement statement (estimated or final) against the contract before the buyer sends closing funds or signs closing documents: purchase price, deposit credited, every seller credit the buyer is owed (the contract's and any accepted repair credit), who pays each cost the contract allocates, the close date, the proration date, and credits a lender may cap. Ohvii computes this from the contract it holds and the statement as read, so use it instead of comparing by eye. Without documentId it checks the newest statement. A mismatch contradicts the contract: tell the buyer and have them ask escrow for a corrected statement before funding. A check is a question for escrow. no_statement means no document reads as one yet; if escrow's statement is on the transaction, run retry_transaction_document_extraction on it and check again. It reads nothing but the statement, and wiring instructions never come from it.

Effect
Read
Required scopes
workspace:read
Workflow stages
closing, transaction
Data classes
transaction
Operation cost
1 weighted units; additional domain limits may apply.
Configurations
Standard, Buyer UI v2
Muse proposal
Read. Retrieves or computes authorized information; consult the tool contract for its scopes and result. Meta makes the final classification during review.

Buyer approval and signing controls apply in addition to the scopes above. Read error and retry guidance before implementing recovery.

Input and output contracts

Returns structured content and a JSON text content block. Live discovery may compact a large output schema; execution validates the full contract below.

Input fields

Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.

FieldRequiredMeaning and constraints
documentIdstringNo

Pattern validation applies; see the raw schema.

workspaceIdstringYes

Pattern validation applies; see the raw schema.

Output fields

Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.

FieldRequiredMeaning and constraints
contractobject | nullYes

Must match at least one alternative.

contract: nested contract
Alternative 1: object

Extra fields are not allowed.

FieldRequiredMeaning and constraints
closeOfEscrowDatestring | nullYes

Must match at least one alternative.

closeOfEscrowDate: nested contract
Alternative 1: string

Pattern validation applies; see the raw schema.

Alternative 2: null

depositAmountnumberYes

Minimum: 0.

purchasePricenumberYes

Minimum: 0.

sellerCreditsarray<object>Yes

Maximum items: 40.

sellerCredits: nested contract
Array item contract

Extra fields are not allowed.

FieldRequiredMeaning and constraints
amountnumberYesNo additional description in the contract.
descriptionstringYes

Maximum characters: 300.

Alternative 2: null

findingsarray<object>Yes

Maximum items: 40.

findings: nested contract
Array item contract

Extra fields are not allowed.

FieldRequiredMeaning and constraints
codestringYes

Allowed: "price", "deposit", "credit_missing", "credit_extra", "payer", "close_date", "proration_date", "credits_exceed_costs", "unreadable".

messagestringYes

Minimum characters: 1.

Maximum characters: 1200.

severitystringYes

Allowed: "mismatch", "check".

matchesarray<string>Yes

Maximum items: 40.

matches: nested contract
Array item contract

Minimum characters: 1. Maximum characters: 300.

schemaVersionstringYes

Must be "1".

statementobject | nullYes

Must match at least one alternative.

statement: nested contract
Alternative 1: object

Extra fields are not allowed.

FieldRequiredMeaning and constraints
cashToClosenumber | nullYes

Must match at least one alternative.

cashToClose: nested contract
Alternative 1: number

Alternative 2: null

closeDatestring | nullYes

Must match at least one alternative.

closeDate: nested contract
Alternative 1: string

Maximum characters: 40.

Alternative 2: null

documentIdstringYes

Pattern validation applies; see the raw schema.

fromEmailstring | nullYes

Must match at least one alternative.

fromEmail: nested contract
Alternative 1: string

Maximum characters: 320.

Alternative 2: null

fromRolestring | nullYes

Must match at least one alternative.

fromRole: nested contract
Alternative 1: string

Maximum characters: 40.

Alternative 2: null

kindstring | nullYes

Must match at least one alternative.

kind: nested contract
Alternative 1: string

Allowed: "estimated", "final".

Alternative 2: null

labelstringYes

Maximum characters: 300.

preparerstring | nullYes

Must match at least one alternative.

preparer: nested contract
Alternative 1: string

Maximum characters: 300.

Alternative 2: null

securityFlaggedbooleanYesNo additional description in the contract.
Alternative 2: null

statusstringYes

Allowed: "checked", "no_statement".

workspaceIdstringYes

Pattern validation applies; see the raw schema.

Raw input schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "workspaceId"
  ],
  "additionalProperties": false
}
Full output schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contract": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "closeOfEscrowDate": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "depositAmount": {
              "type": "number",
              "minimum": 0
            },
            "purchasePrice": {
              "type": "number",
              "minimum": 0
            },
            "sellerCredits": {
              "maxItems": 40,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "amount": {
                    "type": "number"
                  },
                  "description": {
                    "type": "string",
                    "maxLength": 300
                  }
                },
                "required": [
                  "amount",
                  "description"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "closeOfEscrowDate",
            "depositAmount",
            "purchasePrice",
            "sellerCredits"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "findings": {
      "maxItems": 40,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "price",
              "deposit",
              "credit_missing",
              "credit_extra",
              "payer",
              "close_date",
              "proration_date",
              "credits_exceed_costs",
              "unreadable"
            ]
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1200
          },
          "severity": {
            "type": "string",
            "enum": [
              "mismatch",
              "check"
            ]
          }
        },
        "required": [
          "code",
          "message",
          "severity"
        ],
        "additionalProperties": false
      }
    },
    "matches": {
      "maxItems": 40,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 300
      }
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "statement": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "cashToClose": {
              "anyOf": [
                {
                  "type": "number"
                },
                {
                  "type": "null"
                }
              ]
            },
            "closeDate": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 40
                },
                {
                  "type": "null"
                }
              ]
            },
            "documentId": {
              "type": "string",
              "pattern": "^[A-Za-z0-9_-]{1,200}$"
            },
            "fromEmail": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 320
                },
                {
                  "type": "null"
                }
              ]
            },
            "fromRole": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 40
                },
                {
                  "type": "null"
                }
              ]
            },
            "kind": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "estimated",
                    "final"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "label": {
              "type": "string",
              "maxLength": 300
            },
            "preparer": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 300
                },
                {
                  "type": "null"
                }
              ]
            },
            "securityFlagged": {
              "type": "boolean"
            }
          },
          "required": [
            "cashToClose",
            "closeDate",
            "documentId",
            "fromEmail",
            "fromRole",
            "kind",
            "label",
            "preparer",
            "securityFlagged"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "checked",
        "no_statement"
      ]
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "contract",
    "findings",
    "matches",
    "schemaVersion",
    "statement",
    "status",
    "workspaceId"
  ],
  "additionalProperties": false
}
Tool annotations
{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": true
}

Reference 00e5441a095c7e20. Download the full catalog.