Verträge / CreditVoucherPatch
Gutschrift Patch
CreditVoucherPatch · com.nexoware.connect.events
- Aggregat
- CreditVoucher · State CreditVoucherState
- Topic
- creditvoucher.patch je Mandant mit Präfix, z. B.
<mandant>.creditvoucher.patch - Key
- CreditVoucherUuid
- 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
- 72
Patch-Pfad
- Pflicht bei Anlage
- CreditVoucherNumber, Version, State, AccountUuid, CreditVoucherDate, CurrencyFactor, OnlyPriceValue
- Fix nach Anlage
- CreditVoucherNumber
Kanonischer Vertrag, Version 1: Teilaenderung einer Gutschrift (ADR-0023 Punkt 3). Alle Patches einer Gutschrift laufen ueber dieses eine Topic mit Key = CreditVoucherUuid; der Zusammenfuehrungsdienst wendet sie in Kafka-Reihenfolge an und veroeffentlicht den State auf creditvoucher.state. Semantik: Pfad nicht in ChangedFields -> unveraendert (Wert in Data wird ignoriert); Pfad in ChangedFields mit Wert -> setzen; mit null -> leeren, sofern die Einheit im State nullable ist. Die Maske ist Pflicht, ohne Wildcard. Positions und Receivers sind je eine Einheit und werden als Ganzes ersetzt - wer eine Liste maskiert, liefert sie vollstaendig. Die Anlage einer Gutschrift braucht CreditVoucherNumber, Version, State, AccountUuid, CreditVoucherDate, CurrencyFactor und OnlyPriceValue (requiredOnCreate); CreditVoucherNumber setzt nur der anlegende Patch (fixedAfterCreate). Ein ungueltiger Patch wird als Ganzes abgelehnt. Fachliche Anforderungen: docs/contracts/creditvoucher.md.
Fassungen
Felder
-
EventId ↗ extern: EventId uuidBeim ersten Enqueue in die Outbox erzeugt, bei jeder Wiederholung identisch. Grundlage der fachlichen Deduplizierung.
-
CreditVoucherUuid Key uuidObjektidentitaet; muss dem Message-Key entsprechen.
-
Mode enum(CHANGE|INITIAL_LOAD)
-
ChangedFields Liste string[]Feldmaske: Pfade der geaenderten Einheiten, z. B. State, ReasonText, Positions. Jeder Pfad nennt genau eine Einheit des State.
-
Data CreditVoucherPatchData
21 Felder von
CreditVoucherPatchData-
CreditVoucherNumber optional intDefault:
nullNur bei Anlage; danach lehnt der Dienst einen CHANGE mit diesem Pfad ab (FIXED_AFTER_CREATE). -
Version optional intDefault:
null -
State optional intDefault:
null -
Default:
null -
Default:
null -
CreditVoucherDate optional timestampDefault:
null -
DeliveryDate optional timestampDefault:
null -
Default:
null -
Default:
null -
Default:
null -
Default:
null -
CurrencyIso optional stringDefault:
null -
CurrencyFactor optional decimal(18,6)Default:
null -
NetTotal optional decimal(18,2)Default:
null -
GrossTotal optional decimal(18,2)Default:
null -
OnlyPriceValue optional booleanDefault:
null -
ReasonText optional stringDefault:
null -
ProjectNumber optional stringDefault:
null -
PurchaseOrderNumber optional stringDefault:
null -
Positions Liste optional CreditVoucherPosition[]Default:
nullDie vollstaendige neue Liste; im State nicht leerbar (NULL_NOT_ALLOWED), eine leere Liste ist erlaubt.12 Felder von
CreditVoucherPosition[]-
PositionNumber intDefault:
0Interne Positionsnummer (Sortierung; quellseitig non-null). -
DisplayPositionNumber optional stringDefault:
nullAngezeigte Positionsnummer (z. B. 1.2); DB nullable. -
Kind intDefault:
0Positionsart (ReceiptItemKind: 0 = Gruppenkopf, 1 = Artikel, 2 = Freitext, 3 = Kundenrabatt, 4 = Gesamtsumme, 5 = Zwischensumme, 6 = Titelposition, 7 = Stammdatenliste, 11/12 = Fracht/Versicherung). -
Default:
nullReferenz auf das Artikel-Stammdatum ueber dessen UUID. Null fuer Zeilen ohne Artikel (Text-/Gruppen-/Summenpositionen) - deshalb optional, obwohl Artikelpositionen sie fachlich immer tragen. -
ArticleCode optional stringDefault:
nullFachlicher Artikelcode der Position (Kopie zum Save-Zeitpunkt); DB nullable. -
Text optional stringDefault:
nullPositionstext (Artikel-/Freitext je nach Kind); DB nullable. -
Quantity optional doubleDefault:
nullGutgeschriebene Menge der Position (Quelle Stk); quellseitig nullable. -
BasePrice optional decimal(18,4)Default:
nullNetto-Einzelpreis der Position (Quelle VKBasisWert, vor Rabatt); quellseitig nullable float, beim Publish kaufmaennisch auf 4 Nachkommastellen gerundet. -
Discount decimal(6,2)Default:
"\u0000"Positionsrabatt in Prozent; quellseitig non-null Property, beim Publish kaufmaennisch auf 2 Nachkommastellen gerundet. -
Default:
nullReferenz auf das Mehrwertsteuersatz-Stammdatum der Position ueber dessen UUID; quellseitig nullable. -
VatRate optional decimal(6,2)Default:
nullMehrwertsteuersatz der Position in Prozent (Kopie zum Save-Zeitpunkt); quellseitig nullable. -
PurchasePrice optional decimal(18,4)Default:
nullEinkaufspreis der Position (Quelle EK); quellseitig nullable.
-
-
Receivers Liste optional CreditVoucherReceiver[]Default:
nullDie vollstaendige neue Liste; im State nicht leerbar (NULL_NOT_ALLOWED), eine leere Liste ist erlaubt.11 Felder von
CreditVoucherReceiver[]-
Kind intDefault:
0Empfaenger-Slot am Belegkopf: 0 = Standard, 1 = Rechnung, 2 = Lieferung, 3 = Lizenznehmer. -
CompanyName optional stringDefault:
nullFirmenname des Empfaengers; DB nullable. -
ContactName optional stringDefault:
nullAnsprechpartner-Name; DB nullable. -
Department optional stringDefault:
nullAbteilung; DB nullable. -
Street optional stringDefault:
nullStrasse; DB nullable. -
HouseNumber optional stringDefault:
nullHausnummer; DB nullable. -
PostOfficeBox optional stringDefault:
nullPostfach; DB nullable. -
Zip optional stringDefault:
nullPostleitzahl; DB nullable. -
City optional stringDefault:
nullOrt; DB nullable. -
Default:
nullReferenz auf das Laender-Stammdatum ueber dessen UUID; quellseitig nullable. -
Default:
nullReferenz auf den Account, aus dem der Empfaenger stammt, ueber dessen UUID; quellseitig nullable.
-
-
-
ChangedByUuid optional ↗ extern: ChangedBy uuidDefault:
nullUUID des aendernden Mitarbeiters (Employee); null, wenn unbekannt. Audit. -
ChangedAt timestampZeitpunkt der Aenderung als UTC-Instant. Audit, kein Konfliktentscheider - es entscheidet die Kafka-Reihenfolge.
Referenziert von
Kein Vertrag verweist auf diesen.
Rohfassung
Schema dieser Fassung (Avro)
{
"type": "record",
"name": "CreditVoucherPatch",
"namespace": "com.nexoware.connect.events",
"doc": "Kanonischer Vertrag, Version 1: Teilaenderung einer Gutschrift (ADR-0023 Punkt 3). Alle Patches einer Gutschrift laufen ueber dieses eine Topic mit Key = CreditVoucherUuid; der Zusammenfuehrungsdienst wendet sie in Kafka-Reihenfolge an und veroeffentlicht den State auf creditvoucher.state. Semantik: Pfad nicht in ChangedFields -> unveraendert (Wert in Data wird ignoriert); Pfad in ChangedFields mit Wert -> setzen; mit null -> leeren, sofern die Einheit im State nullable ist. Die Maske ist Pflicht, ohne Wildcard. Positions und Receivers sind je eine Einheit und werden als Ganzes ersetzt - wer eine Liste maskiert, liefert sie vollstaendig. Die Anlage einer Gutschrift braucht CreditVoucherNumber, Version, State, AccountUuid, CreditVoucherDate, CurrencyFactor und OnlyPriceValue (requiredOnCreate); CreditVoucherNumber setzt nur der anlegende Patch (fixedAfterCreate). Ein ungueltiger Patch wird als Ganzes abgelehnt. Fachliche Anforderungen: docs/contracts/creditvoucher.md.",
"fields": [
{
"name": "EventId",
"type": {
"type": "string",
"logicalType": "uuid"
},
"doc": "Beim ersten Enqueue in die Outbox erzeugt, bei jeder Wiederholung identisch. Grundlage der fachlichen Deduplizierung."
},
{
"name": "CreditVoucherUuid",
"type": {
"type": "string",
"logicalType": "uuid"
},
"doc": "Objektidentitaet; muss dem Message-Key entsprechen."
},
{
"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": "Feldmaske: Pfade der geaenderten Einheiten, z. B. State, ReasonText, Positions. Jeder Pfad nennt genau eine Einheit des State."
},
{
"name": "Data",
"type": {
"type": "record",
"name": "CreditVoucherPatchData",
"doc": "Typisierte Werte. Alle Felder optional, damit ein Producer ausserhalb der Maske nichts erfinden muss; ob null erlaubt ist, entscheidet der State-Vertrag.",
"fields": [
{
"name": "CreditVoucherNumber",
"type": [
"null",
"int"
],
"doc": "Nur bei Anlage; danach lehnt der Dienst einen CHANGE mit diesem Pfad ab (FIXED_AFTER_CREATE).",
"default": null
},
{
"name": "Version",
"type": [
"null",
"int"
],
"default": null
},
{
"name": "State",
"type": [
"null",
"int"
],
"default": null
},
{
"name": "AccountUuid",
"type": [
"null",
{
"type": "string",
"logicalType": "uuid"
}
],
"default": null
},
{
"name": "InvoiceUuid",
"type": [
"null",
{
"type": "string",
"logicalType": "uuid"
}
],
"default": null
},
{
"name": "CreditVoucherDate",
"type": [
"null",
{
"type": "long",
"logicalType": "timestamp-millis"
}
],
"default": null
},
{
"name": "DeliveryDate",
"type": [
"null",
{
"type": "long",
"logicalType": "timestamp-millis"
}
],
"default": null
},
{
"name": "AssetConditionUuid",
"type": [
"null",
{
"type": "string",
"logicalType": "uuid"
}
],
"default": null
},
{
"name": "CostCenterUuid",
"type": [
"null",
{
"type": "string",
"logicalType": "uuid"
}
],
"default": null
},
{
"name": "CostObjectUuid",
"type": [
"null",
{
"type": "string",
"logicalType": "uuid"
}
],
"default": null
},
{
"name": "BranchUuid",
"type": [
"null",
{
"type": "string",
"logicalType": "uuid"
}
],
"default": null
},
{
"name": "CurrencyIso",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "CurrencyFactor",
"type": [
"null",
{
"type": "bytes",
"logicalType": "decimal",
"precision": 18,
"scale": 6
}
],
"default": null
},
{
"name": "NetTotal",
"type": [
"null",
{
"type": "bytes",
"logicalType": "decimal",
"precision": 18,
"scale": 2
}
],
"default": null
},
{
"name": "GrossTotal",
"type": [
"null",
{
"type": "bytes",
"logicalType": "decimal",
"precision": 18,
"scale": 2
}
],
"default": null
},
{
"name": "OnlyPriceValue",
"type": [
"null",
"boolean"
],
"default": null
},
{
"name": "ReasonText",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "ProjectNumber",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "PurchaseOrderNumber",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "Positions",
"type": [
"null",
{
"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": "Die vollstaendige neue Liste; im State nicht leerbar (NULL_NOT_ALLOWED), eine leere Liste ist erlaubt.",
"default": null
},
{
"name": "Receivers",
"type": [
"null",
{
"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": "Die vollstaendige neue Liste; im State nicht leerbar (NULL_NOT_ALLOWED), eine leere Liste ist erlaubt.",
"default": null
}
]
}
},
{
"name": "ChangedByUuid",
"type": [
"null",
{
"type": "string",
"logicalType": "uuid"
}
],
"doc": "UUID des aendernden Mitarbeiters (Employee); null, wenn unbekannt. Audit.",
"default": null
},
{
"name": "ChangedAt",
"type": {
"type": "long",
"logicalType": "timestamp-millis"
},
"doc": "Zeitpunkt der Aenderung als UTC-Instant. Audit, kein Konfliktentscheider - es entscheidet die Kafka-Reihenfolge."
}
],
"aggregate": "CreditVoucher",
"label": "Gutschrift",
"topic": "creditvoucher.patch",
"key": "CreditVoucherUuid",
"cleanupPolicy": "delete",
"retentionMs": 2592000000,
"partitions": 1,
"writers": [
"centron",
"nexoware-erp"
],
"requiredOnCreate": [
"CreditVoucherNumber",
"Version",
"State",
"AccountUuid",
"CreditVoucherDate",
"CurrencyFactor",
"OnlyPriceValue"
],
"fixedAfterCreate": [
"CreditVoucherNumber"
]
}