Mokėjimo objektas „payments“ – RetailForce

Šis straipsnis skirtas „Payment“ objektui („payments“) „Document“ objekte.

Išsamus „RetailForce“ DOM (dokumento objektų modelio) aprašymas, taip pat atskirų elementų aprašymas pateikiami RetailForce website atsisiuntimų skyriuje (Object model documentation.pdf) atitinkamame versijų kataloge.

Mokėjimo objektas, žinoma, gali apimti kelis skirtingus mokėjimus (= skirtingus mokėjimo būdus – „PaymentType“) vienam kvitui.

payments-object

Toliau pateiktame mokėjimo objekte yra pavyzdiniai duomenys.

"payments": [
    {
      "amount": 120.00,
      "currencyIsoCode": "EUR",
      "caption": "BAR",
      "uniqueReadablePaymentIdentifier": "BARZAHLUNG",
      "foreignAmount": 0,
      "foreignAmountExchangeRate": 0,
      "isTip": false,
      "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"
      }
    }
  ],

Toliau pateiktame mokėjimo objekte yra pavyzdiniai duomenys.

Informacija stulpelyje „Type“:

M ... privaloma / reikalaujama
M* ... privalomas / reikalaujamas tam tikrose šalyse arba tam tikromis sąlygomis
R ... rekomenduojama
O... neprivaloma

Elementai		Tipas	Aprašymas
kiekis		M	Mokėjimo pozicijos suma
CurrencyIsoCode		M	ISO 4217 valiutos kodas
caption		M	Mokėjimo būdo / mokėjimo priemonės pavadinimas
UniqueReadablePaymentIdentifier		M	(pasirinktinis) unikalus mokėjimo tipo identifikatorius. Pavyzdžiai: „grynieji“, „mokėjimas grynaisiais“, „VISA“, „grynieji-EUR“,... Dėmesio: vienoje dienos ataskaitoje (Z-ataskaitoje) negalima naudoti dviejų skirtingų valiutos santrumpų tam pačiam UniqueReadablePaymentIdentifier! Jei naudojamos kelios valiutos, kiekvienai valiutai turi būti naudojamas atskiras UniqueReadablePaymentIdentifier. Pvz., „CashEUR“, „CashUSD“, „CashDKK“, „Cash payment EUR“,...
ForeignAmount		O	Bendra suma, jei mokėjimas atliekamas užsienio valiuta
ForeignAmountExchangeRate		O	Užsienio valiutos keitimo kursas
isTip		M*	Naudojama atitinkamam mokėjimui pažymėti kaip arbatpinigius. Turi būti nustatytas, jei „fiscalCountryProperties“: „mustIndicateTipCompanyTipPayment“: true Daugiau informacijos rasite straipsnyje: Mokėjimų paskirstymas pagal konkrečius tikslus. Šalies duomenys: Kroatija: privaloma nurodyti, jei mokamas arbatpinigis
AdditionalFields		M*
	VoucherId	M*	Tipai: „MultiPurposeVoucher“, „SinglePurposeVoucher“. Dėmesio: `VoucherId` turi būti įterptas po `AdditionalFields` objekto.
	additionalProp1-x	M*
PaymentType		M	Mokėjimo būdas / Mokėjimo priemonė
~~IsCash~~		-	elementas „IsCash“ nuo 2023 m. kovo 1 d. nebėra palaikomas. Mokėjimo tipas apibrėžiamas elementu PaymentType. Dėmesio: savybė „IsCash“ buvo pašalinta nuo „Fiscal Client“ versijos 1.7.6!
CreateDate		O	Mokėjimo tipo sukūrimo data (jei yra)
VatIdentification		M*	PVM klasės ID (pagal RF priskyrimą), žr.: GET /api/v1/information/client/ {clientId}/getVatIdentification Dėmesio: Tam tikrų mokėjimo tipų atveju būtina pateikti informaciją apie Vat. Pavyzdžiui, avansų (užstato), kuponų atveju... Rekomenduojame visada nurodyti Vat duomenis.
VatPercent		M*	Vat procentas / tarifas
VatPercent2		O	Antrasis Vat procentas / tarifas (mokėjimams, kuriems taikomi skirtingi Vat tarifai)
TaxValue		M*	Vat suma
TaxValue2		O	Antroji Vat suma (mokėjimams, kuriems taikomas mišrus Vat tarifas)
ExternalIdentifier		O
user		O/M*	Kaso aparato naudotojo duomenys (galima nurodyti, jei jie skiriasi nuo duomenų dokumento header’e ar eilutėse).
	ID	O/M*	Kaso aparato vartotojo ID kodas
	caption	O/M*	Kaso aparato vartotojo pavadinimas
	firstName	O	Kaso aparato naudotojo vardas
	lastName	O	Kaso operatoriaus pavardė
	taxNumber	O/M*	Kaso aparato naudotojo mokesčių mokėtojo numeris Šalies duomenys: tam tikrose šalyse (pvz., Slovėnijoje) būtina nurodyti kasininko mokesčių mokėtojo numerį.
