NEXOWARE ConnectSchema-Explorer · Kafka-Backbone

Verträge / CreditVoucherState

Gutschrift State

CreditVoucherState · com.nexoware.connect.events

Aggregat
CreditVoucher · Patch CreditVoucherPatch
Topic
creditvoucher.state je Mandant mit Präfix, z. B. <mandant>.creditvoucher.state
Key
CreditVoucherUuid
Nachrichtenart
State — der aktuelle Zustand, ein Writer
Schreiber
Zusammenführungsdienst (merge)
Leser
c-entron Webservice (centron) , NEXOWARE.ERP (nexoware-erp)
Fassung
Version 1 (neueste)
Schema-ID
71

Kanonischer Vertrag, Version 1: der vollstaendige zusammengefuehrte Zustand einer Gutschrift (buchhalterischer Negativ-Beleg zur Rechnung, Quelle c-entron GutKopf/GutPos): Kopf mit eingebetteter Positionsliste und eingebetteten Beleg-Empfaengern. Positions und Receivers sind je eine Liste und damit je eine Einheit, die ein Patch als Ganzes ersetzt. Einziger Writer ist der Zusammenfuehrungsdienst (ADR-0023 Punkt 2 und 4); die Produkte schreiben Patches auf creditvoucher.patch und lesen diesen State mit isolation.level=read_committed. Identitaet und alle Referenzen ausschliesslich ueber UUID; quell-lokale IDs sind nicht Teil des Vertrags. Anders als die Rechnung traegt die Gutschrift keine Zahl- und Mahnfelder; die Ursprungsrechnung reist als optionale Referenz InvoiceUuid. Keine Buendelung mit der Lieferanten-Gutschrift (eigene Tabellen und Nummernraeume in der Quelle). Storno ist State = 3, kein Tombstone. Geldfelder als decimal, kaufmaennisch gerundet (ADR-0006). Feldumfang 1:1 aus dem Bestandsvertrag CreditVoucherChanged (archiviert), ergaenzt um Revision und LastEventId. Fachliche Anforderungen: docs/contracts/creditvoucher.md.

Fassungen

Felder

Referenziert von

Kein Vertrag verweist auf diesen.

Rohfassung

