Hoppa till huvudinnehållet

Header-objekt RetailForce DOM

Harald Krondorfer
  • Uppdaterad

Denna artikel behandlar Header-objektet ("payments") respektive elementen i Header inom Document-objektet.

En fullständig beskrivning av RetailForce DOM (Document Object Model), samt en beskrivning av de enskilda elementen, finns i avsnittet ”Downloads” på RetailForce website (Object model documentation.pdf) i respektive versionskatalog.

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 innehåller följande information.

Information i kolumnen ”Type”:

  • M ... krävs ("obligatoriskt")
  • M* ... krävs i vissa länder eller under vissa förutsättningar
  • R ... rekommenderat ("rekommenderat")
  • O ... valfritt
Element Typ Beskrivning
uniqueClientId M Klientens unika ID, motsvarar terminal-ID:t i RetailForce Cloud (returneras/tilldelas vid idrifttagning via PUT /api/v1/management/clients/byCloud).
applicationVersion R/M*

Version av kassaprogramvaran.

Observera: I vissa länder (Frankrike) fastställs versionsnumret som en del av certifieringsprocessen. Om ett felaktigt versionsnummer anges (som inte stämmer överens med det certifierade numret) går det inte att slutföra dokumentet (=fel). Se även: Certifierad version .

Landsspecifikationer:
ApplicationVersionId

R/M*

ID för kassasystemets programvaruversion.

Landspecifika uppgifter:

  • Kanada – Québec: Obligatoriskt fält. ID för programversionen, tillhandahållet/genererat av Revenu Québec. Mappas till fältet ”idVersi ”. Observera ”Programversioner Kanada/Québec ”!
ApplicationVersionPrevious

R/M*

ID för den tidigare versionen av kassasystemets programvara.

Landsspecifikationer:

  • Kanada – Québec: Obligatoriskt fält. Överordnad programvaruversion (tidigare version). Mappad till fältet ”versiParn ”. Observera ”Programvaruversioner Kanada / Québec ”!
FiscalModuleVersion O/M* Version av den skattemodul (Trusted Fiscal Module) som använts för att generera respektive dokument. Ställs in automatiskt av middleware om den inte överförs av programvaran.
FiscalCountryModuleVersion O/M* Version av landmodulen (Trusted Fiscal Country Module) som använts för att generera det aktuella dokumentet. Ställs in automatiskt av middleware om den inte överförs av programvaran.
FiscalisationType O  
  signatur O Signatur
  skatteskrivare   Fiskalisk skrivare
  online   Online
  signaturMedOnline   Signatur med onlineanslutning
  ingen skatteplikt   Ingen skatteplikt
FiskaliseringsformItalien O  
  skrivare O Registratore Telematico
retailForceReceiptId O Globalt unikt kvittonummer (bestående av terminalId och kvittots löpnummer). Kan skapas vid upprättandet av en transaktion (med createDocument).
AdditionalFields O  
  additionalProp1-x O  
automaticVatCalculation O

Detta element utlöser automatisk beräkning av olika summafält på positionsnivå.

0 noCalculation – ingen automatisk beräkning sker

1 netValueCalculation – automatisk beräkning av nettobelopp och momsbelopp. Åtminstone bruttobelopp och momssats/momsnummer måste anges.

2 grossValueCalculation – automatisk beräkning av brutto- och skattebelopp. Åtminstone nettovärde och momsprocent/momsnummer måste anges.
AllowedVatDeviation O

Kan användas för att kompensera för avrundningsfel vid Vat-beräkningen.

Använd med försiktighet! Om ett högt värde anges inaktiveras kontrollen av Vat-beräkningen!

Exempel: "AllowedVatDeviation": 0,05, tillåter en avvikelse på 5 cent mellan nettovärdet och skattebeloppet = bruttovärdet (+-0,05)
TerminalSlaveId O Anger ID för en inmatningsterminal.
cashRegisterSerialNumber

O

 Kassaregisterenhetens serienummer. Detta fält identifierar den specifika fysiska kassaregisterhårdvaran som används för att bearbeta transaktionen.
footerGraphicIndex O

Via footerGraphicIndex placeras ett fördefinierat grafiskt element i dokumentets sidfot.

Landspecifika uppgifter:
AuditLogEntryType   Anger typen av revisionsloggpost när dokumentet i sig är en revisionsloggpost.
amount   Ett belopp kopplat till dokumentets header (t.ex. för revisionsloggändamål).
identifier   Ett allmänt identifieringsfält (t.ex. för revisionsloggändamål).
DocumentGuid M Unikt identifieringsnummer för dokumentet med hjälp av UUID/GUID. Används även som länk för digitala kvitton.
DocumentId M Unikt, löpande nummer för dokumentet (kvittot) inom filialen / dotterbolaget / restaurangen (över alla kassor), tilldelat av kassasystemet (max. 40 tecken).
CreateDate M Tidpunkt för dokumentets skapande
BookDate M Bokningstid
AccountingDate O Möjligt bokningsdatum för detta dokument i bokföringen
ProcessStartDate R/M* Skapandetidpunkt för den första kvittensen inom hela processen (t.ex. Tyskland: Skapandetidpunkt för den första kundordern i samband med den aktuella betalningskvittensen – se även ”Särdrag för restaurangbranschen”)
DocumentNumber R/M* Dokumentets unika, löpande nummer (=”kvittensnummer”), tilldelat av kassasystemet.
documentNumberSeries O/M*

