Obiect de plată „payments” – RetailForce

Acest articol se referă la obiectul „Plată” („plăți”) din cadrul obiectului „Document”.

O descriere completă a RetailForce DOM (Document Object Model), precum și o descriere a elementelor individuale, pot fi găsite în secțiunea de descărcări a RetailForce website (Documentația modelului de obiecte.pdf) în directorul versiunii respective.

Desigur, obiectul „Plată” poate conține mai multe plăți diferite (= mijloace de plată diferite – PaymentType) pentru un singur bon.

obiectul-plăți

Următorul obiect de plată conține date de exemplu.

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

Următorul obiect de plată conține date de exemplu.

Informații din coloana „Tip”:

M ... obligatoriu / necesar
M* ... obligatoriu / necesar în anumite țări sau în anumite condiții
R ... recomandat
O... opțional

Elemente		Tip	Descriere
cantitate		M	Totalul poziției de plată
CurrencyIsoCode		M	Codul monedei conform ISO 4217
caption		M	Denumirea metodei de plată / mijlocului de plată
UniqueReadablePaymentIdentifier		M	identificator unic (arbitrar) al tipului de plată. Exemple: „numerar”, „plată în numerar”, „VISA”, „numerar-EUR”,... Atenție: nu este posibilă utilizarea a două abrevieri valutare diferite pentru același UniqueReadablePaymentIdentifier în cadrul unui singur extras zilnic (raport Z)! Dacă se utilizează mai multe valute, trebuie folosit un UniqueReadablePaymentIdentifier pentru fiecare monedă. De exemplu: „CashEUR”, „CashUSD”, „CashDKK”, „plată în numerar EUR”,...
ForeignAmount		O	Total dacă plata se efectuează într-o monedă străină
ForeignAmountExchangeRate		O	Cursul de schimb al monedei străine
AdditionalFields		M*
	VoucherId	M*	Tipuri: MultiPurposeVoucher, SinglePurposeVoucher. Atenție: `VoucherId` trebuie să fie imbricat sub obiectul `AdditionalFields` obiect.
	proprietate suplimentară1-x	M*
PaymentType		M	Metoda de plată / Mijloacele de plată
~~IsCash~~		-	elementul „IsCash” nu mai este acceptat începând cu 1 martie 2023. Tipul de plată este definit de elementul PaymentType. Atenție: Proprietatea „IsCash” a fost eliminată începând cu versiunea 1.7.6 a aplicației Fiscal Client!
CreateDate		O	Data la care a fost creat tipul de plată (dacă este disponibil)
VatIdentification		M*	ID-ul clasei de TVA (conform atribuirii RF), a se vedea: GET /api/v1/information/client/ {clientId}/getVatIdentification Atenție: Pentru anumite tipuri de plăți, trebuie furnizate informații privind Vat-ul. De exemplu, pentru avansuri (depozit), bonuri de reducere... Vă recomandăm să includeți întotdeauna detaliile privind Vat-ul.
VatPercent		M*	Procentul/rata Vat-ului
VatPercent2		O	Al doilea procentaj/rată Vat (pentru plățile cu rate mixte de Vat)
TaxValue		M*	Suma Vat
TaxValue2		O	A doua sumă a Vat-ului (pentru plățile cu cote mixte de Vat)
ExternalIdentifier		O
user		O/M*	Detalii privind utilizatorul casei de marcat (pot fi specificate dacă acestea diferă de detaliile din header-ul documentului sau din liniile de detaliu).
	ID	O/M*	ID al utilizatorului casei de marcat
	caption	O/M*	Denumirea utilizatorului casei de marcat
	firstName	O	Prenumele utilizatorului casei de marcat
	lastName	O	Prenumele utilizatorului casei de marcat
	taxNumber	O/M*	Codul fiscal al utilizatorului casei de marcat Detalii privind țara: în anumite țări (de exemplu, Slovenia), trebuie indicat numărul fiscal al casierului.
SalesPerson		O/M*	Detalii despre SalesPerson (pot fi indicate dacă acestea diferă de detaliile din header-ul documentului sau din articolele individuale)
	ID	O/M*	Numărul de ID al agentului de vânzări
	caption	O/M*	Funcția SalesPerson
	firstName	O	Prenumele SalesPerson-ului
	lastName	O	Prenumele SalesPerson-ului
	taxNumber	O/M*	Codul fiscal al SalesPerson-ului Detalii privind țara: în anumite țări (de exemplu, Slovenia), trebuie indicat numărul fiscal al casierului.
PaymentTerminalReferenceId		O/M*	ID-ul tranzacției returnat de terminalul de plată (dacă terminalul de plată este integrat cu sistemul POS și ID-ul tranzacției trebuie tipărit pe document). Detalii privind țara: Danemarca: PaymentTerminalReferenceId trebuie inclus în cerere în cazul plăților cu cardul. Informații suplimentare pot fi găsite la punctul 7 din cerințele privind casele de marcat din Danemarca .
cardData		O	Chitanțele de la terminalele de carduri de credit (fără funcție proprie de imprimare) pot fi integrate într-o chitanță prin intermediul cardData. În țările în care se utilizează „imprimante fiscale” (= RetailForce system controlează imprimarea documentelor), informațiile incluse în zona cardData sunt imprimate sub formă de linii de text liber după chitanța fiscală. Nu există nicio separare între cele două părți. Detalii privind țările: Grecia: Pentru procesarea plăților electronice în Grecia sunt necesare câmpuri suplimentare, inclusiv ProviderSignature, ProviderTransactionId și ProviderSignatureMessage, în vederea respectării reglementărilor locale.
	ReceiptCopyCount	O	Numărul de copii ale bonului fiscal
	chitanță	O	Matricea liniilor de text ale chitanței
	CardNumberMasked	O	Număr de card mascat din motive de securitate (de ex., ****1234)
	IdentificationToken	O	Token de identificare unic pentru tranzacție
	MerchantCopyCount	O	Numărul de copii ale chitanței comerciantului
	MerchantReceipt	O	Matricea liniilor de text ale chitanței comerciantului
	CardType	O	Tipul cardului utilizat în tranzacția de plată (de exemplu, VISA, MASTERCARD etc.)
	AuthorizationCode	O	Codul de autorizare pentru plată
	terminalId	O	ID-ul terminalului de plată
	MerchantId	O	ID-ul (de la achizitor) al comerciantului
	transactionId	O	ID unic pentru tranzacție
	ProviderSignature	O/M*	Semnătura furnizorului de servicii de plată pentru procesul de plată în Grecia
	ProviderTransactionId	O/M*	TransactionId-ul furnizorului de servicii de plată pentru procesul de plată în Grecia
	ProviderSignatureMessage	O/M*	Mesajul de semnătură al furnizorului de servicii de plată pentru procesul de plată în Grecia
	TransactionDate	O	Data tranzacției de plată
	TransactionNumber	O	Numărul tranzacției de plată electronică

Notă: Începând cu 1 martie 2023, câmpul „IsCash” a fost eliminat din modelul de obiect. Acesta poate fi încă transmis, dar nu mai declanșează nicio funcție. Tipurile de plată sunt controlate prin câmpul „PaymentType”.

Acest articol a fost tradus automat.

obiectul-plăți

Articole conexe