Gå til hovedindhold

Header-objekt RetailForce DOM

Harald Krondorfer
  • Opdateret

Denne artikel omhandler Header-objektet ("payments") eller elementerne i Header inden for Document-objektet.

En fuldstændig beskrivelse af RetailForce DOM (Document Object Model) samt en beskrivelse af de enkelte elementer findes i afsnittet Downloads på RetailForce website (Object model documentation.pdf) i det respektive versionsbibliotek.

Header-objektet

{
  "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": {}
}

Header-objektet indeholder følgende oplysninger.

Oplysninger i kolonnen "Type":

  • M ... påkrævet ("obligatorisk")
  • M* ... påkrævet i visse lande eller under visse betingelser
  • R ... anbefalet ("anbefalet")
  • O ... valgfrit
Element Type Beskrivelse
uniqueClientId M Clientens unikke ID, svarer til terminal-ID'et i RetailForce Cloud (returneres/tildeles under idriftsættelsen via PUT /api/v1/management/clients/byCloud).
applicationVersion R/M*

Version af kassesystemets software.

OBS: Bemærk, at versionsnummeret i nogle lande (f.eks. Frankrig) er fastlagt som led i certificeringsprocessen. Hvis der angives et forkert versionsnummer (som ikke svarer til det certificerede nummer), er det ikke muligt at færdiggøre dokumentet (=fejl). Se også: Certificeret version .

Landespecifikationer:
ApplicationVersionId

R/M*

ID for kasseapparatets softwareversion.

Landespecifikationer:

  • Canada – Québec: Obligatorisk felt. ID for softwareversionen, leveret/genereret af Revenu Québec. Tilknyttet feltet "idVersi ". Bemærk venligst "Softwareversioner Canada / Québec "!
ApplicationVersionPrevious

R/M*

ID for den forrige version af kasseapparatsoftwaren.

Landespecifikationer:

  • Canada - Québec: Obligatorisk felt. Overordnet softwareversion (forrige version). Tilknyttet feltet "versiParn ". Bemærk venligst "Softwareversioner Canada / Québec "!
FiscalModuleVersion O/M* Version af det skattemodul (Trusted Fiscal Module), der blev brugt til at generere det pågældende dokument. Indstilles automatisk af middlewaren, hvis det ikke overføres af softwaren.
FiscalCountryModuleVersion O/M* Version af landemodulet (Trusted Fiscal Country Module), der er anvendt til at generere det pågældende dokument. Indstilles automatisk af middlewaren, hvis den ikke overføres af softwaren.
FiscalisationType O  
  signatur O Signatur
  fiscalPrinter   Fiskalprinter
  online   Online
  signaturMedOnline   Signatur med onlineforbindelse
  ingen fiskalisering   Ingen skattepligt
FiskaliseringstypeItalien O  
  printer O Telematisk registreringsapparat
retailForceReceiptId O Globalt unikt kvitteringsnummer (bestående af terminalId og kvitteringens løbenummer). Kan oprettes ved oprettelse af en transaktion (med createDocument).
AdditionalFields O  
  additionalProp1-x O  
automaticVatCalculation O

Dette element udløser den automatiske beregning af forskellige sumfelter på positionsniveau.

0 noCalculation – der foretages ingen automatisk beregning

1 netValueCalculation – automatisk beregning af nettobeløb og Vat-beløb. Der skal som minimum angives bruttobeløb og Vat-sats/Vat-identifikation.

2 grossValueCalculation – Automatisk beregning af brutto- og skattebeløb. Der skal som minimum angives nettoværdi og Vat-sats/identifikation.
AllowedVatDeviation O

Kan bruges til at kompensere for afrundingsproblemer i Vat-beregningen.

Brug med forsigtighed! Hvis værdien indstilles for højt, deaktiveres kontrollen af Vat-beregningen!

Eksempel: "AllowedVatDeviation": 0,05 tillader en afvigelse på 5 cent mellem nettoværdi + moms = bruttoværdi (+-0,05)
TerminalSlaveId O Angivelse af ID'et for en indgangsterminal.
cashRegisterSerialNumber

O

 Serienummeret på kasseapparatet. Dette felt identificerer den specifikke fysiske kassehardware, der anvendes til at behandle transaktionen.
footerGraphicIndex O

Via footerGraphicIndex placeres et foruddefineret grafisk element i dokumentets footer.

