NEXOWARE ConnectSchema-Explorer · Kafka-Backbone

Verträge / ContractPatch

Vertrag Patch

ContractPatch · com.nexoware.connect.events

Aggregat
Contract · State ContractState
Topic
contract.patch je Mandant mit Präfix, z. B. <mandant>.contract.patch
Key
ContractUuid
Nachrichtenart
Patch — ausdrückliche Teiländerungen, zusammengeführt vom Zusammenführungsdienst
Schreiber
c-entron Webservice (centron) , NEXOWARE.ERP (nexoware-erp)
Retention
30 Tage
Fassung
Version 1 (neueste)
Schema-ID
62

Patch-Pfad

Pflicht bei Anlage
ContractNumber, Version, State, AccountUuid, ContractDate, CurrencyFactor
Fix nach Anlage
ContractNumber

Vertragsentwurf: typisierte Teilaenderung fuer Vertrag. Nur ChangedFields werden angewandt; null leert nur nullable State-Einheiten. Listen und Unterobjekte sind atomare Ersetzungen mit vollstaendigem Inhalt. Fachliche Freigabe und Regeln gekoppelter Werte sind offen; siehe docs/contracts/contract.md.

Fassungen

Felder

Referenziert von

Kein Vertrag verweist auf diesen.

Rohfassung

