Tento článek se zabývá objektem Header („payments“) neboli prvky v objektu Header v rámci objektu Document.
Úplný popis DOM (Document Object Model) RetailForce, stejně jako popis jednotlivých prvků, najdete v sekci „Downloads“ na webových stránkách RetailForce (Object model documentation.pdf) v příslušném adresáři s verzemi.
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 následující informace.
Informace ve sloupci „Type“:
- M ... povinné („mandatory“)
- M* ... povinné v určitých zemích nebo za určitých podmínek
- R ... doporučeno („doporučeno“)
- O ... volitelné
| Prvek | Typ | Popis | |
| uniqueClientId | M | Jedinečné ID klienta, odpovídá ID terminálu v RetailForce Cloud (je vráceno/přiřazeno během uvedení do provozu pomocí PUT /api/v1/management/clients/byCloud). | |
| applicationVersion | R/M* |
Verze softwaru pokladny.
Upozornění:
Vezměte prosím na vědomí, že v některých zemích (např. ve Francii) je číslo verze pevně stanoveno v rámci certifikačního procesu. Pokud je zadáno nesprávné číslo verze (nekorespondující s certifikovaným číslem), není možné dokument dokončit (= chyba). Viz také: Certifikovaná verze
.
Údaje o zemi:
|
|
| ApplicationVersionId | R/M* |
ID verze softwaru pokladny. Údaje o zemi:
|
|
| ApplicationVersionPrevious | R/M* |
ID předchozí verze softwaru pokladny. Údaje o zemi:
|
|
| fiscalModuleVersion | O/M* | Verze fiskálního modulu (důvěryhodného fiskálního modulu) použitého k vygenerování příslušného dokladu. Pokud není předána softwarem, nastaví ji automaticky middleware. | |
| FiscalCountryModuleVersion | O/M* | Verze národního modulu (Trusted Fiscal Country Module) použitého k vygenerování příslušného dokumentu. Pokud není předána softwarem, nastaví ji automaticky middleware. | |
| FiscalisationType | O | ||
| signature | O | Podpis | |
| fiskální tiskárna | Fiskální tiskárna | ||
| online | Online | ||
| signatureWithOnline | Podpis s připojením k internetu | ||
| bez fiskalizace | Bez fiskalizace | ||
| Typ fiskalizace Itálie | O | ||
| tiskárna | O | Telematický pokladní systém | |
| retailForceReceiptId | O | Globálně jedinečné číslo účtenky (složené z terminalId a pořadového čísla účtenky). Lze vytvořit při vytváření transakce (pomocí createDocument). | |
| AdditionalFields | O | ||
| additionalProp1-x | O | ||
| automatický výpočet DPH | O |
Tento prvek spouští automatický výpočet různých součtových polí na úrovni pozice. 0 noCalculation – nedochází k žádnému automatickému výpočtu 1 netValueCalculation – automatický výpočet čisté částky a částky Vat. Je nutné zadat alespoň hrubou částku a sazbu Vat nebo identifikační číslo. 2 grossValueCalculation – automatický výpočet hrubé částky a částky daně. Je nutné zadat alespoň čistou hodnotu a sazbu Vat nebo identifikační číslo. |
|
| AllowedVatDeviation | O |
Lze použít k vyrovnání zaokrouhlovacích odchylek při výpočtu Vat. Používejte s opatrností! Pokud je nastavena vysoká hodnota, kontrola výpočtu Vat je deaktivována! Příklad: „AllowedVatDeviation“: 0,05, umožňuje odchylku 5 centů mezi čistou hodnotou + částkou daně = hrubou hodnotou (+-0,05) |
|
| TerminalSlaveId | O | Specifikace ID vstupního terminálu. | |
| cashRegisterSerialNumber | O |
Sériové číslo pokladního zařízení. Toto pole identifikuje konkrétní fyzické pokladní zařízení použité ke zpracování transakce. | |
| footerGraphicIndex | O |
Pomocí pole FooterGraphicIndex se do zápatí dokumentu vloží předdefinovaný grafický prvek. Údaje o zemi:
|
|
| AuditLogEntryType | Určuje typ záznamu v auditním protokolu, pokud je samotný dokument záznamem v auditním protokolu. | ||
| amount | Částka spojená s hlavičkou dokumentu (např. pro účely auditního protokolu). | ||
| identifier | Obecné identifikační pole (např. pro účely auditního protokolu). | ||
| documentGuid | M | Jedinečný identifikátor dokumentu využívající UUID / GUID. Používá se také jako odkaz na digitální účtenky. | |
| documentId | M | Jedinečné, pořadové číslo dokumentu (účtenky) v rámci pobočky / dceřiné společnosti / restaurace (napříč všemi pokladnami), přidělené pokladním systémem (max. 40 znaků). | |
| createDate | M | Čas vytvoření dokladu | |
| bookDate | M | Čas rezervace | |
| accountingDate | O | Možné datum zaúčtování tohoto dokladu | |
| ProcessStartDate | R/M* | Čas vytvoření prvního příjmu v rámci celého procesu (např. Německo: čas vytvoření první zákaznické objednávky související s daným příjmem platby – viz také „Zvláštnosti v gastronomii“) | |
| SystemEntryDate | O |
Čas, kdy byl doklad zadán do pokladního systému. Údaje o zemi:
|
|
| documentNumber | R/M* |
Jedinečné, pořadové číslo dokladu (="číslo účtenky“), přidělené pokladním systémem. Údaje o zemi:
|
|
| ExternalDocumentNumber | O |
Číslo dokladu z externího systému. Lze použít, pokud neexistuje žádný interní doklad (např. faktura), na který by bylo možné odkazovat. Údaje o jednotlivých zemích:
|
|
| documentNumberSeries | O/M* |
Název číselné řady čísla dokladu (documentNumber). Údaje o zemi:
|
|
| doklad o zrušení | M |
Příznak, zda je tento dokument použit ke zrušení jiného (dříve vydaného) dokumentu true – Dokument o zrušení false – Žádný dokument o zrušení |
|
| ParagonDocument | O |
Příznak (true / false) udávající, zda se jedná o následný záznam ručně vypsané stvrzenky („paragon“), např. po poruše pokladny. | |
| ParagonNumber | M* |
Číslo ručně vyhotovené účtenky (paragon). Musí být zadáno, pokud je ParagonDocument nastaveno na true, v opačném případě nesmí být zadáno; pokud není toto pravidlo dodrženo, je dokument zamítnut. Údaje o zemi:
|
|
| ParagonIssueDate | M* |
Datum vystavení ručně vystavené účtenky (paragon). Musí být zadáno, pokud je ParagonDocument nastaveno na hodnotu true, a nesmí být zadáno v opačném případě; pokud toto pravidlo není dodrženo, dokument bude zamítnut. Údaje o zemi:
|
|
| FailedToPay | O |
Logický příznak (true/false), který udává, zda platba za dokument selhala. |
|
| documentReference | O/M* | Slouží k odkazu na jiný dokument. | |
| {...} | |||
| isTraining | O/M* | Příznak pro označení školicích / demo dokumentů (vygenerováno v režimu školení / demo pokladny). | |
| TestCaseNumber | O/M* |
Pole pro zadání čísla testovacího případu pro účely certifikace. Údaje o zemi:
|
|
| FriendlyName | O |
Volitelný popisný název pro žádosti o certifikát (obvykle se používá pouze v testovacích prostředích). Údaje o zemi:
|
|
| documentType | O | Specifikace typu dokumentu | |
| documentTypeCaption | M* |
Popis typu dokumentu. Slouží především k lepšímu popisu nebo objasnění. Údaje o zemi:
|
|
| uživatel | O/M* |
Informace o uživateli (pokladny). Údaje o zemi:
|
|
| {...} | |||
| SalesPerson | O/M* |
Informace o prodejním personálu. Údaje o zemi:
|
|
| {...} | |||
| AllocationGroups [] | O/M* |
Slouží k přiřazení účtenek ke konkrétním položkám (např. stolům v gastronomii). Viz také: Dlouhodobý proces objednávek v gastronomii. Údaje o zemi:
|
|
| partner | O/M* |
Informace o příslušných (obchodních) partnerech společnosti vystavující dokument. Údaje o zemi:
|
|
| addressType | (v partner objektu) Nové volitelné pole pro určení typu adresy (např. fakturační adresa). |
||
| {...} | |||
| poznámky | O | Zaznamenávání doplňujících poznámek | |
| customerCount | O/M* |
Počet zákazníků týkajících se tohoto dokladu (např. v gastronomii počet hostů u pokladny/stolu) Údaje o zemi:
|
|
| paymentTerms | O | Platební podmínky | |
| {...} | |||
| ServicePeriodStart | O |
Začátek období poskytování služby (zejména pro faktury) Údaje o zemi:
|
|
| servicePeriodEnd | O |
Konec období poskytování služby (zejména u faktur) Údaje o zemi:
|
|
| počet pozic | O/M* |
Počet položek obsažených v dokladu (všechny položky, včetně položky, textu, rezervace, subTotal, total) Viz také objekt Position. Údaje o zemi:
|
|
| documentIssueType | O/M* |
Určuje typ vystavení dokladu.
Údaje o zemi:
|
|
| kupón | O | Možnost vytisknout na účtenku další kupóny a další prvky. | |
| {...} | |||
| typSlužby | O/M* |
Specifikace typu služby v gastronomii (obsluha u stolu, u pultu). Možné hodnoty (dodržujte CamelCase!)
Údaje o zemi:
|
|
| IsEcommerceTransaction | O/M* |
Údaj o tom, zda se jedná o transakci v rámci elektronického obchodu (true / false). Údaje o zemi:
|
|
| TaxPositions | R |
Specifikace všech pozic Vat v dokladu. Je nutné zadat buď všechny pozice Vat, nebo žádnou. Chcete-li získat daňové pozice z dokumentu (pokud nebyla tato vlastnost nastavena), použijte GetTaxPositions(Document, Boolean).
Poznámka pro Rakousko:
Doporučujeme použít toto pole k přenosu daňových pozic účtenky, aby se předešlo problémům se zaokrouhlováním v rámci protokolu pro záznam dat („DEP7“).
|
|
| {...} | |||
| fiscalResponse | - |
Odpověď fiskalizační služby po odeslání příkazů createDocument a storeDocument. Doporučujeme uložit obsah fiscalResponse do databáze pokladny.
Poznámka:
Určité prvky objektu fiscalResponse musí být po volání funkce createDocument
zahrnuty do dokumentu JSON (který by měl být odeslán do funkce
storeDocument
). NEZAHRNUJTE prosím celý objekt fiscalResponse!
|
|
| {...} | |||
| fiscalDocumentNumber | M* |
Číslo fiskálního dokladu (přiřazené systémem RetailForce nebo příslušnou fiskalizační jednotkou – např. TSE v Německu)
Upozornění:
Vezměte prosím na vědomí, že v systémech do verze v1.7.7 byla informace fiscalDocumentNumber vracena v poli fiscalisationDocumentNumber objektu fiscalResponse. Viz také článek: „Daná transakce nebyla zahájena
“. Ve verzi v1.7.7 bylo do objektu fiscalResponse zavedeno další pole fiscalDocumentNumber (řetězec).
|
|
| fiscalDocumentRevision | O/M* |
Číslo revize fiskálního dokladu (přiřazené systémem RetailForce nebo příslušnou fiskalizační jednotkou – např. TSE v Německu)
Upozornění:
Vezměte prosím na vědomí, že v systémech do verze v1.7.7 byla vlastnost fiscalDocumentRevision vrácena v poli fiscalisationDocumentRevision v hlavičce objektu fiscalResponse. Viz také článek: „Daná transakce nebyla zahájena
“. Od verze v1.7.7 byla tato vlastnost v objektu fiscalResponse přejmenována na fiscalDocumentRevision a je nyní vrácena pouze v poli AdditionalFields objektu fiscalResponse-Germany.
|
|
| FiscalDocumentStartTime | M* | Čas vytvoření daňového dokladu (přiřazený systémem RetailForce nebo příslušnou fiskalizační jednotkou – např. TSE v Německu) | |
| pozice | M | Informace o příslušné položce účtenky / dokladu (obsah závisí na typu dokladu a položky – documentType, positionType) | |
| {...} | |||
| platby | O/M* | Informace o platbě (použití závisí na typu dokumentu – documentType) | |
| {...} | |||
| doplňková hlavička | O |
Pole additionalHeader lze použít k nastavení dalších řádků volného textu v záhlaví dokumentu. Údaje o jednotlivých zemích:
Poznámka: V současné době je toto pole podporováno pouze v Itálii. Lze jej vyplnit i v jiných zemích, ale nemá žádný účinek. |
|
| additionalFooter | O |
Pole additionalFooter lze použít k nastavení dalších řádků volného textu v Footeru dokumentu. Podrobnosti pro jednotlivé země:
Poznámka: V současné době je toto pole podporováno pouze v Itálii. Lze jej vyplnit i v jiných zemích, ale nemá žádný účinek. |
|
| FiscalAdditionalFields | O | ||
Tento článek byl přeložen automaticky.
Komentáře
0 komentářů
Prosím přihlaste se, abyste mohli napsat komentář.