Tento článok sa zaoberá objektom Header („payments“) alebo prvkami v hlavičke v rámci objektu Document.
Úplný popis RetailForce DOM (Document Object Model), ako aj popis jednotlivých prvkov, nájdete v sekcii „Downloads“ na RetailForce website (Object model documentation.pdf) v príslušnom adresári verzií.
Objekt Header
{
"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": {}
}Objekt header obsahuje nasledujúce informácie.
Informácie v stĺpci „Type“:
- M ... povinné („mandatory“)
- M* ... povinné v určitých krajinách alebo za určitých podmienok
- R ... odporúčané („recommended“)
- O ... voliteľné
| Prvok | Typ | Popis | |
| uniqueClientId | M | Jedinečné ID klienta, zodpovedá ID terminálu v RetailForce Cloud (je vrátené/priradené počas uvedenia do prevádzky prostredníctvom PUT /api/v1/management/clients/byCloud). | |
| applicationVersion | R/M* |
Verzia softvéru pokladnice.
Upozornenie:
Vezmite prosím na vedomie, že v niektorých krajinách (napr. vo Francúzsku) je číslo verzie pevne stanovené v rámci certifikačného procesu. Ak je uvedené nesprávne číslo verzie (nezodpovedajúce certifikovanému číslu), nie je možné dokument dokončiť (=chyba). Pozrite si tiež: Certifikovaná verzia
.
Údaje o krajine:
|
|
| ApplicationVersionId | R/M* |
ID verzie softvéru pokladne. Údaje o krajine:
|
|
| ApplicationVersionPrevious | R/M* |
ID predchádzajúcej verzie softvéru pokladne. Údaje o krajine:
|
|
| FiscalModuleVersion | O/M* | Verzia fiškálneho modulu (dôveryhodného fiškálneho modulu) použitého na vygenerovanie príslušného dokladu. Ak ju softvér neprepošle, automaticky ju nastaví middleware. | |
| FiscalCountryModuleVersion | O/M* | Verzia krajinského modulu (dôveryhodný fiskálny krajinský modul) použitá na vygenerovanie príslušného dokumentu. Ak ju softvér neprepošle, automaticky ju nastaví middleware. | |
| FiscalisationType | O | ||
| signature | O | Podpis | |
| fiškálna tlačiareň | Fiskálna tlačiareň | ||
| online | Online | ||
| signatureWithOnline | Podpis s online pripojením | ||
| bez fiskalizácie | Bez zdanenia | ||
| Typ zdanenia Taliansko | O | ||
| tlačiareň | O | Telematický registračný prístroj | |
| retailForceReceiptId | O | Globálne jedinečné číslo potvrdenia (pozostávajúce z terminalId a poradového čísla potvrdenia). Môže byť vytvorené pri vytváraní transakcie (pomocou createDocument). | |
| AdditionalFields | O | ||
| additionalProp1-x | O | ||
| automaticVatCalculation | O |
Tento prvok spúšťa automatický výpočet rôznych súčtových polí na úrovni pozície. 0 noCalculation – neprebieha žiadny automatický výpočet 1 netValueCalculation – automatický výpočet čistej sumy a sumy Vat. Je potrebné zadať aspoň hrubú sumu a sadzbu Vat alebo identifikačný kód. 2 grossValueCalculation – automatický výpočet hrubej sumy a sumy dane. Je potrebné zadať aspoň čistú hodnotu a sadzbu Vat alebo identifikačný kód. |
|
| AllowedVatDeviation | O |
Môže sa použiť na kompenzáciu zaokrúhľovacích chýb pri výpočte Vat. Používajte s opatrnosťou! Ak je nastavená vysoká hodnota, kontrola výpočtu Vat je deaktivovaná! Príklad: „AllowedVatDeviation“: 0,05, umožňuje odchýlku 5 centov medzi čistou hodnotou + hodnotou dane = hrubou hodnotou (+-0,05) |
|
| TerminalSlaveId | O | Špecifikácia ID vstupného terminálu. | |
| cashRegisterSerialNumber | O |
Sériové číslo pokladničného zariadenia. Toto pole identifikuje konkrétne fyzické pokladničné zariadenie použité na spracovanie transakcie. | |
| footerGraphicIndex | O |
Prostredníctvom footerGraphicIndex sa do päty dokumentu umiestni preddefinovaný grafický prvok. Údaje o krajine:
|
|
| AuditLogEntryType | Určuje typ záznamu v audítorskom protokole, ak je samotný dokument záznamom v audítorskom protokole. | ||
| amount | Suma spojená s headerem dokumentu (napr. na účely audítorského protokolu). | ||
| identifier | Všeobecné identifikačné pole (napr. na účely audítorského protokolu). | ||
| DocumentGuid | M | Jedinečný identifikátor dokumentu pomocou UUID / GUID. Používa sa aj ako odkaz na digitálne potvrdenky. | |
| DocumentId | M | Jedinečné, poradové číslo dokumentu (potvrdenia) v rámci pobočky / dcérskej spoločnosti / reštaurácie (vo všetkých pokladniach), pridelené pokladničným systémom (max. 40 znakov). | |
| CreateDate | M | Čas vytvorenia dokumentu | |
| BookDate | M | Čas rezervácie | |
| AccountingDate | O | Možný dátum zaúčtovania tohto dokladu | |
| ProcessStartDate | R/M* | Čas vytvorenia prvého príjmu v rámci celého procesu (napr. Nemecko: Čas vytvorenia prvej zákazky zákazníka v súvislosti s daným príjmom platby – pozri tiež „Špeciálne funkcie pre gastronómiu“) | |
| DocumentNumber | R/M* | Jedinečné, poradové číslo dokumentu (="číslo potvrdenia“), pridelené pokladničným systémom. | |
| documentNumberSeries | O/M* |
Názov číselnej série čísla dokladu (DocumentNumber). Informácie o krajine:
|
|
| cancellationDocument | M |
Flag, či sa tento dokument používa na zrušenie iného (predtým vydaného) dokumentu true – Dokument o zrušení false – Žiadny dokument o zrušení |
|
| FailedToPay | O |
Booleovský flag (true/false), ktorý označuje, či platba za dokument zlyhala. |
|
| documentReference | O/M* | Používa sa na odkazovanie na iný dokument. | |
| {...} | |||
| IsTraining | O/M* | Flag na označenie školiacich/ukážkových dokumentov (vygenerovaných v školiacom/ukážkovom režime pokladne). | |
| TestCaseNumber | O/M* |
Pole na zadanie čísla testovacieho prípadu na účely certifikácie. Údaje o krajine:
|
|
| documentType | O | Špecifikácia typu dokumentu | |
| documentTypeCaption | M* |
Popis typu dokumentu. Slúži v podstate na lepší popis alebo objasnenie. Údaje o krajine:
|
|
| užívateľ | O/M* |
Informácie o používateľovi (pokladne). Údaje o krajine:
|
|
| {...} | |||
| SalesPerson | O/M* |
Informácie o predajnom personáli. Údaje o krajine:
|
|
| {...} | |||
| AllocationGroups [] | O/M* |
Používa sa na priradenie príjmov ku konkrétnym položkám (napr. stoly v gastronómii). Pozri tiež: Dlhodobý proces objednávania v gastronómii. Podrobnosti o krajine:
|
|
| partner | O/M* |
Informácie o príslušných (obchodných) partneroch spoločnosti, ktorá dokument vystavila. Údaje o krajine:
|
|
| addressType | (v partner objekte) Nové voliteľné pole na špecifikovanie typu adresy (napr. fakturačná adresa). |
||
| {...} | |||
| poznámky | O | Zaznamenávanie dodatočných poznámok | |
| CustomerCount | O/M* |
Počet zákazníkov týkajúcich sa tohto dokumentu (napr. v gastronómii počet hostí pri pokladni/stole) Údaje o krajine:
|
|
| PaymentTerms | O | Platobné podmienky | |
| {...} | |||
| ServicePeriodStart | O |
Začiatok obdobia poskytovania služby (najmä pre faktúry) Údaje o krajine:
|
|
| ServicePeriodEnd | O |
Koniec obdobia poskytovania služby (najmä v prípade faktúr) Údaje o krajine:
|
|
| PositionCount | O/M* |
Počet položiek obsiahnutých v doklade (všetky položky, vrátane položky, textu, rezervácie, čiastkovej sumy, celkovej sumy) Pozri tiež Objekt položky. Podrobnosti o krajine:
|
|
| DocumentIssueType | O/M* |
Určuje typ vydania potvrdenia.
Údaje o krajine:
|
|
| coupon | O | Možnosť vytlačiť na potvrdenku dodatočné kupóny a ďalšie prvky. | |
| {...} | |||
| serviceType | O/M* |
Špecifikácia typu služby v gastronómii (obsluha pri stole, obsluha pri pulte). Možné hodnoty (dodržiavajte CamelCase!)
Údaje o krajine:
|
|
| IsEcommerceTransaction | O/M* |
Údaj o tom, či ide o transakciu v rámci elektronického obchodu (true / false). Údaje o krajine:
|
|
| TaxPositions | R |
Špecifikácia všetkých položiek Vat v dokumente. Je potrebné špecifikovať buď všetky, alebo žiadne pozície Vat. Na získanie daňových pozícií z dokumentu (ak nebola táto vlastnosť nastavená) použite GetTaxPositions(Document, boolean).
Poznámka pre Rakúsko:
Odporúčame použiť toto pole na odosielanie daňových položiek z dokladu, aby sa predišlo problémom so zaokrúhľovaním v rámci protokolu zaznamenávania údajov („DEP7“).
|
|
| {...} | |||
| fiscalResponse | - |
Odpoveď služby fiskalizácie po odoslaní metód createDocument a storeDocument. Odporúčame uložiť obsah fiscalResponse do databázy pokladne.
Poznámka:
Niektoré prvky objektu fiscalResponse musia byť po volaní funkcie createDocument
zahrnuté v dokumente JSON (ktorý by mal byť odoslaný do funkcie storeDocument
). Nezahrňujte, prosím, celý objekt fiscalResponse!
|
|
| {...} | |||
| fiscalDocumentNumber | M* |
Číslo fiskálneho dokladu (pridelené systémom RetailForce alebo príslušnou fiskalizačnou jednotkou – napr. TSE v Nemecku)
Upozornenie:
V systémoch do verzie v1.7.7 bola informácia fiscalDocumentNumber vrátená v poli fiscalisation
DocumentNumber objektu fiscalResponse. Pozrite si tiež článok: „Daná transakcia nebola spustená
“. Vo verzii v1.7.7 bolo do objektu fiscalResponse zavedené dodatočné pole fiscalDocumentNumber (string).
|
|
| fiscalDocumentRevision | O/M* |
Číslo revízie daňového dokladu (pridelené RetailForce systemom alebo príslušnou daňovou jednotkou – napr. TSE v Nemecku)
Upozornenie:
V systémoch do verzie v1.7.7 sa fiscalDocumentRevision vracalo v poli fiscalisation
DocumentRevision v header objektu fiscalResponse. Pozrite si tiež článok: „Daná transakcia nebola spustená
“. Od verzie v1.7.7 bola táto vlastnosť v rámci objektu fiscalResponse premenovaná na fiscalDocumentRevision a teraz sa vracia iba v poli AdditionalFields objektu fiscalResponse-Germany.
|
|
| fiscalDocumentStartTime | M* | Čas vytvorenia daňového dokladu (priradený RetailForce systemom alebo príslušnou daňovou jednotkou – napr. TSE v Nemecku) | |
| pozície | M | Informácie o príslušnej položke pokladničného dokladu / dokumentu (obsah závisí od typu dokumentu a položky – documentType, positionType) | |
| {...} | |||
| platby | O/M* | Informácie o platbe (použitie závisí od typu dokumentu – documentType) | |
| {...} | |||
| AdditionalHeader | O |
Pole AdditionalHeader možno použiť na nastavenie dodatočných riadkov voľného textu v hlavičke dokumentu. Podrobnosti o krajine:
Poznámka: V súčasnosti je toto pole podporované len v Taliansku. Je možné ho vyplniť aj v iných krajinách, ale nemá žiadny účinok. |
|
| AdditionalFooter | O |
AdditionalFooter možno použiť na nastavenie ďalších riadkov s voľným textom v Footeru dokumentu. Podrobnosti pre jednotlivé krajiny:
Poznámka: V súčasnosti je toto pole podporované len v Taliansku. Je možné ho vyplniť aj v iných krajinách, ale nemá žiadny účinok. |
|
| FiscalAdditionalFields | O | ||
Tento článok bol preložený automaticky.
Príspevky
0 komentárov
Ak chcete napísať komentár, prihlásiť sa.