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 a RetailForce website letöltési részében (Object model documentation.pdf) található 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 mintadatokat 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ő / bizonyos országokban vagy bizonyos feltételek mellett kötelező
- 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ébként „false”. | |
| DeletedPosition | O | „true”, ha ez a pozíció törlésre került; 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": "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": {}
}
],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 megjelölése, a szolgáltatás leírása | |
| ItemShortCaption | O | Az elem rövid neve, amelyet például akkor használnak, ha a karakterhosszra korlátozások vonatkoznak, például pénzügyi nyomtatók esetén. | |
| 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* |
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. |
|
| 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) ha [1] = 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; ellenkező esetben „false”. | |
| SubItems | O | A 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 | |
| CostPrice | O/M* |
A cikk egységára Országspecifikus adatok:
|
|
| itemDateOfEntry | M* |
A tétel létrehozásának időpontja. Országspecifikus részletek:
|
|
| mennyiség | M | A cikk mennyiségére vonatkozó információk | |
| 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 adatok:
|
|
| isoCode | M* |
Az ISO/UCUM-kód szerinti szabványos mértékegység. További információkért lásd a hivatkozott cikket. | |
| ItemId | M | A cikk ID-je | |
| ItemType | M* |
Leírja az elem típusát: áru vagy szolgáltatás.
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 az árucikké. Ha a mennyiség = 2, akkor a BaseNetValue is az árucikk ára x 2!
|
|
| BaseGrossValue | M* |
Bruttó összeg (Vat-mal 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 |
Globális árucikk-azonosító (GTIN) Országadatok:
|
|
| BusinessTransactionType | M |
Az üzleti tranzakció típusa. Enum:
|
|
| ItemTypeClassification |
Az ItemTypeClassification segítségével további osztályozást lehet alkalmazni 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 összege (vagy az első adókulcs szerinti összeg) (levonva az esetleges kedvezményeket / hozzáadva a 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 pozíció 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 | „true”, ha ez a pozíció egy másik dokumentum pozícióját törli; egyébként „false” | |
| CreateDate | O | A pozíció rögzítésének időpontja | |
[1] = SubItem
Az „alelemek” (DocumentPositionSubItem) lehetővé teszik az eladott termékek összetételének vagy a termékcsoport-leírások tételszintű részletezését.
Példa: Menü = kóla és hamburger.
SubItems magyarázó jellegűek, használatuk nem kötelező. Az árra, az értékesítésre és a hozzáadottérték-adóra semmilyen hatással nincsenek.
[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-ok értékesítése esetén használják (PayIn, payOut, MultiPurposeVoucher,...).
Példa a DocumentPositionBooking-ra:
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": {}
}
],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ő / 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) | |
| 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 (esetleges kedvezmények levonása után) – 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 pozíció 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] = Total
Teljes pozíció. Ha a DocumentPositionTotal használata szükséges, annak mindig a dokumentum utolsó pozíciójának kell lennie (a legmagasabb PositionNumber).
Példa a DocumentPositionTotal használatá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. Például a 0,01 érték +/-0,01-es kerekítési eltérést engedélyezne Megjegyzés: Kérjük, óvatosan használja. A magas értékek letiltják az összeg érvényesítését a fizetési összeg / a dokumentum bruttó értéke esetében |
|
| BaseValue | M* | A tétel alapösszege a kedvezmények alkalmazása előtt (csak akkor, ha kedvezményeket alkalmaznak) | |
| value | 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 |
Kedvezmény értéke (a csökkentés összege) ha [0] = Kedvezmény: a DiscountValue ha [1] = 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é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 | |
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.