Denna artikel behandlar objektet positions inom dokumentobjektet (Document-objektet).
En fullständig beskrivning av RetailForce DOM (Document Object Model), samt en beskrivning av de enskilda elementen, finns i nedladdningsområdet på RetailForce website (Object model documentation.pdf) i respektive versionskatalog.
Objektet ”positions” innehåller information om dokumentets respektive position.
Positionsobjektet består av:
- DocumentPositionBase – innehåller grundläggande information om positionen (oberoende av typen av respektive position)
- Positionsspecifik information – beroende på positions typ ”type” (DocumentPositionType) måste olika innehåll anges (positionstypen definierar positionens innehåll).
DocumentPositionsBase
Följande objekt innehåller exempeldata.
"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-objektet innehåller följande information.
Information i kolumnen ”Type”:
- M … obligatoriskt
- M* ... obligatoriskt / krävs i vissa länder eller under vissa förutsättningar
- R ... rekommenderat
- O... valfritt
| Element | Typ | Beskrivning | |
| PositionNumber | M |
Positionens löpnummer.
Observera:
Nummeret för den första positionen är alltid "0"!
|
|
| positionReference | O | Hänvisning till en annan position i dokumentet. Motsvarar documentReference. | |
| {...} | O | ||
| cancellationPosition | M | "true" om denna position upphäver en position i ett annat dokument; annars "false". | |
| DeletedPosition | O | "true" om denna position har raderats; annars "false". | |
| typ | M |
anger positionstypen "type" (DocumentPositionType). Enum:
Förklaringar av de enskilda typerna (DocumentPositionTypes) finns efter denna tabell. |
|
| AdditionalFields | O | ||
| {...} | |||
| CreateDate | M | Tidpunkt då positionen skapades. | |
| ExternalIdentifierare | O | Externt ID (från det tidigare systemet), för interna ändamål, inte relevant för skattehantering. | |
| user | O | Uppgifter om den (kassaregister-)användare som lagt in respektive artikel. | |
| {...} | |||
| SalesPerson | O | Uppgifter om försäljaren på respektive position. | |
| {...} | |||
| FiscalAdditionalFields | O | ||
DocumentPositionType
[0] = Artikel
Typen ”artikel” (DocumentPositionItem) är en specifik försäljningsartikel (vara eller tjänst).
Exempel på 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": "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": {}
}
],Objektet DocumentPositionItem innehåller följande information.
Information i kolumnen ”Typ”:
- M ... obligatoriskt / krävs
- M* ... obligatoriskt/krävs i vissa länder eller under vissa förutsättningar
- R ... rekommenderat
- O... valfritt
| Element | Typ | Beskrivning | |
| ItemCaption | M |
Artikelbeteckning, beskrivning av tjänsten Uppgifter om landet:
|
|
| ItemShortCaption | O | Kort namn på artikeln, används t.ex. när det finns begränsningar för teckenlängden, såsom vid användning av skatteskrivare. | |
| ItemSerialNumber | M* |
Artikelns serienummer. Landspecifika uppgifter:
|
|
| rabatter | Uppgifter om rabatter, prisnedsättningar m.m. | ||
| DiscountValue | M |
Rabattbelopp / rabattens storlek
Observera:
om DiscountType [1] = discount måste rabattbeloppet anges med 4 decimaler!
|
|
| caption | R |
Rabattens beteckning Landspecifika uppgifter:
|
|
| DiscountOrder | M* |
Anger i vilken ordning rabatten beräknas. Den första rabatten som beaktas har värdet 0. Måste anges om flera rabatter tillämpas på en artikel. |
|
| typ | M |
Rabattyp Enum:
|
|
| TypeValue | M |
Rabattvärde (summan av avdraget) vid [0] = Rabatt: DiscountValue (=> DiscountValue = TypeValue) vid [1] = Rabatt: procenttalet (t.ex. 10 % rabatt) |
|
| PromotionKeys | O | Kampanjnycklar – om sådana används (t.ex. kupongkod) | |
| identifier | O | Ytterligare identifierare för rabatten (kan t.ex. användas för att gruppera rabatter i rabatttyper). | |
| typ | M | Positions-Typ (DocumentPositionType) | |
| UseSubItemVatCalculation | O | "true" om momsberäkningen för underposterna (SubItems) ska övertas och momsen för överordnad post ska ignoreras; annars "false". Standardvärde (om inte annat anges): "true". Om "true" anges måste varje underpost ha en VatIdentification och summan av underposternas brutto-, netto- och skattevärden måste motsvara överordnad posts BaseGrossValue, BaseNetValue och BaseTaxValue; i annat fall avvisas dokumentet. | |
| SubItems | O | Detaljer om SubItems. Se: DocumentPositionType [1] = SubItem | |
| [...] | |||
| inhouse | O | Anger om det rör sig om en intern eller extern försäljning (true/falskt). | |
| ItemGroupId | M* |
Artikelgruppindikator Landspecifika uppgifter:
|
|
| ItemGroupCaption | O |
Beteckning för artikelgrupp Landsspecifikationer:
|
|
| CostPrice | O/M* |
Artikelns enhetspris Landsspecifikationer:
|
|
| itemDateOfEntry | M* |
Tidpunkt för artikelns skapande. Landspecifika uppgifter:
|
|
| quantity | M |
Antal för artikeln Landspecifika detaljer:
|
|
| QuantityUnit | M* |
Angivelse av måttenheten Landsspecifikationer:
|
|
| ID | M* |
Angivelse av måttenheten. Landsspecifikationer:
|
|
| isoCode | M* |
Standardmåttenhet, skickas som namnet på ett QuantityUnitIsoCode-värde (t.ex. ”Quantity” för styck, ”Kilogram”), inte som själva ISO/UCUM-koden. Modulen omvandlar namnet till ISO/UCUM-koden (t.ex. ”Quantity” = ”1”). Ett tal tolkas som enum-värdet, så ”1” betyder ”Percent”. För mer information, se den länkade artikeln. Landsspecifikationer:
|
|
| ItemId | M |
Artikelns ID Landuppgifter:
|
|
| ItemType | M* |
Beskriver typen av artikel: varor eller tjänster.
Landspecifika uppgifter:
|
|
| BaseNetValue | M* |
Nettosumma (exkl. Vat) före rabatt eller tillägg
Observera:
(Netto)summan för raden/positionen, INTE för artikeln. Om kvantiteten = 2, är BaseNetValue också artikelpriset x 2!
|
|
| BaseGrossValue | M* |
Bruttosumma (inkl. Vat) före rabatt eller tillägg
Observera:
(Brutto)summan för raden/positionen, INTE för artikeln. Om kvantiteten = 2, är BaseGrossValue också artikelpriset x 2!
|
|
| BaseTaxValue | M* |
Vat-belopp (eller summan av den första skattesatsen) före rabatt eller tillägg
Observera:
(Vat) summan för raden/positionen, INTE för artikeln. Om antalet = 2, är BaseTaxValue också artikelpriset x 2!
Landspecifikationer:
|
|
| BaseTaxValue2 | M* |
Summan av den andra skattesatsen för positionen före rabatt/tillägg. Landsinformation:
|
|
| GTIN | O/R |
Globalt varunummer (GTIN) Landsinformation:
|
|
| BusinessTransactionType | M |
Typ av affärstransaktion. Enum:
|
|
| ItemTypeClassification | O/M* |
ItemTypeClassification kan användas för att tillämpa en ytterligare klassificering på en artikel. ItemTypeClassification kan endast anges om egenskapen ”ItemType” har angetts till ”[0] – Artikel” eller ”ItemType”: 0. Detaljerad information om egenskapen ”ItemTypeClassification” finns i den länkade artikeln. Följande klassificeringar finns tillgängliga.
Landspecifikationer:
|
|
| VatIdentification | M |
ID för mervärdesskattesatsen. Kan hämtas via GET /api/v1/information/client/ {clientId}/getVatIdentification, där man anger momsatsen för respektive land. |
|
| VatPercent | M |
Vat i procent eller den första skattesatsen som gäller för artikeln i respektive land. Landsinformation:
|
|
| VatPercent2 | M* |
Andra skattesatsen som gäller för artikeln, uttryckt i procent i respektive land. Landsinformation:
|
|
| NetValue | M |
Nettototal för positionen (minus eventuella rabatter / plus tillägg) – exkl. Vat. Måste alltid anges. |
|
| GrossValue | M |
Positionens bruttosumma (minus eventuella rabatter / plus tillägg) – inkl. Vat. Måste alltid anges. |
|
| TaxValue | M |
Vat-belopp (eller summan av den första skattesatsen) för positionen (minus eventuella rabatter / plus tillägg) Måste alltid anges. Landuppgifter:
|
|
| TaxValue2 | M* |
Summan av den andra skattesatsen för varan efter rabatt/tillägg. Landsinformation:
|
|
| AccountingIdentifier | O | Ytterligare identifierare för redovisningsändamål (redovisningsgränssnitt) | |
| ItemTaxType | M* |
Skattetyp för positionen:
Landuppgifter:
|
|
| PositionNumber | M | Positionsnummer, börjar med 0 | |
| positionReference | O | Angivelse av ett positionsnummer som ska hänvisas till | |
| cancellationPosition | O/M* | "true" om denna position upphäver en position i ett annat dokument; i annat fall "false" | |
| CreateDate | O | Tidpunkt för registrering av positionen | |
[1] = SubItem
"Underposter" (DocumentPositionSubItem) gör det möjligt att förklara sammansättningen av sålda produkter eller produktgruppsbeskrivningar på artikelnivå.
Exempel: Meny = Cola och hamburgare.
SubItems behöver inte användas. Om den överordnade posten har "UseSubItemVatCalculation": true (standardinställningen) används SubItems' moms istället för den överordnade postens moms, och deras värden måste summera till den överordnade postens basvärden. Med "UseSubItemVatCalculation": false gäller den överordnade postens moms och SubItems förklarar endast postens sammansättning.
[2] = Text
Används för att konvertera en text- eller Barcode-position i dokumentet.
Exempel på 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": {}
}
],Objektet DocumentPositionText innehåller följande information.
Information i kolumnen ”Type”:
- M ... obligatoriskt / krävs
- M* ... obligatoriskt i vissa länder eller under vissa förhållanden
- R ... rekommenderat
- O... valfritt
| Element | Typ | Beskrivning | |
| typ | M | Positions-Typ (DocumentPositionType) | |
| text | O |
Fält för fritext Landspecifika uppgifter:
|
|
| barcodeType | O |
Angivelse av Barcode-typ Enum:
|
|
| Barcode | O | Barcode-data | |
| PositionNumber | M | Positionsnummer, börjar med 0 | |
[3] = Bokning
Bokningspositioner (DocumentPositionBooking) används för insättningar, uttag samt försäljning av MultiPurposeVoucher (PayIn, payOut, MultiPurposeVoucher, ...).
Exempel på 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": {}
}
],Objektet DocumentPositionBooking innehåller följande information.
Information i kolumnen ”Typ”:
- M ... obligatoriskt / krävs
- M* ... obligatoriskt i vissa länder eller under vissa förhållanden
- R ... rekommenderat
- O... valfritt
| Element | Typ | Beskrivning | |
| typ | M | Positions-Typ (DocumentPositionType) | |
| caption | M | Beskrivning av bokningspositionen | |
| identifierare | O | Indikator för ytterligare ID för bokningen | |
| BusinessTransactionType | M |
Typ av affärstransaktion. Enum:
|
|
| PayOutType | M* |
Anger typen av utbetalning. Obligatoriskt i vissa länder. Möjliga värden:
Landspecifika uppgifter:
Obs:
Nytt från och med DOM v1.2.0 / Client v1.7.6
|
|
| VatIdentification | M |
Moms-ID. Kan hämtas via GET /api/v1/information/client/ {clientId}/getVatIdentification, genom att ange momsatsen för respektive land. |
|
| VatPercent | M | Vat rate in percent | |
| NetValue | M |
Nettosumman för positionen (efter eventuella rabatter) – exkl. Vat. Måste alltid anges. |
|
| GrossValue | M |
Positionens bruttosumma (minus eventuella rabatter) – inkl. Vat. Måste alltid anges. |
|
| TaxValue | M |
Posterens Vat-belopp (minus eventuella rabatter) Måste alltid anges. |
|
| AccountingIdentifier | O | Ytterligare identifierare för redovisningsändamål (redovisningsgränssnitt) | |
| ItemTaxType | M* |
Skattetyp för posten:
Landuppgifter:
|
|
| PositionNumber | M | Positionsnummer, börjar med 0 | |
| positionReference | O | Angivelse av ett artikelnummer som ska hänvisas till | |
| cancellationPosition | O | "true" om denna position upphäver en position i ett annat dokument; i annat fall "false". | |
| DeletedPosition | O | "true" om denna position har raderats; annars "false". | |
| CreateDate | O | Tidpunkt för registrering av positionen | |
[9] = Delsumma
Delsumma för posten
[10] = Total
Totalposition. Om DocumentPositionTotal används måste den alltid vara den sista positionen i dokumentet (högsta PositionNumber).
Exempel på 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": {}
}
],Objektet DocumentPositionTotal innehåller följande information.
Information i kolumnen ”Type”:
- M ... obligatoriskt / krävs
- M* ... obligatoriskt/krävs i vissa länder eller under vissa förutsättningar
- R ... rekommenderat
- O... valfritt
| Element | Typ | Beskrivning | |
| typ | M | Positions-Typ (DocumentPositionType) | |
| avrundning | O |
avrundning tillämpas. Om summan av positionerna (bruttovärdet) inte är lika med betalningssumman. Avrundningen läggs till summan av bruttovärdena för posten och bokföringspositionerna, och summan av betalningarna måste exakt motsvara resultatet. Det är ett tecknat belopp, inte en tolerans: t.ex. -0,02 betyder att betalningarna är 0,02 lägre än positionernas bruttosumma, 0,01 betyder att de är exakt 0,01 högre. Obs! Använd med försiktighet. Om betalningarna och posterna inte skiljer sig åt med exakt detta värde avvisas dokumentet. |
|
| BaseValue | M* | Positionens basbelopp före tillämpning av rabatter (endast om rabatter tillämpas) | |
| värde | M | Positionens värde inklusive rabatter. | |
| rabatter | Uppgifter om rabatter, prisnedsättningar m.m. | ||
| DiscountValue | M |
Rabattbelopp / rabattens storlek
Observera:
om DiscountType [1] = discount måste rabattbeloppet anges med 4 decimaler!
|
|
| caption | O | Beteckning på rabatten | |
| DiscountOrder | M* |
Anger i vilken ordning rabatten beräknas. Den första rabatten som beaktas har värdet 0. Måste anges om flera rabatter tillämpas på en artikel. |
|
| typ | M |
Rabattyp Enum:
|
|
| TypeValue | M |
Rabattvärde (summan av avdraget) vid [0] = Rabatt: DiscountValue vid [1] = Rabatt: procenttalet (t.ex. 10 % rabatt) |
|
| PromotionKeys | O | Kampanjnycklar – om sådana används (t.ex. kupongkod) | |
| identifier | O | Ytterligare identifierare för rabatten (kan t.ex. användas för att gruppera rabatter i rabatttyper). | |
| caption | O | Beteckningen för positionen | |
| PositionNumber | M | Tjänstenummer, börjar med 0 | |
| positionReference | O | Angivelse av ett positionsnummer som ska hänvisas till | |
| cancellationPosition | O | "true" om denna position upphäver en position i ett annat dokument; i annat fall "false". | |
| DeletedPosition | O | "true" om denna position har raderats; annars "false". | |
| CreateDate | O | Tidpunkt för registrering av positionen | |
Den här artikeln har översatts automatiskt.
Kommentarer
0 kommentarer
logga in för att lämna en kommentar.