Обект „positions“

Настоящата статия разглежда обекта „positions“ в рамките на обекта „Document“ (обект „Document“).

Пълно описание на RetailForce DOM (Document Object Model), както и описание на отделните елементи, можете да намерите в раздела за изтегляне на RetailForce website (Object model documentation.pdf) в съответната директория с версии.

Обектът „positions“ съдържа информация за съответната позиция на документа.

Обектът „positions“ се състои от:

• DocumentPositionBase – съдържа основна информация за позицията (независимо от типа на съответната позиция)
• Информация, специфична за типа на позицията – в зависимост от типа на позицията „type“ (DocumentPositionType) трябва да се задава различно съдържание (типът на позицията определя съдържанието на позицията).

DocumentPositionsBase

Следващият обект съдържа примерни данни.

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

Обектът DocumentPositionsBase съдържа следната информация.

Информация в колоната „Type“:

• M ... задължително / изисквано
• M* ... задължително / изисква се в определени държави или при определени условия
• R ... препоръчително
• O... по избор

DocumentPositionType

[0] = Артикул

Типът „артикул“ (DocumentPositionItem) представлява конкретен артикул за продажба (стока или услуга).

Пример за 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": "1"
      }
      "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": {}
   }
],

Обектът DocumentPositionItem съдържа следната информация.

Информация в колоната „Тип“:

• M ... задължително / изисквано
• M* ... задължително / изисквано в определени държави или при определени условия
• R ... препоръчително
• O... по избор

[1] = Подпозиция

„Подпозициите“ (DocumentPositionSubItem) дават възможност да се опише съставът на продадените продукти или описанията на продуктовите групи на ниво позиция.

Пример: Меню = Кола и хамбургер.

SubItems имат обяснителен характер и не е задължително да се използват. Те също така нямат влияние върху цената и продажбите / данъка върху добавената стойност.

[2] = Текст

Използва се за преобразуване на позицията на текст или Barcode в документа.

Пример за 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": {}
   }
],

Обектът „DocumentPositionText“ съдържа следната информация.

Информация в колоната „Type“:

• M ... задължително / изисквано
• M* ... задължително / изисква се в определени държави или при определени условия
• R ... препоръчително
• O... по избор

[3] = Резервация

Позициите за резервации (DocumentPositionBooking) се използват за депозити, тегления, както и за продажби на многофункционални ваучери (PayIn, payOut, MultiPurposeVoucher,...).

Пример за DocumentPositionBooking:

positions": [
   {
      "type": 3,
      "caption": "Depositg",
      "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": {}
   }
],

Обектът DocumentPositionBooking съдържа следната информация.

Информация в колоната „Type“:

• M ... задължително / изисквано
• M* ... задължително / изисквано в определени държави или при определени условия
• R ... препоръчително
• O... по избор

[9] = Междинна сума

Междинна сума на позицията

[10] = Общо

Позиция „Общо“. Ако се използва DocumentPositionTotal, тя трябва винаги да бъде последната позиция в документа (най-високият PositionNumber).

Пример за 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": {}
   }
],

Обектът DocumentPositionTotal съдържа следната информация.

Информация в колоната „Type“:

• M ... задължително / изисквано
• M* ... задължително / изисквано в определени държави или при определени условия
• R ... препоръчително
• O... по избор

Тази статия е преведена автоматично.