Tento článok sa zaoberá objektom „positions“ v rámci objektu „Document“ (objekt Document).
Úplný popis RetailForce DOM (Document Object Model), ako aj popis jednotlivých prvkov, nájdete v sekcii na stiahnutie na RetailForce website (Object model documentation.pdf) v príslušnom adresári verzií.
Objekt „positions“ obsahuje informácie o príslušnej pozícii v dokumente.
Objekt „positions“ sa skladá z:
- DocumentPositionBase – obsahuje základné informácie o pozícii (nezávisle od typu príslušnej pozície)
- Informácie špecifické pre typ pozície – v závislosti od typu pozície „type“ (DocumentPositionType) je potrebné špecifikovať rôzny obsah (typ pozície definuje obsah pozície).
DocumentPositionsBase
Nasledujúci objekt obsahuje vzorové údaje.
"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 nasledujúce informácie.
Informácie v stĺpci „Type“:
- M ... povinné / vyžadované
- M* ... povinné / vyžadované v určitých krajinách alebo za určitých podmienok
- R ... odporúčané
- O... voliteľné
| Prvky | Typ | Popis | |
| PositionNumber | M |
Poradové číslo pozície.
Pozor:
Číslo prvej pozície je vždy „0“!
|
|
| positionReference | O | Odkaz na inú pozíciu v dokumente. Je ekvivalentný parametru documentReference. | |
| {...} | O | ||
| cancellationPosition | M | „true“, ak táto pozícia ruší pozíciu v inom dokumente; inak „false“. | |
| DeletedPosition | O | „true“, ak bola táto pozícia odstránená; inak „false“. | |
| typ | M |
určuje typ pozície „type“ (DocumentPositionType). Enum:
Vysvetlenia jednotlivých typov (DocumentPositionType) nájdete za touto tabuľkou. |
|
| AdditionalFields | O | ||
| {...} | |||
| CreateDate | M | Čas vytvorenia pozície. | |
| ExternalIdentifier | O | Externé ID (z predchádzajúceho systému), určené na interné účely, nemá vplyv na zdanenie. | |
| user | O | Údaje o používateľovi (pokladne), ktorý zadal príslušnú položku. | |
| {...} | |||
| SalesPerson | O | Údaje o predajcovi na príslušnej pozícii. | |
| {...} | |||
| FiscalAdditionalFields | O | ||
DocumentPositionType
[0] = Položka
Typ „položka“ (DocumentPositionItem) je konkrétna predajná položka (tovar alebo služba).
Prí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": "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": {}
}
],Objekt DocumentPositionItem obsahuje nasledujúce informácie.
Informácie v stĺpci „Type“:
- M ... povinné / vyžadované
- M* ... povinné / vyžadované v určitých krajinách alebo za určitých podmienok
- R ... odporúčané
- O... voliteľné
| Prvky | Typ | Popis | |
| ItemCaption | M | Označenie položky, popis služby | |
| ItemShortCaption | O | Skrátený názov položky, používaný napr. v prípade obmedzenia dĺžky reťazca znakov, ako je to u daňových tlačiarní. | |
| ItemSerialNumber | M* |
Sériové číslo položky. Údaje o krajine:
|
|
| zľavy | Údaje o zľavách, zníženiach cien atď. | ||
| DiscountValue | M |
Suma zľavy / výška zľavy
Pozor:
ak je DiscountType [1] = zľava, suma zľavy sa musí zadať s 4 desatinnými miestami!
|
|
| caption | R |
Označenie zľavy Údaje o krajine:
|
|
| DiscountOrder | M* |
Označuje poradie, v akom sa zľava vypočítava. Prvá zohľadnená zľava má hodnotu 0. Musí byť špecifikované, ak sa na položku uplatňuje viac zliav. |
|
| type | M |
Typ zľavy Enum:
|
|
| TypeValue | M |
Hodnota rabatu (súčet zľavy) pri [0] = Zľava: DiscountValue (=> DiscountValue = TypeValue) pri [1] = Zľava: percentuálna zľava (napr. 10 % zľava) |
|
| PromotionKeys | O | Propagačné kľúče – ak sa používajú (napr. kód poukážky) | |
| identifikátor | O | Dodatočný identifikátor zľavy (možno použiť napr. na zoskupovanie zliav do typov zliav). | |
| typ | M | Typ pozície (DocumentPositionType) | |
| UseSubItemVatCalculation | O | „true“, ak sa má prevziať výpočet DPH podpolí (SubItems) a DPH nadradenej položky sa má ignorovať; inak „false“. | |
| SubItems | O | Podrobnosti o SubItems. Pozri: DocumentPositionType [1] = SubItem | |
| [...] | |||
| inhouse | O | Označuje predaj v rámci spoločnosti alebo mimo spoločnosti (true / false). | |
| ItemGroupId | M* |
Indikátor skupiny článkov Údaje o krajine:
|
|
| ItemGroupCaption | O | Označenie skupiny položiek | |
| CostPrice | O/M* |
Jednotková cena tovaru Údaje o krajine:
|
|
| itemDateOfEntry | M* |
Čas vytvorenia položky. Údaje o krajine:
|
|
| množstvo | M | Informácie o množstve tovaru | |
| QuantityUnit | M* |
Špecifikácia jednotky miery Údaje o krajine:
|
|
| ID | M* |
Uvedenie jednotky miery. Údaje o krajine:
|
|
| isoCode | M* |
Štandardná merná jednotka podľa kódu ISO/UCUM. Ďalšie informácie nájdete v článku, na ktorý odkazuje tento odkaz. | |
| ItemId | M | ID položky | |
| ItemType | M* |
Popisuje typ položky: tovar alebo služby.
Údaje o krajine:
|
|
| BaseNetValue | M* |
Celková čistá suma (bez Vat) pred zľavou alebo príplatkom
Pozor:
(Čistá) suma riadku/pozície, NIE položky. Ak je množstvo = 2, potom je BaseNetValue tiež cena položky x 2!
|
|
| BaseGrossValue | M* |
Hrubá suma (vrátane Vat) pred zľavou alebo príplatkom
Pozor:
(Hrubá) suma riadku/pozície, NIE položky. Ak je množstvo = 2, potom je BaseGrossValue tiež cenou položky x 2!
|
|
| BaseTaxValue | M* |
Celková suma Vat (alebo súčet prvej sadzby dane) pred zľavou alebo príplatkom
Pozor:
(Vat) suma riadku/pozície, NIE položky. Ak je množstvo = 2, potom je BaseTaxValue tiež cena položky x 2!
Údaje o krajine:
|
|
| BaseTaxValue2 | M* |
Súčet druhej daňovej sadzby položky pred zľavou/prirážkou. Údaje o krajine:
|
|
| GTIN | O |
Globálne číslo obchodnej položky (GTIN) Údaje o krajine:
|
|
| BusinessTransactionType | M |
Typ obchodnej transakcie. Enum:
|
|
| ItemTypeClassification |
ItemTypeClassification sa môže použiť na ďalšiu klasifikáciu položky. ItemTypeClassification je možné nastaviť len vtedy, ak bola vlastnosť „ItemType“ nastavená na „[0] – Článok“ alebo „ItemType“: 0. Podrobné informácie o vlastnosti „ItemTypeClassification“ nájdete v článku, na ktorý odkazuje tento odkaz. K dispozícii sú nasledujúce klasifikácie.
Údaje o krajine:
|
||
| VatIdentification | M |
ID sadzby DPH. Možno vyžiadať prostredníctvom GET /api/v1/information/client/ {clientId}/getVatIdentification, pričom sa špecifikuje sadzba DPH príslušnej krajiny. sadzba príslušnej krajiny. |
|
| VatPercent | M |
Sadzba Vat v percentách alebo prvá daňová sadzba platná pre daný tovar v príslušnej krajine. Údaje o krajine:
|
|
| VatPercent2 | M* |
druhá daňová sadzba uplatniteľná na daný tovar, vyjadrená v percentách v príslušnej krajine. Údaje o krajine:
|
|
| NetValue | M |
Čistá celková suma položky (bez zliav / plus príplatky) – bez Vat. Musí byť vždy uvedené. |
|
| GrossValue | M |
Hrubá suma položky (bez prípadných zliav / plus príplatky) – vrátane Vat. Musí byť vždy uvedené. |
|
| TaxValue | M |
Celková suma Vat (alebo súčet prvej sadzby Vat) položky (bez prípadných zliav / plus príplatky) Musí byť vždy uvedené. Údaje o krajine:
|
|
| TaxValue2 | M* |
Súčet druhej daňovej sadzby položky po zľave/prirážke. Údaje o krajine:
|
|
| AccountingIdentifier | O | Dodatočný identifikátor pre účtovné účely (účtovné rozhranie) | |
| ItemTaxType | M* |
Daňový typ položky:
Údaje o krajine:
|
|
| PositionNumber | M | Číslo pozície, začínajúce číslom 0 | |
| positionReference | O | Špecifikácia čísla pozície, na ktorú sa má odkazovať | |
| cancellationPosition | O | „true“, ak táto pozícia ruší pozíciu v inom dokumente; inak „false“ | |
| CreateDate | O | Čas zaznamenania pozície | |
[1] = SubItem
„Podpoložky“ (DocumentPositionSubItem) umožňujú vysvetliť zloženie predávaných produktov alebo popisy skupín produktov na úrovni položky.
Príklad: Menu = Cola a hamburger.
SubItems majú vysvetľujúci charakter a ich použitie nie je povinné. Nemajú tiež žiadny vplyv na cenu a predaj / daň z pridanej hodnoty.
[2] = Text
Používa sa na konverziu polohy textu alebo Barcode v dokumente.
Prí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 nasledujúce informácie.
Informácie v stĺpci „Type“:
- M ... povinné / vyžadované
- M* ... povinné / vyžadované v určitých krajinách alebo za určitých podmienok
- R ... odporúčané
- O... voliteľné
| Prvky | Typ | Popis | |
| typ | M | Typ pozícií (DocumentPositionType) | |
| text | O |
Pole voľného textu Údaje o krajine:
|
|
| barcodeType | O |
Označenie typu Barcode Enum:
|
|
| čiarový kód | O | Údaje Barcode | |
| PositionNumber | M | Číslo pozície, začínajúce číslom 0 | |
[3] = Rezervácia
Pozície rezervácií (DocumentPositionBooking) sa používajú na vklady, výbery, ako aj na predaj viacúčelových poukazov (PayIn, payOut, MultiPurposeVoucher,...).
Príklad 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": {}
}
],Objekt DocumentPositionBooking obsahuje nasledujúce informácie.
Informácie v stĺpci „Type“:
- M ... povinné / vyžadované
- M* ... povinné / vyžadované v určitých krajinách alebo za určitých podmienok
- R ... odporúčané
- O... voliteľné
| Prvky | Typ | Popis | |
| typ | M | Typ polohy (DocumentPositionType) | |
| caption | M | Popis rezervačnej pozície | |
| identifikátor | O | Indikátor dodatočného ID účtovnej položky | |
| BusinessTransactionType | M |
Typ obchodnej transakcie. Enum:
|
|
| PayOutType | M* |
Označuje typ výplaty. V niektorých krajinách je to povinné. Možné hodnoty:
Údaje o krajine:
Poznámka:
Novinka od verzie DOM v1.2.0 / Client v1.7.6
|
|
| VatIdentification | M |
ID sadzby Vat. Možno vyžiadať prostredníctvom GET /api/v1/information/client/ {clientId}/getVatIdentification, pričom sa špecifikuje sadzba DPH príslušnej krajiny. |
|
| VatPercent | M | Sadzba Vat v percentách | |
| NetValue | M |
Čistá celková suma položky (bez zliav) – bez Vat. Musí byť vždy uvedené. |
|
| GrossValue | M |
Hrubá suma položky (bez zliav) – vrátane Vat. Musí byť vždy uvedené. |
|
| TaxValue | M |
Celková suma položky vrátane Vat (bez zliav) Musí byť vždy uvedené. |
|
| AccountingIdentifier | O | Dodatočný identifikátor na účtovné účely (účtovné rozhranie) | |
| ItemTaxType | M* |
Daňový typ položky:
Údaje o krajine:
|
|
| PositionNumber | M | Číslo pozície, začínajúce číslom 0 | |
| positionReference | O | Špecifikácia čísla položky, na ktorú sa má odkazovať | |
| cancellationPosition | O | „true“, ak táto pozícia ruší pozíciu iného dokumentu; inak „false“. | |
| DeletedPosition | O | „true“, ak bola táto pozícia vymazaná; inak „false“. | |
| CreateDate | O | Čas zaznamenania pozície | |
[9] = Medzisúčet
Pozícia čiastkového súčtu
[10] = Total
Pozícia „Total“. Ak sa používa DocumentPositionTotal, musí to byť vždy posledná pozícia v dokumente (najvyššie číslo pozície PositionNumber).
Prí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 nasledujúce informácie.
Informácie v stĺpci „Type“:
- M ... povinné / vyžadované
- M* ... povinné / vyžadované v určitých krajinách alebo za určitých podmienok
- R ... odporúčané
- O... voliteľné
| Prvky | Typ | Popis | |
| typ | M | Typ polohy (DocumentPositionType) | |
| zaokrúhľovanie | O |
Použité zaokrúhľovanie. Ak sa súčet pozícií (hrubá hodnota) nezhoduje so súčtom platby. Napr. hodnota 0,01 by umožnila zaokrúhľovacie rozdiely v rozsahu +/-0,01 Poznámka: Používajte opatrne. Vysoké hodnoty deaktivujú overovanie platobnej sumy / hrubej hodnoty dokumentu |
|
| BaseValue | M* | Základná suma položky pred uplatnením zliav (len ak sa uplatňujú zľavy) | |
| hodnota | M | Hodnota pozície vrátane zliav. | |
| zľavy | Podrobnosti o zľavách, zníženiach ceny atď. | ||
| DiscountValue | M |
Suma zľavy / výška rabatu
Pozor:
ak je DiscountType [1] = zľava, suma zľavy sa musí zadať s 4 desatinnými miestami!
|
|
| caption | O | Označenie zľavy | |
| DiscountOrder | M* |
Určuje poradie, v akom sa zľava počíta. Prvá zohľadnená zľava má hodnotu 0. Musí byť špecifikované, ak sa na položku uplatňuje viac zliav. |
|
| typ | M |
Typ zľavy Enum:
|
|
| TypeValue | M |
Hodnota zľavy (súčet zníženia) pri [0] = Zľava: DiscountValue pri [1] = Zľava: percentuálna hodnota (napr. 10 % zľava) |
|
| PromotionKeys | O | Propagačné kľúče – ak sa používajú (napr. kód poukážky) | |
| identifikátor | O | Dodatočný identifikátor zľavy (možno použiť napr. na zoskupovanie zliav do typov zliav). | |
| caption | O | Označenie pozície | |
| PositionNumber | M | Číslo pozície, začínajúce číslom 0 | |
| positionReference | O | Špecifikácia čísla pozície, na ktorú sa má odkazovať | |
| cancellationPosition | O | „true“, ak táto pozícia ruší pozíciu v inom dokumente; inak „false“. | |
| DeletedPosition | O | „true“, ak bola táto pozícia vymazaná; inak „false“. | |
| CreateDate | O | Čas zaznamenania polohy | |
Tento článok bol preložený automaticky.
Príspevky
0 komentárov
Ak chcete napísať komentár, prihlásiť sa.