Schema dieser Fassung (Avro)
{
  "type": "record",
  "name": "ContractPatch",
  "namespace": "com.nexoware.connect.events",
  "doc": "Vertragsentwurf: typisierte Teilaenderung fuer Vertrag. Nur ChangedFields werden angewandt; null leert nur nullable State-Einheiten. Listen und Unterobjekte sind atomare Ersetzungen mit vollstaendigem Inhalt. Fachliche Freigabe und Regeln gekoppelter Werte sind offen; siehe docs/contracts/contract.md.",
  "fields": [
    {
      "name": "EventId",
      "type": {
        "type": "string",
        "logicalType": "uuid"
      },
      "doc": "Beim ersten Enqueue in die Outbox erzeugt; bei Wiederholung identisch."
    },
    {
      "name": "ContractUuid",
      "type": {
        "type": "string",
        "logicalType": "uuid"
      },
      "doc": "Stabile, global eindeutige Identitaet des Vertrags (Matching-Schluessel; zugleich Message-Key). Bleibt ueber Belegversionen hinweg identisch."
    },
    {
      "name": "Mode",
      "type": {
        "type": "enum",
        "name": "PatchMode",
        "doc": "CHANGE: lokal autorisierte Aenderung, LWW je Einheit nach Kafka-Reihenfolge. INITIAL_LOAD: Erstbefuellung beim Anschluss eines Produkts - setzt eine Einheit nur, wenn sie noch nie geschrieben wurde; ueberschreibt nie einen vorhandenen oder ausdruecklich geleerten Wert. Bewusst ohne Enum-Default: ein unbekannter kuenftiger Modus darf nicht still als CHANGE gelesen werden.",
        "symbols": [
          "CHANGE",
          "INITIAL_LOAD"
        ]
      }
    },
    {
      "name": "ChangedFields",
      "type": {
        "type": "array",
        "items": "string"
      },
      "doc": "Explizite Maske der geaenderten Top-Level-Einheiten; keine Wildcards, Identitaets- oder Auditfelder. Listen und Records werden als Ganzes ersetzt."
    },
    {
      "name": "Data",
      "type": {
        "type": "record",
        "name": "ContractPatchData",
        "doc": "Werte der maskierten Einheiten. null ausserhalb der Maske wird ignoriert; innerhalb der Maske entscheidet die Nullability im State.",
        "fields": [
          {
            "name": "ContractNumber",
            "type": [
              "null",
              "int"
            ],
            "doc": "Fachliche Vertragsnummer (Business-Key; quellseitig non-null). Vorlagen (negative Nummer) werden nicht publiziert. Nur bei Anlage; fixedAfterCreate.",
            "default": null
          },
          {
            "name": "Version",
            "type": [
              "null",
              "int"
            ],
            "doc": "Belegversion dieses Snapshots (quellseitig non-null; neue Versionen desselben Vertrags ueberschreiben per LWW).",
            "default": null
          },
          {
            "name": "State",
            "type": [
              "null",
              "int"
            ],
            "doc": "LWW-Statusfeld (ReceiptState: 1 = aktiv, 2 = abgeschlossen, 3 = storniert). Abschluss/Storno reist als Voll-Snapshot, kein Tombstone. Der Wert 0 sendet der Producer nie; er ist allein der Schema-Evolutions-Default fuer Leser, deren Writer-Schema das Feld noch nicht kannte, und darf nicht als Status ausgewertet werden.",
            "default": null
          },
          {
            "name": "AccountUuid",
            "type": [
              "null",
              {
                "type": "string",
                "logicalType": "uuid"
              }
            ],
            "doc": "Pflicht-Referenz auf den Kunden (Account) ueber dessen UUID. Kann der Producer sie nicht aufloesen, scheitert die Avro-Projektion laut (Failed-Outbox-Zeile) statt still null zu senden.",
            "default": null
          },
          {
            "name": "ContractKindUuid",
            "type": [
              "null",
              {
                "type": "string",
                "logicalType": "uuid"
              }
            ],
            "doc": "Referenz auf die Vertragsart (Katalog VertragsArt, Topic contractkind.state) ueber deren UUID; quellseitig nullable.",
            "default": null
          },
          {
            "name": "Name",
            "type": [
              "null",
              "string"
            ],
            "doc": "Vertragsname; DB nullable.",
            "default": null
          },
          {
            "name": "ContractDate",
            "type": [
              "null",
              {
                "type": "long",
                "logicalType": "timestamp-millis"
              }
            ],
            "doc": "Belegdatum als UTC-Instant (Quell-Property non-null; Host-lokale Zeit, beim Publish nach UTC konvertiert).",
            "default": null
          },
          {
            "name": "ContractBegin",
            "type": [
              "null",
              {
                "type": "long",
                "logicalType": "timestamp-millis"
              }
            ],
            "doc": "Vertragsbeginn (Quelle Beginn); DB nullable.",
            "default": null
          },
          {
            "name": "ContractEnd",
            "type": [
              "null",
              {
                "type": "long",
                "logicalType": "timestamp-millis"
              }
            ],
            "doc": "Vertragsende (Quelle Ende); DB nullable. Wird auch durch den naechtlichen Verlaengerungs-Job fortgeschrieben - jede Fortschreibung erzeugt einen neuen Voll-Snapshot.",
            "default": null
          },
          {
            "name": "TerminationDate",
            "type": [
              "null",
              {
                "type": "long",
                "logicalType": "timestamp-millis"
              }
            ],
            "doc": "Kuendigungsdatum (Quelle KuendigungsDatum); DB nullable. Die Kuendigung reist als Datum im Voll-Snapshot, kein eigener Status.",
            "default": null
          },
          {
            "name": "BillingBegin",
            "type": [
              "null",
              {
                "type": "long",
                "logicalType": "timestamp-millis"
              }
            ],
            "doc": "Beginn der Abrechnung (Quelle AbrechnungBeginn); DB nullable.",
            "default": null
          },
          {
            "name": "CalculationKind",
            "type": [
              "null",
              "int"
            ],
            "doc": "Abrechnungsart des Vertrags (Quelle AutoAbrechnung; ContractCalculationKind-Flags: 0 = keine, 1 = automatisch, 2 = nach Bedarf, 4 = manuell); DB nullable.",
            "default": null
          },
          {
            "name": "BillingKind",
            "type": [
              "null",
              "int"
            ],
            "doc": "Berechnungsart des Abrechnungszeitraums (Quelle Berechnungsart; BillingKinds: 0 = vorschuessig, 1 = nachschuessig); DB nullable.",
            "default": null
          },
          {
            "name": "BillingIntervalKind",
            "type": [
              "null",
              "int"
            ],
            "doc": "Einheit des Abrechnungsintervalls (Quelle AbrechnungIntervallArt; BillingIntervalKinds: 0 = Tag(e), 1 = Monat(e), 2 = Jahr(e), 3 = Quartal(e)); DB nullable.",
            "default": null
          },
          {
            "name": "BillingIntervalDuration",
            "type": [
              "null",
              "int"
            ],
            "doc": "Dauer des Abrechnungsintervalls in Einheiten von BillingIntervalKind (Quelle AbrechnungIntervallDauer); DB nullable.",
            "default": null
          },
          {
            "name": "AutomatedProlongation",
            "type": [
              "null",
              "boolean"
            ],
            "doc": "Automatische Vertragsverlaengerung aktiv (Quelle AutoVerlaengerung); DB nullable.",
            "default": null
          },
          {
            "name": "ProlongationMonths",
            "type": [
              "null",
              "int"
            ],
            "doc": "Verlaengerungszeitraum in Monaten (Quelle Verlaengerung); DB nullable.",
            "default": null
          },
          {
            "name": "DurationKind",
            "type": [
              "null",
              "int"
            ],
            "doc": "Einheit der Vertragslaufzeit (Quelle LaufzeitArt; ContractDurationKind: 0 = Tag, 1 = Monat, 2 = Jahr); DB nullable.",
            "default": null
          },
          {
            "name": "DurationTime",
            "type": [
              "null",
              "int"
            ],
            "doc": "Dauer der Vertragslaufzeit in Einheiten von DurationKind (Quelle LaufzeitDauer); DB nullable.",
            "default": null
          },
          {
            "name": "TerminationDeadlineKind1",
            "type": [
              "null",
              "int"
            ],
            "doc": "Einheit der Kuendigungsfrist der Erstlaufzeit (Quelle KuendigungsFristArt1; ContractDurationKind); DB nullable.",
            "default": null
          },
          {
            "name": "TerminationDeadlineDuration1",
            "type": [
              "null",
              "int"
            ],
            "doc": "Dauer der Kuendigungsfrist der Erstlaufzeit (Quelle KuendigungsFristDauer1); DB nullable.",
            "default": null
          },
          {
            "name": "TerminationDeadlineKind2",
            "type": [
              "null",
              "int"
            ],
            "doc": "Einheit der Kuendigungsfrist nach Verlaengerung (Quelle KuendigungsFristArt2; ContractDurationKind); DB nullable.",
            "default": null
          },
          {
            "name": "TerminationDeadlineDuration2",
            "type": [
              "null",
              "int"
            ],
            "doc": "Dauer der Kuendigungsfrist nach Verlaengerung (Quelle KuendigungsFristDauer2); DB nullable.",
            "default": null
          },
          {
            "name": "ForeignContract",
            "type": [
              "null",
              "boolean"
            ],
            "doc": "Fremdvertrag-Kennzeichen (Vertrag eines Fremdanbieters, Quelle Fremdvertrag); DB nullable. Die Fremdvertragsdetails (Lieferantendaten) sind bewusst keine Vertragsfelder.",
            "default": null
          },
          {
            "name": "AssetConditionUuid",
            "type": [
              "null",
              {
                "type": "string",
                "logicalType": "uuid"
              }
            ],
            "doc": "Referenz auf die Belegkondition (Zahlungskondition des Vertrags, Quelle ZahlKondI3D -> Zahkond) ueber deren UUID; quellseitig nullable.",
            "default": null
          },
          {
            "name": "DeliveryConditionUuid",
            "type": [
              "null",
              {
                "type": "string",
                "logicalType": "uuid"
              }
            ],
            "doc": "Referenz auf die Lieferbedingung (Quelle LieferbedingungI3D -> Zahkond, dasselbe Konditions-Stammdatum wie AssetConditionUuid) ueber deren UUID; quellseitig nullable.",
            "default": null,
            "references": "AssetCondition"
          },
          {
            "name": "CostCenterUuid",
            "type": [
              "null",
              {
                "type": "string",
                "logicalType": "uuid"
              }
            ],
            "doc": "Referenz auf die Kostenstelle des Kopfes ueber deren UUID; quellseitig nullable.",
            "default": null
          },
          {
            "name": "CostObjectUuid",
            "type": [
              "null",
              {
                "type": "string",
                "logicalType": "uuid"
              }
            ],
            "doc": "Referenz auf den Kostentraeger des Kopfes ueber dessen UUID; quellseitig nullable.",
            "default": null
          },
          {
            "name": "CurrencyIso",
            "type": [
              "null",
              "string"
            ],
            "doc": "ISO-Waehrungskennzeichen des Belegs (Quelle CurrencyString); DB nullable.",
            "default": null
          },
          {
            "name": "CurrencyFactor",
            "type": [
              "null",
              {
                "type": "bytes",
                "logicalType": "decimal",
                "precision": 18,
                "scale": 6
              }
            ],
            "doc": "Umrechnungsfaktor der Belegwaehrung zur Hauswaehrung; quellseitig non-null Property, beim Publish kaufmaennisch auf 6 Nachkommastellen gerundet.",
            "default": null
          },
          {
            "name": "NetTotal",
            "type": [
              "null",
              {
                "type": "bytes",
                "logicalType": "decimal",
                "precision": 18,
                "scale": 2
              }
            ],
            "doc": "Netto-Gesamtsumme des Vertrags je Abrechnungsintervall (Quelle VertragKopf.Netto, von der Quelle nach dem Save berechnet); DB nullable, beim Publish kaufmaennisch auf 2 Nachkommastellen gerundet.",
            "default": null
          },
          {
            "name": "GrossTotal",
            "type": [
              "null",
              {
                "type": "bytes",
                "logicalType": "decimal",
                "precision": 18,
                "scale": 2
              }
            ],
            "doc": "Brutto-Gesamtsumme des Vertrags je Abrechnungsintervall (Quelle VertragKopf.Brutto); DB nullable.",
            "default": null
          },
          {
            "name": "ProjectNumber",
            "type": [
              "null",
              "string"
            ],
            "doc": "Projektnummer des Vertrags (Quelle ProjNr); DB nullable.",
            "default": null
          },
          {
            "name": "PurchaseOrderNumber",
            "type": [
              "null",
              "string"
            ],
            "doc": "Bestellnummer des Kunden (Quelle BestNr); DB nullable.",
            "default": null
          },
          {
            "name": "ReferenceNumber",
            "type": [
              "null",
              "string"
            ],
            "doc": "Referenznummer des Vertrags (Quelle ReferenzNr); DB nullable.",
            "default": null
          },
          {
            "name": "Positions",
            "type": [
              "null",
              {
                "type": "array",
                "items": {
                  "type": "record",
                  "name": "ContractPosition",
                  "fields": [
                    {
                      "name": "PositionNumber",
                      "type": "int",
                      "doc": "Interne Positionsnummer (Sortierung; quellseitig non-null).",
                      "default": 0
                    },
                    {
                      "name": "DisplayPositionNumber",
                      "type": [
                        "null",
                        "string"
                      ],
                      "doc": "Angezeigte Positionsnummer (z. B. 1.2); DB nullable.",
                      "default": null
                    },
                    {
                      "name": "Kind",
                      "type": "int",
                      "doc": "Positionsart (ReceiptItemKind: 0 = Gruppenkopf, 1 = Artikel, 2 = Freitext, 3 = Kundenrabatt, 4 = Gesamtsumme, 5 = Zwischensumme, 6 = Titelposition, 7 = Stammdatenliste, 11/12 = Fracht/Versicherung).",
                      "default": 0
                    },
                    {
                      "name": "ArticleUuid",
                      "type": [
                        "null",
                        {
                          "type": "string",
                          "logicalType": "uuid"
                        }
                      ],
                      "doc": "Referenz auf das Artikel-Stammdatum ueber dessen UUID. Null fuer Zeilen ohne Artikel (Text-/Gruppen-/Summenpositionen) - deshalb optional, obwohl Artikelpositionen sie fachlich immer tragen.",
                      "default": null
                    },
                    {
                      "name": "ArticleCode",
                      "type": [
                        "null",
                        "string"
                      ],
                      "doc": "Fachlicher Artikelcode der Position (Kopie zum Save-Zeitpunkt); DB nullable.",
                      "default": null
                    },
                    {
                      "name": "Text",
                      "type": [
                        "null",
                        "string"
                      ],
                      "doc": "Positionstext (Artikel-/Freitext je nach Kind); DB nullable.",
                      "default": null
                    },
                    {
                      "name": "Quantity",
                      "type": [
                        "null",
                        "double"
                      ],
                      "doc": "Vertragsmenge der Position (Quelle Stk); quellseitig nullable.",
                      "default": null
                    },
                    {
                      "name": "BasePrice",
                      "type": [
                        "null",
                        {
                          "type": "bytes",
                          "logicalType": "decimal",
                          "precision": 18,
                          "scale": 4
                        }
                      ],
                      "doc": "Netto-Einzelpreis der Position je Abrechnungsintervall (Quelle VKBasisWert, vor Rabatt); quellseitig nullable float, beim Publish kaufmaennisch auf 4 Nachkommastellen gerundet.",
                      "default": null
                    },
                    {
                      "name": "Discount",
                      "type": {
                        "type": "bytes",
                        "logicalType": "decimal",
                        "precision": 6,
                        "scale": 2
                      },
                      "doc": "Positionsrabatt in Prozent; quellseitig non-null Property, beim Publish kaufmaennisch auf 2 Nachkommastellen gerundet.",
                      "default": "\u0000"
                    },
                    {
                      "name": "VatUuid",
                      "type": [
                        "null",
                        {
                          "type": "string",
                          "logicalType": "uuid"
                        }
                      ],
                      "doc": "Referenz auf das Mehrwertsteuersatz-Stammdatum der Position ueber dessen UUID; quellseitig nullable.",
                      "default": null
                    },
                    {
                      "name": "VatRate",
                      "type": [
                        "null",
                        {
                          "type": "bytes",
                          "logicalType": "decimal",
                          "precision": 6,
                          "scale": 2
                        }
                      ],
                      "doc": "Mehrwertsteuersatz der Position in Prozent (Kopie zum Save-Zeitpunkt); quellseitig nullable.",
                      "default": null
                    },
                    {
                      "name": "PurchasePrice",
                      "type": [
                        "null",
                        {
                          "type": "bytes",
                          "logicalType": "decimal",
                          "precision": 18,
                          "scale": 4
                        }
                      ],
                      "doc": "Einkaufspreis der Position (Quelle EK); quellseitig nullable.",
                      "default": null
                    },
                    {
                      "name": "BillingDateFrom",
                      "type": [
                        "null",
                        {
                          "type": "long",
                          "logicalType": "timestamp-millis"
                        }
                      ],
                      "doc": "Beginn des positionsindividuellen Abrechnungszeitraums (Quelle BillingDateFrom); DB nullable. Vertragsspezifisch: Positionen koennen zeitanteilig abgerechnet werden.",
                      "default": null
                    },
                    {
                      "name": "BillingDateTo",
                      "type": [
                        "null",
                        {
                          "type": "long",
                          "logicalType": "timestamp-millis"
                        }
                      ],
                      "doc": "Ende des positionsindividuellen Abrechnungszeitraums (Quelle BillingDateTo); DB nullable.",
                      "default": null
                    }
                  ]
                }
              }
            ],
            "doc": "Eingebettete Positionsliste (VertragPos), aufsteigend nach PositionNumber; alle Zeilenarten (Artikel-, Text-, Gruppen-, Summenpositionen - siehe Kind). Voll-Snapshot: der Consumer ersetzt die Collection je Event vollstaendig (kein positionsweises Mergen). Default [] nur fuer Schema-Evolution.",
            "default": null
          },
          {
            "name": "Receivers",
            "type": [
              "null",
              {
                "type": "array",
                "items": {
                  "type": "record",
                  "name": "ContractReceiver",
                  "fields": [
                    {
                      "name": "Kind",
                      "type": "int",
                      "doc": "Empfaenger-Slot am Belegkopf: 0 = Standard, 1 = Rechnung, 2 = Lieferung, 3 = Lizenznehmer.",
                      "default": 0
                    },
                    {
                      "name": "CompanyName",
                      "type": [
                        "null",
                        "string"
                      ],
                      "doc": "Firmenname des Empfaengers; DB nullable.",
                      "default": null
                    },
                    {
                      "name": "ContactName",
                      "type": [
                        "null",
                        "string"
                      ],
                      "doc": "Ansprechpartner-Name; DB nullable.",
                      "default": null
                    },
                    {
                      "name": "Department",
                      "type": [
                        "null",
                        "string"
                      ],
                      "doc": "Abteilung; DB nullable.",
                      "default": null
                    },
                    {
                      "name": "Street",
                      "type": [
                        "null",
                        "string"
                      ],
                      "doc": "Strasse; DB nullable.",
                      "default": null
                    },
                    {
                      "name": "HouseNumber",
                      "type": [
                        "null",
                        "string"
                      ],
                      "doc": "Hausnummer; DB nullable.",
                      "default": null
                    },
                    {
                      "name": "PostOfficeBox",
                      "type": [
                        "null",
                        "string"
                      ],
                      "doc": "Postfach; DB nullable.",
                      "default": null
                    },
                    {
                      "name": "Zip",
                      "type": [
                        "null",
                        "string"
                      ],
                      "doc": "Postleitzahl; DB nullable.",
                      "default": null
                    },
                    {
                      "name": "City",
                      "type": [
                        "null",
                        "string"
                      ],
                      "doc": "Ort; DB nullable.",
                      "default": null
                    },
                    {
                      "name": "CountryUuid",
                      "type": [
                        "null",
                        {
                          "type": "string",
                          "logicalType": "uuid"
                        }
                      ],
                      "doc": "Referenz auf das Laender-Stammdatum ueber dessen UUID; quellseitig nullable.",
                      "default": null
                    },
                    {
                      "name": "AccountUuid",
                      "type": [
                        "null",
                        {
                          "type": "string",
                          "logicalType": "uuid"
                        }
                      ],
                      "doc": "Referenz auf den Account, aus dem der Empfaenger stammt, ueber dessen UUID; quellseitig nullable.",
                      "default": null
                    }
                  ]
                }
              }
            ],
            "doc": "Eingebettete Beleg-Empfaenger (ReceiptReceivers, Cascade am Kopf): nur belegte Slots reisen mit, unterschieden per Kind. Voll-Snapshot: der Consumer ersetzt die Collection je Event vollstaendig. Default [] nur fuer Schema-Evolution.",
            "default": null
          }
        ]
      }
    },
    {
      "name": "ChangedByUuid",
      "type": [
        "null",
        {
          "type": "string",
          "logicalType": "uuid"
        }
      ],
      "doc": "UUID des aendernden Mitarbeiters (Employee); null, wenn unbekannt (z. B. Fortschreibung durch den Verlaengerungs-Job).",
      "default": null,
      "references": "Employee"
    },
    {
      "name": "ChangedAt",
      "type": {
        "type": "long",
        "logicalType": "timestamp-millis"
      },
      "doc": "Zeitpunkt der Aenderung als UTC-Instant."
    }
  ],
  "aggregate": "Contract",
  "label": "Vertrag",
  "topic": "contract.patch",
  "key": "ContractUuid",
  "cleanupPolicy": "delete",
  "retentionMs": 2592000000,
  "partitions": 1,
  "writers": [
    "centron",
    "nexoware-erp"
  ],
  "requiredOnCreate": [
    "ContractNumber",
    "Version",
    "State",
    "AccountUuid",
    "ContractDate",
    "CurrencyFactor"
  ],
  "fixedAfterCreate": [
    "ContractNumber"
  ]
}