Document reference-object "documentReference" – RetailForce Software GmbH

This Article deals with the document reference object "documentReference" within the Document object.

A complete description of the RetailForce DOM (Document Object Model), as well as a description of the individual elements, can be found in the downloads area of the RetailForce website (Object model documentation.pdf) in the respective version directory.

The object "documentReference" is used to refer to other, already created (issued) documents. This is usually a previously issued document that is to be cancelled in its entirety, or if a reference is to be made to a corresponding sales document in the course of a return of goods or services.

documentReference-object

The following document Reference Object contains sample data.

"documentReference": {
   "referenceType": "[0] = Cancellation",
   "storeNumber": "999",
   "terminalNumber": "03",
   "documentType": "[0] = Receipt",
   "documentNumber": "2023000748605",
   "documentNumberSeries": "YYYYASCNO",
   "fiscalDocumentNumber": 0,
   "documentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "documentId": "999-2023000748605",
   "documentBookDate": "2023-04-27T17:27:12.541Z",
   "returnReasonType": "userMistake",
   "returnReasonText": "cashier error"
},

The document reference object contains the following information.

Information in "Type" column:

M ... mandatory / requird
M* ... mandatory / requird in certain countries or under certain conditions
R ... recommended
O... optional

Elements		Type	Description
documentReference		M*	documentReference is basiaclly an optional array. In some countries referening to other documents is common practice and also often mandatory. If it is used, certain specifications are necessary.
	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		Reason for return 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-object

Related articles