Dokument Referenz-Objekt "documentReference" – RetailForce Software GmbH

Dieser Artikel behandelt das Dokument Referenz-Objekt "documentReference" innerhalb des Dokumenten-Objekts (Document object).

Eine vollständige Beschreibung des RetailForce DOM (Document Object Model), sowie eine Beschreibung der einzelnen Elemente, finden sie im Downloads-Bereich der RetailForce Website (Object model documentation.pdf) im jeweilige Versions-Verzeichnis.

Das Objekt "documentReference" wird verwendet, um auf andere, bereits erzeugte (ausgestellte) Dokumente zu referenzieren. Meist handelt es sich dabei um einen zuvor ausgestellten Beleg, welcher zur Gänze storniert werden soll, oder wenn im Zuge einer Rückgabe von Waren bzw. Dienstleistungen auf ein entsprechendes Verkaufsdokument Bezug genommen werden soll.

documentReference-Objekt

Das nachfolgende Dokument Referenz-Objekt enthält Beispieldaten.

"documentReference": {
   "referenceType": "[0] = Cancellation",
   "storeNumber": "999",
   "terminalNumber": "03",
   "documentType": "[0] = Receipt",
   "documentNumber": "2023000748605",
   "documentNumberSeries": "JJJJLFDNR",
   "fiscalDocumentNumber": 0,
   "documentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "documentId": "999-2023000748605",
   "documentBookDate": "2023-04-27T17:27:12.541+01:00",
   "returnReasonType": "userMistake",
   "returnReasonText": "Fehler bei Belegausstellung"
},

Das Dokument Referenz-Objekt beinhaltet nachfolgende Angaben.

Informationen in der Spalte "Typ":

M ... erforderlich ("mandatory)
M* ... erforderlich in bestimmten Ländern, oder unter bestimmten Voraussetzungen
R ... empfohlen ("recommended")
O ... optional

Element		Typ	Beschreibung
documentReference		O	documentReference ist ein optionales Array. Wird es verwendet, sind bestimmte Angaben notwendig.
	referenceType	M	Art des Dokumenten-Verweises. Enum: [0] = Cancellation (referenziert auf eine storniertes Dokument / stornierte Dokumenten-Position) [1] = Predecessor (verweist auf das vorhergehende Dokument)
	storeNumber		Die Filialnummer, in welcher das referenzierte Dokument ausgestellt wurde.
	terminalNumber		Die Kassennummer, an welcher das referenzierte Dokument ausgestellt wurde.
	documentType		Dokumenten-Typ des referenzierten Dokuments.
	documentNumber		Dokumenten Nummer des referenzierten Dokuments.
	documentNumberSeries		Nummernkreis des referenzierten Dokuments.
	fiscalDocumentNumber		Fiskal-Dokumentennummer des referenzierten Dokuments.
	documentGuid		GUID / UUID des referenzierten Dokuments.
	documentId		Eindeutige Belegnummer des referenzierten Dokuments (max. 40 Zeichen).
	documentBookDate		Buchungszeitpunkt des referenzierten Dokuments.
	returnReasonType		Grund der Rückgabe Enum: CustomerComplaint - Kundenbeschwerde (auch im Falle von Garantiefällen) CustomerDiscount - Kunde möchte einen Nachlass auf den Preis des Artikels CustomerReturn - Kunde möchte den Artikel retournieren (ohne Beschwerdegrund) MasterDataWrong - Artikel- (Stamm-)daten waren falsch (Falsche Angaben zum Artikel) UserMistake - Kassierpersonal hat einen Fehler gemacht, welcher korrigiert werden muss / soll.
	returnReasonText		Beschreibung (Bezeichnung) des Rückgabegrundes.

documentReference-Objekt

Verwandte Beiträge