Namn på nummerserien för kvittonumret (DocumentNumber).

Landspecifik information:

  • Spanien: documentNumberSeries måste anges som obligatoriskt i Spanien (mer information: ”Fakturanummer och serier i Spanien ”).
    • alfanumeriskt (max. 20 tecken)
    • använd följande teckenuppsättning: 0123456789ABCDEFGHJKLMNPQRSTUVXYZ,
    • undvik bokstäverna I, Ñ, O och W för att förbättra läsbarheten,
    • använd inte gemener,
    • använd endast ett tecken för mellanslag,
    • textjustering till vänster, utan inledande mellanslag,
    • accenttecken ska inte användas,
    • bindestreck "-" får användas.
cancellationDocument M

Flag om det aktuella dokumentet används för att annullera ett annat (tidigare utfärdat) dokument

true – Annulleringsdokument

false – Inget annulleringsdokument
FailedToPay

O

 En boolean flagga (true/false) som anger om betalningen för dokumentet misslyckades.
documentReference O/M* Används för att hänvisa till ett annat dokument.
  {...}    
IsTraining O/M* Flagga för att markera utbildnings-/demodokument (genereras i kassans utbildnings-/demoläge).
TestCaseNumber

O/M*

Fält för att ange ett testfallsnummer för certifieringsändamål.

Landsspecifikationer:

  • Kanada – Québec: Testfallsnummer i DEV- eller ESSAI-miljö. Mer information finns i artikeln ”Kommunikation med WEB-SRM ”.
documentType O Angivelse av dokumenttyp
documentTypeCaption M*

Beskrivning av dokumenttypen. Används främst för att ge en bättre beskrivning eller förtydligande.

Landsspecifikationer:

  • Österrike: I Österrike (AT) måste documentTypeCaption ställas in därefter.
    • Startkvitto,
    • månadskvitto,
    • Årskvitto,
    • Slutkvitto
användare O/M*

Information om (kassaregister-)användaren.

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

Information om säljaren.

Landspecifika uppgifter:
  {...}    
AllocationGroups [] O/M*

Används för att tilldela kvitton till specifika objekt (t.ex. bord inom gastronomi).

Se även: Långvarig orderprocess inom restaurangbranschen.

Landspecifika detaljer:

  • Kanada – Québec: Elementet är kopplat till fältet ”noTabl ” i WEB-SRM-schemat. Endast 1 post med max. 5 alfanumeriska tecken är tillåten.
partner O/M*

Information om respektive (affärs)partner till det företag som utfärdar dokumentet.

Landsspecifikationer:

  • Kanada – Québec: Obligatoriskt fält vid B2B-transaktioner
  • Portugal: Obligatoriskt fält vid B2B-transaktioner
addressType   (I partner objektet) Nytt valfritt fält för att ange adresstyp (t.ex. fakturaadress).
  {...}    
anmärkningar O Registrering av ytterligare anteckningar
CustomerCount O/M*

Antal kunder som detta dokument avser (t.ex. inom restaurangbranschen, antalet gäster vid kassan/bordet)

Landspecifika uppgifter:

  • Kanada – Québec: Elementet är kopplat till fältet ”nbClint ” i WEB-SRM-schemat.
PaymentTerms O Betalningsvillkor
  {...}    
ServicePeriodStart O

Tjänsteperiodens start (särskilt för fakturor)

Landspecifika uppgifter:

  • Portugal: Det är obligatoriskt att ange tjänsteperioden för fakturor ("documentType": "[1] = Invoice")
ServicePeriodEnd O

Tjänsteperiodens slut (särskilt för fakturor)

Landsspecifikationer:

  • Portugal: Det är obligatoriskt att ange tjänsteperioden för fakturor ("documentType": "[1] = Invoice")
PositionCount O/M*

Antal positioner i kvittot (alla positioner, inklusive artikel, text, bokning, delsumma, total)

Se även positionsobjektet.

Landspecifika uppgifter:

  • Frankrike: Obligatoriskt fält.
DocumentIssueType O/M*

Anger typen av kvittoutfärdande.

  • paper – tryckt dokument
  • digitalReceipt – elektroniskt dokument (t.ex. e-post)
  • paperAndDigitalReceipt – utfärdande i både tryckt och elektronisk form
  • notIssued – dokumentet utfärdades inte

