Obiekt płatności „payments” – RetailForce

Niniejszy artykuł dotyczy obiektu „Płatność” („payments”) w ramach obiektu „Dokument”.

Pełny opis RetailForce DOM, a także opis poszczególnych elementów, można znaleźć w sekcji plików do pobrania na stronie internetowej RetailForce (Object model documentation.pdf) w odpowiednim katalogu wersji.

Obiekt „płatność” może oczywiście zawierać kilka różnych płatności (= różne środki płatnicze – PaymentType) dla jednego dokumentu księgowego.

Obiekt „payments”

Poniższy obiekt płatności zawiera przykładowe dane.

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

Poniższy obiekt „płatności” zawiera przykładowe dane.

Informacje w kolumnie „Typ”:

M … obowiązkowe / wymagane
M* ... obowiązkowe / wymagane w niektórych krajach lub pod pewnymi warunkami
R ... zalecane
O... opcjonalne

Elementy		Typ	Opis
ilość		M	Suma pozycji płatności
CurrencyIsoCode		M	Kod waluty według normy ISO 4217
caption		M	Oznaczenie metody płatności / środka płatniczego
UniqueReadablePaymentIdentifier		M	(dowolny) unikalny identyfikator rodzaju płatności. Przykłady: „gotówka”, „płatność gotówkowa”, „VISA”, „gotówka-EUR”,... Uwaga: w ramach jednego raportu dziennego (raportu Z) nie można używać dwóch różnych skrótów walutowych dla tego samego unikalnego identyfikatora płatności (UniqueReadablePaymentIdentifier)! W przypadku korzystania z kilku walut należy zastosować odrębny unikalny identyfikator płatności (UniqueReadablePaymentIdentifier) dla każdej z nich. Np. „gotówkaEUR”, „gotówkaUSD”, „gotówkaDKK”, „płatność gotówkowa EUR”,...
ForeignAmount		O	Suma, jeśli płatność została dokonana w walucie obcej
ForeignAmountExchangeRate		O	Kurs wymiany waluty obcej
AdditionalFields		M*
	VoucherId	M*	Typy: MultiPurposeVoucher, SinglePurposeVoucher. Uwaga: `VoucherId` musi znajdować się w strukturze obiektu `AdditionalFields` obiektu.
	additionalProp1-x	M*
PaymentType		M	Sposób płatności / Środek płatniczy
~~IsCash~~		-	Od dnia 1 marca 2023 r. element „IsCash” nie jest już obsługiwany. Rodzaj płatności określa element PaymentType. Uwaga: Właściwość „IsCash” została usunięta w wersji programu Fiscal Client 1.7.6!
CreateDate		O	Data utworzenia typu płatności (jeśli jest dostępna)
VatIdentification		M*	ID klasy VAT (zgodnie z przypisaniem RF), patrz: GET /api/v1/information/client/ {clientId}/getVatIdentification Uwaga: W przypadku niektórych rodzajów płatności należy podać informacje dotyczące podatku Vat. Dotyczy to na przykład zaliczek (kaucji), bonów itp. Zalecamy, aby zawsze podawać dane dotyczące podatku Vat.
VatPercent		M*	Stawka Vat
VatPercent2		O	Druga stawka Vat (w przypadku płatności z zastosowaniem mieszanych stawek Vat)
TaxValue		M*	Kwota podatku Vat
TaxValue2		O	Druga kwota Vat (w przypadku płatności objętych mieszaną stawką Vat)
ExternalIdentifier		O
user		O/M*	Dane użytkownika kasy fiskalnej (można je podać, jeśli różnią się od danych zawartych w hederze dokumentu lub w pozycjach).
	ID	O/M*	ID użytkownika kasy
	caption	O/M*	Nazwa użytkownika kasy fiskalnej
	firstName	O	Imię użytkownika kasy
	lastName	O	Nazwisko użytkownika kasy
	taxNumber	O/M*	Numer podatkowy użytkownika kasy Dane dotyczące kraju: w niektórych krajach (np. w Słowenii) należy podać numer podatkowy kasjera.
SalesPerson		O/M*	Dane SalesPersona (można je podać, jeśli różnią się od danych zawartych w headerze dokumentu lub w poszczególnych pozycjach)
	ID	O/M*	ID sprzedawcy
	caption	O/M*	Stanowisko SalesPersona
	firstName	O	Imię SalesPersona
	lastName	O	Nazwisko SalesPersona
	taxNumber	O/M*	Numer podatkowy SalesPerson Dane dotyczące kraju: w niektórych krajach (np. w Słowenii) należy podać numer podatkowy kasjera.
PaymentTerminalReferenceId		O/M*	ID transakcji zwrócony przez terminal płatniczy (jeżeli terminal płatniczy jest zintegrowany z systemem POS, a ID transakcji ma zostać wydrukowany na dokumencie). Szczegóły dotyczące poszczególnych krajów: Dania: w przypadku płatności kartą w żądaniu należy podać identyfikator PaymentTerminalReferenceId. Więcej informacji można znaleźć w punkcie 7 wymagań dotyczących kas fiskalnych w Danii .
cardData		O	Paragony z terminali kart kredytowych (nieposiadających własnej funkcji drukowania) można włączyć do paragonu za pośrednictwem pola cardData. W krajach, w których stosuje się „drukarki fiskalne” (= RetailForce system kontroluje drukowanie dokumentów), informacje zawarte w obszarze cardData są drukowane jako wiersze tekstu swobodnego następujące po paragonie fiskalnym. Nie ma rozdzielenia między tymi dwiema częściami. Szczegóły dotyczące poszczególnych krajów: Grecja: W Grecji do przetwarzania płatności elektronicznych wymagane są dodatkowe pola, w tym ProviderSignature, ProviderTransactionId oraz ProviderSignatureMessage, w celu zapewnienia zgodności z lokalnymi przepisami.
	ReceiptCopyCount	O	Liczba kopii paragonu
	paragon	O	Tablica wierszy tekstu paragonu
	CardNumberMasked	O	Zamaskowany numer karty ze względów bezpieczeństwa (np. ****1234)
	IdentificationToken	O	Unikalny token identyfikacyjny transakcji
	MerchantCopyCount	O	Liczba kopii paragonu dla sprzedawcy
	MerchantReceipt	O	Tablica wierszy tekstowych paragonu sprzedawcy
	CardType	O	Typ karty, którą dokonano transakcji płatniczej (np. VISA, MASTERCARD itp.)
	AuthorizationCode	O	Kod autoryzacyjny dla danej płatności
	terminalId	O	ID terminala płatniczego
	MerchantId	O	ID (nadany przez podmiot obsługujący transakcję) akceptanta
	transactionId	O	Unikalny ID transakcji
	ProviderSignature	O/M*	Podpis dostawcy usług płatniczych dla procesu płatności w Grecji
	ProviderTransactionId	O/M*	TransactionId dostawcy usług płatniczych dla procesu płatności w Grecji
	ProviderSignatureMessage	O/M*	Komunikat z podpisem dostawcy usług płatniczych dotyczący procesu płatności w Grecji
	TransactionDate	O	Data transakcji płatniczej
	TransactionNumber	O	Numer transakcji płatności elektronicznej

Uwaga: Od 1 marca 2023 r. pole „IsCash” zostało usunięte z modelu obiektowego. Nadal można je przesyłać, ale nie uruchamia ono już żadnej funkcji. Rodzaje płatności są kontrolowane za pomocą pola „PaymentType”.

Ten artykuł został przetłumaczony automatycznie.

Obiekt „payments”

Powiązane artykuły