NEXOWARE ConnectSchema-Explorer · Kafka-Backbone

Verträge / PickupListPatch

Abholschein Patch

PickupListPatch · com.nexoware.connect.events

Aggregat
PickupList · State PickupListState
Topic
pickuplist.patch je Mandant mit Präfix, z. B. <mandant>.pickuplist.patch
Key
PickupListUuid
Nachrichtenart
Patch — ausdrückliche Teiländerungen, zusammengeführt vom Zusammenführungsdienst
Schreiber
c-entron Webservice (centron)
Retention
30 Tage
Fassung
Version 1 (neueste)
Schema-ID
76

Patch-Pfad

Pflicht bei Anlage
PickupListNumber, Version, State, AccountUuid, PickupListDate, CurrencyFactor
Fix nach Anlage
PickupListNumber

Vertragsentwurf: typisierte Teilaenderung fuer Abholschein. 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/pickuplist.md.

Fassungen

Felder

Referenziert von

Kein Vertrag verweist auf diesen.

Rohfassung

Schema dieser Fassung (Avro)
{
  "type": "record",
  "name": "PickupListPatch",
  "namespace": "com.nexoware.connect.events",
  "doc": "Vertragsentwurf: typisierte Teilaenderung fuer Abholschein. 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/pickuplist.md.",
  "fields": [
    {
      "name": "EventId",
      "type": {
        "type": "string",
        "logicalType": "uuid"
      },
      "doc": "Beim ersten Enqueue in die Outbox erzeugt; bei Wiederholung identisch."
    },
    {
      "name": "PickupListUuid",
      "type": {
        "type": "string",
        "logicalType": "uuid"
      },
      "doc": "Stabile, global eindeutige Identitaet des Abholscheins (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": "PickupListPatchData",
        "doc": "Werte der maskierten Einheiten. null ausserhalb der Maske wird ignoriert; innerhalb der Maske entscheidet die Nullability im State.",
        "fields": [
          {
            "name": "PickupListNumber",
            "type": [
              "null",
              "int"
            ],
            "doc": "Fachliche Abholscheinnummer (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 Abholscheins ueberschreiben per LWW).",
            "default": null
          },
          {
            "name": "State",
            "type": [
              "null",
              "int"
            ],
            "doc": "LWW-Statusfeld (ReceiptState: 1 = aktiv, 2 = abgeschlossen, 3 = storniert). Deaktivierung/Storno reist als Voll-Snapshot mit State = 3, kein Tombstone. Abgeschlossene Abholscheine sind quellseitig unveraenderbar (PickupListSpecificLogic.OnReceiptNewVersion). 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": "DeliveryListUuid",
            "type": [
              "null",
              {
                "type": "string",
                "logicalType": "uuid"
              }
            ],
            "doc": "Vorbeleg-Referenz auf den Lieferschein ueber dessen UUID. Der Abholschein kann quellseitig NUR aus dem Lieferschein weitergeleitet werden (CanBeForwardedFrom = DeliveryList) - eine OrderUuid wie im Lieferschein gaebe es nur erfunden. Optional nach Quell-Garantie: freie Anlage existiert. Producer-seitig aus den Positions-Urspruengen abgeleitet (UrsprungArt 2 = Lieferschein): genau EIN eindeutiger Ursprungs-Lieferschein -> dessen UUID; kein oder mehrere unterschiedliche Lieferscheine -> null (es gibt dann keinen EINEN Vorbeleg).",
            "default": null
          },
          {
            "name": "PickupListDate",
            "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": "AssetConditionUuid",
            "type": [
              "null",
              {
                "type": "string",
                "logicalType": "uuid"
              }
            ],
            "doc": "Referenz auf die Belegkondition (Zahlungskondition des Abholscheins, Quelle ZahlKondID -> Zahkond) ueber deren UUID; quellseitig nullable. Eine Lieferbedingung (LieferBedID) traegt der AbholKopf - anders als der Lieferschein - nicht (Abholung statt Versand).",
            "default": null
          },
          {
            "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": "BranchUuid",
            "type": [
              "null",
              {
                "type": "string",
                "logicalType": "uuid"
              }
            ],
            "doc": "Referenz auf die Filiale des Belegs (Quelle FilialI3D -> Filiale) ueber deren UUID; quellseitig nullable - fuer Click & Collect die Abholfiliale. 0/NULL im Quell-FK bedeutet 'Hauptsitz (keine Filiale)' (BranchBL.GetHeadquarter) - der Hauptsitz ist KEIN Filiale-Datensatz, die Referenz reist dann als null. Der zweite Quell-FK FilialgeberI3D ist bewusst kein Vertragsfeld - kein konzernweiter Konsument benannt (Filial-FK-Befund, Topic-Zuschnitt Anhang A Nr. 9).",
            "default": null
          },
          {
            "name": "PickupReasonText",
            "type": [
              "null",
              "string"
            ],
            "doc": "Abholgrund als Text-Kopie zum Save-Zeitpunkt (Quelle AbholscheinGrundText, Schreibpfad ReceiptReasonText); DB nullable. Der zugehoerige Katalog-FK (AbholscheinGrundI3D) ist eine quell-lokale ID ohne Katalog-Topic und reist nicht.",
            "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, 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 Abholscheins (Quelle AbholKopf.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 Abholscheins (Quelle AbholKopf.Brutto); DB nullable.",
            "default": null
          },
          {
            "name": "Positions",
            "type": [
              "null",
              {
                "type": "array",
                "items": {
                  "type": "record",
                  "name": "PickupListPosition",
                  "fields": [
                    {
                      "name": "PositionNumber",
                      "type": "int",
                      "doc": "Interne Positionsnummer (Sortierung; im Save-Pfad immer gesetzt, DB-Spalte nullable).",
                      "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": "Abzuholende bzw. abgeholte Menge 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 (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
                    }
                  ]
                }
              }
            ],
            "doc": "Eingebettete Positionsliste (AbholPos), 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. KEINE Bestandsfelder - die Bestandswirkung der Buchung reist als ArticleStockState (QS-3). KEIN QuantityProcessed: der Abholschein ist nie Vorbeleg eines Folgebelegs (CanBeForwardedInto leer, SaveReceiptAfterOriginUpdate wirft NotSupported), AbholPos traegt keine verarbeitete-Menge-Spalte - umgekehrt schreibt die Abhol-Buchung numAbhol am Ursprungs-Lieferschein fort (reist als DeliveryListState).",
            "default": null
          },
          {
            "name": "Receivers",
            "type": [
              "null",
              {
                "type": "array",
                "items": {
                  "type": "record",
                  "name": "PickupListReceiver",
                  "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.",
      "default": null,
      "references": "Employee"
    },
    {
      "name": "ChangedAt",
      "type": {
        "type": "long",
        "logicalType": "timestamp-millis"
      },
      "doc": "Zeitpunkt der Aenderung als UTC-Instant."
    }
  ],
  "aggregate": "PickupList",
  "label": "Abholschein",
  "topic": "pickuplist.patch",
  "key": "PickupListUuid",
  "cleanupPolicy": "delete",
  "retentionMs": 2592000000,
  "partitions": 1,
  "writers": [
    "centron"
  ],
  "requiredOnCreate": [
    "PickupListNumber",
    "Version",
    "State",
    "AccountUuid",
    "PickupListDate",
    "CurrencyFactor"
  ],
  "fixedAfterCreate": [
    "PickupListNumber"
  ]
}