Skip to main content

Header-објекат RetailForce DOM

Harald Krondorfer
  • Updated

Овај чланак обухвата објекат заглавља ("плаћања"), односно елементе у заглављу у оквиру објекта документа.

Комплетна документација за RetailForce DOM (модел објеката документа), као и опис појединачних елемената, може се наћи у одељку За преузимање на веб-сајту RetailForce (Object model documentation.pdf) у одговарајућем директоријуму верзија.

Објекат заглавља

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

Објекат заглавља садржи следеће информације.

Информације у колони "Type":

  • M ... обавезно ("mandatory")
  • M* ... обавезно у одређеним земљама или под одређеним условима
  • R ... препоручено ("препоручено")
  • O ... опционално
Елемент Тип Опис
јединствениКлијентИД M Јединствени ИД клијента, одговара ИД терминала у RetailForce облаку (враћа се/додељује током пуштања у рад путем PUT /api/v1/management/clients/byCloud).
applicationVersion R/M*

Верзија софтвера благајне.

Пажња: Имајте у виду да је у неким земљама (Француска) број верзије фиксни као део процеса сертификације. Ако је наведена нетачна верзија (која не одговара сертификованом броју), није могуће довршити документ (= грешка). Такође погледајте: Сертификована верзија .

Подаци о земљи:
applicationVersionId

R/M*

ИД верзије софтвера касе.

Подаци о земљи:

  • Канада - Квебек: Обавезно поље. ИД верзије софтвера, достављен / генерисан од стране Revenu Québec. Повезано са пољем "idVersi ". Имајте у виду "Верзије софтвера Канада / Квебек "!
prethodnaVerzijaAplikacije

R/M*

ИД претходне верзије софтвера за касу.

Подаци о земљи:
верзија фискалног модула O/M* Верзија фискалног модула (поуздани фискални модул) коришћена за генерисање одговарајућег документа. Аутоматски подешава мидлвејр ако софтвер не пренесе.
fiscalCountryModuleVersion O/M* Верзија модула за земљу (поузданог фискалног модула за земљу) коришћена за генерисање одговарајућег документа. Аутоматски подешава мидлвејр ако софтвер не пренесе.
Тип фискализације O  
  потпис O Потпис
  фискални штампач   Фискални штампач
  онлајн   Онлајн
  потписСаОнлајн   Потпис са онлајн везом
  без фискализације   Без фискализације
Тип фискализације Италија O  
  принтер Oпринтер Телематички регистар
реtailForceReceiptId O Глобално јединствен број потврде (који се састоји од terminalId и редовног броја потврде). Може се креирати приликом креирања трансакције (помоћу createDocument).
additionalFields O  
  additionalProp1-x O  
аутоматски израчун ПДВ-а O

Овај елемент покреће аутоматско израчунавање различитих поља са укупним износима на нивоу позиције.

0 noCalculation - не врши се аутоматско израчунавање

1 netValueCalculation - аутоматско израчунавање нето износа и износа ПДВ-а. Морају бити наведени најмање бруто износ и проценат/идентификација ПДВ-а.

2 grossValueCalculation - аутоматско израчунавање бруто и пореског износа. Мора се навести најмање нето вредност и проценат ПДВ-а/идентификација.
дозвољено одступање ПДВ-а O

Може се користити за компензацију проблема у заокруживању ПДВ-а.

Молимо користите са опрезом! Ако се подеси на велику вредност, провера обрачуна ПДВ-а је онемогућена!

Пример: "allowedVatDeviation": 0.05, дозвољава одступање од 5 центи између нето вредности + вредности пореза = бруто вредности (±0.05)
terminalSlaveId O Спецификација ИД-а улазног терминала.
серијски број касе

O

 Серијски број уређаја благајне. Ово поље идентификује специфичан физички хардвер благајне који се користи за обраду трансакције.
footerGraphicIndex O

Померањем индекса графичког елемента у подножју документа (footerGraphicIndex) у подножје документа се убацује унапред дефинисан графички елемент.

Подаци о земљи:

  • Италија: контролише функцију Footer Graphico на EPSON RT уређајима.
