← Tool reference

prepare_contract_amendment

Prepare contract amendment

Prepare the recording of an amendment both parties signed outside Ohvii's own counter flow (an escrow or listing-side addendum signed through the document-signing ceremony, or any executed amendment the buyer added as a document). Signing such a document changes no recorded term by itself. Name the executed document, its title, and exactly the terms it changed as the document states them: purchase price, close of escrow date (a calendar date), seller credits (the full list), the initial deposit (earnestMoneyAmount), financing type, who pays each cost it reallocates, included or excluded items, the escrow holder or title company, rent-back, or repairs; null for rent-back, repairs, or items removes them. Limits: whole dollars, a title up to 120 characters, rent-back and repairs up to 500 characters each, items up to 2,000, and at most 10 credits described in 200 characters each. Ohvii computes the before and after for each term and the re-derived close date; show that to the buyer and ask whether it matches the signed copy. Nothing changes until confirm_contract_amendment.

Effect
Read
Required scopes
transaction:confirm
Workflow stages
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
changesobjectYes

Extra fields are not allowed.

changes: nested contract
FieldRequiredMeaning and constraints
closeOfEscrowDatestringNo

Pattern validation applies; see the raw schema.

costsobjectNo

Extra fields are not allowed.

costs: nested contract
FieldRequiredMeaning and constraints
escrowstringNo

Allowed: "buyer", "seller", "split".

hoaAndNhdstringNo

Allowed: "buyer", "seller", "split".

homeWarrantyobjectNo

Extra fields are not allowed.

homeWarranty: nested contract
FieldRequiredMeaning and constraints
amountintegerNo

Minimum: 0.

Maximum: 100000.

payerstringNo

Allowed: "buyer", "seller", "split".

requestedbooleanNoNo additional description in the contract.
recordingstringNo

Allowed: "buyer", "seller", "split".

titlePolicystringNo

Allowed: "buyer", "seller", "split".

transferTaxesstringNo

Allowed: "buyer", "seller", "split".

creditsarray<object>No

Maximum items: 10.

credits: nested contract
Array item contract

Extra fields are not allowed.

FieldRequiredMeaning and constraints
amountintegerYes

Maximum: 1000000000.

Greater than: 0.

descriptionstringYes

Minimum characters: 1.

Maximum characters: 200.

earnestMoneyAmountintegerNo

Maximum: 1000000000.

Greater than: 0.

excludedItemsstring | nullNo

Must match at least one alternative.

excludedItems: nested contract
Alternative 1: string

Minimum characters: 1. Maximum characters: 2000.

Alternative 2: null

financingTypestringNo

Allowed: "cash", "conventional", "fha", "va", "other".

includedItemsstring | nullNo

Must match at least one alternative.

includedItems: nested contract
Alternative 1: string

Minimum characters: 1. Maximum characters: 2000.

Alternative 2: null

purchasePriceintegerNo

Maximum: 1000000000.

Greater than: 0.

rentBackstring | nullNo

Must match at least one alternative.

rentBack: nested contract
Alternative 1: string

Minimum characters: 1. Maximum characters: 500.

Alternative 2: null

repairsstring | nullNo

Must match at least one alternative.

repairs: nested contract
Alternative 1: string

Minimum characters: 1. Maximum characters: 500.

Alternative 2: null

settlementobjectNo

Extra fields are not allowed.

settlement: nested contract
FieldRequiredMeaning and constraints
escrowHolderstringNo

Minimum characters: 1.

Maximum characters: 200.

titleCompanystringNo

Minimum characters: 1.

Maximum characters: 200.

sourceDocumentIdstringYes

Pattern validation applies; see the raw schema.

titlestringYes

Minimum characters: 1.

Maximum characters: 120.

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
expiresAtstringYes

Format: date-time.

Pattern validation applies; see the raw schema.

preparedActionIdstringYes

Pattern validation applies; see the raw schema.

schemaVersionstringYes

Must be "1".

statusstringYes

Allowed: "prepared", "applied".

summaryobjectYes

Extra fields are not allowed.

summary: nested contract
FieldRequiredMeaning and constraints
addressstringYes

Minimum characters: 1.

Maximum characters: 500.

changesarray<object>Yes

Minimum items: 1.

Maximum items: 11.

changes: nested contract
Array item contract

Extra fields are not allowed.

FieldRequiredMeaning and constraints
afterstringYes

Minimum characters: 1.

Maximum characters: 600.

beforestringYes

Minimum characters: 1.

Maximum characters: 600.

termstringYes

Allowed: "closeOfEscrow", "costs", "credits", "deposit", "excludedItems", "financingType", "includedItems", "purchasePrice", "rentBack", "repairs", "settlement".

closeOfEscrowWhenobject | nullYes

Must match at least one alternative.

closeOfEscrowWhen: nested contract
Alternative 1: object

Extra fields are not allowed.

FieldRequiredMeaning and constraints
datestringYes

Pattern validation applies; see the raw schema.

labelstringYes

Minimum characters: 1.

Maximum characters: 80.

localstringYes

Minimum characters: 16.

Maximum characters: 40.

timestringYes

Minimum characters: 1.

Maximum characters: 20.

timezonestringYes

