Ez a cikk a Document objektumon belüli positions objektummal foglalkozik (Document objektum).
A RetailForce DOM (Document Object Model) teljes leírása, valamint az egyes elemek leírása megtalálható a RetailForce website letöltési részében (Object model documentation.pdf) a megfelelő verzió könyvtárában.
A „positions” objektum a dokumentum megfelelő pozíciójára vonatkozó információkat tartalmazza.
A positions objektum a következőkből áll:
- DocumentPositionBase – a pozícióra vonatkozó alapvető információkat tartalmazza (függetlenül az adott pozíció típusától)
- Pozíciótípus-specifikus információk – a „type” (DocumentPositionType) pozíciótípustól függően különböző tartalmakat kell megadni (a pozíciótípus határozza meg a pozíció tartalmát).
DocumentPositionsBase
A következő objektum mintadadatokat tartalmaz.
"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": {}
}
],A DocumentPositionsBase objektum a következő információkat tartalmazza.
A „Type” oszlopban szereplő információk:
- M ... kötelező / előírt
- M* ... kötelező / előírt bizonyos országokban vagy bizonyos feltételek mellett
- R ... ajánlott
- O... opcionális
| Elemek | Típus | Leírás | |
| PositionNumber | M |
A pozíció sorszáma.
Figyelem:
Az első pozíció száma mindig „0”!
|
|
| positionReference | O | Hivatkozás a dokumentumon belüli egy másik pozícióra. Megegyezik a documentReference-szel. | |
| {...} | O | ||
| cancellationPosition | M | „true”, ha ez a pozíció egy másik dokumentum pozícióját törli; egyéb esetben „false”. | |
| DeletedPosition | O | „true”, ha ezt a pozíciót törölték; egyébként „false”. | |
| type | M |
meghatározza a pozíció típusát „type” (DocumentPositionType). Enum:
Az egyes típusok (DocumentPositionType) magyarázata a táblázat után található. |
|
| AdditionalFields | O | ||
| {...} | |||
| CreateDate | M | A pozíció létrehozásának időpontja . | |
| ExternalIdentifier | O | Külső ID (az előző rendszerből), belső célokra, a számviteli elszámolás szempontjából nem releváns. | |
| user | O | Az adott tételt rögzítő (pénztárgép) felhasználó adatai. | |
| {...} | |||
| SalesPerson | O | Az adott pozícióban dolgozó értékesítő adatai. | |
| {...} | |||
| FiscalAdditionalFields | O | ||
DocumentPositionType
[0] = Tétel
Az „tétel” (DocumentPositionItem) típus egy konkrét értékesítési tétel (áru vagy szolgáltatás).
Példa a DocumentPositionItem-re:
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": {}
}
],A DocumentPositionItem objektum a következő információkat tartalmazza.
A „Type” oszlopban szereplő információk:
- M ... kötelező / előírt
- M* ... kötelező / bizonyos országokban vagy bizonyos feltételek mellett kötelező
- R ... ajánlott
- O... opcionális
| Elemek | Típus | Leírás | |
| ItemCaption | M |
Cikk megnevezése, a szolgáltatás leírása Országadatok:
|
|
| ItemShortCaption | O | A tétel rövid neve, amelyet pl. akkor használnak, ha a karakterhosszra korlátozások vonatkoznak, mint például a pénzügyi nyomtatók esetében. | |
| ItemSerialNumber | M* |
Az elem sorozatszáma. Országspecifikus adatok:
|
|
| kedvezmények | A kedvezmények, árcsökkentések stb. részletei. | ||
| DiscountValue | M |
Kedvezmény összege / visszatérítés összege
Figyelem:
ha a DiscountType [1] = discount, akkor a kedvezmény összegét 4 tizedesjegy pontossággal kell megadni!
|
|
| caption | R |
A kedvezmény megnevezése Országspecifikus adatok:
|
|
| DiscountOrder | M* |
Jelzi a kedvezmény kiszámításának sorrendjét. Az első figyelembe vett kedvezmény értéke 0. Meg kell adni, ha egy tételre több kedvezményt is alkalmaznak. |
|
| type | M |
A kedvezmény típusa Enum:
|
|
| TypeValue | M |
Visszatérítés értéke (a csökkentés összege) ha [0] = Kedvezmény: a kedvezmény értéke (=> DiscountValue = TypeValue) [1] esetén = Kedvezmény: a százalékos érték (pl. 10% kedvezmény) |
|
| PromotionKeys | O | Promóciós kulcsok – ha használják (pl. utalványkód) | |
| azonosító | O | A kedvezményhez tartozó további azonosító (például a kedvezmények kedvezménytípusokba történő csoportosításához használható). | |
| típus | M | Pozíciótípus (DocumentPositionType) | |
| UseSubItemVatCalculation | O | „true”, ha az alelemek (SubItems) áfa-számítását át kell venni, és a szülőelem áfáját figyelmen kívül kell hagyni; egyébként „false”. Alapértelmezett (ha nem kerül megadásra): „true”. „true” érték esetén minden alelemnek rendelkeznie kell VatIdentification azonosítóval, és az alelemek bruttó, nettó és adóértékeinek összegének meg kell egyeznie a szülőelem BaseGrossValue, BaseNetValue és BaseTaxValue értékeivel; ellenkező esetben a dokumentum elutasításra kerül. | |
| SubItems | O | SubItems részletei. Lásd: DocumentPositionType [1] = SubItem | |
| [...] | |||
| inhouse | O | Jelzi, hogy belső vagy külső értékesítésről van szó (true / hamis). | |
| ItemGroupId | M* |
Cikksorozat-jelző Országspecifikus adatok:
|
|
| ItemGroupCaption | O |
Cikkszám-csoport megjelölése Országspecifikus részletek:
|
|
| CostPrice | O/M* |
A cikk egységára Országspecifikus részletek:
|
|
| itemDateOfEntry | M* |
A cikk létrehozásának időpontja. Országspecifikus részletek:
|
|
| mennyiség | M |
A cikk mennyiségére vonatkozó adatok Országspecifikus részletek:
|
|
| QuantityUnit | M* |
A mértékegység megadása Országspecifikációk:
|
|
| ID | M* |
A mértékegység megjelölése. Országspecifikus részletek:
|
|
| isoCode | M* |
Szabványos mértékegység, amelyet a QuantityUnitIsoCode érték nevének formájában kell megadni (pl. „Quantity” darabszám esetén, „Kilogram”), nem pedig magának az ISO/UCUM-kódnak a formájában. A modul a nevet ISO/UCUM-kóddá alakítja át (pl. „Quantity” = „1”). A számot az enum numerikus értékeként olvassa be, így a „1” a „Percent” értéket jelenti. További információkért lásd a hivatkozott cikket. Országspecifikus részletek:
|
|
| ItemId | M |
A cikk ID-je Országadatok:
|
|
| ItemType | M* |
Leírja a tétel típusát: áruk vagy szolgáltatások.
Országadatok:
|
|
| BaseNetValue | M* |
Nettó összeg (Vat nélkül) kedvezmény vagy felár előtt
Figyelem:
A sor/pozíció (nettó) összege, NEM a cikké. Ha a mennyiség = 2, akkor a BaseNetValue is a tételár x 2!
|
|
| BaseGrossValue | M* |
Bruttó összeg (Vat-tal együtt) kedvezmény vagy felár előtt
Figyelem:
a sor/pozíció (bruttó) összege, NEM az árucikké. Ha a mennyiség = 2, akkor a BaseGrossValue szintén az árucikk ára x 2!
|
|
| BaseTaxValue | M* |
Vat-összeg (vagy az első adókulcs összege) kedvezmény vagy felár előtt
Figyelem:
(Vat) a sor/pozíció összege, NEM az árucikké. Ha a mennyiség = 2, akkor a BaseTaxValue szintén az árucikk ára x 2!
Országadatok:
|
|
| BaseTaxValue2 | M* |
A pozíció második adókulcsának összege a kedvezmény/felár előtt. Országadatok:
|
|
| GTIN | O/R |
Globális árucikk-azonosító (GTIN) Országadatok:
|
|
| BusinessTransactionType | M |
Az üzleti tranzakció típusa. Enum:
|
|
| ItemTypeClassification | O/M* |
Az ItemTypeClassification segítségével további osztályozás alkalmazható egy tételre. Az ItemTypeClassification csak akkor állítható be, ha az „ItemType” tulajdonság értéke „[0] – Cikk” vagy „ItemType”: 0. Az „ItemTypeClassification” tulajdonságról részletes információk a hivatkozott cikkben találhatók. A következő osztályozások állnak rendelkezésre.
Országadatok:
|
|
| VatIdentification | M |
ID azonosítója. A GET /api/v1/information/client/ {clientId}/getVatIdentification parancs segítségével lekérdezhető, az adott ország áfa-kulcsának megadásával. az adott ország áfa-kulcsa. |
|
| VatPercent | M |
Az adott országban az árura alkalmazandó Vat-kulcs százalékban kifejezve vagy az első adókulcs. Országadatok:
|
|
| VatPercent2 | M* |
az adott országban az árura alkalmazandó második adókulcs, százalékban kifejezve. Országadatok:
|
|
| NetValue | M |
A pozíció nettó összege (levonva az esetleges kedvezményeket / hozzáadva a felárakat) – Vat nélkül. Mindig meg kell adni. |
|
| GrossValue | M |
A tétel bruttó összege (levonva az esetleges kedvezményeket / hozzáadva a felárakat) – Vat-tal együtt. Mindig meg kell adni. |
|
| TaxValue | M |
Vat total (vagy az első adókulcs szerinti összeg) (levonva az esetleges kedvezményeket / hozzáadva az esetleges felárakat) Mindig meg kell adni. Országadatok:
|
|
| TaxValue2 | M* |
A tétel második adókulcsának összege a kedvezmény/felár után. Országadatok:
|
|
| AccountingIdentifier | O | Kiegészítő azonosító számviteli célokra (számviteli interfész) | |
| ItemTaxType | M* |
A tétel adótípusa:
Országadatok:
|
|
| PositionNumber | M | Pozíciószám, 0-tól kezdődően | |
| positionReference | O | Az a pozíciószám, amelyre hivatkozni kell | |
| cancellationPosition | O/M* | „true”, ha ez a pozíció egy másik dokumentum pozícióját törli; egyéb esetben „false” | |
| CreateDate | O | A pozíció rögzítésének időpontja | |
[1] = Alelem
Az „alelemek” (DocumentPositionSubItem) lehetővé teszik az eladott termékek összetételének vagy a termékcsoport-leírások tételek szintjén történő részletezését.
Példa: Menü = Kóla és hamburger.
The use of SubItems is not required. If the parent element has „UseSubItemVatCalculation”: true (the default), the Vat of the SubItems is used instead of the Vat of the parent element, and the values of the SubItems must add up to the parent element’s base values. If „UseSubItemVatCalculation”: false is set, the Vat of the parent element is in effect, and the SubItems only provide information about the composition of the item.
[2] = Szöveg
A dokumentumon belüli szöveg vagy Barcode pozíciójának átalakítására szolgál.
Példa a DocumentPositionText-re:
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": {}
}
],A DocumentPositionText objektum a következő információkat tartalmazza.
A „Type” oszlopban szereplő információk:
- M ... kötelező / előírt
- M* ... kötelező / előírt bizonyos országokban vagy bizonyos feltételek mellett
- R ... ajánlott
- O... opcionális
| Elemek | Típus | Leírás | |
| típus | M | Pozíciók típusa (DocumentPositionType) | |
| szöveg | O |
Szabad szövegmező Országadatok:
|
|
| barcodeType | O |
Barcode-típus jelölése Enum:
|
|
| Barcode | O | Barcode adatok | |
| PositionNumber | M | Pozíciószám, 0-tól kezdődően | |
[3] = Foglalás
A foglalások pozícióját (DocumentPositionBooking) betétek, kifizetések, valamint MultiPurposeVoucher-ek értékesítése esetén használják (PayIn, payOut, MultiPurposeVoucher,...).
Példa a DocumentPositionBooking-ra:
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": {}
}
],A DocumentPositionBooking objektum a következő információkat tartalmazza.
A „Type” oszlopban szereplő információk:
- M ... kötelező / előírt
- M* ... kötelező / szükséges bizonyos országokban vagy bizonyos feltételek mellett
- R ... ajánlott
- O... opcionális
| Elemek | Típus | Leírás | |
| típus | M | Pozíciók típusa (DocumentPositionType) | |
| caption | M | A foglalási pozíció leírása | |
| azonosító | O | A könyvelési tétel kiegészítő ID-ja | |
| BusinessTransactionType | M |
Az üzleti tranzakció típusa. Enum:
|
|
| PayOutType | M* |
A kifizetés típusát jelzi. Bizonyos országokban kötelező megadni. Lehetséges értékek:
Országspecifikus részletek:
Megjegyzés:
Új a DOM v1.2.0 / Client v1.7.6 verziótól
|
|
| VatIdentification | M |
Vat-ID. A GET /api/v1/information/client/ {clientId}/getVatIdentification parancs segítségével lekérdezhető, az adott ország áfa-kulcsának megadásával. |
|
| VatPercent | M | Vat százalékban | |
| NetValue | M |
A tétel nettó összege (kedvezmények nélkül) – Vat nélkül. Mindig meg kell adni. |
|
| GrossValue | M |
A tétel bruttó összege (esetleges kedvezmények levonásával) – Vat-tal együtt. Mindig meg kell adni. |
|
| TaxValue | M |
A tétel Vat-összege (esetleges kedvezmények levonásával) Mindig meg kell adni. |
|
| AccountingIdentifier | O | Kiegészítő azonosító számviteli célokra (számviteli interfész) | |
| ItemTaxType | M* |
A tétel adótípusa:
Országadatok:
|
|
| PositionNumber | M | Pozíciószám, 0-tól kezdődően | |
| positionReference | O | Az a tételszám, amelyre hivatkozni kell | |
| cancellationPosition | O | „true”, ha ez a pozíció egy másik dokumentum pozícióját törli; egyéb esetben „false”. | |
| DeletedPosition | O | „true”, ha ezt a pozíciót törölték; egyébként „false”. | |
| CreateDate | O | A pozíció rögzítésének időpontja | |
[9] = Részösszeg
Részösszeg pozíció
[10] = Összesen
Teljes pozíció. Ha a DocumentPositionTotal-t használjuk, annak mindig a dokumentum utolsó pozíciójának kell lennie (a legnagyobb PositionNumber).
Példa a DocumentPositionTotal-ra:
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": {}
}
],A DocumentPositionTotal objektum a következő információkat tartalmazza.
A „Type” oszlopban szereplő információk:
- M ... kötelező / előírt
- M* ... kötelező / előírt bizonyos országokban vagy bizonyos feltételek mellett
- R ... ajánlott
- O... opcionális
| Elemek | Típus | Leírás | |
| típus | M | Pozíciók típusa (DocumentPositionType) | |
| kerekítés | O |
Kerekítés alkalmazva. Ha a pozíciók összege (bruttó érték) nem egyezik meg a kifizetési összeggel. A kerekítést hozzáadjuk a tétel és a könyvelési pozíciók bruttó értékeinek összegéhez, és a kifizetések összegének pontosan meg kell egyeznie az eredménnyel. Ez egy előjeles összeg, nem pedig tűréshatár: pl. a -0,02 azt jelenti, hogy a kifizetések 0,02-vel alacsonyabbak, mint a pozíciók bruttó összege, a 0,01 pedig azt, hogy pontosan 0,01-rel magasabbak. Megjegyzés: Kérjük, óvatosan használja. Ha a kifizetések és a tételek nem pontosan ezzel az értékkel térnek el egymástól, a dokumentumot elutasítják. |
|
| BaseValue | M* | A pozíció alapösszege a kedvezmények alkalmazása előtt (csak akkor, ha kedvezményeket alkalmaznak) | |
| érték | M | A pozíció értéke a kedvezmények figyelembevételével. | |
| kedvezmények | A kedvezmények, árcsökkentések stb. részletei. | ||
| DiscountValue | M |
A kedvezmény összege / a visszatérítés összege
Figyelem:
ha a DiscountType [1] = discount, akkor a kedvezmény összegét 4 tizedesjegy pontossággal kell megadni!
|
|
| caption | O | A kedvezmény megnevezése | |
| DiscountOrder | M* |
A kedvezmény kiszámításának sorrendjét jelzi. Az első figyelembe vett kedvezmény értéke 0. Meg kell adni, ha egy tételre több kedvezményt is alkalmaznak. |
|
| típus | M |
Kedvezménytípus Enum:
|
|
| TypeValue | M |
Visszatérítés értéke (a csökkentés összege) ha [0] = Kedvezmény: a DiscountValue [1] esetén = Kedvezmény: a százalékos érték (pl. 10% kedvezmény) |
|
| PromotionKeys | O | Promóciós kulcsok – ha használják (pl. utalványkód) | |
| azonosító | O | A kedvezményhez tartozó további azonosító (például a kedvezmények kedvezménytípusokba történő csoportosításához használható). | |
| caption | O | A pozíció megnevezése | |
| PositionNumber | M | A pozíció száma, 0-tól kezdődően | |
| positionReference | O | Az a pozíciószám, amelyre hivatkozni kell | |
| cancellationPosition | O | „true”, ha ez a pozíció egy másik dokumentum pozícióját törli; egyébként „false”. | |
| DeletedPosition | O | „true”, ha ezt a pozíciót törölték; egyébként „false”. | |
| CreateDate | O | A pozíció rögzítésének időpontja | |
Ezt a cikket automatikusan lefordították.
Hozzászólások
0 hozzászólás
Hozzászólások írásához jelentkezzen be.