Platební objekt „payments“ – RetailForce

Tento článek se zabývá objektem „Payment“ („payments“) v rámci objektu „Document“.

Úplný popis DOM (Document Object Model) systému RetailForce, stejně jako popis jednotlivých prvků, naleznete v sekci ke stažení na webových stránkách RetailForce (Object model documentation.pdf) v příslušném adresáři s verzemi.

Objekt „Payment“ může samozřejmě obsahovat několik různých plateb (= různých platebních prostředků – „PaymentType“) pro jeden doklad.

Objekt „payments“

Následující objekt platby obsahuje ukázková data.

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

Následující objekt „payments“ obsahuje vzorová data.

Informace ve sloupci „Type“:

M ... povinné / vyžadované
M* ... povinné / vyžadované v určitých zemích nebo za určitých podmínek
R ... doporučeno
O... volitelné

Prvky		Typ	Popis
množství		M	Celková částka platební položky
kód měny ISO		M	Kód měny podle normy ISO 4217
popisek		M	Označení platební metody / platebního prostředku
jedinečný čitelný identifikátor platby		M	(libovolný) jedinečný identifikátor typu platby. Příklady: „hotovost“, „platba v hotovosti“, „VISA“, „hotovost-EUR“,... Upozornění: v rámci jednoho denního výpisu (Z-reportu) není možné použít 2 různé zkratky měn pro stejný jedinečný identifikátor čitelné platby! Pokud se používá více měn, musí být pro každou měnu použit vlastní jedinečný identifikátor čitelné platby. Např. „CashEUR“, „CashUSD“, „CashDKK“, „Cash payment EUR“,...
ForeignAmount		O	Celková částka, pokud je platba provedena v cizí měně
ForeignAmountExchangeRate		O	Směnný kurz cizí měny
AdditionalFields		M*
	ID dokladu	M*	Typy: MultiPurposeVoucher, SinglePurposeVoucher. Pozor: `VoucherId` musí být vnořeno pod objekt `AdditionalFields` objektu.
	additionalProp1-x	M*
paymentType		M	Způsob platby / Platební prostředek
~~isCash~~		-	prvek „isCash“ již od 1. března 2023 není podporován. Typ platby je definován prvkem paymentType. Upozornění: Vlastnost „IsCash“ byla odstraněna od verze Fiscal Client 1.7.6!
createDate		O	Datum vytvoření typu platby (je-li k dispozici)
vatIdentification		M*	ID třídy Vat (podle přiřazení RF), viz: GET /api/v1/information/client/ {clientId}/getVatIdentification Upozornění: U určitých typů plateb je nutné uvést informace o Vat. Například u záloh (vkladů), poukázek... Doporučujeme vždy uvádět údaje o Vat.
vatPercent		M*	Procentní sazba Vat
VatPercent2		O	Druhá sazba Vat (pro platby se smíšenou sazbou Vat)
taxValue		M*	Částka DPH
TaxValue2		O	Druhá částka Vat (u plateb se smíšenou sazbou Vat)
externalIdentifier		O
user		O/M*	Údaje o uživateli pokladny (lze uvést, pokud se liší od údajů v záhlaví dokladu nebo v jednotlivých položkách).
	id	O/M*	Identifikační kód uživatele pokladny
	caption	O/M*	Označení uživatele pokladny
	křestní jméno	O	Křestní jméno uživatele pokladny
	lastName	O	Příjmení uživatele pokladny
	daňové číslo	O/M*	Daňové číslo uživatele pokladny Údaje o zemi: v některých zemích (např. ve Slovinsku) je nutné uvést daňové číslo pokladníka.
SalesPerson		O/M*	Údaje o SalesPersonovi (lze uvést, pokud se liší od údajů v záhlaví dokladu nebo v jednotlivých položkách)
	id	O/M*	Identifikační číslo SalesPersona
	caption	O/M*	Funkce SalesPerson
	jméno	O	Křestní jméno SalesPerson
	příjmení	O	Příjmení SalesPerson
	daňové číslo	O/M*	Daňové číslo SalesPersona Údaje o zemi: v některých zemích (např. ve Slovinsku) je nutné uvést daňové číslo pokladníka.
PaymentTerminalReferenceId		O/M*	ID transakce vrácené platebním terminálem (pokud je platební terminál integrován do POS systému a ID transakce má být vytištěno na dokladu). Údaje o zemi: Dánsko: v případě plateb kartou musí být v žádosti uvedeno PaymentTerminalReferenceId. Další informace naleznete v bodě 7 požadavků na pokladny v Dánsku .
cardData		O	Účtenky z terminálů pro platby kreditními kartami (bez vlastní tiskové funkce) lze integrovat do účtenky prostřednictvím pole cardData. V zemích, kde se používají „fiskální tiskárny“ (= systém RetailForce řídí tisk dokumentů), se informace obsažené v oblasti cardData tisknou jako řádky volného textu následující po fiskálním dokladu. Mezi těmito dvěma částmi není žádné oddělení. Podrobnosti podle zemí: Řecko: Pro zpracování elektronických plateb v Řecku jsou vyžadována další pole, včetně ProviderSignature, ProviderTransactionId a ProviderSignatureMessage, aby byly splněny místní předpisy.
	ReceiptCopyCount	O	Počet kopií účtenky
	stvrzenka	O	Pole řádků textu účtenky
	CardNumberMasked	O	Zamaskované číslo karty z bezpečnostních důvodů (např. ****1234)
	IdentificationToken	O	Jedinečný identifikační token transakce
	MerchantCopyCount	O	Počet kopií účtenky pro obchodníka
	MerchantReceipt	O	Pole textových řádků účtenky obchodníka
	CardType	O	Typ karty použité při platební transakci (např. VISA, MASTERCARD atd.)
	AuthorizationCode	O	Autorizační kód pro platbu
	terminalId	O	ID terminálu pro platbu
	MerchantId	O	ID (od akceptanta) obchodníka
	transactionId	O	Jedinečné ID transakce
	podpis_poskytovatele	O/M*	Podpis poskytovatele plateb pro platební proces v Řecku
	ProviderTransactionId	O/M*	Transakční ID poskytovatele plateb pro platební proces v Řecku
	ProviderSignatureMessage	O/M*	Podpisová zpráva poskytovatele plateb pro platební proces v Řecku
	TransactionDate	O	Datum platební transakce
	TransactionNumber	O	Číslo transakce elektronické platby

Poznámka: Od 1. března 2023 bylo pole „IsCash“ z objektového modelu odstraněno. Lze jej sice stále odesílat, ale již nespouští žádnou funkci. Typy plateb se řídí polem „PaymentType“.

Tento článek byl přeložen automaticky.

Objekt „payments“

Související články