Platobný objekt „payments“ – RetailForce

Tento článok sa týka objektu „Payment“ („payments“) v rámci objektu „Document“.

Úplný popis RetailForce DOM (Document Object Model), ako aj popis jednotlivých prvkov, nájdete v sekcii na stiahnutie na RetailForce website (Object model documentation.pdf) v príslušnom adresári verzií.

Objekt platby môže samozrejme obsahovať niekoľko rôznych platieb (= rôzne platobné prostriedky – PaymentType) pre jeden doklad.

objekt-platieb

Nasledujúci objekt platby obsahuje vzorové údaje.

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

Nasledujúci objekt platby obsahuje vzorové údaje.

Informácie v stĺpci „Type“:

M ... povinné / nevyhnutné
M* ... povinné / vyžadované v určitých krajinách alebo za určitých podmienok
R ... odporúčané
O... voliteľné

Prvky		Typ	Popis
množstvo		M	Celková suma platobnej pozície
CurrencyIsoCode		M	Kód meny podľa ISO 4217
caption		M	Označenie spôsobu platby / platobného prostriedku
UniqueReadablePaymentIdentifier		M	(ľubovoľný) jedinečný identifikátor typu platby. Príklady: „hotovosť“, „platba v hotovosti“, „VISA“, „hotovosť-EUR“,... Upozornenie: v rámci jedného denného výpisu (Z-správy) nie je možné použiť 2 rôzne skratky mien pre ten istý jedinečný UniqueReadablePaymentIdentifier! Ak sa používa viacero mien, pre každú menu sa musí použiť vlastný jedinečný UniqueReadablePaymentIdentifier. Napr. „CashEUR“, „CashUSD“, „CashDKK“, „Cash payment EUR“,...
ForeignAmount		O	Celková suma, ak je platba realizovaná v cudzej mene
ForeignAmountExchangeRate		O	Kurz cudzej meny
AdditionalFields		M*
	VoucherId	M*	Typy: MultiPurposeVoucher, SinglePurposeVoucher. Poznámka: `VoucherId` musí byť vložené pod objektom `AdditionalFields` objektu.
	additionalProp1-x	M*
PaymentType		M	Spôsob platby / Platobný prostriedok
~~IsCash~~		-	prvok „IsCash“ sa od 1. marca 2023 už nepodporuje. Typ platby je definovaný prvkom PaymentType. Upozornenie: Vlastnosť „IsCash“ bola odstránená od verzie Fiscal Client 1.7.6!
CreateDate		O	Dátum vytvorenia typu platby (ak je k dispozícii)
VatIdentification		M*	ID triedy Vat (podľa priradenia RF), pozri: GET /api/v1/information/client/ {clientId}/getVatIdentification Upozornenie: Pri určitých typoch platieb je potrebné uviesť informácie o Vat. Napríklad pri zálohách (depozit), poukážkach... Odporúčame vždy uvádzať údaje o Vat.
VatPercent		M*	Percentuálna sadzba Vat
VatPercent2		O	Druhá sadzba Vat (pre platby so zmiešanou sadzbou Vat)
TaxValue		M*	Suma Vat
TaxValue2		O	Druhá suma Vat (pre platby so zmiešanou sadzbou Vat)
ExternalIdentifier		O
user		O/M*	Údaje o používateľovi pokladne (možno uviesť, ak sa líšia od údajov v hederi dokladu alebo v položkách).
	ID	O/M*	ID používateľa pokladne
	caption	O/M*	Označenie používateľa pokladne
	firstName	O	Kresťanské meno používateľa pokladne
	lastName	O	Priezvisko používateľa pokladne
	taxNumber	O/M*	Daňové číslo používateľa pokladne Údaje o krajine: v niektorých krajinách (napr. v Slovinsku) je potrebné uviesť daňové číslo pokladníka.
SalesPerson		O/M*	Údaje o SalesPersonovi (možno uviesť, ak sa líšia od údajov v hlavičke dokladu alebo v jednotlivých položkách)
	ID	O/M*	ID predajcu
	caption	O/M*	Funkcia SalesPersona
	firstName	O	Krstné meno SalesPersona
	lastName	O	Priezvisko SalesPersona
	taxNumber	O/M*	Daňové číslo SalesPersona Údaje o krajine: v niektorých krajinách (napr. v Slovinsku) je potrebné uviesť daňové číslo pokladníka.
PaymentTerminalReferenceId		O/M*	ID transakcie vrátené platobným terminálom (ak je platobný terminál integrovaný s POS systémom a ID transakcie sa má vytlačiť na doklade). Špecifikácie pre jednotlivé krajiny: Dánsko: V prípade platieb kartou musí byť v žiadosti uvedené PaymentTerminalReferenceId. Ďalšie informácie nájdete v bode 7 požiadaviek na pokladnice v Dánsku .
cardData		O	Potvrdenia z terminálov na platby kreditnými kartami (bez vlastnej funkcie tlače) je možné integrovať do potvrdenia prostredníctvom cardData. V krajinách, kde sa používajú „fiskálne tlačiarne“ (= RetailForce system riadi tlač dokumentov), sa informácie uvedené v oblasti cardData vytlačia ako riadky voľného textu za fiskálnou účtenkou. Medzi týmito dvoma časťami nie je žiadne oddelenie. Podrobnosti o krajinách: Grécko: Pre spracovanie elektronických platieb v Grécku sú potrebné ďalšie polia, vrátane ProviderSignature, ProviderTransactionId a ProviderSignatureMessage, aby sa zabezpečilo dodržanie miestnych predpisov.
	ReceiptCopyCount	O	Počet kópií dokladu
	potvrdenie	O	Pole riadkov textu potvrdenia
	CardNumberMasked	O	Zamaskované číslo karty z bezpečnostných dôvodov (napr. ****1234)
	IdentificationToken	O	Jedinečný identifikačný token pre transakciu
	MerchantCopyCount	O	Počet kópií potvrdenia pre obchodníka
	MerchantReceipt	O	Pole riadkov textu potvrdenia obchodníka
	CardType	O	Typ karty platobnej transakcie (napr. VISA, MASTERCARD atď.)
	AuthorizationCode	O	Autorizačný kód pre platbu
	terminalId	O	ID terminálu pre platbu
	MerchantId	O	ID (od akceptanta) obchodníka
	transactionId	O	Jedinečné ID transakcie
	ProviderSignature	O/M*	Podpis poskytovateľa platobných služieb pre platobný proces v Grécku
	ProviderTransactionId	O/M*	TransactionId poskytovateľa platobných služieb pre platobný proces v Grécku
	ProviderSignatureMessage	O/M*	Správa s podpisom poskytovateľa platobných služieb pre platobný proces v Grécku
	TransactionDate	O	Dátum platobnej transakcie
	TransactionNumber	O	Číslo transakcie elektronickej platby

Poznámka: Od 1. marca 2023 bolo pole „IsCash“ odstránené z objektového modelu. Stále ho je možné odoslať, ale už nespúšťa žiadnu funkciu. Typy platieb sa riadia prostredníctvom poľa „PaymentType“.

Tento článok bol preložený automaticky.

objekt-platieb

Podobné články