Dokumento nuorodos objektas „documentReference“ – RetailForce

Šiame straipsnyje aptariamas dokumentų objekto (Document object) vidinis dokumentų nuorodos objektas „documentReference“.

Išsamų „RetailForce DOM“ (dokumento objektų modelio) aprašymą bei atskirų elementų aprašymą rasite „RetailForce“ svetainės atsisiuntimų skyriuje (Object model documentation.pdf) atitinkamoje versijų kataloge.

Objektas „documentReference“ naudojamas norint nurodyti kitus, jau sukurtus (išduotus) dokumentus. Dažniausiai tai yra anksčiau išduotas dokumentas, kuris turi būti visiškai anuliuotas, arba kai grąžinant prekes ar paslaugas reikia nurodyti atitinkamą pardavimo dokumentą.

„documentReference“ objektas

Toliau pateiktame dokumento nuorodos objekte yra pavyzdiniai duomenys.

"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"
},

Dokumento nuorodos objektas apima toliau pateiktą informaciją.

Informacija stulpelyje „Tipas“:

M ... privaloma („mandatory“)
M* ... privaloma tam tikrose šalyse arba tam tikromis sąlygomis
R ... rekomenduojama („recommended“)
O ... neprivaloma

Elementas		Tipas	Aprašymas
documentReference		O	documentReference yra neprivalomas masyvas. Jei jis naudojamas, būtina pateikti tam tikrą informaciją.
	referenceType	M	Dokumento nuorodos tipas. Enum: [0] = Cancellation (nuoroda į atšauktą dokumentą / atšauktą dokumento poziciją) [1] = Predecessor (nuoroda į ankstesnį dokumentą)
	storeNumber		Filialo numeris, kuriame buvo išduotas dokumentas, į kurį daroma nuoroda.
	terminalNumber		Kaso numeris, kuriame buvo išduotas nurodytas dokumentas.
	documentType		Nuorodoje nurodyto dokumento tipas.
	documentNumber		Nuorodoje nurodyto dokumento numeris.
	documentNumberSeries		Nuorodoje nurodyto dokumento numerių serija.
	fiscalDocumentNumber		Nuorodoje nurodyto dokumento fiskalinis numeris.
	documentGuid		Nuorodos dokumento GUID / UUID.
	documentId		Nuorodoje nurodyto dokumento unikalus numeris (maks. 40 simbolių).
	documentBookDate		Nuorodoje nurodyto dokumento įrašymo data.
	returnReasonType		Grąžinimo priežastis Enum: CustomerComplaint – kliento skundas (taip pat garantinio aptarnavimo atveju) CustomerDiscount – klientas nori nuolaidos prekės kainai CustomerReturn – klientas nori grąžinti prekę (be skundo priežasties) MasterDataWrong – prekės (pagrindiniai) duomenys buvo neteisingi (neteisingi duomenys apie prekę) UserMistake – kasininkas padarė klaidą, kuri turi / turėtų būti ištaisyta.
	returnReasonText		Grąžinimo priežasties aprašymas (pavadinimas).

„documentReference“ objektas

Susiję straipsniai