Landespecifikke oplysninger:
AuditLogEntryType   Angiver typen af revisionslogpost, når selve dokumentet er en revisionslogpost.
amount   Et beløb knyttet til dokumentets header (f.eks. til revisionslogformål).
identifier   Et generelt identifikationsfelt (f.eks. til revisionslogformål).
DocumentGuid M Unikt identifikationsnummer for dokumentet ved hjælp af UUID/GUID. Anvendes også som link til digitale kvitteringer.
DocumentId M Unikt, fortløbende nummer på dokumentet (kvitteringen) inden for filialen / datterselskabet / restauranten (på tværs af alle kasseapparater), tildelt af kassesystemet (maks. 40 tegn).
CreateDate M Tidspunkt for dokumentets oprettelse
BookDate M Reservationsd ato
AccountingDate O Mulig bogføringsdato for dette dokument i regnskabet
ProcessStartDate R/M* Oprettelsestidspunkt for den første kvittering i hele processen (f.eks. Tyskland: Oprettelsestidspunkt for den første kundeordre i forbindelse med den aktuelle betalingskvittering – se også "Særlige funktioner inden for gastronomi")
DocumentNumber R/M* Dokumentets unikke, fortløbende nummer (="kvitteringsnummer"), tildelt af kassesystemet.
documentNumberSeries O/M*

Navn på nummerserien for kvitteringsnummeret (DocumentNumber).

Landespecifikke oplysninger:

  • Spanien: documentNumberSeries skal angives som obligatorisk i Spanien (yderligere oplysninger: "Fakturanumre og -serier i Spanien ").
    • alfanumerisk (maks. 20 tegn)
    • Brug følgende tegnsæt: 0123456789ABCDEFGHJKLMNPQRSTUVXYZ,
    • undgå bogstaverne I, Ñ, O og W for at forbedre læsbarheden,
    • brug ikke små bogstaver,
    • brug kun ét tegn til mellemrum,
    • tekstjustering til venstre, uden foranstillede mellemrum,
    • der må ikke bruges accenttegn,
    • bindestregen "-" må gerne bruges.
cancellationDocument M

Flag, om det foreliggende dokument bruges til at annullere et andet (tidligere udstedt) dokument

true – Annulleringsdokument

false – Intet annulleringsdokument
FailedToPay

O

 Et boolean flag (true/false), der angiver, om betalingen for dokumentet mislykkedes.
documentReference O/M* Bruges til at henvise til et andet dokument.
  {...}    
IsTraining O/M* Flag til markering af trænings-/demodokumenter (genereret i kasseapparatets trænings-/demotilstand).
TestCaseNumber

O/M*

Felt til angivelse af et testcasenummer til certificeringsformål.

Landespecifikationer:

  • Canada – Québec: Testcasenummer i DEV- eller ESSAI-miljøet. Yderligere oplysninger findes i artiklen "Kommunikation med WEB-SRM ".
documentType O Angivelse af dokumenttypen
documentTypeCaption M*

Beskrivelse af dokumenttypen. Tjener hovedsageligt til bedre beskrivelse eller præcisering.

Landespecifikationer:

  • Østrig: I Østrig (AT) skal documentTypeCaption indstilles i overensstemmelse hermed.
    • Startkvittering,
    • Månedlig kvittering,
    • Årskvittering,
    • Endelig kvittering
bruger O/M*

Oplysninger om (kasseapparatets) bruger.

Landespecifikationer:
  {...}    
SalesPerson O/M*

Oplysninger om salgspersonalet.

Landespecifikke oplysninger:
  {...}    
AllocationGroups [] O/M*

Bruges til at tildele kvitteringer til bestemte enheder (f.eks. borde i restaurationsbranchen).

Se også: Langvarig ordreproces inden for gastronomi.

Landespecifikationer:

  • Canada – Québec: Elementet er knyttet til feltet "noTabl " i WEB-SRM-skemaet. Der er kun tilladt én indtastning med maks. 5 alfanumeriske tegn.
partner O/M*

Oplysninger om de respektive (forretnings)partnere til den virksomhed, der udsteder dokumentet.

Landespecifikationer:

  • Canada – Québec: Obligatorisk felt ved B2B-transaktioner
  • Portugal: Obligatorisk felt ved B2B-transaktioner
addressType   (I partner objektet) Nyt valgfrit felt til angivelse af adressetype (f.eks. faktureringsadresse).
  {...}    
bemærkninger O Registrering af yderligere noter
CustomerCount O/M*

Antal kunder i forbindelse med dette dokument (f.eks. i restaurationsbranchen: antallet af gæster ved kassen/bordet)

Landespecifikke oplysninger:

  • Canada - Québec: Elementet er knyttet til feltet "nbClint " i WEB-SRM-skemaet.
PaymentTerms O Betalingsbetingelser / betalingsvilkår
  {...}    
ServicePeriodStart O

Start på serviceperioden (især for fakturaer)

Landespecifikationer:

  • Portugal: Det er obligatorisk at angive serviceperioden for fakturaer ("documentType": "[1] = Invoice")
ServicePeriodEnd O

Slutningen af tjenesteperioden (især for fakturaer)

Landespecifikationer:

  • Portugal: Det er obligatorisk at angive tjenesteperioden for fakturaer ("documentType": "[1] = Invoice")
PositionCount O/M*

Antal positioner i kvitteringen (alle positioner, herunder vare, tekst, bogføring, subTotal, total)

Se også Position-objektet.

Landespecifikationer:

  • Frankrig: Obligatorisk felt.
DocumentIssueType O/M*

