Šiame straipsnyje aptariamas „positions“ objektas, esantis „Document“ objekte („Document“ objektas).
Išsamus „RetailForce“ DOM (dokumento objektų modelio) aprašymas, taip pat atskirų elementų aprašymas pateikiami „RetailForce“ website atsisiuntimų skyriuje (Object model documentation.pdf) atitinkamame versijų kataloge.
Objektas „positions“ (pozicijos) apima informaciją apie atitinkamą dokumento poziciją.
Objektą „positions“ sudaro:
- „DocumentPositionBase“ – pateikia pagrindinę informaciją apie poziciją (nepriklausomai nuo atitinkamos pozicijos tipo)
- Informaciją, būdingą pozicijos tipui – priklausomai nuo pozicijos tipo „type“ (DocumentPositionType), turi būti nurodytas skirtingas turinys (pozicijos tipas apibrėžia pozicijos turinį).
„DocumentPositionsBase“
Šiame objekte pateikiami pavyzdiniai duomenys.
"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“ objektas apima šią informaciją.
Informacija stulpelyje „Type“:
- M ... privaloma / reikalaujama
- M* ... privaloma / reikalaujama tam tikrose šalyse arba tam tikromis sąlygomis
- R ... rekomenduojama
- O... neprivaloma
| Elementai | Tipas | Aprašymas | |
| PositionNumber | M |
Pozicijos eilės numeris.
Dėmesio:
pirmosios pozicijos numeris visada yra „0“!
|
|
| positionReference | O | Nuoroda į kitą poziciją dokumente. Atitinka „documentReference“. | |
| {...} | O | ||
| cancellationPosition | M | „true“, jei ši pozicija panaikina kito dokumento poziciją; kitais atvejais – „false“. | |
| DeletedPosition | O | „true“, jei ši pozicija buvo ištrinta; kitais atvejais – „false“. | |
| type | M |
nurodo pozicijos tipą „type“ (DocumentPositionType). Enum:
Atskirų tipų (DocumentPositionType) paaiškinimai pateikiami po šia lentele. |
|
| AdditionalFields | O | ||
| {...} | |||
| CreateDate | M | Pozicijos sukūrimo laikas . | |
| išorinis identifikatorius | O | Išorinis ID (iš ankstesnės sistemos), skirtas vidaus reikmėms, nesusijęs su apskaita. | |
| user | O | (Kaso aparato) vartotojo, įvedusio atitinkamą prekę, duomenys. | |
| {...} | |||
| SalesPerson | O | Atitinkamoje pozicijoje dirbančio pardavėjo duomenys. | |
| {...} | |||
| FiscalAdditionalFields | O | ||
DocumentPositionType
[0] = Prekė
Tipas „prekė“ (DocumentPositionItem) yra konkreti parduodama prekė (prekė arba paslauga).
„DocumentPositionItem“ pavyzdys:
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“ objektas turi šią informaciją.
Informacija stulpelyje „Type“:
- M ... privaloma / reikalaujama
- M* ... privaloma / reikalaujama tam tikrose šalyse arba tam tikromis sąlygomis
- R ... rekomenduojama
- O... neprivaloma
| Elementai | Tipas | Aprašymas | |
| ItemCaption | M | Prekės pavadinimas, paslaugos aprašymas | |
| ItemShortCaption | O | Trumpas elemento pavadinimas, naudojamas, pvz., kai yra simbolių skaičiaus apribojimai, kaip antai fiskaliniuose spausdintuvuose. | |
| ItemSerialNumber | M* |
Prekės serijos numeris. Informacija apie šalį:
|
|
| nuolaidos | Informacija apie nuolaidas, kainų sumažinimus ir pan. | ||
| DiscountValue | M |
Nuolaidos suma / grąžinamos sumos dydis
Dėmesio:
jei DiscountType [1] = discount, nuolaidos suma turi būti įvedama su 4 skaičiais po kablelio!
|
|
| caption | R |
Nuolaidos pavadinimas Šalies duomenys:
|
|
| DiscountOrder | M* |
Nurodo nuolaidos apskaičiavimo tvarką. Pirmoji įskaičiuojama nuolaida turi vertę 0. Būtina nurodyti, jei vienam prekių vienetui taikomos kelios nuolaidos. |
|
| type | M |
Nuolaidos tipas Enum:
|
|
| TypeValue | M |
Nuolaidos vertė (nuolaidos suma) kai [0] = Nuolaida: DiscountValue (=> DiscountValue = TypeValue) kai [1] = Nuolaida: procentas (pvz., 10 % nuolaida) |
|
| PromotionKeys | O | Akcijos raktai – jei naudojami (pvz., kupono kodas) | |
| identifikatorius | O | Papildomas nuolaidos identifikatorius (gali būti naudojamas, pvz., nuolaidoms sugrupuoti pagal nuolaidų tipus). | |
| tipas | M | Pozicijų tipas (DocumentPositionType) | |
| UseSubItemVatCalculation | O | „true“, jei turi būti perimtas PVM apskaičiavimas pagal papunkčius (SubItems) ir ignoruojamas pagrindinio elemento PVM; priešingu atveju – „false“. | |
| SubItems | O | SubItems duomenys. Žr.: DocumentPositionType [1] = SubItem | |
| [...] | |||
| inhouse | O | Nurodo, ar pardavimas vyksta įmonės viduje, ar už jos ribų (true / false). | |
| ItemGroupId | M* |
Prekių grupės rodiklis Šalies duomenys:
|
|
| ItemGroupCaption | O | Prekių grupės pavadinimas | |
| CostPrice | O/M* |
Prekės vieneto kaina Šalies duomenys:
|
|
| itemDateOfEntry | M* |
Prekės sukūrimo laikas. Šalies duomenys:
|
|
| kiekis | M | Prekės kiekio informacija | |
| QuantityUnit | M* |
Matavimo vieneto specifikacija Šalies duomenys:
|
|
| ID | M* |
Matavimo vieneto nurodymas. Šalies duomenys:
|
|
| isoCode | M* |
Standartinis matavimo vienetas pagal ISO/UCUM kodą. Daugiau informacijos rasite nuorodoje pateiktame straipsnyje. | |
| ItemId | M | Prekės ID | |
| ItemType | M* |
Apibūdina elemento tipą: prekės ar paslaugos.
Šalies duomenys:
|
|
| BaseNetValue | M* |
Bendra grynoji suma (be Vat) prieš taikant nuolaidą ar priedą
Dėmesio:
tai yra eilutės/pozicijos (grynosios) sumos, o NE prekės kaina. Jei kiekis = 2, tuomet „BaseNetValue“ taip pat yra prekės kaina x 2!
|
|
| BaseGrossValue | M* |
Bendra suma (įskaitant Vat) prieš nuolaidą ar priedą
Dėmesio:
tai yra eilutės/pozicijos (bendra) suma, o NE prekės kaina. Jei kiekis = 2, tuomet „BaseGrossValue“ taip pat yra prekės kaina x 2!
|
|
| BaseTaxValue | M* |
Vat suma (arba pirmojo mokesčio tarifo suma) prieš nuolaidą ar priedą
Dėmesio:
tai yra eilutės/pozicijos (Vat) suma, o NE prekės kaina. Jei kiekis = 2, tuomet „BaseTaxValue“ taip pat yra prekės kaina x 2!
Šalies duomenys:
|
|
| BaseTaxValue2 | M* |
Pozicijos antrojo mokesčio tarifo suma prieš nuolaidą / priedą. Šalies duomenys:
|
|
| GTIN | O |
Pasaulinis prekės numeris (GTIN) Šalies duomenys:
|
|
| BusinessTransactionType | M |
Sandorio tipas. Enum:
|
|
| ItemTypeClassification |
„ItemTypeClassification“ galima naudoti, norint pritaikyti papildomą elemento klasifikaciją. „ItemTypeClassification“ galima nustatyti tik tuo atveju, jei savybei „ItemType“ buvo priskirta reikšmė „[0] – Straipsnis“ arba „ItemType“: 0. Išsami informacija apie savybę „ItemTypeClassification“ pateikta nuorodoje nurodytame straipsnyje. Galimos šios klasifikacijos.
Šalies duomenys:
|
||
| VatIdentification identifikatorius | M |
PVM tarifo ID. Galima užklausti per GET /api/v1/information/client/ {clientId}/getVatIdentification, nurodant atitinkamos šalies PVM tarifą. atitinkamos šalies tarifą. |
|
| VatPercent | M |
Vat tarifas procentais arba pirmasis mokesčio tarifas, taikomas prekei atitinkamoje šalyje. Informacija apie šalį:
|
|
| VatPercent2 | M* |
antrasis prekės apmokestinimo tarifas, išreikštas procentais atitinkamoje šalyje. Šalies duomenys:
|
|
| NetValue | M |
Pozicijos grynoji suma (atėmus nuolaidas / pridėjus priedus) – be Vat. Būtina visada nurodyti. |
|
| GrossValue | M |
Pozicijos bendra suma (atėmus nuolaidas / pridėjus priedus) – įskaitant Vat. Būtina visada nurodyti. |
|
| TaxValue | M |
Pozicijos Vat suma (arba pirmojo mokesčio tarifo suma) (atėmus nuolaidas / pridėjus priedus) Būtina visada nurodyti. Informacija apie šalį:
|
|
| TaxValue2 | M* |
Prekės antrojo mokesčio tarifo suma po nuolaidos / priedo. Šalies duomenys:
|
|
| AccountingIdentifier | O | Papildomas identifikatorius apskaitos tikslais (apskaitos sąsaja) | |
| ItemTaxType | M* |
Pozicijos mokesčio tipas:
Šalies duomenys:
|
|
| PositionNumber | M | Pozicijos numeris, prasidedantis nuo 0 | |
| positionReference | O | Pozicijos numerio, į kurį turi būti daroma nuoroda, nurodymas | |
| cancellationPosition | O | „true“, jei ši pozicija panaikina kito dokumento poziciją; kitais atvejais – „false“ | |
| CreateDate | O | Pozicijos įregistravimo laikas | |
[1] = SubItem
„Papunkčiai“ (DocumentPositionSubItem) suteikia galimybę paaiškinti parduotų produktų sudėtį arba produktų grupių aprašymus prekės lygmeniu.
Pavyzdys: Meniu = „Coca-Cola“ ir mėsainis.
SubItems yra paaiškinamojo pobūdžio ir jų naudoti nebūtina. Be to, jie neturi jokios įtakos kainai ir pardavimams / pridėtinės vertės mokesčiui.
[2] = Tekstas
Naudojamas teksto arba Barcode pozicijai dokumente nustatyti.
Pavyzdys „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“ objektas apima šią informaciją.
Informacija stulpelyje „Type“:
- M ... privaloma / reikalaujama
- M* ... privaloma / reikalaujama tam tikrose šalyse arba tam tikromis sąlygomis
- R ... rekomenduojama
- O... neprivaloma
| Elementai | Tipas | Aprašymas | |
| tipas | M | Pozicijų tipas (DocumentPositionType) | |
| tekstas | O |
Laisvo teksto laukas Šalies duomenys:
|
|
| barcodeType | O |
Barcode tipo nurodymas Enum:
|
|
| brūkšninis kodas | O | Barcode kodo duomenys | |
| PositionNumber | M | Pozicijos numeris, prasidedantis nuo 0 | |
[3] = Rezervacija
Rezervacijų pozicijos (DocumentPositionBooking) naudojamos indėliams, išėmimams, taip pat MultiPurposeVoucher pardavimui (PayIn, payOut, MultiPurposeVoucher,...).
Pavyzdys „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": {}
}
],„DocumentPositionBooking“ objektas turi šią informaciją.
Informacija stulpelyje „Type“:
- M ... privaloma / reikalaujama
- M* ... privaloma / reikalaujama tam tikrose šalyse arba tam tikromis sąlygomis
- R ... rekomenduojama
- O... neprivaloma
| Elementai | Tipas | Aprašymas | |
| tipas | M | Pozicijų tipas (DocumentPositionType) | |
| caption | M | Užsakymo pozicijos aprašymas | |
| identifikatorius | O | Papildomas ID identifikatorius | |
| BusinessTransactionType | M |
Verslo sandorio tipas. Enum:
|
|
| PayOutType | M* |
Nurodo išmokos tipą. Būtina tam tikrose šalyse. Galimos reikšmės:
Šalies duomenys:
Pastaba:
Nauja nuo DOM v1.2.0 / Client v1.7.6
|
|
| VatIdentification | M |
Vat tarifo ID. Galima gauti per GET /api/v1/information/client/ {clientId}/getVatIdentification, nurodant atitinkamos šalies PVM tarifą. |
|
| VatPercent | M | Vat tarifas procentais | |
| NetValue | M |
Pozicijos grynoji suma (atskaičius visas nuolaidas) – be Vat. Būtina visada nurodyti. |
|
| GrossValue | M |
Pozicijos bendra suma (atėmus nuolaidas) – įskaitant Vat. Būtina visada nurodyti. |
|
| TaxValue | M |
Pozicijos suma su Vat (atėmus visas nuolaidas) Būtina visada nurodyti. |
|
| AccountingIdentifier | O | Papildomas identifikatorius apskaitos tikslais (apskaitos sąsaja) | |
| ItemTaxType | M* |
Pozicijos mokesčio tipas:
Šalies duomenys:
|
|
| PositionNumber | M | Pozicijos numeris, prasidedantis nuo 0 | |
| positionReference | O | Prekės numerio, į kurį turi būti daroma nuoroda, nurodymas | |
| cancellationPosition | O | „true“, jei ši pozicija panaikina kito dokumento poziciją; kitais atvejais – „false“. | |
| DeletedPosition | O | „true“, jei ši pozicija buvo ištrinta; kitais atvejais – „false“. | |
| CreateDate | O | Pozicijos įregistravimo laikas | |
[9] = Tarpinė suma
Tarpinė pozicijos suma
[10] = „Total“
Bendrosios pozicijos pozicija. Jei naudojama „DocumentPositionTotal“, ji visada turi būti paskutinė pozicija dokumente (didžiausias „PositionNumber“).
„DocumentPositionTotal“ pavyzdys:
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“ objektas turi šią informaciją.
Informacija stulpelyje „Type“:
- M ... privaloma / reikalaujama
- M* ... privaloma / reikalaujama tam tikrose šalyse arba tam tikromis sąlygomis
- R ... rekomenduojama
- O... neprivaloma
| Elementai | Tipas | Aprašymas | |
| tipas | M | Pozicijų tipas (DocumentPositionType) | |
| apvalinimas | O |
Taikomas apvalinimas. Jei pozicijų suma (bendra vertė) nesutampa su mokėjimo suma. Pvz., 0,01 leistų apvalinimo skirtumus +/-0,01 Pastaba: Prašome naudoti atsargiai. Didelės reikšmės išjungs mokėjimo sumos / dokumento bendrosios vertės tikrinimą |
|
| BaseValue | M* | Pozicijos bazinė suma prieš taikant nuolaidas (tik jei taikomos nuolaidos) | |
| value | M | Pozicijos vertė, įskaitant nuolaidas. | |
| nuolaidos | Išsami informacija apie nuolaidas, kainų sumažinimus ir pan. | ||
| DiscountValue | M |
Nuolaidos suma / grąžinamos sumos dydis
Dėmesio:
jei DiscountType [1] = discount, nuolaidos suma turi būti įvedama su 4 skaičiais po kablelio!
|
|
| caption | O | Nuolaidos pavadinimas | |
| DiscountOrder | M* |
Nurodo nuolaidos apskaičiavimo tvarką. Pirmoji įskaičiuojama nuolaida turi vertę 0. Būtina nurodyti, jei prekei taikomos kelios nuolaidos. |
|
| tipas | M |
Nuolaidos tipas Enum:
|
|
| TypeValue | M |
Nuolaidos vertė (nuolaidos suma) kai [0] = nuolaida: DiscountValue kai [1] = Nuolaida: procentinė dalis (pvz., 10 % nuolaida) |
|
| PromotionKeys | O | Akcijos kodai – jei naudojami (pvz., kupono kodas) | |
| identifikatorius | O | Papildomas nuolaidos identifikatorius (gali būti naudojamas, pvz., nuolaidoms sugrupuoti pagal nuolaidų tipus). | |
| caption | O | Pozicijos pavadinimas | |
| PositionNumber | M | Pareigybės numeris, pradedant nuo 0 | |
| positionReference | O | Pozicijos numerio, į kurį turi būti daroma nuoroda, nurodymas | |
| cancellationPosition | O | „true“, jei ši pozicija panaikina kito dokumento poziciją; kitais atvejais – „false“. | |
| DeletedPosition | O | „true“, jei ši pozicija buvo ištrinta; kitais atvejais – „false“. | |
| CreateDate | O | Pozicijos užregistravimo laikas | |
Šis straipsnis buvo išverstas automatiškai.
Komentarai
0 komentarų
Tam, kad paliktumėte komentarus prisijunkite