Objekt „positions“

Tento článek se zabývá objektem „positions“ v rámci objektu „Document“ (objekt Document).

Úplný popis DOM (Document Object Model) systému RetailForce, stejně jako popis jednotlivých prvků, najdete v sekci ke stažení na webových stránkách RetailForce (Object model documentation.pdf) v příslušném adresáři s verzemi.

Objekt „positions“ obsahuje informace o příslušné pozici v dokumentu.

Objekt „positions“ se skládá z:

• DocumentPositionBase – obsahuje základní informace o pozici (nezávisle na typu dané pozice)
• Informace specifické pro typ pozice – v závislosti na typu pozice „type“ (DocumentPositionType) je třeba specifikovat různý obsah (typ pozice definuje obsah pozice).

DocumentPositionsBase

Následující objekt obsahuje vzorová data.

  "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-05-03T11:20:40.057+01:00",
        "returnReasonType": "userMistake",
        "returnReasonText": "string"
      },
      "cancellationPosition": true,
      "deletedPosition": false,
      "type": "[0] = Item",
      "additionalFields": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "createDate": "2023-05-03T11:20:40.057+01:00",
      "externalIdentifier": [
        "string"
      ],
      "user": {
        "id": "string",
        "caption": "string",
        "firstName": "string",
        "lastName": "string",
        "taxNumber": "string"
      },
      "salesPerson": {
        "id": "string",
        "caption": "string",
        "firstName": "string",
        "lastName": "string",
        "taxNumber": "string"
      },
      "FiscalAdditionalFields": {}
    }
  ],

Objekt DocumentPositionsBase obsahuje následující informace.

Informace ve sloupci „Type“:

• M … povinné / vyžadované
• M* ... povinné / vyžadované v určitých zemích nebo za určitých podmínek
• R ... doporučeno
• O... volitelné

DocumentPositionType

[0] = Položka

Typ „položka“ (DocumentPositionItem) představuje konkrétní prodejní položku (zboží nebo službu).

Příklad DocumentPositionItem:

positions": [
   {
      "itemCaption": "Prime rib steak house style",
      "itemShortCaption": "PrimeRibSpec",
      "itemSerialNumber": "string",
      "discounts": [
         {
            "discountValue": 1.6900,
            "caption": "Regular customer discount",
            "discountOrder": 0,
            "type": 1,
            "typeValue": 10.00,
            "promotionKeys": [],
            "identifier": null
         }
      ],
      "type": 0,
      "useSubItemVatCalculation": false,
      "subItems": [],
      "inHouse": true,
      "itemGroupId": "1000",
      "itemGroupCaption": "mains",
      "costPrice": null,
      "itemDateOfEntry": null,
      "quantity": 1.0,
      "quantityUnit": {
         "id": null,
         "isoCode": "Quantity"
      },
      "itemId": "1028",
      "itemType": "[0] = Article",
      "baseNetValue": 14.08,
      "baseGrossValue": 16.90,
      "baseTaxValue": 2.82,
      "baseTaxValue2": 0,
      "gtin": "8718274490558",
      "businessTransactionType": 0,
      "itemTypeClassification": "[1] = AlcoholicBeverage",
      "vatIdentification": 1,
      "vatPercent": 20.00,
      "vatPercent2": 5,
      "additionalTax": {
         "additionalTaxType": "alcohol",
         "additionalTaxTypeIdentification": "string",
         "taxPercent": 0,
         "taxValue": 0
      },
      "netValue": 12.68,
      "grossValue": 15.21,
      "taxValue": 2.53,
      "taxValue2": 0,
      "accountingIdentifier": null,
      "itemTaxType": null,
      "positionNumber": 0,
      "positionReference": null,
      "cancellationPosition": false,
      "deletedPosition": false,
      "additionalFields": {},
      "createDate": null,
      "externalIdentifier": [
         "string"
      ],
      "user": {
         "id": "string",
         "caption": "string",
         "firstName": "string",
         "lastName": "string",
         "taxNumber": "string"
      },
      "salesPerson": {
         "id": "string",
         "caption": "string",
         "firstName": "string",
         "lastName": "string",
         "taxNumber": "string"
      },
      "FiscalAdditionalFields": {}
   }
],

Objekt DocumentPositionItem obsahuje následující informace.

Informace ve sloupci „Typ“:

• M ... povinné / vyžadované
• M* ... povinné / vyžadované v určitých zemích nebo za určitých podmínek
• R ... doporučeno
• O... volitelné

[1] = SubItem

„Podpoložky“ (DocumentPositionSubItem) umožňují vysvětlit složení prodávaných produktů nebo popisy skupin produktů na úrovni položky.

