Plačilni objekt »payments« – RetailForce

Ta članek obravnava objekt »Plačilo« (»payments«) znotraj objekta »Dokument«.

Celoten opis modela RetailForce DOM (Document Object Model) ter opis posameznih elementov najdete v rubriki za prenose na RetailForce website (Object model documentation.pdf) v ustreznem imeniku različic.

Objekt »plačilo« lahko seveda vsebuje več različnih plačil (= različnih načinov plačila – PaymentType) za eno samo potrdilo.

objekt-plačil

Naslednji objekt plačila vsebuje vzorčne podatke.

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

Naslednji objekt »plačila« vsebuje vzorčne podatke.

Informacije v stolpcu »Type«:

M … obvezno / zahtevano
M* ... obvezno / zahtevano v nekaterih državah ali pod določenimi pogoji
R ... priporočeno
O... neobvezno

Elementi		Tip	Opis
količina		M	Skupni znesek plačilne pozicije
CurrencyIsoCode		M	koda valute po standardu ISO 4217
caption		M	Oznaka načina plačila / plačilnega sredstva
UniqueReadablePaymentIdentifier		M	(poljuben) edinstven identifikator vrste plačila. Primeri: »gotovina«, »gotovinsko plačilo«, »VISA«, »gotovina-EUR«,... Pozor: v enem dnevnem poročilu (Z-poročilu) ni mogoče uporabiti dveh različnih valutnih kratkic za isti edinstveni UniqueReadablePaymentIdentifier! Če se uporablja več valut, je treba za vsako valuto uporabiti svoj edinstveni UniqueReadablePaymentIdentifier. Npr. „gotovinaEUR“, „gotovinaUSD“, „gotovinaDKK“, „gotovinsko plačilo EUR“,...
ForeignAmount		O	Skupaj, če je plačilo izvedeno v tuji valuti
ForeignAmountExchangeRate		O	Menjalni tečaj tuje valute
AdditionalFields		M*
	VoucherId	M*	Tipi: MultiPurposeVoucher, SinglePurposeVoucher. Opomba: `VoucherId` mora biti vgrajeno pod objektom `AdditionalFields` objektu.
	additionalProp1-x	M*
PaymentType		M	Način plačila / Plačilno sredstvo
~~IsCash~~		-	element »IsCash« od 1. marca 2023 ni več podprt. Vrsta plačila je opredeljena z elementom PaymentType. Pozor: Lastnost »IsCash« je bila odstranjena v različici Fiscal Client 1.7.6!
CreateDate		O	Datum, ko je bil ustvarjen način plačila (če je na voljo)
VatIdentification		M*	ID razreda Vat (v skladu z dodelitvijo RF), glej: GET /api/v1/information/client/ {clientId}/getVatIdentification Pozor: Za določene vrste plačil je treba navesti podatke o Vat. Na primer za predplačila (polog), kupone... Priporočamo, da vedno vključite podatke o Vat.
VatPercent		M*	Odstotek/stopnja DDV
VatPercent2		O	Drugi odstotek Vat / stopnja (za plačila z mešanimi stopnjami Vat)
TaxValue		M*	Znesek Vat
TaxValue2		O	Drugi znesek Vat (za plačila z mešanimi stopnjami Vat)
ExternalIdentifier		O
uporabnik		O/M*	Podatki o uporabniku blagajne (se lahko navedejo, če se razlikujejo od podatkov v headerju dokumenta ali v posameznih postavkah).
	ID	O/M*	ID-koda uporabnika blagajne
	caption	O/M*	Naziv uporabnika blagajne
	firstName	O	Ime uporabnika blagajne
	lastName	O	Priimek uporabnika blagajne
	taxNumber	O/M*	Davčna številka uporabnika blagajne Podatki o državi: v nekaterih državah (npr. v Sloveniji) je treba navesti davčno številko blagajnika.
SalesPerson		O/M*	Podatki o SalesPersonu (se lahko navedejo, če se razlikujejo od podatkov v headerju dokumenta ali v posameznih postavkah)
	ID	O/M*	ID številka SalesPersona
	caption	O/M*	Naziv SalesPersona
	firstName	O	Ime SalesPersona
	lastName	O	Priimek SalesPersona
	taxNumber	O/M*	Davčna številka SalesPersona Podatki o državi: v nekaterih državah (npr. v Sloveniji) je treba navesti davčno številko blagajnika.
PaymentTerminalReferenceId		O/M*	ID transakcije, ki ga vrne plačilni terminal (če je plačilni terminal integriran s POS sistemom in se ID transakcije natisne na dokument). Podrobnosti o državi: Danska: v primeru plačil s kartico mora biti PaymentTerminalReferenceId vključen v zahtevo. Dodatne informacije so na voljo v točki 7 zahtev za blagajne na Danskem .
cardData		O	Potrdila iz terminalov za kreditne kartice (brez lastne funkcije tiskanja) se lahko vključijo v potrdilo prek cardData. V državah, kjer se uporabljajo »fiskalni tiskalniki« (= RetailForce system nadzira tiskanje dokumentov), se podatki iz polja cardData natisnejo kot vrstice prostega besedila za fiskalnim računom. Med temi dvema deloma ni ločnice. Podrobnosti po državah: Grčija: Za obdelavo elektronskih plačil v Grčiji so potrebna dodatna polja, vključno s ProviderSignature, ProviderTransactionId in ProviderSignatureMessage, da se zagotovi skladnost z lokalnimi predpisi.
	ReceiptCopyCount	O	Število kopij potrdila
	račun	O	Niz vrstic besedila potrdila
	CardNumberMasked	O	Zaslonjena številka kartice zaradi varnosti (npr. ****1234)
	IdentificationToken	O	Edinstven identifikacijski žeton za transakcijo
	MerchantCopyCount	O	Število kopij potrdila trgovca
	MerchantReceipt	O	Niz besedilnih vrstic potrdila trgovca
	CardType	O	Vrsta kartice za plačilno transakcijo (npr. VISA, MASTERCARD itd.)
	AuthorizationCode	O	Avtorizacijska koda za plačilo
	terminalId	O	ID terminala za plačilo
	MerchantId	O	ID (od pridobitelja) trgovca
	transactionId	O	Edinstvena ID transakcije
	ProviderSignature	O/M*	Podpis ponudnika plačilnih storitev za plačilni postopek v Grčiji
	ProviderTransactionId	O/M*	TransactionId ponudnika plačilnih storitev za plačilni proces v Grčiji
	ProviderSignatureMessage	O/M*	Podpisno sporočilo ponudnika plačilnih storitev za plačilni postopek v Grčiji
	TransactionDate	O	Datum plačilne transakcije
	TransactionNumber	O	Številka transakcije elektronskega plačila

Opomba: S 1. marcem 2023 je bilo polje »IsCash« odstranjeno iz objektnega modela. Še vedno ga je mogoče posredovati, vendar ne sproži več nobene funkcije. Vrste plačil se nadzorujejo prek polja »PaymentType«.

Ta članek je bil samodejno preveden.

objekt-plačil

Sorodni sklopi