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.541Z",
   "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	Type of document reference. Enum: [0] = Cancellation (references a cancelled document / cancelled document item) [1] = Predecessor (refers to the previous document)
	storeNumber		The branch- / store number where the referenced document was issued.
	terminalNumber		The cash register number at which the referenced document was issued.
	documentType		Document type of the referenced document
	documentNumber		Document number of the referenced document
	documentNumberSeries		Number range of the referenced document
	fiscalDocumentNumber		Fiscal document number of the referenced document
	documentGuid		GUID / UUID of the referenced document
	documentId		Unique document number of the referenced document (max. 40 characters)
	documentBookDate		Booking date and time of the referenced document
	returnReasonType		Grund der Rückgabe Enum: CustomerComplaint - Customer complaints (also in the case of warranty claims) CustomerDiscount - Customer wants a discount on the price of the item CustomerReturn - Customer would like to return the item (without reason for complaint) MasterDataWrong - Article (master) data was wrong (Wrong article data) UserMistake - Cashier staff made a mistake which must / should be corrected.
	returnReasonText		Description of the reason for return

documentReference-Objekt

Verwandte Beiträge