Definerer typen af kvitteringsudstedelse.

  • papir – trykt dokument
  • digitalReceipt – elektronisk dokument (f.eks. e-mail)
  • paperAndDigitalReceipt – udstedelse i både trykt og elektronisk form
  • notIssued – dokumentet blev ikke udstedt

Landespecifikationer:

  • Canada – Québec: Obligatorisk felt.
coupon O Mulighed for at udskrive yderligere kuponer og andre elementer på kvitteringen.
  {...}    
serviceType O/M*

Angivelse af servicetype inden for gastronomi (bordservering, betjening ved disken).

Mulige værdier (CamelCase skal overholdes!)

  • CounterService - Betjening ved disken
  • DeliveryByOperator – Levering af operatør
  • OrderThroughDigitalPlatform – Levering via digital platform (tredjepart)
  • TableService – Betjening ved bordet / bordservering

Landespecifikationer:

  • Canada – Québec: Obligatorisk felt inden for gastronomi (RBF – Restauranter, barer, madvogne). Detaljer om "aktivitet".
    Kortlægning (RetailForce DOM – WEB-SRM):
    • CounterService – "CMP"
    • DeliveryByOperator – "LVR"
    • OrderThroughDigitalPlatform – "LVT"
    • Bordservering – "TBL"
IsEcommerceTransaction O/M*

Angivelse af, om der er tale om en e-handelstransaktion (true / false).

Landespecifikationer:

  • Canada – Québec: Obligatorisk felt ved e-handelstransaktioner.
TaxPositions R

Angivelse af alle Vat-positioner i dokumentet.

Enten skal alle eller ingen Vat-positioner angives.

For at hente momspositionerne fra dokumentet (når denne egenskab ikke er angivet), skal du bruge GetTaxPositions(Document, boolean).

Bemærk vedrørende Østrig: Vi anbefaler at bruge denne matrix til at overføre momspositionerne for en kvittering for at undgå afrundingsproblemer i dataregistreringsprotokollen ("DEP7").
  {...}    
fiscalResponse -

Svar fra fiskaliseringsservicen efter overførsel med createDocument og storeDocument.

Vi anbefaler, at indholdet af fiscalResponse gemmes i kasseapparatets database.

Bemærk: Visse elementer i fiscalResponse-objektet skal, efter at funktionen createDocument er blevet kaldt, medtages i JSON-dokumentet (som skal sendes til storeDocument ). Medtag IKKE hele fiscalResponse-objektet!
  {...}    
fiscalDocumentNumber M*

Fiskaliseringsdokumentnummer (tildelt af RetailForce systemet eller af den respektive fiskaliseringsenhed – f.eks. TSE i Tyskland)

OBS: Bemærk, at i systemer op til v1.7.7 blev oplysningen fiscalDocumentNumber returneret i feltet fiscalisation DocumentNumber i fiscalResponse-objektet. Se også artiklen: "Givet transaktion ikke startet ". I v1.7.7 blev der introduceret et ekstra felt, fiscalDocumentNumber (string), i fiscalResponse-objektet.
fiscalDocumentRevision O/M*

Revisionsnummer for det skattemæssige dokument (tildelt af RetailForce systemet eller af den respektive skatteenhed – f.eks. TSE i Tyskland)

OBS: Bemærk, at i systemer op til v1.7.7 blev fiscalDocumentRevision returneret i feltet fiscalisation DocumentRevision i headeren på fiscalResponse. Se også artiklen: »Den angivne transaktion er ikke startet «. Fra v1.7.7 blev egenskaben i fiscalResponse-objektet omdøbt til fiscalDocumentRevision og returneres nu kun i AdditionalFields-arrayet i fiscalResponse-Germany.
fiscalDocumentStartTime M* Tidspunktet for oprettelsen af det skattemæssige dokument (tildelt af RetailForce systemet eller af den respektive skattemæssige enhed – f.eks. TSE i Tyskland)
positioner M Oplysninger om den pågældende kvittering/dokumentposition (indholdet afhænger af dokumenttypen og positionstypen – documentType, positionType)
  {...}    
betalinger O/M* Oplysninger om betaling (anvendelsen afhænger af dokumenttypen – documentType)
  {...}    
AdditionalHeader O

arrayet AdditionalHeader kan bruges til at indstille yderligere linjer med fri tekst i dokumentets header.

Landespecifikke oplysninger:

Bemærk: I øjeblikket understøttes denne array kun i Italien. Den kan også udfyldes i andre lande, men har ingen effekt.
AdditionalFooter O

arrayet AdditionalFooter kan bruges til at indstille yderligere linjer med fri tekst i dokumentets sidefooter.

Landespecifikke oplysninger:

Bemærk: I øjeblikket understøttes denne array kun i Italien. Den kan også udfyldes i andre lande, men har ingen effekt.
FiscalAdditionalFields O  

 

Denne artikel er oversat automatisk.

Relaterede artikler

Kommentarer

0 kommentarer

Log ind for at kommentere.

Drevet af Zendesk