Landuppgifter:

  • Kanada – Québec: Obligatoriskt fält.
coupon O Möjlighet att skriva ut ytterligare kuponger och andra element på kvittot.
  {...}    
serviceType O/M*

Angivelse av servicetyp inom restaurangbranschen (bordsservering, servering vid disken).

Möjliga värden (CamelCase ska följas!)

  • CounterService – Service vid disken
  • DeliveryByOperator – Leverans av operatör
  • OrderThroughDigitalPlatform – Leverans via digital plattform (tredje part)
  • TableService – Servering vid bordet / bordsservering

Landsspecifikationer:

  • Kanada – Québec: Obligatoriskt fält inom gastronomi (RBF – restauranger, barer, food trucks). Detaljer om ”verksamhet”.
    Kartläggning (RetailForce DOM – WEB-SRM):
    • CounterService – ”CMP”
    • DeliveryByOperator – ”LVR”
    • OrderThroughDigitalPlatform – ”LVT”
    • Bordsbetjäning – ”TBL”
IsEcommerceTransaction O/M*

Anger om det är en e-handelstransaktion (true/falskt).

Landuppgifter:

  • Kanada – Québec: Obligatoriskt fält vid e-handelstransaktioner.
TaxPositions R

Angivelse av alle Vat-positioner i dokumentet.

Antingen måste alla eller inga Vat-positioner anges.

För att hämta momspositionerna från dokumentet (när denna egenskap inte har angetts) använder du GetTaxPositions(Document, boolean).

Obs! Österrike: Vi rekommenderar att du använder denna array för att överföra skattepositionerna för ett kvitto för att undvika avrundningsproblem inom dataregistreringsprotokollet ("DEP7").
  {...}    
fiscalResponse -

Svar från skattehanteringstjänsten efter överföring med createDocument och storeDocument.

Vi rekommenderar att innehållet i fiscalResponse lagras i kassasystemets databas.

Observera: vissa delar av objektet fiscalResponse måste, efter att funktionen createDocument har anropats, inkluderas i JSON-dokumentet (som ska skickas till storeDocument ). Inkludera INTE hela objektet fiscalResponse!
  {...}    
fiscalDocumentNumber M*

Fiskaldokumentnummer (tilldelat av RetailForce systemet eller av respektive skatteregistreringsenhet – t.ex. TSE i Tyskland)

Observera: I system upp till version 1.7.7 returnerades informationen fiscalDocumentNumber i fältet fiscalisation DocumentNumber i objektet fiscalResponse. Se även artikeln: ”Given Transaction not started ”. I version 1.7.7 infördes ett ytterligare fält, fiscalDocumentNumber (string), i objektet fiscalResponse.
fiscalDocumentRevision O/M*

Revisionsnummer för skattedokumentet (tilldelat av RetailForce systemet eller av respektive skatteenhet – t.ex. TSE i Tyskland)

Observera: I system upp till v1.7.7 returnerades fiscalDocumentRevision i fältet fiscalisation DocumentRevision i headern på fiscalResponse. Se även artikeln: ”Angiven transaktion har inte påbörjats ”. Från och med v1.7.7 har egenskapen i fiscalResponse-objektet bytt namn till fiscalDocumentRevision och returneras nu endast i arrayen AdditionalFields i fiscalResponse-Germany.
fiscalDocumentStartTime M* Tidpunkt för skattedokumentets skapande (tilldelad av RetailForce systemet eller av respektive skatteenhet – t.ex. TSE i Tyskland)
positioner M Information om respektive kvitto-/dokumentposition (innehållet beror på dokument- och positionstyp – documentType, positionType)
  {...}    
betalningar O/M* Information om betalning (användningen beror på dokumenttypen – documentType)
  {...}    
AdditionalHeader O

Arrayen AdditionalHeader kan användas för att ange ytterligare fritextrader i dokumenthuvudet.

Landspecifika uppgifter:

  • Italien: Lägg till ytterligare rader i headern (max. 9 rader med upp till 46 tecken vardera (överskjutande tecken avkortas).
    Mer information finns i artikeln: Ytterligare texter i header och Footer

Obs! För närvarande stöds denna array endast i Italien. Den kan även fyllas i i andra länder, men har ingen effekt.
AdditionalFooter O

Arrayen AdditionalFooter kan användas för att ange ytterligare fritextrader i dokumentets sidfot.

Landsspecifika detaljer:

Obs! För närvarande stöds denna array endast i Italien. Den kan även fyllas i i andra länder, men har ingen effekt.
FiscalAdditionalFields O  

 

Den här artikeln har översatts automatiskt.

Relaterade artiklar

Kommentarer

0 kommentarer

logga in för att lämna en kommentar.

Powered by Zendesk