Denne artikel omhandler positionsobjektet inden for Document-objektet (Document-objektet).
En fuldstændig beskrivelse af RetailForce DOM (Document Object Model) samt en beskrivelse af de enkelte elementer findes i downloadområdet på RetailForce website (Object model documentation.pdf) i det respektive versionsbibliotek.
Objektet »positions« indeholder oplysninger om dokumentets respektive position.
Positionsobjektet består af:
- DocumentPositionBase – indeholder grundlæggende oplysninger om positionen (uafhængigt af den pågældende positions type)
- Positionsspecifikke oplysninger – afhængigt af positionstypen "type" (DocumentPositionType) skal der angives forskellige indholdselementer (positionstypen definerer positionens indhold).
DocumentPositionsBase
Følgende objekt indeholder eksempeldata.
"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 indeholder følgende oplysninger.
Oplysninger i kolonnen "Type":
- M ... obligatorisk / påkrævet
- M* ... obligatorisk / påkrævet i visse lande eller under visse betingelser
- R ... anbefalet
- O... valgfrit
| Elementer | Type | Beskrivelse | |
| PositionNumber | M |
Sekvensnummer for positionen.
Bemærk:
Nummeret på den første position er altid "0"!
|
|
| positionReference | O | Henvisning til en anden position i dokumentet. Svarer til documentReference. | |
| {...} | O | ||
| cancellationPosition | M | "true", hvis denne position annullerer en position i et andet dokument; ellers "false". | |
| DeletedPosition | O | "true", hvis denne position blev slettet; ellers "false". | |
| type | M |
angiver positionstypen "type" (DocumentPositionType). Enum:
Forklaringer til de enkelte typer (DocumentPositionTypes) findes efter denne tabel. |
|
| AdditionalFields | O | ||
| {...} | |||
| CreateDate | M | Tidspunktet, hvor positionen blev oprettet. | |
| ExternalIdentifier | O | Eksternt ID (fra det tidligere system) til interne formål, ikke relevant for skatteopgørelsen. | |
| bruger | O | Oplysninger om den (kasseapparat-)bruger, der har indtastet den pågældende vare. | |
| {...} | |||
| SalesPerson | O | Oplysninger om den pågældende salgsmedarbejder. | |
| {...} | |||
| FiscalAdditionalFields | O | ||
DocumentPositionType
[0] = Vare
Typen "vare" (DocumentPositionItem) er en specifik salgsvare (vare eller tjenesteydelse).
Eksempel 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": {}
}
],DocumentPositionItem-objektet indeholder følgende oplysninger.
Oplysninger i kolonnen "Type":
- M ... obligatorisk / påkrævet
- M* ... obligatorisk / påkrævet i visse lande eller under visse betingelser
- R ... anbefalet
- O... valgfrit
| Elementer | Type | Beskrivelse | |
| ItemCaption | M |
Artikelbetegnelse, beskrivelse af tjenesten Landespecifikke oplysninger:
|
|
| ItemShortCaption | O | Kort betegnelse for varen, der f.eks. anvendes, når der er begrænsninger i tegnlængden, som f.eks. ved skatteprintere. | |
| ItemSerialNumber | M* |
Varenummeret. Landespecifikke oplysninger:
|
|
| rabatter | Oplysninger om rabatter, prisnedsættelser osv. | ||
| DiscountValue | M |
Rabatsum / rabatbeløb
Bemærk:
hvis DiscountType [1] = discount, skal rabatbeløbet indtastes med 4 decimaler!
|
|
| caption | R |
Betegnelse for rabatten Landespecifikke oplysninger:
|
|
| DiscountOrder | M* |
Angiver den rækkefølge, hvori rabatten beregnes. Den første rabat, der tages i betragtning, har værdien 0. Skal angives, hvis der anvendes flere rabatter på en vare. |
|
| type | M |
Rabattype Enum:
|
|
| TypeValue | M |
Rabatværdi (summen af nedsættelsen) ved [0] = Rabat: DiscountValue (=> DiscountValue = TypeValue) ved [1] = Rabat: procentdelen (f.eks. 10 % rabat) |
|
| PromotionKeys | O | Kampagnenøgler – hvis de anvendes (f.eks. kuponkode) | |
| identifikator | O | Yderligere identifikator for rabatten (kan f.eks. bruges til at gruppere rabatter i rabat-typer). | |
| type | M | Positions-Typ (DocumentPositionType) | |
| UseSubItemVatCalculation | O | "true", hvis momsberegningen for underposterne (SubItems) skal overtages, og momsen for overordnede post skal ignoreres; ellers "false". Standard (hvis ikke angivet): "true". Hvis "true", skal hver underpost have en VatIdentification, og summen af underposternes brutto-, netto- og skatteværdier skal svare til overordnede posts BaseGrossValue, BaseNetValue og BaseTaxValue; ellers afvises dokumentet. | |
| SubItems | O | Detaljer om SubItems. Se: DocumentPositionType [1] = SubItem | |
| [...] | |||
| inhouse | O | Angiver et internt salg eller et eksternt salg (true / false). | |
| ItemGroupId | M* |
Artikelgruppeindikator Landespecifikke oplysninger:
|
|
| ItemGroupCaption | O |
Betegnelse for artikelgruppe Landespecifikationer:
|
|
| CostPrice | O/M* |
Enhedspris for varen Landespecifikationer:
|
|
| itemDateOfEntry | M* |
Tidspunkt for oprettelse af varen. Landespecifikke oplysninger:
|
|
| mængde | M |
Mængdeoplysninger for varen Landespecifikke detaljer:
|
|
| QuantityUnit | M* |
Angivelse af måleenheden Landespecifikationer:
|
|
| ID | M* |
Angivelse af måleenheden. Landespecifikationer:
|
|
| isoCode | M* |
Standardmåleenhed, der sendes som navnet på en QuantityUnitIsoCode-værdi (f.eks. "Quantity" for styk, "Kilogram"), ikke som selve ISO/UCUM-koden. Modulet konverterer navnet til ISO/UCUM-koden (f.eks. "Quantity" = "1"). Et tal læses som enumets numeriske værdi, så "1" betyder "Percent". Se den linkede artikel for yderligere oplysninger. Landespecifikke oplysninger:
|
|
| ItemId | M |
Artiklens ID Landespecifikke oplysninger:
|
|
| ItemType | M* |
Beskriver varetypen: varer eller tjenesteydelser.
Landespecifikke oplysninger:
|
|
| BaseNetValue | M* |
Nettotal (ekskl. Vat) før rabat eller tillæg
Bemærk:
(Netto)summen for linjen/positionen, IKKE for varen. Hvis mængden = 2, er BaseNetValue også enhedsprisen x 2!
|
|
| BaseGrossValue | M* |
Bruttotal (inkl. Vat) før rabat eller tillæg
Bemærk:
(Brutto)summen af linjen/positionen, IKKE af varen. Hvis mængden = 2, er BaseGrossValue også vareprisen x 2!
|
|
| BaseTaxValue | M* |
Vat-beløb (eller summen af den første Vat-sats) før rabat eller tillæg
Bemærk:
(Vat) summen af linjen/positionen, IKKE af varen. Hvis mængden = 2, er BaseTaxValue også vareprisen x 2!
Landespecifikationer:
|
|
| BaseTaxValue2 | M* |
Summen af den anden skattesats for positionen før rabat/tillæg. Landespecifikationer:
|
|
| GTIN | O/R |
Global varenummer (GTIN) Landespecifikationer:
|
|
| BusinessTransactionType | M |
Transaktionstype. Enum:
|
|
| ItemTypeClassification | O/M* |
ItemTypeClassification kan bruges til at anvende en yderligere klassificering på en vare. ItemTypeClassification kan kun angives, hvis egenskaben ‘ItemType’ er sat til "[0] - Artikel" eller “ItemType”: 0. Detaljerede oplysninger om egenskaben "ItemTypeClassification" findes i den linkede artikel. Følgende klassifikationer er tilgængelige.
Landespecifikationer:
|
|
| VatIdentification | M |
ID for momssatsen. Kan hentes via GET /api/v1/information/client/ {clientId}/getVatIdentification ved at angive momssatsen for det pågældende land. |
|
| VatPercent | M |
Vat i procent eller den første skattesats, der gælder for varen i det pågældende land. Landespecifikke oplysninger:
|
|
| VatPercent2 | M* |
Den anden skattesats, der gælder for varen, udtrykt i procent i det pågældende land. Landedetaljer:
|
|
| NetValue | M |
Nettotal for positionen (fratrukket eventuelle rabatter / tillagt eventuelle tillæg) – ekskl. Vat. Skal altid angives. |
|
| GrossValue | M |
Bruttotal for positionen (minus eventuelle rabatter / plus tillæg) – inkl. Vat. Skal altid angives. |
|
| TaxValue | M |
Vat-beløb (eller summen af den første Vat-sats) for varen (fratrukket eventuelle rabatter / tillagt eventuelle tillæg) Skal altid angives. Landespecifikke oplysninger:
|
|
| TaxValue2 | M* |
Summen af varens anden skattesats efter rabat/tillæg. Landespecifikationer:
|
|
| AccountingIdentifier | O | Yderligere identifikator til regnskabsmæssige formål (regnskabsgrænseflade) | |
| ItemTaxType | M* |
Skatteklasse for posten:
Landoplysninger:
|
|
| PositionNumber | M | Positionsnummer, der starter med 0 | |
| positionReference | O | Angivelse af et positionsnummer, der skal henvises til | |
| cancellationPosition | O/M* | "true", hvis denne position annullerer en position i et andet dokument; ellers "false" | |
| CreateDate | O | Tidspunkt for registrering af positionen | |
[1] = Underpost
"Underposter" (DocumentPositionSubItem) giver mulighed for at forklare sammensætningen af solgte produkter eller produktgruppebeskrivelser på vareniveau.
Eksempel: Menu = Cola og hamburger.
SubItems behøver ikke at blive brugt. Hvis den overordnede post har "UseSubItemVatCalculation": true (standardindstillingen), anvendes Vat for SubItems i stedet for Vat for den overordnede post, og deres værdier skal tilsammen svare til den overordnede posts basisværdier. Med "UseSubItemVatCalculation": false gælder Vat for den overordnede post, og SubItems beskriver kun postens sammensætning.
[2] = Tekst
Bruges til at angive placeringen af en tekst eller en Barcode i dokumentet.
Eksempel 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": {}
}
],DocumentPositionText-objektet indeholder følgende oplysninger.
Oplysninger i kolonnen "Type":
- M ... obligatorisk / påkrævet
- M* ... obligatorisk / påkrævet i visse lande eller under visse betingelser
- R ... anbefalet
- O... valgfrit
| Elementer | Type | Beskrivelse | |
| type | M | Positions-type (DocumentPositionType) | |
| tekst | O |
Felt til fritekst Landespecifikationer:
|
|
| barcodeType | O |
Angivelse af Barcode-type Enum:
|
|
| Barcode | O | Barcode-data | |
| PositionNumber | M | Positionsnummer, der starter med 0 | |
[3] = Booking
Reservationspositioner (DocumentPositionBooking) bruges til indbetalinger, udbetalinger samt salg af multifunktionelle kuponer (PayIn, payOut, MultiPurposeVoucher, ...).
Eksempel 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": {}
}
],DocumentPositionBooking-objektet indeholder følgende oplysninger.
Oplysninger i kolonnen "Type":
- M ... obligatorisk / påkrævet
- M* ... obligatorisk / påkrævet i visse lande eller under visse betingelser
- R ... anbefalet
- O... valgfrit
| Elementer | Type | Beskrivelse | |
| type | M | Positions-type (DocumentPositionType) | |
| caption | M | Beskrivelse af reservationspositionen | |
| identifikator | O | Indikator for yderligere ID for bogføringen | |
| BusinessTransactionType | M |
Type forretningstransaktion. Enum:
|
|
| PayOutType | M* |
Angiver udbetalingstypen. Kræves i visse lande. Mulige værdier:
Landespecifikationer:
Bemærk:
Nyt fra DOM v1.2.0 / Client v1.7.6
|
|
| VatIdentification | M |
Vat-ID. Kan hentes via GET /api/v1/information/client/ {clientId}/getVatIdentification ved angivelse af det pågældende lands momssats. |
|
| VatPercent | M | Vat in percent | |
| NetValue | M |
Nettobeløb for positionen (fratrukket eventuelle rabatter) – ekskl. Vat. Skal altid angives. |
|
| GrossValue | M |
Bruttotal for positionen (fratrukket eventuelle rabatter) – inkl. Vat. Skal altid angives. |
|
| TaxValue | M |
Vat-beløb for varen (fratrukket eventuelle rabatter) Skal altid angives. |
|
| AccountingIdentifier | O | Yderligere identifikator til regnskabsmæssige formål (regnskabsgrænseflade) | |
| ItemTaxType | M* |
Skatteklasse for posten:
Landoplysninger:
|
|
| PositionNumber | M | Positionsnummer, der starter med 0 | |
| positionReference | O | Angivelse af et varenummer, der skal henvises til | |
| cancellationPosition | O | "true", hvis denne position annullerer en position i et andet dokument; ellers "false". | |
| DeletedPosition | O | "true", hvis denne position er blevet slettet; ellers "false". | |
| CreateDate | O | Tidspunkt for registrering af positionen | |
[9] = SubTotal
Subtotal-position
[10] = Total
Totalposition. Hvis DocumentPositionTotal anvendes, skal den altid være den sidste position i dokumentet (højeste PositionNumber).
Eksempel 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": {}
}
],DocumentPositionTotal-objektet indeholder følgende oplysninger.
Oplysninger i kolonnen "Type":
- M ... obligatorisk / påkrævet
- M* ... obligatorisk / påkrævet i visse lande eller under visse betingelser
- R ... anbefalet
- O... valgfrit
| Elementer | Type | Beskrivelse | |
| type | M | Positions-type (DocumentPositionType) | |
| afrunding | O |
Afrunding anvendes. Hvis summen af positioner (bruttoværdi) ikke svarer til betalingssummen. Afrundingen lægges til summen af bruttoværdierne for posten og bogføringspositionerne, og betalingssummen skal svare nøjagtigt til resultatet. Det er et tegnet beløb, ikke en tolerance: f.eks. betyder -0,02, at betalingerne er 0,02 lavere end positionernes bruttosum, mens 0,01 betyder, at de er nøjagtigt 0,01 højere. Bemærk: Brug denne funktion med omhu. Hvis betalingerne og posterne ikke afviger med nøjagtigt denne værdi, afvises dokumentet. |
|
| BaseValue | M* | Positionens basisbeløb før fradrag af rabatter (kun hvis der anvendes rabatter) | |
| værdi | M | Positionsværdien inklusive rabatter. | |
| rabatter | Oplysninger om rabatter, prisnedsættelser osv. | ||
| DiscountValue | M |
Rabatsum / rabatbeløb
Bemærk:
hvis DiscountType [1] = rabat, skal rabatbeløbet indtastes med 4 decimaler!
|
|
| caption | O | Betegnelse for rabatten | |
| DiscountOrder | M* |
Angiver den rækkefølge, hvori rabatten beregnes. Den første rabat, der tages i betragtning, har værdien 0. Skal angives, hvis der anvendes flere rabatter på en vare. |
|
| type | M |
Rabattype Enum:
|
|
| TypeValue | M |
Rabatværdi (summen af nedsættelsen) ved [0] = Rabat: DiscountValue ved [1] = Rabat: procentdelen (f.eks. 10 % rabat) |
|
| PromotionKeys | O | Kampagnenøgler – hvis anvendt (f.eks. kuponkode) | |
| identifikator | O | Yderligere identifikator for rabatten (kan f.eks. bruges til at gruppere rabatter i rabat-typer). | |
| caption | O | Betegnelsen for positionen | |
| PositionNumber | M | Stillingsnummer, der starter med 0 | |
| positionReference | O | Angivelse af et positionsnummer, der skal henvises til | |
| cancellationPosition | O | "true", hvis denne position annullerer en position i et andet dokument; ellers "false". | |
| DeletedPosition | O | "true", hvis denne position er blevet slettet; ellers "false". | |
| CreateDate | O | Tidspunkt for registrering af positionen | |
Denne artikel er oversat automatisk.
Kommentarer
0 kommentarer
Log ind for at kommentere.