Denna artikel handlar om betalningsobjektet (”payments”) inom dokumentobjektet.
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.
Betalningsobjektet kan naturligtvis innehålla flera olika betalningar (= olika betalningssätt – PaymentType) för en enskild kvittens.
betalningsobjekt
Följande betalningsobjekt innehåller exempeldata.
"payments": [
{
"amount": 120.00,
"currencyIsoCode": "EUR",
"caption": "BAR",
"uniqueReadablePaymentIdentifier": "BARZAHLUNG",
"foreignAmount": 0,
"foreignAmountExchangeRate": 0,
"additionalFields": {
"voucherId": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"paymentType": "cash",
"createDate": "2023-04-25T15:08:11.57+01:00",
"vatIdentification": 1,
"vatPercent": 20,
"vatPercent2": 10,
"taxValue": 20.00,
"taxValue2": 10.00,
"externalIdentifier": [
"string"
],
"user": {
"id": "user01",
"caption": "user01",
"firstName": "Manuela",
"lastName": "Musterfrau",
"taxNumber": "123456789"
},
"salesPerson": {
"id": "VK01",
"caption": "Franz",
"firstName": "Franz",
"lastName": "Österreicher",
"taxNumber": "234567890"
},
"paymentTerminalReferenceId": "string",
"cardData": {
"receiptCopyCount": 2,
"receipt": ["line1", "line2"],
"cardNumberMasked": "****1234",
"identificationToken": "token123",
"merchantCopyCount": 1,
"merchantReceipt": ["merchant line1"],
"cardType": "VISA",
"authorizationCode": "AUTH123",
"terminalId": "TERM001",
"merchantId": "MERCH001",
"transactionId": "TRX123456",
"providerSignature": "signature_string",
"providerTransactionId": "PROV_TRX_001",
"providerSignatureMessage": "signature_message",
"transactionDate": "2023-04-25T15:08:11.57+01:00",
"transactionNumber": "12345"
}
}
],Följande betalningsobjekt innehåller exempeldata.
Information i kolumnen ”Type”:
- M ... obligatoriskt / krävs
- M* ... obligatoriskt i vissa länder eller under vissa förutsättningar
- R ... rekommenderat
- O... valfritt
| Element | Typ | Beskrivning | |
| antal | M | Summa för betalningsposten | |
| CurrencyIsoCode | M | ISO 4217-valutakod | |
| caption | M | Betalningsmetodens beteckning / betalningsmedel | |
| UniqueReadablePaymentIdentifier | M |
(valfri) unik identifierare för betalningstypen. Exempel: "kontanter", "kontantbetalning", "VISA", "kontanter-EUR",...
Observera:
det är inte möjligt att använda två olika valutaförkortningar för samma unika UniqueReadablePaymentIdentifier inom en daglig rapport (Z-rapport)! Om flera valutor används måste en unik UniqueReadablePaymentIdentifier användas för varje valuta. T.ex. "KontanterEUR", "KontanterUSD", "KontanterDKK", "Kontantbetalning EUR",...
|
|
| ForeignAmount | O | Totalt om betalningen görs i utländsk valuta | |
| ForeignAmountExchangeRate | O | Växelkurs för utländsk valuta | |
| AdditionalFields | M* | ||
| VoucherId | M* | Typer: MultiPurposeVoucher, SinglePurposeVoucher. Observera: VoucherId måste placeras under AdditionalFields objektet. |
|
| additionalProp1-x | M* | ||
| PaymentType | M | Betalningsmetod / Betalningssätt | |
| - |
Elementet "IsCash" stöds inte längre från och med den 1 mars 2023. Betalningstyp definieras av elementet PaymentType.
Observera:
Egenskapen ”IsCash” har tagits bort från och med Fiscal Client version 1.7.6!
|
||
| CreateDate | O | Datum då betalningstypen skapades (om tillgängligt) | |
| VatIdentification | M* |
MomsidentifikationsID (enligt RF-tilldelning), se: GET /api/v1/information/client/ {clientId}/getVatIdentification
Observera:
För vissa betalningstyper måste information om Vat anges. Till exempel för handpenning (deposit), kuponger, ...
Vi rekommenderar att du alltid inkluderar Vat-uppgifter. |
|
| VatPercent | M* | Vat-procent / Vat-ssats | |
| VatPercent2 | O | Andra Vat-procent / skattesats (för betalningar med blandade Vat-satser) | |
| TaxValue | M* | Momsbelopp | |
| TaxValue2 | O | Andra momsbeloppet (för betalningar med blandad momssats) | |
| ExternalIdentifierare | O | ||
| användare | O/M* | Uppgifter om kassaanvändaren (kan anges om dessa skiljer sig från uppgifterna i headern eller i radposterna). | |
| ID | O/M* | ID-kod för kassanvändaren | |
| caption | O/M* | Beteckning på kassanvändaren | |
| firstName | O | Förnamn på kassanvändaren | |
| lastName | O | Efternamn på kassanvändaren | |
| taxNumber | O/M* |
Skatteregistreringsnummer för kassanvändaren
Landspecifika uppgifter:
I vissa länder (t.ex. Slovenien) måste kassörens taxNumber anges. Slovenien: Endast user.taxNumber i dokumentets header utvärderas, inte värdet i betalningen.
|
|
| SalesPerson | O/M* | Uppgifter om SalesPersonen (kan anges om dessa skiljer sig från uppgifterna i headern eller i de enskilda posterna) | |
| ID | O/M* | SalesPersons ID-nummer | |
| caption | O/M* | SalesPersons titel | |
| firstName | O | Förnamn på SalesPersonen | |
| lastName | O | SalesPersons efternamn | |
| taxNumber | O/M* |
SalesPersons skattenummer
Landuppgifter:
i vissa länder (t.ex. Slovenien) måste kassörens taxNumber anges. Slovenien: endast user.taxNumber i headern utvärderas, inte värdet i betalningen.
|
|
| PaymentTerminalReferenceId | O/M* |
Transaktions-ID som returneras av betalningsterminalen (om betalningsterminalen är integrerad med POS-systemet och transaktions-ID:t ska skrivas ut på dokumentet). Landsspecifikationer:
|
|
| cardData | O/M* |
Kvitton från kreditkortsterminaler (utan egen utskriftsfunktion) kan integreras i ett kvitto via cardData. I länder där ”fiskala skrivare” används (= RetailForce systemet styr utskriften av dokument) skrivs informationen i cardData-området ut som fritextrader efter det fiskala kvittot. Det finns ingen åtskillnad mellan de två delarna. Landsspecifikationer:
Obs: AADE-beslut A.1155/2023 föreskriver en leverantörs signatur eller en ECR-token, beroende på den tillämpliga grekiska arkitekturen för betalningsintegration. Detta lagkrav innebär inte i sig att alla tre RetailForce-fälten ProviderSignature, ProviderTransactionId och ProviderSignatureMessage är obligatoriska i varje kortbetalningstransaktion. Deras tillämplighet beror på integrationsscenariot. |
|
| ReceiptCopyCount | O | Antal kvittenskopior | |
| kvitto | O | Array med kvittots textrader | |
| CardNumberMasked | O | Maskat kortnummer av säkerhetsskäl (t.ex. ****1234) | |
| IdentificationToken | O | Unikt identifieringstoken för transaktionen | |
| MerchantCopyCount | O | Antal kopior av kvittot till handlaren | |
| MerchantReceipt | O | Array med textrader i handlarens kvitto | |
| CardType | O | Korttypen för betalningstransaktionen (t.ex. VISA, MASTERCARD osv.) | |
| AuthorizationCode | O | Auktoriseringskoden för betalningen | |
| terminalId | O/M* | Terminalens ID för betalningen | |
| MerchantId | O | ID (från inlösaren) för handlaren | |
| transactionId | O/M* | Unikt ID för transaktionen | |
| ProviderSignature | O/M* | Betalningsleverantörens signatur för betalningsprocessen i Grekland | |
| ProviderTransactionId | O/M* | Betalningsleverantörens transactionId för betalningsprocessen i Grekland | |
| ProviderSignatureMessage | O/M* | Betalningsleverantörens signaturmeddelande för betalningsprocessen i Grekland | |
| TransactionDate | O | Datum för betalningstransaktionen | |
| TransactionNumber | O | Transaktionsnumret för den elektroniska betalningen | |
Den här artikeln har översatts automatiskt.
Kommentarer
0 kommentarer
logga in för att lämna en kommentar.