Příklad: Menu = Cola a hamburger.

SubItems nemusí být použity. Pokud má nadřazená položka „UseSubItemVatCalculation“: true (výchozí nastavení), použije se Vat podpoložek namísto Vatu nadřazené položky a jejich hodnoty se musí sčítat do základních hodnot nadřazené položky. Při nastavení „UseSubItemVatCalculation“: false platí Vat nadřazené položky a podpoložky pouze vysvětlují složení položky.

[2] = Text

Slouží k převodu pozice textu nebo Barcode v dokumentu.

Příklad DocumentPositionText:

positions": [
   {
      "type": 2,
      "text": "Example text",
      "barcodeType": code128,
      "barcode": "Example text",
      "positionNumber": 0,
      "positionReference": null,
      "cancellationPosition": false,
      "deletedPosition": false,
      "additionalFields": {},
      "createDate": null,
      "externalIdentifier": [
         "string"
      ],
      "user": {
         "id": "string",
         "caption": "string",
         "firstName": "string",
         "lastName": "string",
         "taxNumber": "string"
      },
      "salesPerson": {
         "id": "string",
         "caption": "string",
         "firstName": "string",
         "lastName": "string",
         "taxNumber": "string"
      },
      "FiscalAdditionalFields": {}
   }
],

Objekt DocumentPositionText obsahuje následující informace.

Informace ve sloupci „Type“:

• M ... povinné / vyžadované
• M* ... povinné / vyžadované v určitých zemích nebo za určitých podmínek
• R ... doporučeno
• O... volitelné

[3] = Rezervace

Pozice rezervace (DocumentPositionBooking) se používají pro vklady, výběry i prodej víceúčelových poukázek (payIn, payOut, multiPurposeVoucher,...).

Příklad DocumentPositionBooking:

positions": [
   {
      "type": 3,
      "caption": "Deposit",
      "identifier": null,
      "businessTransactionType": 11,
      "payOutType": null,
      "vatIdentification": 4,
      "vatPercent": 0.00,
      "netValue": 20.00,
      "grossValue": 20.00,
      "taxValue": 0.00,
      "accountingIdentifier": null,
      "itemTaxType": null,
      "positionNumber": 0,
      "positionReference": null,
      "cancellationPosition": false,
      "deletedPosition": false,
      "additionalFields": {},
      "createDate": null,
      "externalIdentifier": [
         "string"
      ],
      "user": {
         "id": "string",
         "caption": "string",
         "firstName": "string",
         "lastName": "string",
         "taxNumber": "string"
      },
      "salesPerson": {
         "id": "string",
         "caption": "string",
         "firstName": "string",
         "lastName": "string",
         "taxNumber": "string"
      },
      "FiscalAdditionalFields": {}
   }
],

Objekt DocumentPositionBooking obsahuje následující informace.

Informace ve sloupci „Type“:

• M ... povinné / vyžadované
• M* ... povinné / vyžadované v určitých zemích nebo za určitých podmínek
• R ... doporučeno
• O... volitelné

[9] = SubTotal

Položka „SubTotal“

[10] = Total

Celková pozice. Pokud se používá DocumentPositionTotal, musí to být vždy poslední pozice v dokumentu (nejvyšší číslo pozice).

Příklad DocumentPositionTotal:

positions": [
   {
      "type": 10,
      "rounding": null,
      "baseValue": 200.00,
      "value": "200.00",
      "discounts": [
         {
            "discountValue": 1.6900,
            "caption": "Regulars discount",
            "discountOrder": 0,
            "type": 1,
            "typeValue": 10.00,
            "promotionKeys": [],
            "identifier": null
         }
      ],
      "caption": "Total",
      "positionNumber": 0,
      "positionReference": null,
      "cancellationPosition": false,
      "deletedPosition": false,
      "additionalFields": {},
      "createDate": null,
      "externalIdentifier": [
         "string"
      ],
      "user": {
         "id": "string",
         "caption": "string",
         "firstName": "string",
         "lastName": "string",
         "taxNumber": "string"
      },
      "salesPerson": {
         "id": "string",
         "caption": "string",
         "firstName": "string",
         "lastName": "string",
         "taxNumber": "string"
      },
      "FiscalAdditionalFields": {}
   }
],

Objekt DocumentPositionTotal obsahuje následující informace.

Informace ve sloupci „Type“:

• M ... povinné / vyžadované
• M* ... povinné / vyžadované v určitých zemích nebo za určitých podmínek
• R ... doporučeno
• O... volitelné

Tento článek byl přeložen automaticky.