Skip to main content

Header-objekt RetailForce DOM

Harald Krondorfer
  • Ažurirano

Ovaj članak obuhvaća objekt zaglavlja ("payments"), odnosno elemente u zaglavlju unutar objekta dokumenta.

Potpuni opis RetailForce DOM-a (modela objekata dokumenta), kao i opis pojedinih elemenata, možete 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 stupcu "Type":

  • M ... obavezno ("mandatorno")
  • M* ... obavezno u određenim zemljama ili pod određenim uvjetima
  • R ... preporučeno ("preporučeno")
  • O ... neobavezno
Element Tip Opis
jedinstveniIDklijenta M Jedinstveni ID klijenta, odgovara ID-u terminala u RetailForce Cloudu (vraća se/dodjeljuje tijekom 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 netočan broj verzije (koji ne odgovara certificiranom broju), nije moguće dovršiti dokument (=pogreška). Također pogledajte: Certificirana verzija .

Podaci o zemlji:
applicationVersionId

R/M*

ID verzije softvera blagajne.

Podaci o zemlji:

  • Kanada - Québec: Obavezno polje. ID verzije softvera, koji je dostavio / generirao Revenu Québec. Mapirano na polje "idVersi ". Imajte na umu "Softverske verzije Kanada / Québec "!
prethodnaVerzijaAplikacije

R/M*

ID prethodne verzije blagajničkog softvera.

Podaci o zemlji:

  • Kanada - Québec: Obavezno polje. Verzija roditeljskog softvera (prethodna verzija). Mapirano na polje "versiParn ". Imajte na umu "Verzije softvera Kanada / Québec "!
fiskalniModulVerzija O/M* Verzija fiskalnog modula (pouzdani fiskalni modul) korištena za generiranje odgovarajućeg dokumenta. Automatski postavlja posrednički softver ako je nije prenio aplikacijski softver.
fiscalCountryModuleVersion O/M* Verzija državnog modula (pouzdanog fiskalnog državnog modula) korištena za generiranje odgovarajućeg dokumenta. Automatski postavlja posrednički sloj ako je nije prenio softver.
Tip fiskalizacije O  
  potpis O Potpis
  fiskalni pisač   Fiskalni pisač
  online   Online
  potpisSinternetskomvezom   Potpis s internetskom vezom
  bezfiskalizacije   Bez fiskalizacije
Tip fiskalizacije Italija O  
  pisač O Telematski blagajni aparat
retailForceReceiptId OORegistratore TelematicoretailForceReceiptId Globalno jedinstveni broj računa (koji se sastoji od terminalId i rednog broja računa). Može se stvoriti prilikom izrade transakcije (putem createDocument).
dodatnaPolja O  
  additionalProp1-x O  
automaticVatCalculation O

Ovaj element pokreće automatsko izračunavanje različitih zbirnih polja na razini pozicije.

0 noCalculation - ne provodi se automatsko izračunavanje

1 netValueCalculation - automatsko izračunavanje neto iznosa i iznosa PDV-a. Najmanje mora biti naveden bruto iznos i postotak/identifikacija PDV-a.

2 grossValueCalculation - Automatsko izračunavanje bruto iznosa i poreznog iznosa. Mora biti navedeno najmanje neto iznos i postotak PDV-a/ identifikacija PDV-a.
dozvoljenoOdstupanjePDV-a O

Može se koristiti za kompenzaciju problema s zaokruživanjem u izračunu PDV-a.

Molimo koristite s oprezom! Ako se postavi na visoku vrijednost, provjera ispravnosti izračuna PDV-a je onemogućena!

Primjer: "allowedVatDeviation": 0.05, dopušta odstupanje od 5 centi između neto vrijednosti + porezne vrijednosti = bruto vrijednost (+-0.05)
terminalSlaveId O Specifikacija ID-a ulaznog terminala.
serijskiBrojblagajne

O

 Serijski broj uređaja blagajne. Ovo polje identificira određeni fizički hardver blagajne koji se koristi za obradu transakcije.
footerGraphicIndex O

Putem footerGraphicIndex-a u podnožje dokumenta postavlja se unaprijed definirani grafički element.

Podaci o zemlji:
auditLogEntryType   Određuje vrstu unosa u zapisnik revizije kada je sam dokument unos u zapisnik revizije.
iznos   Iznos povezan s zaglavljem dokumenta (npr. za potrebe revizijskog zapisa).
identifikator   Opće identifikacijsko polje (npr. za potrebe revizijskog zapisa).
documentGuid M Jedinstveni identifikator dokumenta koji koristi UUID / GUID. Također se koristi kao poveznica za digitalne račune.
ID dokumenta M Jedinstveni, uzastopni broj dokumenta (potvrde o kupnji) unutar podružnice / filijale / restorana (u svim blagajnama), dodijeljen sustavom blagajne (max. 40 znakova).
datumIzrade M Vrijeme izrade dokumenta
datumRezervacije M Vrijeme rezervacije
datum računovodstva O Mogući datum evidentiranja ovog dokumenta u računovodstvu
datumPočetkaProcesa R/M* Vrijeme izrade prve potvrde unutar cijelog procesa (npr. Njemačka: vrijeme izrade prve narudžbe kupca u vezi s ovom potvrdom o plaćanju – vidi također "Posebne značajke gastronomija")
brojDokumenta R/M* Jedinstveni, uzastopni broj dokumenta ("broj računa"), dodijeljen od strane sustava blagajne.
Serijski broj dokumenta O/M*

Naziv serije brojeva računa (documentNumber).

Podaci o zemlji:

  • Španjolska: serija dokumenta mora biti obavezna u Španjolskoj (više informacija: "Brojevi računa i serije u Španjolskoj ".
    • alfanumerički (najviše 20 znakova)
    • koristite sljedeći skup znakova: 0123456789ABCDEFGHJKLMNPQRSTUVXYZ,
    • izbjegavajte slova I, Ñ, O i W radi bolje čitljivosti,
    • ne koristite mala slova,
    • koristite samo jedan znak za razmake,
    • poravnanje teksta ulijevo, bez vodećih razmaka,
    • ne koristiti naglaske,
    • može se koristiti crtica "-".
dokument o otkazu M

Označite je li ovaj dokument korišten za poništenje drugog (ranije izdanog) dokumenta

true - Dokument za poništenje

false - Nema dokumenta za poništenje
neuspjeloPlaćanje

O

 Booleovska zastavica (true/false) koji označava je li plaćanje dokumenta neuspjelo.
reference dokumenta O/M* Koristi se za referenciranje drugog dokumenta.
  {...}    
isTraining O/M* Zastavica za označavanje dokumenata za obuku / demonstraciju (generirano u načinu rada za obuku / demonstraciju blagajne).
brojtestnogslučaja

O/M*

Polje za navođenje broja testa za potrebe certificiranja.

Podaci o zemlji:

  • Kanada - Québec: broj testnog slučaja u DEV ili ESSAI okruženju. Više informacija u članku "Komunikacija s WEB-SRM ".
vrsta-dokumenta O Specifikacija vrste dokumenta
Opis vrste dokumenta M*

Opis vrste dokumenta. Služi u suštini za bolji opis ili pojašnjenje.

Podaci o zemlji:

  • Austrija: u Austriji (AT) dokumentTypeCaption mora biti postavljena u skladu s tim.
    • Početak računa,
    • Mjesečna potvrda,
    • Godišnja potvrda,
    • Završni račun
korisnik O/M*

Informacije o korisniku (blagajne).

Podaci o zemlji:
  {...}    
prodajni_stručnjak O/M*

Informacije o prodajnom osoblju.

Podaci o zemlji:
  {...}    
allocationGroups [] O/M*

Koristi se za dodjeljivanje računa određenim stavkama (npr. stolovima u gastronomiji).

Također pogledajte: dugotrajni proces narudžbe u gastronomiji.

Podaci o zemlji:

  • Kanada - Québec: Element je povezan s poljem "noTabl " u shemi WEB-SRM. Dozvoljena je samo jedna stavka s najviše 5 alfanumeričkih znakova.
partner O/M*

Informacije o odgovarajućim (poslovnim) partnerima tvrtke koja izdaje dokument.

Podaci o zemlji:

  • Kanada - Québec: Obavezno polje u slučaju B2B transakcija
  • Portugal: Obavezno polje u slučaju B2B transakcija
vrstaadresa   (U partner object) Novo neobavezno polje za navođenje vrste adrese (npr. adresa za naplatu).
  {...}    
napomene O Zabilježavanje dodatnih napomena
broj kupaca O/M*

Broj kupaca u vezi s ovim dokumentom (npr. u gastronomiji, broj gostiju na blagajni/stolu)

Podaci o zemlji:

  • Kanada - Québec: Element je povezan s poljem "nbClint " u shemi WEB-SRM.
uvjetiPlaćanja O Uvjeti plaćanja / uvjeti plaćanja
  {...}    
servicePeriodStart O

Početak razdoblja usluge (posebno za račune)

Podaci o zemlji:

  • Portugal: Obavezno je navesti razdoblje usluge za račune ("documentType": "[1] = račun")
krajRazdobljaUsluge O

Kraj razdoblja usluge (posebno za račune)

Podaci o zemlji:

  • Portugal: Obavezno je navesti razdoblje usluge za račune ("documentType": "[1] = Invoice")
brojpozicija O/M*

Broj stavki sadržanih u računu (sve stavke, uključujući artikl, tekst, rezervaciju, podukupan iznos, ukupan iznos)

Vidi također Objekt pozicije.

Podaci o zemlji:

  • Francuska: Obavezno polje.
vrstaIzdavanjaDokumenta O/M*

Definira vrstu izdavanja potvrde o preuzimanju.

  • papir - tiskani dokument
  • digitalReceipt - elektronički dokument (npr. e-pošta)
  • papirIdigitalniPotvrda - izdavanje u tiskanom i elektroničkom obliku
  • nijeIzdano - dokument nije izdan

Podaci o zemlji:

  • Kanada - Québec: Obavezno polje.
kupon O Mogućnost ispisa 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!)

  • Usluga na šanku
  • DeliveryByOperator - Dostava od strane operatera
  • NarudžbaKrozDigitalnuPlatformu - Dostava putem digitalne platforme (treća strana)
  • Stolna usluga - usluga za stolom / usluga na stolu

Podaci o zemlji:

  • Kanada - Québec: Obavezno polje u gastronomiji (RBF - restorani, barovi, food-truckovi). Detalj "aktivnosti".
    Mapiranje (RetailForce DOM - WEB-SRM):
    • Usluga na šanku - "CMP"
    • DeliveryByOperator - "LVR"
    • NarudžbaPutemDigitalnePlatforme - "LVT"
    • Usluga za stolom - "TBL"
isEcommerceTransaction O/M*

Indikacija je li riječ o transakciji e-trgovine (istina / laž).

Podaci o zemlji:

  • Kanada - Québec: Obavezno polje u slučaju transakcija e-trgovine.
porezne pozicije R

Specifikacija svih PDV stavki dokumenta.

Mora se navesti ili sve ili nijedna PDV pozicija.

Za dohvaćanje poreznih stavki iz dokumenta (kada ova svojstva nije postavljena), upotrijebite GetTaxPositions(Document, Boolean).

Napomena za Austriju: Preporučujemo korištenje ovog niza za prijenos poreznih stavki iz računa kako bi se izbjegli problemi s zaokruživanjem unutar protokola za bilježenje podataka ("DEP7").
  {...}    
fiscalResponse -

Odgovor usluge fiskalizacije nakon prijenosa createDocument i storeDocument.

Preporučujemo pohranu sadržaja objekta fiscalResponse u bazu podataka blagajne.

Napomena: određeni elementi objekta fiscalResponse, nakon pozivanja funkcije createDocument , moraju biti uključeni u JSON dokument (koji se treba poslati u storeDocument ). Molimo, NEMOJTE uključivati cijeli objekt fiscalResponse!
  {...}    
fiskalni broj dokumenta M*

Broj fiskalnog dokumenta (dodijeljen od strane sustava RetailForce ili nadležne jedinice za fiskalizaciju – npr. TSE u Njemačkoj)

Pažnja: Imajte na umu da se u sustavima do verzije v1.7.7 informacija fiscalDocumentNumber vraćala u polju fiscalisation DocumentNumber objekta fiscalResponse. Vidi također članak: "Given Transaction not started ". U verziji v1.7.7 u objekt fiscalResponse uvedeno je dodatno polje fiscalDocumentNumber (string).
fiscalDocumentRevision O/M*

Broj revizije fiskalnog dokumenta (dodijeljen od strane sustava RetailForce ili odgovarajuće jedinice za fiskalizaciju – npr. TSE u Njemačkoj)

Napomena: Imajte na umu da se u sustavima do verzije 1.7.7 polje fiscalDocumentRevision vraćalo u polje fiscalisation DocumentRevision u zaglavlju objekta fiscalResponse. Vidi također članak: "Dana transakcija nije započela ". Od verzije 1.7.7 svojstvo unutar objekta fiscalResponse preimenovano je u fiscalDocumentRevision i sada se vraća samo u nizu additionalFields objekta fiscalResponse-Germany.
FiscalDocumentStartTime M* Vrijeme izrade fiskalnog dokumenta (dodijeljeno od strane sustava RetailForce ili nadležne fiskalne jedinice – npr. TSE u Njemačkoj)
pozicije M Informacije o odgovarajućoj poziciji računa / dokumenta (sadržaj ovisi o vrsti dokumenta i pozicije – documentType, positionType)
  {...}    
isplate O/M* Informacije o uplati (upotreba ovisi o vrsti dokumenta - documentType)
  {...}    
dodatni zaglavlje O

Niz additionalHeader može se 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 ispuniti i u drugim zemljama, ali nema učinka.
dodatniPodnožak O

Niz additionalFooter može se koristiti za postavljanje dodatnih linija slobodnog teksta u podnožju dokumenta.

Podaci o zemlji:

Napomena: Trenutno je ovaj niz podržan samo u Italiji. Može se ispuniti i u drugim zemljama, ali nema učinka.
Fiskalni dodatni polja O  

 

Ovaj je članak automatski preveden.

Povezani članci

Komentari

0 komentara

Molimo Prijavite se kako bi ostavili komentar.

Powered by Zendesk