Schema dieser Fassung (Avro)
{
  "type": "record",
  "name": "CreditVoucherState",
  "namespace": "com.nexoware.connect.events",
  "doc": "Kanonischer Vertrag, Version 1: der vollstaendige zusammengefuehrte Zustand einer Gutschrift (buchhalterischer Negativ-Beleg zur Rechnung, Quelle c-entron GutKopf/GutPos): Kopf mit eingebetteter Positionsliste und eingebetteten Beleg-Empfaengern. Positions und Receivers sind je eine Liste und damit je eine Einheit, die ein Patch als Ganzes ersetzt. Einziger Writer ist der Zusammenfuehrungsdienst (ADR-0023 Punkt 2 und 4); die Produkte schreiben Patches auf creditvoucher.patch und lesen diesen State mit isolation.level=read_committed. Identitaet und alle Referenzen ausschliesslich ueber UUID; quell-lokale IDs sind nicht Teil des Vertrags. Anders als die Rechnung traegt die Gutschrift keine Zahl- und Mahnfelder; die Ursprungsrechnung reist als optionale Referenz InvoiceUuid. Keine Buendelung mit der Lieferanten-Gutschrift (eigene Tabellen und Nummernraeume in der Quelle). Storno ist State = 3, kein Tombstone. Geldfelder als decimal, kaufmaennisch gerundet (ADR-0006). Feldumfang 1:1 aus dem Bestandsvertrag CreditVoucherChanged (archiviert), ergaenzt um Revision und LastEventId. Fachliche Anforderungen: docs/contracts/creditvoucher.md.",
  "fields": [
    {
      "name": "CreditVoucherUuid",
      "type": {
        "type": "string",
        "logicalType": "uuid"
      },
      "doc": "Stabile, global eindeutige Identitaet der Gutschrift; zugleich Message-Key auf State und Patch. Bleibt ueber Belegversionen hinweg identisch."
    },
    {
      "name": "CreditVoucherNumber",
      "type": "int",
      "doc": "Fachliche Gutschriftsnummer (Business-Key; quellseitig non-null, eigener Nummernraum getrennt von der Lieferanten-Gutschrift). Vorlagen (negative Nummer) werden nicht publiziert. Pflicht bei Anlage und danach unveraenderlich: Ein Patch vergibt keine Nummer neu."
    },
    {
      "name": "Version",
      "type": "int",
      "doc": "Belegversion (quellseitig non-null). Pflicht bei Anlage - kein Default; eine neue Belegversion ist ein Patch auf diese Einheit."
    },
    {
      "name": "State",
      "type": "int",
      "doc": "LWW-Statusfeld (ReceiptState: 1 = aktiv/offen, 2 = abgeschlossen/verrechnet, 3 = storniert). Storno ist ein Patch mit State = 3, kein Tombstone. Der Abschluss durch den Zahlungsausgleich (Online-Banking) ist ein Patch mit State = 2. Pflicht bei Anlage - kein Default, damit 0 keinen Status vortaeuscht."
    },
    {
      "name": "AccountUuid",
      "type": {
        "type": "string",
        "logicalType": "uuid"
      },
      "doc": "Pflicht-Referenz auf den Kunden (AccountState) ueber dessen UUID; Pflicht bei Anlage, danach aenderbar (docs/contracts/creditvoucher.md, OFFEN-6). Kann der Producer sie nicht aufloesen, scheitert er laut, statt still null zu senden."
    },
    {
      "name": "InvoiceUuid",
      "type": [
        "null",
        {
          "type": "string",
          "logicalType": "uuid"
        }
      ],
      "doc": "Referenz auf die Ursprungsrechnung ueber deren UUID. Optional nach Quell-Garantie: freie Gutschriften ohne Rechnungsbezug existieren. Producer-seitig aus den Positions-Urspruengen abgeleitet (UrsprungArt 4 = Rechnung): genau EINE eindeutige Ursprungsrechnung -> deren UUID; keine oder mehrere unterschiedliche Rechnungen -> null (es gibt dann keinen EINEN Vorbeleg).",
      "default": null
    },
    {
      "name": "CreditVoucherDate",
      "type": {
        "type": "long",
        "logicalType": "timestamp-millis"
      },
      "doc": "Belegdatum als UTC-Instant (Quell-Property non-null; Host-lokale Zeit, beim Publish nach UTC konvertiert). Pflicht bei Anlage."
    },
    {
      "name": "DeliveryDate",
      "type": [
        "null",
        {
          "type": "long",
          "logicalType": "timestamp-millis"
        }
      ],
      "doc": "Lieferdatum der Gutschrift (Quelle Lieferdatum); DB nullable.",
      "default": null
    },
    {
      "name": "AssetConditionUuid",
      "type": [
        "null",
        {
          "type": "string",
          "logicalType": "uuid"
        }
      ],
      "doc": "Referenz auf die Belegkondition (Zahlungskondition der Gutschrift, Quelle ZahlKondID -> Zahkond) ueber deren UUID; quellseitig nullable. Eine Lieferbedingungs-Referenz gibt es am Gutschrift-Kopf nicht (keine LieferBedID-Spalte).",
      "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. 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.",
      "default": null
    },
    {
      "name": "CurrencyIso",
      "type": [
        "null",
        "string"
      ],
      "doc": "ISO-Waehrungskennzeichen des Belegs (Quelle CurrencyString); DB nullable.",
      "default": null
    },
    {
      "name": "CurrencyFactor",
      "type": {
        "type": "bytes",
        "logicalType": "decimal",
        "precision": 18,
        "scale": 6
      },
      "doc": "Umrechnungsfaktor der Belegwaehrung zur Hauswaehrung; quellseitig non-null, beim Publish kaufmaennisch auf 6 Nachkommastellen gerundet. Pflicht bei Anlage."
    },
    {
      "name": "NetTotal",
      "type": [
        "null",
        {
          "type": "bytes",
          "logicalType": "decimal",
          "precision": 18,
          "scale": 2
        }
      ],
      "doc": "Netto-Gesamtsumme der Gutschrift (Quelle GutKopf.Netto, von der Quelle nach dem Save berechnet); DB nullable, beim Publish kaufmaennisch auf 2 Nachkommastellen gerundet. Vorzeichen wie in der Quelle: die Gutschrift ist als eigener Beleg positiv erfasst, die buchhalterische Negativ-Wirkung ergibt sich aus der Belegart.",
      "default": null
    },
    {
      "name": "GrossTotal",
      "type": [
        "null",
        {
          "type": "bytes",
          "logicalType": "decimal",
          "precision": 18,
          "scale": 2
        }
      ],
      "doc": "Brutto-Gesamtsumme der Gutschrift (Quelle GutKopf.Brutto); DB nullable.",
      "default": null
    },
    {
      "name": "OnlyPriceValue",
      "type": "boolean",
      "doc": "Wert-Gutschrift (Quelle WertGutschrift 0/1): true = es wird nur der Preiswert gutgeschrieben, keine Warenbewegung; false = Waren-Gutschrift. Pflicht bei Anlage - kein Default, damit false keine Waren-Gutschrift vortaeuscht."
    },
    {
      "name": "ReasonText",
      "type": [
        "null",
        "string"
      ],
      "doc": "Gutschriftsgrund als Text (Quelle GutschriftGrundText, Kopie des Grund-Stammdatums zum Save-Zeitpunkt); DB nullable. Das Grund-Stammdatum selbst traegt keine UUID und reist deshalb nicht als Referenz.",
      "default": null
    },
    {
      "name": "ProjectNumber",
      "type": [
        "null",
        "string"
      ],
      "doc": "Projektnummer der Gutschrift; DB nullable.",
      "default": null
    },
    {
      "name": "PurchaseOrderNumber",
      "type": [
        "null",
        "string"
      ],
      "doc": "Bestellnummer des Kunden (Quelle BestNr); DB nullable.",
      "default": null
    },
    {
      "name": "Positions",
      "type": {
        "type": "array",
        "items": {
          "type": "record",
          "name": "CreditVoucherPosition",
          "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": "Gutgeschriebene 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 (GutPos), aufsteigend nach PositionNumber; alle Zeilenarten (Artikel-, Text-, Gruppen-, Summenpositionen - siehe Kind). Eine Liste ist eine Einheit: Ein Patch ersetzt sie als Ganzes (kein positionsweises Mergen), die leere Liste ist ein Wert, null nicht. Default [] fuer die Anlage ohne Positionen. KEIN QuantityProcessed: die Gutschrift ist Endbeleg (keine Folgebelege), die Quelle schreibt keine verarbeiteten Mengen.",
      "default": []
    },
    {
      "name": "Receivers",
      "type": {
        "type": "array",
        "items": {
          "type": "record",
          "name": "CreditVoucherReceiver",
          "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. Eine Liste ist eine Einheit: Ein Patch ersetzt sie als Ganzes, die leere Liste ist ein Wert, null nicht. Default [] fuer die Anlage ohne Empfaenger.",
      "default": []
    },
    {
      "name": "Revision",
      "type": "long",
      "doc": "Anzahl der zustandsaendernden Patches seit Erstanlage. Streng monoton je Objekt - Consumer ueberspringen Revisionen <= der zuletzt uebernommenen."
    },
    {
      "name": "LastEventId",
      "type": {
        "type": "string",
        "logicalType": "uuid"
      },
      "doc": "EventId des zuletzt angewandten Patches (Diagnose)."
    },
    {
      "name": "ChangedByUuid",
      "type": [
        "null",
        {
          "type": "string",
          "logicalType": "uuid"
        }
      ],
      "doc": "UUID des aendernden Mitarbeiters (Employee) aus dem zuletzt angewandten Patch; null, wenn unbekannt (z. B. Fortschreibung durch Folgebeleg-Buchung).",
      "default": null
    },
    {
      "name": "ChangedAt",
      "type": {
        "type": "long",
        "logicalType": "timestamp-millis"
      },
      "doc": "Audit aus dem zuletzt angewandten Patch als UTC-Instant - kein Konfliktentscheider, es entscheidet die Kafka-Reihenfolge der Patches."
    }
  ],
  "aggregate": "CreditVoucher",
  "label": "Gutschrift",
  "topic": "creditvoucher.state",
  "key": "CreditVoucherUuid",
  "cleanupPolicy": "compact",
  "partitions": 1,
  "writers": [
    "merge"
  ],
  "readers": [
    "centron",
    "nexoware-erp"
  ]
}