auditLogEntryType   Одређује тип уноса у записник о ревизији када је сам документ унос у записник о ревизији.
износ   Износ повезан са заглављем документа (нпр. у сврху евиденције ревизије).
идентификатор   Опште поље за идентификацију (нпр. у сврху евиденције ревизије).
documentGuid M Јединствени идентификатор документа користећи UUID / GUID. Такође се користи као веза за дигиталне рачуне.
documentId M Јединствени, узастопни број документа (потврде о плаћању) у оквиру филијале / подружнице / ресторана (у свим регистрима), додељен системом касе (макс. 40 знакова).
createDate M Време креирања документа
Датум резервације M Време резервације
датас рачуноводства O Могући датум за књижење овог документа
датумПочећаПроцеса R/M* Време креирања првог потврђеног рачуна у оквиру целог процеса (нпр. Немачка: време креирања прве наруџбине купца у вези са овим потврђеним рачуном – погледајте и "Посебне карактеристике гастрономије")
бројдокумента R/M* Јединствени, узастопни број документа ("број потврде о уплати"), додељен од стране система касе.
серијабројдокумента O/M*

Назив серије бројева потврде (documentNumber).

Подаци о земљи:

  • Шпанија: documentNumberSeries мора бити наведена као обавезна у Шпанији (више информација: "Бројеви фактура и серије у Шпанији ").
    • алфанумерички (макс. 20 знакова)
    • користите следећи скуп карактера: 0123456789ABCDEFGHJKLMNPQRSTUVXYZ,
    • избегавајте слове I, Ñ, O и W ради боље читљивости,
    • не користите мала слова,
    • користите само један знак за размаке,
    • текст поравнајте лево, без водећих размака,
    • не користити акценте,
    • може се користити цртица "-".
документ о отказивању M

Означите да ли се овај документ користи за поништење другог (раније издатог) документа

true - Документ за поништење

false - Нема документа о поништењу
неуспело плаћање

O

 Булеовска ознака (true/false) који означава да ли је плаћање за документ неуспешно.
референцаДокумента O/M* Користи се за позивање другог документа.
  {...}    
isTraining O/M* Ознака за означавање докумената за обуку/демонстрацију (генерисано у режиму обуке/демонстрације касе).
бројслучајатеста

O/M*

Поље за навођење броја случаја тестирања у сврху сертификације.

Подаци о земљи:

  • Канада - Квебек: број тест случаја у DEV или ESSAI окружењу. Више информација у чланку "Communication with WEB-SRM ".
тип документа O Навођење типа документа
Наслов типа документа M*

Опис типа документа. Служи у суштини за боље описивање или појашњење.

Подаци о земљи:

  • Аустрија: у Аустрији (AT) документTypeCaption мора бити подешен у складу са тим.
    • Почетак потврде,
    • Месечна потврда,
    • Годишњи пријемац,
    • Коначна потврда
корисник O/M*

Информације о кориснику (касе).

Подаци о земљи:
  {...}    
продавац O/M*

Информације о продајном особљу.

Подаци о земљи:
  {...}    
allocationGroups [] O/M*

Користи се за додељивање потврда одређеним стварима (нпр. столовима у гастрономији).

Такође погледајте: Дугорочни процес наручивања у гастрономији.

Детаљи о земљи:

  • Канада - Квебек: Елемент је повезан са пољем "noTabl " у шеми WEB-SRM. Дозвољена је само једна унос са највише 5 алфанумеричких знакова.
партнер O/M*

Информације о одговарајућим (пословним) партнерима компаније која издаје документ.

Подаци о земљи:

  • Канада - Квебек: Обавезно поље у случају B2B трансакција
  • Португал: Обавезно поље у случају B2B трансакција
тип адресе   (У partner object) Ново опционо поље за навођење типа адресе (нпр. адреса за наплату).
  {...}    
напомене O Запис додатних белешки
број купаца O/M*

Број купаца у вези са овим документом (нпр. у гастрономији, број гостију на каси/столу)

Подаци о земљи:

  • Канада - Квебек: Елемент је повезан са пољем "nbClint " у шеми WEB-SRM.
условиПлаћања O Услови плаћања / услови плаћања
  {...}    
servicePeriodStart O

Почетак периода услуге (посебно за фактуре)

Подаци о земљи:

  • Португал: Обавезно је навести период услуге за фактуре ("documentType": "[1] = фактура")
servicePeriodEnd O

Крај периода услуге (посебно за фактуре)

Подаци о земљи:

  • Португал: Обавезно је навести период услуге за фактуре ("documentType": "[1] = Invoice")
positionCount O/M*

Број позиција садржаних у рачуну (све позиције, укључујући ставку, текст, резервацију, под-укуп, укупно)

Погледајте и Објекат позиције.

Подаци о земљи:

  • Француска: Обавезно поље.
тип издавања документа O/M*