SalesPerson		O/M*	SalesPerson duomenys (galima nurodyti, jei jie skiriasi nuo duomenų dokumento header arba atskiruose pozicijose)
	ID	O/M*	SalesPerson ID numeris
	caption	O/M*	SalesPerson pareigos
	firstName	O	SalesPerson vardas
	lastName	O	SalesPerson pavardė
	taxNumber	O/M*	SalesPerson mokesčių mokėtojo numeris Šalies duomenys: tam tikrose šalyse (pvz., Slovėnijoje) būtina nurodyti kasininko mokesčių mokėtojo numerį.
PaymentTerminalReferenceId		O/M*	Mokėjimo terminalo grąžintas sandorio ID (jei mokėjimo terminalas integruotas su POS sistema ir sandorio ID turi būti atspausdintas dokumente). Šalies duomenys: Danija: atliekant mokėjimus kortele, prašyme privaloma nurodyti „PaymentTerminalReferenceId“. Daugiau informacijos galima rasti Danijos kasos aparatų reikalavimų 7 punkte.
cardData		O	Kredito kortelių terminalų (neturinčių savos spausdinimo funkcijos) kvitai gali būti integruojami į kvitą per „cardData“. Šalyse, kuriose naudojami „fiskaliniai spausdintuvai“ (= RetailForce system kontroliuoja dokumentų spausdinimą), „cardData“ srityje pateikta informacija spausdinama kaip laisvos formos teksto eilutės po fiskalinio kvito. Šios dvi dalys nėra atskirtos. Informacija apie šalis: Graikija: Elektroninių mokėjimų apdorojimui Graikijoje reikalingi papildomi laukai, įskaitant „ProviderSignature“, „ProviderTransactionId“ ir „ProviderSignatureMessage“, siekiant laikytis vietinių teisės aktų reikalavimų.
	ReceiptCopyCount	O	Kvitų kopijų skaičius
	kvitas	O	Kvitų teksto eilučių masyvas
	CardNumberMasked	O	Užmaskuotas kortelės numeris saugumo sumetimais (pvz., ****1234)
	IdentificationToken	O	Unikalus sandorio identifikavimo žetonas
	MerchantCopyCount	O	Prekybininko kvito kopijų skaičius
	MerchantReceipt	O	Prekybininko kvito teksto eilučių masyvas
	CardType	O	Mokėjimo operacijos kortelės tipas (pvz., VISA, MASTERCARD ir pan.)
	AuthorizationCode	O	Mokėjimo autorizacijos kodas
	terminalId	O	ID of the terminal for payment
	MerchantId	O	Prekybininko ID (iš įsigyjančiosios įstaigos)
	transactionId	O	Unikalus sandorio ID
	ProviderSignature	O/M*	Mokėjimo paslaugų teikėjo parašas, skirtas mokėjimo procesui Graikijoje
	ProviderTransactionId	O/M*	Mokėjimo teikėjo transactionId, skirtas mokėjimo procesui Graikijoje
	ProviderSignatureMessage	O/M*	Mokėjimo teikėjo parašo pranešimas, skirtas mokėjimo procesui Graikijoje
	TransactionDate	O	Mokėjimo operacijos data
	TransactionNumber	O	Elektroninio mokėjimo operacijos numeris

Pastaba: Nuo 2023 m. kovo 1 d. laukas „IsCash“ buvo pašalintas iš objekto modelio. Jį vis dar galima perduoti, tačiau jis nebeaktyvina jokios funkcijos. Mokėjimo tipai nustatomi per lauką „PaymentType“.

Šis straipsnis buvo išverstas automatiškai.

payments-object

Susiję straipsniai