Ta članek obravnava objekt »positions« znotraj objekta »Document« (objekt »Document«).
Celoten opis modela RetailForce DOM (Document Object Model) ter opis posameznih elementov najdete v rubriki za prenose na RetailForce website (Object model documentation.pdf) v ustreznem imeniku različic.
Objekt »positions« vsebuje informacije o posamezni poziciji v dokumentu.
Objekt »positions« sestavljajo:
- DocumentPositionBase – vsebuje osnovne informacije o poziciji (neodvisno od vrste zadevne pozicije)
- Podatke, specifične za vrsto pozicije – odvisno od vrste pozicije »type« (DocumentPositionType) je treba določiti različne vsebine (vrsta pozicije določa vsebino pozicije).
DocumentPositionsBase
Naslednji objekt vsebuje vzorčne podatke.
"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 vsebuje naslednje informacije.
Podatki v stolpcu »Type«:
- M … obvezno / zahtevano
- M* ... obvezno / zahtevano v nekaterih državah ali pod določenimi pogoji
- R ... priporočeno
- O... neobvezno
| Elementi | Tip | Opis | |
| PositionNumber | M |
Zaporedna številka pozicije.
Pozor:
Številka prve pozicije je vedno »0«!
|
|
| positionReference | O | Sklic na drugo pozicijo znotraj dokumenta. Enakovredno documentReference. | |
| {...} | O | ||
| cancellationPosition | M | »true«, če ta položaj razveljavlja položaj drugega dokumenta; sicer »false«. | |
| DeletedPosition | O | "true", če je bil ta položaj izbrisan; sicer "false". | |
| tip | M |
določa tip položaja »type« (DocumentPositionType). Enum:
Pojasnila posameznih tipov (DocumentPositionType) so na voljo pod to tabelo. |
|
| AdditionalFields | O | ||
| {...} | |||
| CreateDate | M | Čas, ko je bil položaj ustvarjen. | |
| ExternalIdentifier | O | Zunanja ID številka (iz prejšnjega sistema), za notranje namene, ni pomembna za fiskalizacijo. | |
| user | O | Podatki o uporabniku (blagajne), ki je vnesel zadevno postavko. | |
| {...} | |||
| SalesPerson | O | Podrobnosti o prodajnem osebju na zadevnem delovnem mestu. | |
| {...} | |||
| FiscalAdditionalFields | O | ||
DocumentPositionType
[0] = Postavka
Tip »postavka« (DocumentPositionItem) je posamezna prodajna postavka (blago ali storitev).
Primer 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 vsebuje naslednje informacije.
Podatki v stolpcu »Type«:
- M ... obvezno / zahtevano
- M* ... obvezno / zahtevano v nekaterih državah ali pod določenimi pogoji
- R ... priporočeno
- O... neobvezno
| Elementi | Tip | Opis | |
| ItemCaption | M | Oznaka artikla, opis storitve | |
| ItemShortCaption | O | Kratko ime postavke, ki se uporablja npr. kadar obstajajo omejitve glede dolžine znakov, kot npr. pri fiskalnih tiskalnikih. | |
| ItemSerialNumber | M* |
Serijska številka artikla. Podatki o državi:
|
|
| popusti | Podrobnosti o popustih, znižanjih cen itd. | ||
| DiscountValue | M |
Znesek popusta / višina popusta
Pozor:
če je DiscountType [1] = popust, je treba znesek popusta vnesti z 4 decimalnimi mesti!
|
|
| caption | R |
Oznaka popusta Podatki o državi:
|
|
| DiscountOrder | M* |
Označuje vrstni red, v katerem se izračuna popust. Prvi upoštevan popust ima vrednost 0. Treba ga je navesti, če se za izdelek uporablja več popustov. |
|
| tip | M |
Vrsta popusta Enum:
|
|
| TypeValue | M |
Vrednost popusta (vsota znižanja) pri [0] = popust: DiscountValue (=> DiscountValue = TypeValue) pri [1] = popust: odstotek (npr. 10 % popust) |
|
| PromotionKeys | O | Ključi promocije – če se uporabljajo (npr. koda kupona) | |
| identifikator | O | Dodatni identifikator za popust (se lahko uporabi npr. za razvrščanje popustov v vrste popustov). | |
| tip | M | Vrsta postavk (DocumentPositionType) | |
| UseSubItemVatCalculation | O | »true«, če je treba prevzeti izračun DDV za podpostavke (SubItems) in prezreti DDV nadrejenega elementa; sicer »false«. | |
| SubItems | O | Podrobnosti o SubItems. Glej: DocumentPositionType [1] = SubItem | |
| [...] | |||
| inhouse | O | Označuje notranjo prodajo ali zunanjo prodajo (true / false). | |
| ItemGroupId | M* |
Kazalnik skupine izdelkov Podatki o državi:
|
|
| ItemGroupCaption | O | Oznaka skupine artiklov | |
| CostPrice | O/M* |
Cena na enoto izdelka Podatki o državi:
|
|
| itemDateOfEntry | M* |
Čas ustvarjanja artikla. Podrobnosti o državi:
|
|
| količina | M | Podatek o količini za artikel | |
| QuantityUnit | M* |
Določitev merske enote Podatki o državi:
|
|
| ID | M* |
Navedba merske enote. Podrobnosti o državi:
|
|
| isoCode | M* |
Standardna merska enota v skladu s kodo ISO/UCUM. Za več informacij glejte povezani članek. | |
| ID artikla | M | ID članka | |
| ItemType | M* |
Opisuje vrsto artikla: blago ali storitve.
Podatki o državi:
|
|
| BaseNetValue | M* |
Neto skupni znesek (brez Vat) pred odbitkom ali doplačilom
Pozor:
(Neto) vsota vrstice/položaja, NE artikla. Če je količina = 2, je BaseNetValue tudi cena artikla x 2!
|
|
| BaseGrossValue | M* |
Bruto skupni znesek (vključno z Vat) pred popustom ali doplačilom
Pozor:
(Bruto) vsota vrstice/položaja, NE artikla. Če je količina = 2, je BaseGrossValue prav tako cena artikla x 2!
|
|
| BaseTaxValue | M* |
Skupni znesek Vat (ali vsota prve davčne stopnje) pred popustom ali doplačilom
Pozor:
(Vat) vsota vrstice/položaja, NE artikla. Če je količina = 2, je BaseTaxValue prav tako cena artikla x 2!
Podatki o državi:
|
|
| BaseTaxValue2 | M* |
Vsota druge davčne stopnje postavke pred popustom/doplačilom. Podrobnosti o državi:
|
|
| GTIN | O |
Globalna številka artikla (GTIN) Podatki o državi:
|
|
| BusinessTransactionType | M |
Vrsta poslovnega dogodka. Enum:
|
|
| ItemTypeClassification |
ItemTypeClassification se lahko uporabi za dodatno razvrstitev postavke. ItemTypeClassification se lahko nastavi le, če je lastnost »ItemType« nastavljena na »[0] – Članek« ali »ItemType«: 0. Podrobne informacije o lastnosti »ItemTypeClassification« najdete v povezanem članku. Na voljo so naslednje klasifikacije.
Podrobnosti o državi:
|
||
| VatIdentification | M |
ID stopnje DDV. Lahko se poizveduje prek GET /api/v1/information/client/ {clientId}/getVatIdentification, pri čemer se določi stopnja Vat zadevne države. stopnja zadevne države. |
|
| VatPercent | M |
Stopnja Vat v odstotkih ali prva davčna stopnja, ki velja za izdelek v zadevni državi. Podatki o državi:
|
|
| VatPercent2 | M* |
druga davčna stopnja, ki velja za izdelek, izražena v odstotkih v zadevni državi. Podatki o državi:
|
|
| NetValue | M |
Neto skupna vrednost postavke (brez morebitnih popustov / z morebitnimi doplačili) – brez Vat. Vedno mora biti navedeno. |
|
| GrossValue | M |
Bruto skupni znesek postavke (brez morebitnih popustov / z morebitnimi doplačili) – vključno z Vat. Vedno mora biti navedena. |
|
| TaxValue | M |
Skupni znesek Vat (ali vsota prve davčne stopnje) za postavko (brez morebitnih popustov / z morebitnimi doplačili) Mora biti vedno navedeno. Podatki o državi:
|
|
| TaxValue2 | M* |
Vsota druge davčne stopnje artikla po odbitku/doplačilu. Podrobnosti o državi:
|
|
| AccountingIdentifier | O | Dodatni identifikator za računovodske namene (računovodski vmesnik) | |
| ItemTaxType | M* |
Davčna vrsta postavke:
Podatki o državi:
|
|
| PositionNumber | M | Številka položaja, ki se začne z 0 | |
| positionReference | O | Navedba številke položaja, na katerega se sklicuje | |
| cancellationPosition | O | »true«, če ta položaj razveljavlja položaj iz drugega dokumenta; sicer »false« | |
| CreateDate | O | Čas vnosa pozicije | |
[1] = Podelement
»Podpostavke« (DocumentPositionSubItem) omogočajo pojasnitev sestave prodanih izdelkov ali opisov skupin izdelkov na ravni postavke.
Primer: Meni = koka kola in hamburger.
SubItems imajo pojasnjevalni značaj in jih ni treba uporabljati. Prav tako nimajo nobenega vpliva na ceno ter prodajo/davek na dodano vrednost.
[2] = Besedilo
Uporablja se za pretvorbo položaja besedila ali Barcodea znotraj dokumenta.
Primer 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 vsebuje naslednje informacije.
Podatki v stolpcu »Type«:
- M ... obvezno / zahtevano
- M* ... obvezno / zahtevano v nekaterih državah ali pod določenimi pogoji
- R ... priporočeno
- O... neobvezno
| Elementi | Tip | Opis | |
| tip | M | Tip položajev (DocumentPositionType) | |
| besedilo | O |
Polje za prosto besedilo Podatki o državi:
|
|
| barcodeType | O |
Oznaka vrste Barcode Enum:
|
|
| črtna koda | O | Podatki o Barcode | |
| PositionNumber | M | Številka položaja, ki se začne z 0 | |
[3] = Rezervacija
Pozicije rezervacij (DocumentPositionBooking) se uporabljajo za vplačila, izplačila ter prodajo večnamenskih kuponov (PayIn, payOut, MultiPurposeVoucher, ...).
Primer 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 vsebuje naslednje informacije.
Podatki v stolpcu »Type«:
- M ... obvezno / zahtevano
- M* ... obvezno / zahtevano v nekaterih državah ali pod določenimi pogoji
- R ... priporočeno
- O... neobvezno
| Elementi | Tip | Opis | |
| tip | M | Tip položajev (DocumentPositionType) | |
| caption | M | Opis pozicije rezervacije | |
| identifikator | O | ID dodatne identifikacijske številke knjiženja | |
| BusinessTransactionType | M |
Vrsta poslovne transakcije. Enum:
|
|
| PayOutType | M* |
Označuje vrsto izplačila. Obvezno v nekaterih državah. Možne vrednosti:
Podatki o državi:
Opomba:
Novo od DOM v1.2.0 / Client v1.7.6
|
|
| VatIdentification | M |
ID stopnje DDV. Lahko se pridobi z zahtevkom GET /api/v1/information/client/ {clientId}/getVatIdentification, pri čemer je treba navesti stopnjo Vat zadevne države. |
|
| VatPercent | M | Stopnja DDV v odstotkih | |
| NetValue | M |
Neto skupni znesek postavke (brez morebitnih popustov) – brez Vat. Mora biti vedno navedena. |
|
| GrossValue | M |
Bruto skupni znesek postavke (brez morebitnih popustov) – vključno z Vat. Vedno mora biti navedena. |
|
| TaxValue | M |
Skupni znesek Vat za postavko (brez morebitnih popustov) Mora biti vedno navedeno. |
|
| AccountingIdentifier | O | Dodatni identifikator za računovodske namene (računovodski vmesnik) | |
| ItemTaxType | M* |
Davčna vrsta postavke:
Podatki o državi:
|
|
| PositionNumber | M | Številka položaja, ki se začne z 0 | |
| positionReference | O | Navedba številke postavke, na katero se sklicuje | |
| cancellationPosition | O | »true«, če ta položaj razveljavlja položaj drugega dokumenta; sicer »false«. | |
| DeletedPosition | O | "true", če je bil ta položaj izbrisan; sicer "false". | |
| CreateDate | O | Čas evidentiranja položaja | |
[9] = Vmesni seštevek
Vrstica »SubTotal«
[10] = Total
Skupna postavka. Če se uporablja DocumentPositionTotal, mora biti vedno zadnja postavka v dokumentu (najvišja številka postavke).
Primer 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 vsebuje naslednje informacije.
Podatki v stolpcu »Type«:
- M ... obvezno / zahtevano
- M* ... obvezno / zahtevano v nekaterih državah ali pod določenimi pogoji
- R ... priporočeno
- O... neobvezno
| Elementi | Tip | Opis | |
| tip | M | Tip položajev (DocumentPositionType) | |
| zaokroževanje | O |
uporabljeno zaokroževanje. Če vsota položajev (bruto vrednost) ni enaka vsoti plačil. Npr. vrednost 0,01 bi omogočala zaokrožitvene razlike v obsegu +/-0,01 Opomba: Uporabljajte previdno. Visoke vrednosti onemogočijo preverjanje zneska za znesek plačila / bruto vrednost dokumenta |
|
| BaseValue | M* | Osnovni znesek postavke pred uporabo popustov (samo če se uporabljajo popusti) | |
| vrednost | M | Vrednost pozicije, vključno s popusti. | |
| popusti | Podrobnosti o popustih, znižanjih cen itd. | ||
| DiscountValue | M |
Znesek popusta / višina popusta
Pozor:
če je DiscountType [1] = popust, je treba znesek popusta vnesti z 4 decimalnimi mesti!
|
|
| caption | O | Oznaka popusta | |
| DiscountOrder | M* |
Označuje vrstni red, v katerem se izračuna popust. Prvi upoštevan popust ima vrednost 0. Treba ga je navesti, če se za artikel uporablja več popustov. |
|
| tip | M |
Vrsta popusta Enum:
|
|
| TypeValue | M |
Vrednost popusta (vsota znižanja) pri [0] = popust: DiscountValue pri [1] = popust: odstotek (npr. 10 % popust) |
|
| PromotionKeys | O | Ključi promocije – če se uporabljajo (npr. koda kupona) | |
| identifikator | O | Dodatni identifikator za popust (se lahko uporabi npr. za razvrščanje popustov v vrste popustov). | |
| caption | O | Oznaka položaja | |
| PositionNumber | M | Številka delovnega mesta, ki se začne z 0 | |
| positionReference | O | Navedba številke položaja, na katerega se sklicuje | |
| cancellationPosition | O | »true«, če ta položaj razveljavlja položaj drugega dokumenta; sicer »false«. | |
| DeletedPosition | O | "true", če je bil ta položaj izbrisan; sicer "false". | |
| CreateDate | O | Čas zabeležitve položaja | |
Ta članek je bil samodejno preveden.
Komentar
0 komentarjev
Za dodajanje komentarja prosimo kliknite Vpis.