Ez a cikk a Header objektumot („payments”), illetve a Document objektumon belüli Header elemeit tárgyalja.
A RetailForce DOM (Document Object Model) teljes leírása, valamint az egyes elemek leírása a RetailForce website Letöltések szakaszában (Object model documentation.pdf) található a megfelelő verzió könyvtárában.
Header objektum
{
"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": {}
}A header objektum a következő információkat tartalmazza.
A „Type” oszlopban szereplő információk:
- M ... kötelező („mandatory”)
- M* ... bizonyos országokban vagy bizonyos feltételek mellett kötelező
- R ... ajánlott („ajánlott”)
- O ... opcionális
| Elem | Típus | Leírás | |
| uniqueClientId | M | Az ügyfél egyedi ID-je, amely megfelel a RetailForce Cloud terminal-azonosítójának (az üzembe helyezés során a PUT /api/v1/management/clients/byCloud parancs segítségével kerül visszaadásra/hozzárendelésre). | |
| applicationVersion | R/M* |
A pénztárgép szoftver verziója.
Figyelem:
Kérjük, vegye figyelembe, hogy egyes országokban (pl. Franciaországban) a verziószám a tanúsítási folyamat részeként rögzített. Ha helytelen verziószámot ad meg (amely nem felel meg a tanúsított számnak), a dokumentum kitöltése nem lehetséges (=hiba). Kérjük, olvassa el még: Tanúsított verzió
.
Országspecifikus részletek:
|
|
| ApplicationVersionId | R/M* |
A pénztárgép-szoftver verziójának ID-je. Országadatok:
|
|
| ApplicationVersionPrevious | R/M* |
Az előző pénztárgép-szoftver verzió ID-ja. Országadatok:
|
|
| FiscalModuleVersion | O/M* | A vonatkozó dokumentum létrehozásához használt adómodul (megbízható adómodul) verziója. Ha a szoftver nem továbbítja, a middleware automatikusan állítja be. | |
| FiscalCountryModuleVersion | O/M* | Az adott dokumentum létrehozásához használt országmodul (megbízható fiskális országmodul) verziója. Ha a szoftver nem továbbítja, a middleware automatikusan állítja be. | |
| FiscalisationType | O | ||
| aláírás | O | Aláírás | |
| fiscalPrinter | Fiskális nyomtató | ||
| online | Online | ||
| online_aláírás | Aláírás online kapcsolattal | ||
| noFiscalisation | Nincs adóügyi nyilvántartás | ||
| FiscalisationTypeItaly | O | ||
| nyomtató | O | Telematikus nyilvántartó | |
| retailForceReceiptId | O | Globálisan egyedi nyugta-szám (a terminalId-ből és a nyugta sorszámából áll). Tranzakció létrehozásakor hozható létre (a createDocument paranccsal). | |
| AdditionalFields | O | ||
| additionalProp1-x | O | ||
| automaticVatCalculation | O |
Ez az elem elindítja a különböző összegmezők automatikus kiszámítását pozíciószinten. 0 noCalculation – nem történik automatikus kiszámítás 1 netValueCalculation – a nettó összeg és az áfa-összeg automatikus kiszámítása. Legalább a bruttó összeget és az áfa-százalékot/azonosítót meg kell adni. 2 grossValueCalculation – a bruttó összeg és az adóösszeg automatikus kiszámítása. Legalább a nettó értéket és a Vat-százalékot/azonosítót meg kell adni. |
|
| AllowedVatDeviation | O |
A Vat-számítás során felmerülő kerekítési problémák kompenzálására használható. Kérjük, óvatosan használja! Ha magas értékre állítja be, a Vat-számítás ellenőrzése le van tiltva! Példa: „AllowedVatDeviation”: 0,05, 5 cent eltérést engedélyez a nettó érték + adóösszeg = bruttó érték között (+-0,05) |
|
| TerminalSlaveId | O | A bemeneti terminal ID-jének megadása. | |
| cashRegisterSerialNumber | O |
A pénztárgép sorozatszáma. Ez a mező azonosítja a tranzakció feldolgozásához használt konkrét fizikai pénztárgép hardvert. | |
| footerGraphicIndex | O |
A footerGraphicIndex segítségével egy előre meghatározott grafikai elem kerül elhelyezésre a dokumentum láblécében. Országspecifikus adatok:
|
|
| AuditLogEntryType | Meghatározza az ellenőrzési naplóbejegyzés típusát, amikor maga a dokumentum egy ellenőrzési naplóbejegyzés. | ||
| amount | A dokumentum headeréhez társított összeg (pl. auditnapló-célokra). | ||
| identifier | Általános azonosító mező (pl. auditnapló-célokra). | ||
| DocumentGuid | M | A dokumentum egyedi azonosítója UUID / GUID formátumban. Digitális nyugtákhoz is használható hivatkozásként. | |
| DocumentId | M | A dokumentum (nyugta) egyedi, sorszámozott száma a fiókban / leányvállalatnál / étteremben (az összes pénztárgépet figyelembe véve), amelyet a pénztárgép-rendszer rendel hozzá (max. 40 karakter). | |
| CreateDate | M | A dokumentum létrehozásának időpontja | |
| BookDate | M | Foglalás időpontja | |
| AccountingDate | O | A dokumentum könyvelésbe vételének lehetséges dátuma | |
| ProcessStartDate | R/M* | Az első bizonylat létrehozásának időpontja a teljes folyamaton belül (pl. Németország: az első, a jelen fizetési bizonylathoz kapcsolódó vevői megrendelés létrehozásának időpontja – lásd még: „Különlegességek a vendéglátásban”) | |
| DocumentNumber | R/M* | A dokumentum egyedi, sorszámozott száma (="nyugta száma”), amelyet a pénztárgép-rendszer rendel hozzá. | |
| documentNumberSeries | O/M* |
A nyugta számának (DocumentNumber) számsorozatának neve. Országspecifikus részletek:
|
|
| cancellationDocument | M |
Flag, hogy a jelen dokumentum egy másik (korábban kiállított) dokumentum törlésére szolgál-e true – Törlési dokumentum false – Nincs érvénytelenítő dokumentum |
|
| FailedToPay | O |
Egy boolean flag (true/false), amely jelzi, hogy a dokumentumhoz tartozó fizetés sikertelen volt-e. |
|
| documentReference | O/M* | Egy másik dokumentum hivatkozására szolgál. | |
| {...} | |||
| IsTraining | O/M* | A képzési/bemutató dokumentumok megjelölésére szolgáló flag (a pénztárgép képzési/bemutató módjában generálva). | |
| TestCaseNumber | O/M* |
A tanúsítási célokra szolgáló teszteset-szám megadására szolgáló mező. Országspecifikus részletek:
|
|
| documentType | O | A dokumentumtípus megadása | |
| documentTypeCaption | M* |
A dokumentumtípus leírása. Elsősorban a pontosabb leírás vagy tisztázás célját szolgálja. Országspecifikus adatok:
|
|
| felhasználó | O/M* |
A (pénztárgép) felhasználójára vonatkozó információk. Országadatok:
|
|
| {...} | |||
| SalesPerson | O/M* |
Az értékesítő személyzetre vonatkozó információk. Országadatok:
|
|
| {...} | |||
| AllocationGroups [] | O/M* |
A nyugták konkrét tárgyakhoz (pl. asztalok a vendéglátásban) történő hozzárendelésére szolgál. Lásd még: Hosszú távú rendelési folyamat a vendéglátásban. Országspecifikus részletek:
|
|
| partner | O/M* |
Információk a dokumentumot kiállító vállalat megfelelő (üzleti) partnereiről. Országspecifikus adatok:
|
|
| addressType | (az partner objektumban) Új, opcionális mező a címtípus (pl. számlázási cím) megadásához. |
||
| {...} | |||
| megjegyzések | O | További megjegyzések rögzítése | |
| CustomerCount | O/M* |
A dokumentumhoz tartozó ügyfélszám (pl. a vendéglátásban a pénztárnál/asztalnál lévő vendégek száma) Országadatok:
|
|
| PaymentTerms | O | Fizetési feltételek / fizetési feltételek | |
| {...} | |||
| ServicePeriodStart | O |
A szolgáltatási időszak kezdete (különösen a számlák esetében) Országspecifikus adatok:
|
|
| ServicePeriodEnd | O |
A szolgáltatási időszak vége (különösen a számlák esetében) Országspecifikus adatok:
|
|
| PositionCount | O/M* |
A bizonylatban szereplő tételek száma (minden tétel, beleértve a tételt, a szöveget, a könyvelést, az alösszeget és a végösszeget) Lásd még: Pozíció objektum. Országspecifikus részletek:
|
|
| DocumentIssueType | O/M* |
Meghatározza a nyugta kiállításának típusát.
Országadatok:
|
|
| coupon | O | Lehetőség további couponok és egyéb elemek nyomtatására a nyugtán. | |
| {...} | |||
| serviceType | O/M* |
A vendéglátásban alkalmazott szolgáltatástípus megadása (asztali, pulti kiszolgálás). Lehetséges értékek (CamelCase írásmódot be kell tartani!)
Országadatok:
|
|
| IsEcommerceTransaction | O/M* |
Jelzi, hogy e-kereskedelmi tranzakcióról van-e szó (true / hamis). Országadatok:
|
|
| TaxPositions | R |
A dokumentum összes Vat-pozíciójának megadása. Vagy az összes, vagy egyáltalán nincs Vat-pozíció megadása szükséges. A dokumentumból származó adópozíciók lekéréséhez (ha ez a tulajdonság nincs beállítva) használja a GetTaxPositions(Document, boolean) függvényt.
Megjegyzés Ausztria:
Javasoljuk ennek a tömbnek a használatát a nyugta adópozícióinak továbbításához, hogy elkerüljük a kerekítési problémákat az adatrögzítési protokollban („DEP7”).
|
|
| {...} | |||
| fiscalResponse | - |
A fiskalizációs szolgáltatás válasza a createDocument és a storeDocument műveletek továbbítása után. Javasoljuk a fiscalResponse tartalmának tárolását a pénztárgép adatbázisában.
Megjegyzés:
a fiscalResponse objektum bizonyos elemeit a createDocument
függvény meghívása után be kell építeni a JSON-dokumentumba (amelyet a storeDocument
-nek kell elküldeni). Kérjük, NE építse be a teljes fiscalResponse objektumot!
|
|
| {...} | |||
| fiscalDocumentNumber | M* |
Fiskális dokumentumszám (amelyet a RetailForce system vagy az illetékes fiskalizációs egység – pl. Németországban a TSE – rendel hozzá)
Figyelem:
Kérjük, vegye figyelembe, hogy a v1.7.7-es verzióig terjedő rendszerekben a fiscalDocumentNumber információt a fiscalResponse objektum fiscalisation
DocumentNumber mezőjében adták vissza. Lásd még a „A megadott tranzakció nem indult el
” című cikket. A v1.7.7-es verzióban egy további fiscalDocumentNumber (string) mező került bevezetésre a fiscalResponse objektumban.
|
|
| fiscalDocumentRevision | O/M* |
Az adóügyi dokumentum revíziós száma (amelyet a RetailForce system vagy az illetékes adóügyi hatóság – pl. Németországban a TSE – rendel hozzá)
Figyelem:
Kérjük, vegye figyelembe, hogy a v1.7.7-ig terjedő verziókban a fiscalDocumentRevision értéket a fiscalResponse headerben található fiscalisation
DocumentRevision mezőben adták vissza. Lásd még a „Megadott tranzakció nem indult el
” című cikket. A v1.7.7-től kezdve a fiscalResponse objektumon belüli tulajdonság nevét fiscalDocumentRevision-re változtatták, és mostantól kizárólag a fiscalResponse-Germany AdditionalFields tömbjében kerül visszaadásra.
|
|
| fiscalDocumentStartTime | M* | Az adóügyi dokumentum létrehozásának időpontja (amelyet a RetailForce system vagy az illetékes adóügyi hatóság – pl. Németországban a TSE – rendel hozzá) | |
| pozíciók | M | Információk az adott bizonylat/bizonylati tételről (a tartalom a bizonylat és a tétel típusától függ – documentType, positionType) | |
| {...} | |||
| fizetések | O/M* | A kifizetéssel kapcsolatos információk (a használat a dokumentum típusától függ – documentType) | |
| {...} | |||
| AdditionalHeader | O |
Az AdditionalHeader tömb segítségével további szabad szövegsorok állíthatók be a dokumentum fejlécében. Országspecifikus részletek:
Megjegyzés: Jelenleg ezt a tömböt csak Olaszországban támogatja a rendszer. Más országokban is kitölthető, de nincs hatása. |
|
| AdditionalFooter | O |
Az AdditionalFooter tömb segítségével további szabad szövegsorok állíthatók be a dokumentum Footer-ében. Országspecifikus részletek:
Megjegyzés: Jelenleg ezt a tömböt csak Olaszországban támogatják. Más országokban is kitölthető, de nincs hatása. |
|
| FiscalAdditionalFields | O | ||
Ezt a cikket automatikusan lefordították.
Hozzászólások
0 hozzászólás
Hozzászólások írásához jelentkezzen be.