Minimum characters: 1.

Maximum characters: 64.

utcstringYes

Format: date-time.

Pattern validation applies; see the raw schema.

weekdaystringYes

Allowed: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday".

Alternative 2: null

effectstringYes

Minimum characters: 1.

Maximum characters: 400.

purchasePriceintegerYes

Maximum: 1000000000.

Greater than: 0.

sourceDocumentIdstringYes

Pattern validation applies; see the raw schema.

sourceDocumentLabelstringYes

Minimum characters: 1.

Maximum characters: 200.

titlestringYes

Minimum characters: 1.

Maximum characters: 120.

workspaceIdstringYes

Pattern validation applies; see the raw schema.

Raw input schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "changes": {
      "type": "object",
      "properties": {
        "closeOfEscrowDate": {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
        },
        "costs": {
          "type": "object",
          "properties": {
            "escrow": {
              "type": "string",
              "enum": [
                "buyer",
                "seller",
                "split"
              ]
            },
            "hoaAndNhd": {
              "type": "string",
              "enum": [
                "buyer",
                "seller",
                "split"
              ]
            },
            "homeWarranty": {
              "type": "object",
              "properties": {
                "amount": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 100000
                },
                "payer": {
                  "type": "string",
                  "enum": [
                    "buyer",
                    "seller",
                    "split"
                  ]
                },
                "requested": {
                  "type": "boolean"
                }
              },
              "additionalProperties": false
            },
            "recording": {
              "type": "string",
              "enum": [
                "buyer",
                "seller",
                "split"
              ]
            },
            "titlePolicy": {
              "type": "string",
              "enum": [
                "buyer",
                "seller",
                "split"
              ]
            },
            "transferTaxes": {
              "type": "string",
              "enum": [
                "buyer",
                "seller",
                "split"
              ]
            }
          },
          "additionalProperties": false
        },
        "credits": {
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "integer",
                "exclusiveMinimum": 0,
                "maximum": 1000000000
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              }
            },
            "required": [
              "amount",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "earnestMoneyAmount": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 1000000000
        },
        "excludedItems": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            },
            {
              "type": "null"
            }
          ]
        },
        "financingType": {
          "type": "string",
          "enum": [
            "cash",
            "conventional",
            "fha",
            "va",
            "other"
          ]
        },
        "includedItems": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            },
            {
              "type": "null"
            }
          ]
        },
        "purchasePrice": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 1000000000
        },
        "rentBack": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 500
            },
            {
              "type": "null"
            }
          ]
        },
        "repairs": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 500
            },
            {
              "type": "null"
            }
          ]
        },
        "settlement": {
          "type": "object",
          "properties": {
            "escrowHolder": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "titleCompany": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "sourceDocumentId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "changes",
    "sourceDocumentId",
    "title",
    "workspaceId"
  ],
  "additionalProperties": false
}
Full output schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "preparedActionId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "status": {
      "type": "string",
      "enum": [
        "prepared",
        "applied"
      ]
    },
    "summary": {
      "type": "object",
      "properties": {
        "address": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        "changes": {
          "minItems": 1,
          "maxItems": 11,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "after": {
                "type": "string",
                "minLength": 1,
                "maxLength": 600
              },
              "before": {
                "type": "string",
                "minLength": 1,
                "maxLength": 600
              },
              "term": {
                "type": "string",
                "enum": [
                  "closeOfEscrow",
                  "costs",
                  "credits",
                  "deposit",
                  "excludedItems",
                  "financingType",
                  "includedItems",
                  "purchasePrice",
                  "rentBack",
                  "repairs",
                  "settlement"
                ]
              }
            },
            "required": [
              "after",
              "before",
              "term"
            ],
            "additionalProperties": false
          }
        },
        "closeOfEscrowWhen": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "date": {
                  "type": "string",
                  "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
                },
                "label": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                },
                "local": {
                  "type": "string",
                  "minLength": 16,
                  "maxLength": 40
                },
                "time": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 20
                },
                "timezone": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 64
                },
                "utc": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
                },
                "weekday": {
                  "type": "string",
                  "enum": [
                    "Monday",
                    "Tuesday",
                    "Wednesday",
                    "Thursday",
                    "Friday",
                    "Saturday",
                    "Sunday"
                  ]
                }
              },
              "required": [
                "date",
                "label",
                "local",
                "time",
                "timezone",
                "utc",
                "weekday"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "effect": {
          "type": "string",
          "minLength": 1,
          "maxLength": 400
        },
        "purchasePrice": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 1000000000
        },
        "sourceDocumentId": {
          "type": "string",
          "pattern": "^[A-Za-z0-9_-]{1,200}$"
        },
        "sourceDocumentLabel": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "title": {
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        }
      },
      "required": [
        "address",
        "changes",
        "closeOfEscrowWhen",
        "effect",
        "purchasePrice",
        "sourceDocumentId",
        "sourceDocumentLabel",
        "title"
      ],
      "additionalProperties": false
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "expiresAt",
    "preparedActionId",
    "schemaVersion",
    "status",
    "summary",
    "workspaceId"
  ],
  "additionalProperties": false
}
Tool annotations
{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": true
}

Reference 00e5441a095c7e20. Download the full catalog.