Ovaj članak pokriva objekt zaglavlja ("payments"), odnosno elemente u zaglavlju unutar objekta dokumenta.
Potpuni opis RetailForce DOM-a (modela objekata dokumenta), kao i opis pojedinačnih elemenata, može se pronaći u odjeljku Preuzimanja na web stranici RetailForce (Object model documentation.pdf) u odgovarajućem direktoriju verzija.
Objekt zaglavlja
{
"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 zaglavlja sadrži sljedeće informacije.
Informacije u koloni "Type":
- M ... obavezno ("mandatorno")
- M* ... obavezno u određenim zemljama ili pod određenim uslovima
- R ... preporučeno ("preporučeno")
- O ... opcionalno
| Element | Tip | Opis | |
| jedinstveniIDklijenta | M | Jedinstveni ID klijenta, odgovara ID-u terminala u RetailForce Cloudu (vraća se/dodjeljuje tokom puštanja u rad putem PUT /api/v1/management/clients/byCloud). | |
| verzijaaplikacije | R/M* |
Verzija softvera blagajne.
Napomena:
Imajte na umu da je u nekim zemljama (Francuska) broj verzije fiksiran kao dio procesa certificiranja. Ako je naveden netačan broj verzije (koji se ne podudara sa certificiranim brojem), nije moguće dovršiti dokument (=greška). Također pogledajte: Certificirana verzija
.
Podaci o zemlji:
|
|
| applicationVersionId | R/M* |
ID verzije softvera kase. Podaci o zemlji:
|
|
| prethodnaVerzijaAplikacije | R/M* |
ID prethodne verzije softvera za blagajnu. Podaci o zemlji:
|
|
| fiskalniModulVerzija | O/M* | Verzija fiskalnog modula (pouzdani fiskalni modul) korištena za generisanje odgovarajućeg dokumenta. Automatski postavlja middleware ako je nije prenio softver. | |
| fiscalCountryModuleVersion | O/M* | Verzija modula za zemlju (pouzdani fiskalni modul za zemlju) koja se koristi za generisanje odgovarajućeg dokumenta. Automatski je postavljena od strane middlewarea ako je softver nije prenio. | |
| Tip fiskalizacije | O | ||
| potpis | O | Potpis | |
| fiskalni štampač | Fiskalni štampač | ||
| online | Online | ||
| potpisSaInternetskomPovezivanjem | Potpis s online vezom | ||
| bezfiskalizacije | Bez fiskalizacije | ||
| Tip fiskalizacije Italija | O | ||
| printer | O | Telematski fiskalni uređaj | |
| retailForceReceiptId | O | Globalno jedinstveni broj računa (koji se sastoji od terminalId i rednog broja računa). Može se kreirati prilikom kreiranja transakcije (putem createDocument). | |
| dodatnaPolja | O | ||
| additionalProp1-x | O | ||
| automatskiProračunPDV-a | O |
Ovaj element pokreće automatsko izračunavanje različitih polja zbroja na nivou pozicije. 0 noCalculation - ne vrši se automatsko proračunavanje 1 netValueCalculation - automatsko izračunavanje neto iznosa i iznosa PDV-a. Najmanje bruto iznos i postotak/identifikacija PDV-a moraju biti navedeni. 2 grossValueCalculation - Automatsko izračunavanje bruto iznosa i poreznog iznosa. Najmanje neto vrijednost i porezni postotak/ identifikacija moraju biti navedeni. |
|
| dozvoljenoOdstupanjePDV-a | O |
Može se koristiti za kompenzaciju problema sa zaokruživanjem u obračunu PDV-a. Molimo koristite s oprezom! Ako je postavljena na visoku vrijednost, provjera obračuna PDV-a je onemogućena! Primjer: "allowedVatDeviation": 0.05, dozvoljava odstupanje od 5 centi između neto vrijednosti + porezne vrijednosti = bruto vrijednost (+-0.05) |
|
| terminalSlaveId | O | Specifikacija ID-a ulaznog terminala. | |
| serijskiBrojKase | O |
Serijski broj uređaja blagajne. Ovo polje identifikuje specifični fizički hardver blagajne koji se koristi za obradu transakcije. | |
| footerGraphicIndex | O |
Putem footerGraphicIndex-a se u podnožje dokumenta postavlja unaprijed definisan grafički element. Podaci o zemlji:
|
|
| auditLogEntryType | Određuje vrstu unosa u evidenciju revizije kada je sam dokument unos u evidenciju revizije. | ||
| iznos | Iznos povezan s zaglavljem dokumenta (npr. za potrebe revizijskog zapisa). | ||
| identifikator | Opće polje za identifikaciju (npr. za potrebe revizijskog zapisa). | ||
| documentGuid | M | Jedinstveni identifikator dokumenta koji koristi UUID / GUID. Također se koristi kao poveznica za digitalne račune. | |
| documentId | M | Jedinstveni, uzastopni broj dokumenta (potvrde) unutar poslovnice / podružnice / restorana (u svim registrima), dodijeljen od strane sistema blagajne (max. 40 znakova). | |
| createDate | M | Vrijeme izrade dokumenta | |
| Datum rezervacije | M | Vrijeme rezervacije | |
| datum računovodstva | O | Mogući datum evidentiranja ovog dokumenta u računovodstvu | |
| datumPočetkaProcesa | R/M* | Vrijeme kreiranja prvog računa u cijelom procesu (npr. Njemačka: Vrijeme kreiranja prve narudžbe kupca u vezi sa ovim računom za plaćanje - vidi također "Posebne značajke gastronomija") | |
| datumUnosaU sistemu | O |
Vrijeme kada je dokument unesen u sistem kase. Podaci o zemlji:
|
|
| brojDokuma | R/M* |
Jedinstveni, uzastopni broj dokumenta ("broj računa"), dodijeljen od strane sistema kase. Podaci o zemlji:
|
|
| externalDocumentNumber | O |
Broj dokumenta iz vanjskog sistema. Može se koristiti kada ne postoji interni dokument (npr. faktura) koji bi se mogao referencirati. Podaci o zemlji:
|
|
| serijaDokumenta | O/M* |
Naziv serije brojeva potvrde o uplati (documentNumber). Podaci o zemlji:
|
|
| dokument o otkazu | M |
Označite da li se ovaj dokument koristi za poništenje drugog (ranije izdanog) dokumenta true - Dokument za poništenje false - Nema dokumenta za poništenje |
|
| paragonDokument | O |
Označite (true / false) da li je dokument naknadno evidentiranje rukom napisanog računa ("paragon"), npr. nakon kvara kase. | |
| paragonNumber | M* |
Broj ručno napisanog računa (paragon). Mora biti postavljen ako je paragonDocument istinito i ne smije biti postavljen inače; dokument se odbacuje ako se ovo ne poštuje. Podaci o zemlji:
|
|
| datumIzdavanjaParagona | M* |
Datum izdavanja ručno ispunjenog računa (paragona). Mora biti postavljeno ako je paragonDocument istinito i ne smije biti postavljeno inače; dokument se odbacuje ako se ovo ne poštuje. Podaci o zemlji:
|
|
| neuspjeloPlaćanje | O |
Boolean zastavica (true/false) koji označava je li plaćanje dokumenta neuspjelo. |
|
| referenceDokumenta | O/M* | Koristi se za referenciranje drugog dokumenta. | |
| {...} | |||
| isTraining | O/M* | Zastavica za označavanje dokumenata za obuku / demo (generisano u načinu rada kase za obuku / demo). | |
| brojtestslucaja | O/M* |
Polje za navođenje broja testa slučaja za potrebe certificiranja. Podaci o zemlji:
|
|
| prijateljskoIme | O |
Opcionalno prikazivo ime za zahtjeve za certifikat (obično se koristi samo u testnim okruženjima). Podaci o zemlji:
|
|
| vrstaDokumenta | O | Specifikacija tipa dokumenta | |
| Naslov tipa dokumenta | M* |
Opis tipa dokumenta. Služi u suštini za bolji opis ili pojašnjenje. Podaci o zemlji:
|
|
| korisnik | O/M* |
Informacije o korisniku (blagajne). Podaci o zemlji:
|
|
| {...} | |||
| salesPerson | O/M* |
Informacije o prodajnom osoblju. Podaci o zemlji:
|
|
| {...} | |||
| allocationGroups [] | O/M* |
Koristi se za dodjeljivanje računa specifičnim stavkama (npr. stolovima u gastronomiji). Također pogledajte: Dugotrajni proces naručivanja u gastronomiji. Detalji o zemlji:
|
|
| partner | O/M* |
Informacije o odgovarajućim (poslovnim) partnerima kompanije koja izdaje dokument. Podaci o zemlji:
|
|
| tip adrese | (U partner objekt) Novo opcionalno polje za navođenje tipa adrese (npr. adresa za naplatu). |
||
| {...} | |||
| napomene | O | Bilježenje dodatnih napomena | |
| broj kupaca | O/M* |
Broj kupaca u vezi s ovim dokumentom (npr. u ugostiteljstvu, broj gostiju na blagajni/stolu) Podaci o zemlji:
|
|
| usloviPlaćanja | O | Uslovi plaćanja / uslovi plaćanja | |
| {...} | |||
| servicePeriodStart | O |
Početak perioda usluge (posebno za fakture) Podaci o zemlji:
|
|
| kraj_perioda_usluge | O |
Kraj perioda usluge (posebno za fakture) Podaci o zemlji:
|
|
| brojpozicija | O/M* |
Broj stavki sadržanih u računu (sve stavke, uključujući artikl, tekst, rezervaciju, podukupan iznos, ukupan iznos) Pogledajte i Objekat pozicije. Podaci o zemlji:
|
|
| vrstaIzdavanjaDokumenta | O/M* |
Definira vrstu izdavanja potvrde o prijemu.
Podaci o zemlji:
|
|
| kupon | O | Mogućnost ispisivanja dodatnih kupona i drugih elemenata na računu. | |
| {...} | |||
| vrsta_usluge | O/M* |
Specifikacija vrste usluge u gastronomiji (usluga za stolom, usluga na šanku). Moguće vrijednosti (poštujte CamelCase!)
Detalji o zemlji:
|
|
| isEcommerceTransaction | O/M* |
Indikacija da li je u pitanju e-trgovinska transakcija (istina / lažna). Podaci o zemlji:
|
|
| porezni položaji | R |
Specifikacija svih PDV stavki dokumenta. Mora se navesti ili sve ili nijedna pozicija PDV-a. Da biste dobili poreske stavke iz dokumenta (kada ova svojstva nisu postavljena), koristite GetTaxPositions(Document, Boolean).
Napomena za Austriju:
Preporučujemo korištenje ovog niza za prijenos poreznih stavki iz računa kako bi se izbjegli problemi sa zaokruživanjem unutar protokola za evidentiranje podataka ("DEP7").
|
|
| {...} | |||
| fiscalResponse | - |
Odgovor usluge fiskalizacije nakon prijenosa createDocument i storeDocument. Preporučujemo pohranu sadržaja objekta fiscalResponse u bazu podataka kase.
Napomena:
određeni elementi objekta fiscalResponse, nakon pozivanja funkcije createDocument
, moraju biti uključeni u JSON dokument (koji treba poslati na storeDocument
). Molimo vas da NE uključite cijeli objekt fiscalResponse!
|
|
| {...} | |||
| fiskalni broj dokumenta | M* |
Broj fiskalnog dokumenta (dodijeljen od strane sistema RetailForce ili nadležne jedinice za fiskalizaciju – npr. TSE u Njemačkoj)
Pažnja:
Imajte na umu da se u sistemima do verzije v1.7.7 informacija fiscalDocumentNumber vraćala u polju fiscalisationDocumentNumber objekta fiscalResponse. Pogledajte i članak: "Given Transaction not started
". U verziji v1.7.7 u objekt fiscalResponse je uvedeno dodatno polje fiscalDocumentNumber (string).
|
|
| fiskalniDokumentRevizija | O/M* |
Broj revizije fiskalnog dokumenta (dodijeljen od strane sistema RetailForce ili nadležne jedinice za fiskalizaciju – npr. TSE u Njemačkoj)
Napomena:
Imajte na umu da se u sistemima do verzije v1.7.7 polje fiscalDocumentRevision vraćalo u polje fiscalisationDocumentRevision u zaglavlju objekta fiscalResponse. Pogledajte i članak: "Given Transaction not started
". Od verzije v1.7.7, svojstvo unutar objekta fiscalResponse je preimenovano u fiscalDocumentRevision i sada se vraća samo u nizu additionalFields objekta fiscalResponse-Germany.
|
|
| FiscalDocumentStartTime | M* | Vrijeme kreiranja fiskalnog dokumenta (dodijeljeno od strane sistema RetailForce ili nadležne jedinice za fiskalizaciju - npr. TSE u Njemačkoj) | |
| pozicije | M | Informacije o odgovarajućoj poziciji potvrde / dokumenta (sadržaj ovisi o vrsti dokumenta i pozicije - documentType, positionType) | |
| {...} | |||
| isplate | O/M* | Informacije o uplati (upotreba zavisi od tipa dokumenta - documentType) | |
| {...} | |||
| dodatni zaglavlje | O |
Niz additionalHeader se može koristiti za postavljanje dodatnih linija slobodnog teksta u zaglavlju dokumenta. Podaci o zemlji:
Napomena: Trenutno je ovaj niz podržan samo u Italiji. Može se popuniti i u drugim zemljama, ali nema učinka. |
|
| dodatniPodnožak | O |
Niz additionalFooter se može koristiti za postavljanje dodatnih linija slobodnog teksta u podnožju dokumenta. Detalji o zemlji:
Napomena: Trenutno je ovaj niz podržan samo u Italiji. Može se popuniti i u drugim zemljama, ali nema učinka. |
|
| Fiskalni dodatni poljani | O | ||
Ovaj članak je automatski preveden.
Comments
0 comments
Please sign in to leave a comment.