„payments” fizetési objektum – RetailForce

Ez a cikk a Document objektumon belüli Payment objektumot („payments”) tárgyalja.

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 payment objektum természetesen tartalmazhat több különböző fizetést (= különböző fizetési módokat – PaymentType) egy adott bizonylathoz.

payments-object

Az alábbi fizetési objektum mintadatokat tartalmaz.

"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"
      }
    }
  ],

Az alábbi fizetési objektum példaadatokat tartalmaz.

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
mennyiség		M	A fizetési pozíció összege
CurrencyIsoCode		M	ISO 4217 pénznemkód
caption		M	A fizetési mód / fizetési eszköz megnevezése
UniqueReadablePaymentIdentifier		M	(tetszőleges) a fizetési típus egyedi azonosítója. Példák: „készpénz”, „készpénzes fizetés”, „VISA”, „készpénz-EUR”,... Figyelem: egy napi kimutatáson (Z-jelentésen) belül ugyanazon egyedi olvasható fizetési azonosítóhoz nem lehet két különböző pénznem-rövidítést használni! Ha több pénznemet használnak, minden pénznemhez külön UniqueReadablePaymentIdentifier-t (uniqueReadablePaymentIdentifier) kell használni. Pl.: „CashEUR”, „CashUSD”, „CashDKK”, „készpénzes fizetés EUR”,...
ForeignAmount		O	Összeg, ha a fizetés külföldi pénznemben történik
ForeignAmountExchangeRate		O	Devizaárfolyam
AdditionalFields		M*
	VoucherId	M*	Típusok: MultiPurposeVoucher, SinglePurposeVoucher. Figyelem: `VoucherId` a `AdditionalFields` objektum alá kell helyezni.
	additionalProp1-x	M*
PaymentType		M	Fizetési mód / Fizetési eszköz
~~IsCash~~		-	Az „IsCash” elem 2023. március 1-jétől már nem támogatott. A fizetési módot a PaymentType elem határozza meg. Figyelem: Az „IsCash” tulajdonság a Fiscal Client 1.7.6-os verziójától kezdve eltávolításra került!
CreateDate		O	A fizetési típus létrehozásának dátuma (ha rendelkezésre áll)
VatIdentification		M*	HÉA-osztály ID (az RF-hozzárendelés szerint), lásd: GET /api/v1/information/client/ {clientId}/getVatIdentification Figyelem: Bizonyos fizetési típusok esetében az áfa-információkat meg kell adni. Például előlegek (letét), utalványok stb . esetén. Javasoljuk, hogy mindig adja meg az áfa-adatokat.
VatPercent		M*	Vat-százalék / -kulcs
VatPercent2		O	Második Vat-százalék / -kulcs (vegyes Vat-kulcsú fizetések esetén)
TaxValue		M*	Vat-összeg
TaxValue2		O	Második Vat-összeg (vegyes Vat-kulcsú kifizetések esetén)
ExternalIdentifier		O
user		O/M*	A pénztárgép-felhasználó adatai (megadható, ha eltérnek a dokumentum header-ében vagy a tételekben szereplő adatoktól).
	ID	O/M*	ID-kódja a pénztárgép-felhasználónak
	caption	O/M*	A pénztárgép-felhasználó megnevezése
	firstName	O	A pénztárgép-felhasználó keresztneve
	lastName	O	A pénztárgép-felhasználó vezetékneve
	taxNumber	O/M*	A pénztáros adószáma Országadatok: bizonyos országokban (pl. Szlovénia) meg kell adni a pénztáros adószámát.
SalesPerson		O/M*	Az eladó adatai (megadható, ha eltérnek a dokumentum headerben vagy az egyes tételekben szereplő adatoktól)
	ID	O/M*	The SalesPerson ID number
	caption	O/M*	Az értékesítő beosztása
	firstName	O	Az értékesítő keresztneve
	lastName	O	Az értékesítő SalesPerson vezetékneve
	taxNumber	O/M*	The SalesPerson's tax number Országadatok: bizonyos országokban (pl. Szlovénia) meg kell adni a pénztáros adószámát.
PaymentTerminalReferenceId		O/M*	A fizetési terminal által visszaadott tranzakciós ID (ha a fizetési terminal integrálva van a POS-rendszerrel, és a tranzakciós ID-t ki kell nyomtatni a dokumentumra). Országspecifikus adatok: Dánia: kártyás fizetések esetén a PaymentTerminalReferenceId-t fel kell tüntetni a kérelemben. További információk a dán pénztárgépekre vonatkozó követelmények 7. pontjában találhatók.
cardData		O	Hitelkártya-terminálok (amelyek nem rendelkeznek saját nyomtatási funkcióval) által kiállított nyugták a cardData segítségével integrálhatók a nyugtaiba. Azokban az országokban, ahol „fiskális nyomtatókat” használnak (= a RetailForce system vezérli a dokumentumok nyomtatását), a cardData mezőben szereplő információk szabad szövegsorokként kerülnek kinyomtatásra a fiskális nyugta után. A két rész között nincs elválasztás. Országspecifikus részletek: Görögország: Görögországban az elektronikus fizetések feldolgozásához további mezők szükségesek, beleértve a ProviderSignature, ProviderTransactionId és ProviderSignatureMessage mezőket a helyi előírásoknak való megfelelés érdekében.
	ReceiptCopyCount	O	A nyugta példányainak száma
	nyugta	O	A nyugta szövegsorainak tömbje
	CardNumberMasked	O	Biztonsági okokból maszkolt kártyaszám (pl.: ****1234)
	IdentificationToken	O	A tranzakció egyedi azonosítója
	MerchantCopyCount	O	A kereskedői nyugta példányainak száma
	MerchantReceipt	O	A kereskedői nyugta szövegsorainak tömbje
	CardType	O	A fizetési tranzakció kártyatípusa (pl. VISA, MASTERCARD stb.)
	AuthorizationCode	O	A fizetés engedélyezési kódja
	terminalId	O	A fizetéshez használt terminal ID
	MerchantId	O	A kereskedő ID-je (az elfogadóintézettől)
	transactionId	O	A tranzakció ID-ja
	szolgáltatói aláírás	O/M*	A görögországi fizetési folyamatra vonatkozó fizetési szolgáltató aláírása
	ProviderTransactionId	O/M*	The transactionId of the payment provider for the Greek payment process
	ProviderSignatureMessage	O/M*	A fizetési szolgáltató aláírási üzenete a görögországi fizetési folyamathoz
	TransactionDate	O	A fizetési tranzakció dátuma
	TransactionNumber	O	Az elektronikus fizetés tranzakciószáma

Megjegyzés: 2023. március 1-jétől az „IsCash” mező eltávolításra került az objektummodellből. Továbbra is továbbítható, de már nem indít el funkciót. A fizetési típusokat a „PaymentType” mezőn keresztül lehet szabályozni.

Ezt a cikket automatikusan lefordították.

payments-object

Kapcsolódó cikkek