Šiame straipsnyje aptariamas „Header“ objektas („payments“) arba „Document“ objekto „Header“ dalyje esantys elementai.
Išsamus „RetailForce“ DOM (dokumento objektų modelio) aprašymas, taip pat atskirų elementų aprašymas pateikiami „RetailForce“ website skyriuje „Atsisiuntimai“ (Object model documentation.pdf) atitinkamame versijų kataloge.
„Header“ objektas
{
"uniqueClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationVersion": "6.2.5",
"applicationVersionId": "string",
"applicationVersionPrevious": "string",
"fiscalModuleVersion": "1.8.8",
"fiscalCountryModuleVersion": "1.0.5",
"softwareName": "GreatesPOS",
"retailForceReceiptId": "W3D9C2Q1",
"additionalFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"automaticVatCalculation": "noCalculation",
"allowedVatDeviation": 0.01,
"terminalSlaveId": "Pad05",
"cashRegisterSerialNumber": "CR123456789",
"footerGraphicIndex": 5,
"auditLogEntryType": "other",
"amount": 0,
"identifier": "string",
"documentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentId": "S962-000001287",
"createDate": "2023-04-27T17:27:12+01:00",
"bookDate": "2023-04-27T17:27:12+01:00",
"accountingDate": "2023-04-27T17:27:12+01:00",
"processStartDate": "2023-04-27T17:27:12+01:00",
"documentNumber": "000001287",
"documentNumberSeries": "Kassenbelege",
"cancellationDocument": false,
"failedToPay": false,
"documentReference": {
"referenceType": "[0] = Cancellation",
"storeNumber": "Restaurant 03",
"terminalNumber": "002",
"documentType": "[0] = Receipt",
"documentNumber": "000000895",
"documentNumberSeries": "Kassenbelege",
"fiscalDocumentNumber": 0,
"documentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentId": "S962-000000895",
"documentBookDate": "2023-04-27T17:27:12+01:00",
"returnReasonType": "userMistake",
"returnReasonText": "Fehler passiert"
},
"isTraining": true,
"testCaseNumber": "string",
"documentType": "[0] = Receipt",
"documentTypeCaption": "Verkaufsbeleg",
"user": {
"id": "03",
"caption": "Bedienung 03",
"firstName": "Franz",
"lastName": "Österreicher",
"taxNumber": "123456789",
"dateOfEntry": "2022-10-01T08:00:00+01:00"
},
"salesPerson": {
"id": "04",
"caption": "Kassier 04",
"firstName": "Sandra",
"lastName": "Hurtig",
"taxNumber": "987654321",
"dateOfEntry": "2022-10-01T08:00:00+01:00"
},
"allocationGroups": [
"Tisch 127"
],
"partner": {
"id": "ABC1234567",
"caption": "Kunde",
"isBusiness": false,
"partnerType": "[0] = Customer",
"partnerClassification": "Privatkunde",
"vatNumber": "n.a.",
"taxNumber": "n.a.",
"identificationType": "passport",
"partnerIdentification": "ABC1234567",
"addressType": "BillingAddress",
"additionalIdentifications": {
"lotteryId": "1234567",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"street": "Musterstraße",
"streetNumber": "186",
"postalCode": "1010",
"city": "Wien",
"community": "n.a.",
"countryCode": "AT"
},
"notes": "Anmerkungen",
"customerCount": 1,
"paymentTerms": {
"dueDateDays": 0,
"discount": 0,
"discountDueDays": 0,
"latePaymentPenaltyRate": 0
},
"servicePeriodStart": "2023-04-27T17:27:12+01:00",
"servicePeriodEnd": "2023-04-27T17:27:12+01:00",
"positionCount": 1,
"documentIssueType": "paper",
"coupon": {
"header": [
{
"text": "string",
"barcodeType": "QrCode",
"barcode": "https://retailforce.cloud"
}
],
"grafic": "string",
"footer": [
{
"text": "string",
"barcodeType": "QrCode",
"barcode": "https://retailforce.cloud"
}
]
},
"serviceType": "string",
"isEcommerceTransaction": true,
"taxPositions": [
{
"vatIdentification": 0,
"vatLabel": "string",
"vatPercent1": 0,
"vatPercent2": 0,
"vatAmount": 0,
"vatAmount2": 0,
"netAmount": 0,
"grossAmount": 0
}
],
"fiscalResponse": {
"fiscalCountry": "[1] = Austria",
"certificationType": "string",
"fiscalisationType": "string",
"supportedPlatformTypes": "string",
"overpaymentNotAllowed": "boolean",
"documentTypeBusinessTransactionTypeSupport": "string",
"fiscalDocumentNumber": "0",
"taxPositions": [
{
"vatIdentification": 0,
"vatLabel": "string",
"vatPercent1": 0,
"vatPercent2": 0,
"vatAmount": 0,
"vatAmount2": 0,
"netAmount": 0,
"grossAmount": 0
}
],
"fiscalDocumentStartTime": 0,
"processStartTime": 0,
"errorDescription": "string",
"cashRegisterId": "string",
"signature": "string",
"userMessage": "string",
"printMessage": "string",
"requestTime": "2023-04-27T17:27:12+01:00",
"requestCompletionTime": "2023-04-27T17:27:12+01:00",
"qrCode": "string",
"printingFields": {},
"AdditionalFields": {}
},
"fiscalDocumentNumber": 0,
"fiscalDocumentRevision": 0,
"FiscalDocumentStartTime": 0,
"positions": [
{
"positionNumber": 0,
"positionReference": {
"positionNumber": 0,
"referenceType": "[0] = Cancellation",
"storeNumber": "string",
"terminalNumber": "string",
"documentType": "[0] = Receipt",
"documentNumber": "string",
"documentNumberSeries": "string",
"fiscalDocumentNumber": 0,
"documentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentId": "string",
"documentBookDate": "2023-04-27T17:27:12+01:00",
"returnReasonType": "userMistake",
"returnReasonText": "string"
},
"cancellationPosition": true,
"deletedPosition": false,
"type": "[0] = Item",
"itemCaption": "Sample Item",
"itemId": "ITEM-001",
"itemType": "[0] = Article",
"quantity": 1.0,
"quantityUnit": { "id": "Stk" },
"businessTransactionType": "[0] = Revenue",
"netValue": 10.0,
"grossValue": 12.0,
"taxValue": 2.0,
"ItemDateOfEntry": "2021-08-08T12:00:00+01:00",
"additionalFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"createDate": "2023-04-27T17:27:12+01:00",
"externalIdentifier": [
"string"
],
"user": {
"id": "string",
"caption": "string",
"firstName": "string",
"lastName": "string",
"taxNumber": "string",
"dateOfEntry": "2021-08-08T12:00:00+01:00"
},
"salesPerson": {
"id": "string",
"caption": "string",
"firstName": "string",
"lastName": "string",
"taxNumber": "string",
"dateOfEntry": "2021-08-08T12:00:00+01:00"
},
"FiscalAdditionalFields": {}
}
],
"payments": [
{
"amount": 12.0,
"currencyIsoCode": "EUR",
"caption": "string",
"uniqueReadablePaymentIdentifier": "string",
"foreignAmount": 0,
"foreignAmountExchangeRate": 0,
"additionalFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"paymentType": "creditCard",
"createDate": "2023-04-27T17:27:12+01:00",
"vatIdentification": 0,
"vatPercent": 0,
"taxValue": 0,
"externalIdentifier": [
"string"
],
"user": {
"id": "string",
"caption": "string",
"firstName": "string",
"lastName": "string",
"taxNumber": "string",
"dateOfEntry": "2021-08-08T12:00:00+01:00"
},
"salesPerson": {
"id": "string",
"caption": "string",
"firstName": "string",
"lastName": "string",
"taxNumber": "string",
"dateOfEntry": "2021-08-08T12:00:00+01:00"
},
"paymentTerminalReferenceId": "string",
"cardData": {
"receiptCopyCount": 0,
"receipt": [
"string"
],
"cardNumberMasked": "string",
"identificationToken": "string",
"merchantCopyCount": 0,
"merchantReceipt": [
"string"
],
"cardType": "VISA",
"authorizationCode": "AUTH123",
"terminalId": "TERM-A1",
"merchantId": "MERCH-B2",
"transactionId": "TRANS-C3",
"providerSignature": "string",
"providerTransactionId": "string",
"providerSignatureMessage": "string",
"transactionDate": "2023-04-27T17:27:12+01:00",
"transactionNumber": "string"
}
}
],
"additionalHeader": [
"string"
],
"additionalFooter": [
"string"
],
"FiscalAdditionalFields": {}
}„Header“ objekte pateikiama ši informacija.
Informacija stulpelyje „Type“:
- M ... privaloma („mandatory“)
- M* ... privaloma tam tikrose šalyse arba tam tikromis sąlygomis
- R ... rekomenduojama („rekomenduojama“)
- O ... neprivaloma
| Elementas | Tipas | Aprašymas | |
| uniqueClientId | M | Unikalus kliento ID, atitinkantis terminalo ID „RetailForce Cloud“ sistemoje (grąžinamas/priskiriamas paleidimo metu naudojant PUT /api/v1/management/clients/byCloud). | |
| applicationVersion | R/M* |
Kasinės programinės įrangos versija.
Dėmesio:
Atkreipkite dėmesį, kad kai kuriose šalyse (Prancūzijoje) versijos numeris yra fiksuotas kaip sertifikavimo proceso dalis. Jei nurodytas neteisingas versijos numeris (neatitinkantis sertifikuoto numerio), neįmanoma užbaigti dokumento (=klaida). Taip pat žr.: Sertifikuota versija
.
Informacija apie šalis:
|
|
| ApplicationVersionId | R/M* |
Kasinės programinės įrangos versijos ID. Informacija apie šalį:
|
|
| ApplicationVersionPrevious | R/M* |
Ankstesnės kasos programinės įrangos versijos ID. Šalies informacija:
|
|
| FiscalModuleVersion | O/M* | Fiskalinio modulio (patikimo fiskalinio modulio), naudoto atitinkamam dokumentui sukurti, versija. Jei programinė įranga jos neperduoda, ją automatiškai nustato middleware. | |
| FiscalCountryModuleVersion | O/M* | Šalies modulio (patikimo fiskalinio šalies modulio), naudoto atitinkamam dokumentui sukurti, versija. Jei programinė įranga jos neperduoda, ją automatiškai nustato middleware. | |
| FiscalisationType | O | ||
| parašas | O | Parašas | |
| fiskalinis spausdintuvas | Fiskalinis spausdintuvas | ||
| internetas | Internetinis | ||
| parašas su internetiniu ryšiu | Parašas su internetiniu ryšiu | ||
| be fiskalinės funkcijos | Be fiskalizacijos | ||
| Fiskalizacijos tipas Italija | O | ||
| spausdintuvas | O | Telematinis registratorius | |
| retailForceReceiptId | O | Visuotinai unikalus kvito numeris (susidedantis iš „terminalId“ ir kvito eilės numerio). Gali būti sukurtas kuriant sandorį (naudojant „createDocument“). | |
| AdditionalFields | O | ||
| additionalProp1-x | O | ||
| automaticVatCalculation | O |
Šis elementas suaktyvina įvairių sumų laukų automatinį skaičiavimą pozicijos lygiu. 0 noCalculation – automatinis skaičiavimas nevyksta 1 netValueCalculation – automatinis grynosios sumos ir PVM sumos apskaičiavimas. Būtina nurodyti bent jau bendrąją sumą ir PVM procentą arba identifikatorių. 2 grossValueCalculation – automatinis bendrosios sumos ir mokesčio sumos apskaičiavimas. Būtina nurodyti bent jau grynąją vertę ir Vat procentą arba identifikatorių. |
|
| AllowedVatDeviation | O |
Gali būti naudojamas Vat skaičiavimo apvalinimo problemoms kompensuoti. Naudokite atsargiai! Jei nustatoma didelė vertė, Vat skaičiavimo patikrinimas išjungiamas! Pavyzdys: „AllowedVatDeviation“: 0,05, leidžia 5 centų nuokrypį tarp grynosios vertės + mokesčio vertės = bendrosios vertės (+-0,05) |
|
| TerminalSlaveId | O | Įvesties terminalo ID nurodymas. | |
| cashRegisterSerialNumber | O |
Kasinės kasos įrenginio serijos numeris. Šis laukas identifikuoja konkretų fizinį kasinės kasos įrenginį, naudojamą sandoriui apdoroti. | |
| footerGraphicIndex | O |
Naudojant „footerGraphicIndex“, iš anksto apibrėžtas grafinis elementas įterpiamas į dokumento apačią. Informacija apie šalį:
|
|
| AuditLogEntryType | Nurodo audito žurnalo įrašo tipą, kai pats dokumentas yra audito žurnalo įrašas. | ||
| amount | Su dokumento header susijusi suma (pvz., audito žurnalo tikslais). | ||
| identifier | Bendrasis identifikavimo laukas (pvz., audito žurnalo tikslais). | ||
| DocumentGuid | M | Unikalus dokumento identifikatorius, naudojantis UUID / GUID. Taip pat naudojamas kaip nuoroda į skaitmeninius kvitus. | |
| DocumentId | M | Unikalus, eilinis dokumento (kvito) numeris filialo / dukterinės įmonės / restorano viduje (visose kasose), kurį priskiria kasos sistema (maks. 40 simbolių). | |
| CreateDate | M | Dokumento sukūrimo laikas | |
| BookDate | M | Užsakymo data | |
| AccountingDate | O | Galima šio dokumento įtraukimo į apskaitą data | |
| ProcessStartDate | R/M* | Pirmojo kvito sukūrimo laikas visame procese (pvz., Vokietija: pirmojo kliento užsakymo, susijusio su šiuo mokėjimo kvitu, sukūrimo laikas – žr. taip pat „Gastronomijos ypatumai“) | |
| DocumentNumber | R/M* | Unikalus, eilinis dokumento numeris (="kvito numeris“), kurį suteikia kasos sistema. | |
| documentNumberSeries | O/M* |
Kvitų numerių (DocumentNumber) serijos pavadinimas. Informacija apie šalį:
|
|
| cancellationDocument | M |
Flag, nurodanti, ar šis dokumentas naudojamas kitam (anksčiau išduotam) dokumentui panaikinti true – Anuliavimo dokumentas false – nėra anuliavimo dokumento |
|
| FailedToPay | O |
Boolean flag (true/false), nurodantis, ar nepavyko atlikti mokėjimo už dokumentą. |
|
| documentReference | O/M* | Naudojama norint nurodyti kitą dokumentą. | |
| {...} | |||
| IsTraining | O/M* | Flag, skirta pažymėti mokymo / demonstracinius dokumentus (sukurti kasos aparato mokymo / demonstraciniame režime). | |
| TestCaseNumber | O/M* |
Laukelis, skirtas nurodyti bandymo atvejo numerį sertifikavimo tikslais. Informacija apie šalis:
|
|
| documentType | O | Dokumento tipo nurodymas | |
| documentTypeCaption | M* |
Dokumento tipo aprašymas. Iš esmės skirtas išsamesniam aprašymui ar paaiškinimui. Informacija apie šalį:
|
|
| vartotojas | O/M* |
Informacija apie (kasos aparato) vartotoją. Šalies duomenys:
|
|
| {...} | |||
| SalesPerson | O/M* |
Informacija apie pardavimo personalą. Šalies duomenys:
|
|
| {...} | |||
| AllocationGroups [] | O/M* |
Naudojama kvitams priskirti konkretiems objektams (pvz., stalams gastronomijos srityje). Taip pat žr.: Ilgalaikis užsakymų apdorojimo procesas maitinimo įstaigose. Šalies duomenys:
|
|
| partneris | O/M* |
Informacija apie atitinkamus (verslo) partnerius, su kuriais bendradarbiauja dokumentą išduodanti įmonė. Šalies duomenys:
|
|
| addressType | (objekte partner objekte) Naujas neprivalomas laukas, skirtas nurodyti adreso tipą (pvz., sąskaitos faktūros adresą). |
||
| {...} | |||
| pastabos | O | Papildomų pastabų įrašymas | |
| CustomerCount | O/M* |
Su šiuo dokumentu susijusių klientų skaičius (pvz., gastronomijos srityje – svečių skaičius prie kasos ar prie stalo) Šalies duomenys:
|
|
| PaymentTerms | O | Mokėjimo sąlygos | |
| {...} | |||
| ServicePeriodStart | O |
Paslaugų teikimo laikotarpio pradžia (ypač sąskaitų faktūrų atveju) Šalies duomenys:
|
|
| ServicePeriodEnd | O |
Paslaugų teikimo laikotarpio pabaiga (ypač sąskaitų faktūrų atveju) Šalies duomenys:
|
|
| PositionCount | O/M* |
Kvitą sudarančių pozicijų skaičius (visos pozicijos, įskaitant prekę, tekstą, užsakymą, subTotal, total) Taip pat žr. Pozicijos objektas. Šalies duomenys:
|
|
| DocumentIssueType | O/M* |
Nurodo kvito išdavimo tipą.
Šalies duomenys:
|
|
| coupon | O | Galimybė ant kvito atspausdinti papildomus kuponus ir kitus elementus. | |
| {...} | |||
| serviceType | O/M* |
Paslaugos tipo nurodymas maitinimo srityje (aptarnavimas prie stalo, prie baro). Galimos reikšmės (reikia laikytis „CamelCase“ rašybos!)
Šalies duomenys:
|
|
| IsEcommerceTransaction | O/M* |
Nurodo, ar tai yra elektroninės prekybos sandoris (true / false). Šalies duomenys:
|
|
| TaxPositions | R |
Visų dokumente esančių Vat pozicijų nurodymas. Turi būti nurodytos visos Vat pozicijos arba nė viena. Norėdami gauti dokumento PVM pozicijas (kai ši savybė nebuvo nustatyta), naudokite GetTaxPositions(Document, boolean).
Pastaba Austrijai:
Rekomenduojame naudoti šį masyvą, norint perduoti kvito mokesčių pozicijas, kad būtų išvengta apvalinimo problemų duomenų įrašymo protokole („DEP7“).
|
|
| {...} | |||
| fiscalResponse | - |
Fiskalizacijos tarnybos atsakymas po perdavimo createDocument ir storeDocument. Rekomenduojame „fiscalResponse“ turinį išsaugoti kasos aparato duomenų bazėje.
Pastaba:
tam tikri „fiscalResponse“ objekto elementai, iškvietus funkciją „createDocument“
, turi būti įtraukti į JSON dokumentą (kuris turėtų būti siunčiamas į „storeDocument“
). Prašome NEįtraukti viso „fiscalResponse“ objekto!
|
|
| {...} | |||
| fiscalDocumentNumber | M* |
Fiskalinio dokumento numeris (priskirtas „RetailForce“ sistemai arba atitinkamam fiskalizacijos padalinio – pvz., TSE Vokietijoje)
Dėmesio:
Atkreipkite dėmesį, kad sistemose iki v1.7.7 informacija „fiscalDocumentNumber“ buvo grąžinama „fiscalResponse“ objekto lauke „fiscalisationDocumentNumber“. Taip pat žr. straipsnį: „Nurodyta operacija nepradėta
“. V1.7.7 versijoje „fiscalResponse“ objekte buvo įvestas papildomas laukas „fiscalDocumentNumber“ (string).
|
|
| fiscalDocumentRevision | O/M* |
Fiskalinio dokumento redagavimo numeris (priskirtas RetailForce system arba atitinkamo fiskalizacijos padalinio – pvz., TSE Vokietijoje)
Dėmesio:
Atkreipkite dėmesį, kad sistemose iki v1.7.7 „fiscalDocumentRevision“ buvo grąžinamas lauke „fiscalisationDocumentRevision“ objekto „fiscalResponse“ antraštėje. Žr. taip pat straipsnį: „Nurodyta operacija nepradėta
“. Nuo v1.7.7 versijos šis „fiscalResponse“ objekto savybės pavadinimas buvo pakeistas į „fiscalDocumentRevision“ ir dabar jis grąžinamas tik „fiscalResponse-Germany“ masyve „AdditionalFields“.
|
|
| fiscalDocumentStartTime | M* | Fiskalinio dokumento sukūrimo laikas (priskiriamas „RetailForce“ sistemos arba atitinkamo fiskalizacijos padalinio – pvz., TSE Vokietijoje) | |
| pozicijos | M | Informacija apie atitinkamą kvito / dokumento poziciją (turinys priklauso nuo dokumento ir pozicijos tipo – documentType, positionType) | |
| {...} | |||
| mokėjimai | O/M* | Informacija apie mokėjimą (naudojimas priklauso nuo dokumento tipo – documentType) | |
| {...} | |||
| AdditionalHeader | O |
Masyvą „AdditionalHeader“ galima naudoti norint nustatyti papildomas laisvo teksto eilutes dokumento antraštėje. Šalių informacija:
Pastaba: Šiuo metu šis masyvas palaikomas tik Italijoje. Jį galima užpildyti ir kitose šalyse, tačiau tai neturi jokio poveikio. |
|
| AdditionalFooter | O |
Masyvą „AdditionalFooter“ galima naudoti norint nustatyti papildomas laisvo teksto eilutes dokumento Footer apačioje. Informacija apie šalį:
Pastaba: Šiuo metu šis masyvas palaikomas tik Italijoje. Jį galima užpildyti ir kitose šalyse, tačiau tai neturi jokio poveikio. |
|
| FiscalAdditionalFields | O | ||
Šis straipsnis buvo išverstas automatiškai.
Komentarai
0 komentarų
Tam, kad paliktumėte komentarus prisijunkite