Дефинише тип издавања потврде.

  • папир - штампани документ
  • digitalReceipt - електронски документ (нпр. е-пошта)
  • paperAndDigitalReceipt - издавање у штампаном и електронском облику
  • notIssued - документ није издат

Подаци о земљи:

  • Канада - Квебек: Обавезно поље.
купон O Могућност штампања додатних купона и других елемената на потврди.
  {...}    
тип услуге O/M*

Дефинисање типа услуге у гастрономији (услуга за столом, услуга на шалтеру).

Могуће вредности (поштовати CamelCase!)

  • CounterService - Услуга на шалтеру
  • Доставаод оператера - Достава од оператера
  • Наруџбина преко дигиталне платформе - испорука преко дигиталне платформе (трећа страна)
  • Стони сервис - сервис за столом / стони сервис

Детаљи о земљи:

  • Канада - Квебек: обавезно поље у гастрономији (RBF - ресторани, барови, камиони са храном). Детаљ о "активности".
    Мапирање (RetailForce DOM - WEB-SRM):
    • Услуга на шалтеру - "CMP"
    • DeliveryByOperator - "LVR"
    • OrderThroughDigitalPlatform - "LVT"
    • Стони сервис - "TBL"
isEcommerceTransaction O/M*

Индикација да ли је у питању е-трговинска трансакција (истина / лаж).

Подаци о земљи:

  • Канада - Квебек: обавезно поље у случају е-трговинских трансакција.
порески положаји R

Спецификација свих ПДВ позиција документа.

Мора се навести или све или ниједна позиција ПДВ-а.

Да бисте добили пореске позиције из документа (када ова својства нису подешена), користите GetTaxPositions(Document, Boolean).

Напомена за Аустрију: Препоручујемо коришћење овог низа за пренос пореских позиција на потврди о плаћању како би се избегли проблеми са заокруживањем у оквиру протокола за евидентирање података ("DEP7").
  {...}    
fiscalResponse -

Одговор сервиса за фискализацију након послова createDocument и storeDocument.

Препоручујемо да се садржај објекта fiscalResponse сачува у бази података касе.

Напомена: одређени елементи објекта fiscalResponse, након позива функције createDocument , морају бити укључени у JSON документ (који треба послати у storeDocument ). Молимо НЕ укључујте цео објекат fiscalResponse!
  {...}    
број фискалног документа M*

Број фискалног документа (додељен од стране система RetailForce или одговарајуће фискалне јединице – нпр. TSE у Немачкој)

Пажња: Имајте у виду да су у системима до верзије v1.7.7 информације о броју фискалног документа биле враћене у поље fiscalisation DocumentNumber објекта fiscalResponse. Погледајте и чланак: "Дата трансакција није започета ". У верзији v1.7.7 уведено је додатно поље fiscalDocumentNumber (стринг) у објекат fiscalResponse.
ревизија фискалног документа O/M*

Број ревизије фискалног документа (додељен од стране система RetailForce или одговарајуће јединице за фискализацију – нпр. TSE у Немачкој)

Пажња: Имајте у виду да се у системима до верзије v1.7.7 поље fiscalDocumentRevision враћало у пољу fiscalisation DocumentRevision у заглављу објекта fiscalResponse. Погледајте и чланак: "Дата трансакција није започета ". Од верзије v1.7.7 својство унутар објекта fiscalResponse је преименовано у fiscalDocumentRevision и сада се враћа само у низу additionalFields објекта fiscalResponse-Germany.
ВремеПочећаФискалногДокумента M* Време креирања фискалног документа (додељено од стране система RetailForce или одговарајуће фискалне јединице - нпр. TSE у Немачкој)
позиције M Информације о одговарајућој позицији потврде/документа (садржај зависи од типа документа и позиције - documentType, positionType)
  {...}    
плаћања O/M* Информације о уплати (употреба зависи од типа документа - documentType)
  {...}    
додатни заглавак O

Масива additionalHeader може да се користи за постављање додатних линија слободног текста у заглављу документа.

Подаци о земљи:

Напомена: Тренутно је ова низа подржана само у Италији. Може се попунити и у другим земљама, али нема ефекта.
additionalFooter O

Масиву additionalFooter можете користити за додавање додатних линија слободног текста у подножје документа.

Детаљи о земљи:

Напомена: Тренутно је овај низ подржан само у Италији. Може се попунити и у другим земљама, али нема ефекта.
Фискалне додатне поља O  

 

Овај чланак је аутоматски преведен.

Povezani članci

Komentari

Komentara: 0

Molimo prijavi se da biste komentarisali.

Powered by Zendesk