Contract Amendment
A supplementary document attached to a contract - attachment, addendum or rescission - carrying one change per contract field it modifies. Applying it executes those changes on the contract and the franchise.
Overview
An amendment is uploaded against an existing ContractContractEntityv1.0.0A franchise contract in CNA Nexus - opening, renewal or resale - uploaded as a document, analysed by AI, reviewed by a p...Ownercna-platformView docs with the list of fields it changes. When it has analysable changes and is not a spreadsheet, it is sent to AI analysis (see the AI topic) to extract the new values, then reviewed by a person. Saving the review sets it to APPLYING and publishes Amendment Apply RequestedAmendment Apply RequestedEventv1.0.0A user finished reviewing a contract amendment and asked for its changes to be applied. cna-nexus's amendment consumer e...Ownercna-platformSchemaMapView docs; the consumer applies each change to the contract and the franchise aggregate, terminates the contract for a rescission, marks the amendment APPLIED, and emits one FranchiseUpdated.
| Name | Type | Required | Description | Reference |
|---|---|---|---|---|
id | string | Required | Internal id (UUID) in contract.contract_amendments. Carried as amendmentId in AmendmentApplyRequested. | |
contractId | string | Required | The contract this amendment modifies. Kafka message key of the Contract topic. | ContractProperty: id |
type | stringEnum:
| Required | Kind of amendment. A RESCISSION terminates the contract when applied. | |
status | stringEnum:
| Required | Lifecycle. PENDING after upload; DRAFT after AI analysis; APPLYING when the review is saved; APPLIED after the consumer applies the changes; APPLY_FAILED when it fails. | |
uploadedById | string | Required | User who uploaded the amendment. | |
fileId | string | Required | The uploaded document (storage.files). | |
signedAt | string | Optional | Signature date, extracted by the AI analysis. | |
changes | array | Required | One row per contract field the amendment changes (LEGAL_NAME, NAME, CNPJ, CORPORATE_CHANGE, ADDITIONAL_CLAUSE, CATEGORY, ESTIMATED_OPENING_DATE, ADDRESS, TERRITORY, ENDED_AT, OTHER), each with its new value. |
Custom properties
| Property | Value |
|---|---|
| Kafka Topicx-kafka-topic | Contract |
| Routing Keyx-routing-key | contractId |