Oggetto di pagamento «payments» – RetailForce

Il presente articolo riguarda l’oggetto «Pagamento» («payments») all’interno dell’oggetto «Documento».

Una descrizione completa del RetailForce DOM (Document Object Model), nonché una descrizione dei singoli elementi, è disponibile nell’area download del sito web di RetailForce (Documentazione sul modello a oggetti.pdf) nella rispettiva directory delle versioni.

L’oggetto «pagamento» può naturalmente contenere più pagamenti (= diversi mezzi di pagamento – PaymentType) per un singolo buono.

Oggetto «payments»

L’oggetto pagamento seguente contiene dati di esempio.

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

Il seguente oggetto "pagamenti" contiene dati di esempio.

Informazioni nella colonna «Tipo»:

M ... obbligatorio / richiesto
M* ... obbligatorio / richiesto in determinati paesi o a determinate condizioni
R ... raccomandato
O... facoltativo

Elementi		Tipo	Descrizione
Quantità		M	Totale della posizione di pagamento
CurrencyIsoCode della valuta		M	Codice valuta ISO 4217
caption		M	Denominazione del metodo di pagamento / mezzo di pagamento
UniqueReadablePaymentIdentifier		M	(arbitrario) identificatore univoco del tipo di pagamento. Esempi: "contanti", "pagamento in contanti", "VISA", "contanti-EUR",... Attenzione: non è possibile utilizzare due diverse abbreviazioni di valuta per lo stesso UniqueReadablePaymentIdentifier all’interno di un unico estratto giornaliero (rapporto Z)! Se vengono utilizzate più valute, è necessario utilizzare un UniqueReadablePaymentIdentifier per ciascuna valuta. Ad esempio: "ContantiEUR", "ContantiUSD", "ContantiDKK", "Pagamento in contanti EUR",...
ForeignAmount		O	Totale se il pagamento è effettuato in valuta estera
ForeignAmountExchangeRate		O	Tasso di cambio della valuta estera
AdditionalFields		M*
	VoucherId	M*	Tipi: MultiPurposeVoucher, SinglePurposeVoucher. Attenzione: `VoucherId` deve essere annidato all'interno dell' `AdditionalFields` oggetto.
	additionalProp1-x	M*
PaymentType		M	Metodo di pagamento / Mezzo di pagamento
~~IsCash~~		-	L'elemento "IsCash" non è più supportato a partire dal 1° marzo 2023. Il tipo di pagamento è definito dall'elemento PaymentType. Si prega di notare che la proprietà "IsCash" è stata rimossa a partire dalla versione 1.7.6 di Fiscal Client.
CreateDate		O	Data di creazione del tipo di pagamento (se disponibile)
VatIdentification		M*	ID classe IVA (in base all’assegnazione RF), vedere: GET /api/v1/information/client/ {clientId}/getVatIdentification Attenzione: per determinati tipi di pagamento è necessario fornire informazioni relative al Vat. Ad esempio, per gli acconti (depositi), i buoni, ecc. Si raccomanda di includere sempre i dettagli relativi al Vat.
VatPercent		M*	Percentuale / aliquota IVA
VatPercent2		O	Seconda percentuale Vat / aliquota (per pagamenti con aliquote Vat miste)
TaxValue		M*	Importo dell’imposta
TaxValue2		O	Secondo importo del VAT (per pagamenti con aliquote VAT miste)
ExternalIdentifier		O
utente		O/M*	Dettagli relativi all’utente del registratore di cassa (specificabili qualora differiscano dai dati riportati nell’header del documento o nelle voci di dettaglio).
	ID	O/M*	ID dell’utente del registratore di cassa
	didascalia	O/M*	Denominazione dell’utente del registratore di cassa
	nomeUtente	O	Nome dell'utente del registratore di cassa
	lastName	O	Cognome dell'utente del registratore di cassa
	taxNumber	O/M*	Codice fiscale dell'utente del registratore di cassa Dettagli relativi al Paese: in alcune giurisdizioni (ad es. Slovenia), è obbligatorio specificare il codice fiscale dell’operatore di cassa.
SalesPerson		O/M*	Dati del SalesPerson (possono essere specificati qualora differiscano dai dati presenti nell’header del documento o nelle singole voci)
	ID	O/M*	ID del venditore
	didascalia	O/M*	Qualifica del SalesPerson
	nome	O	Nome del SalesPerson
	lastName	O	Cognome del SalesPerson
	taxNumber	O/M*	Codice fiscale del SalesPerson Dettagli relativi al Paese: in alcune giurisdizioni (ad es. Slovenia), è obbligatorio specificare il codice fiscale dell’operatore di cassa.
PaymentTerminalReferenceId		O/M*	ID transazione restituito dal terminal di pagamento (qualora il terminal di pagamento sia integrato con il sistema POS e l’ID transazione debba essere stampato sul documento). Dettagli per paese: Danimarca: il PaymentTerminalReferenceId deve essere incluso nella richiesta in caso di pagamenti con carta. Ulteriori informazioni sono disponibili al punto 7 dei requisiti relativi ai registratori di cassa in Danimarca .
cardData		O	Le ricevute provenienti dai terminali per carte di credito (privi di funzione di stampa propria) possono essere integrate in una ricevuta tramite cardData. Nei paesi in cui sono impiegate «stampanti fiscali» (= il RetailForce system controlla la stampa dei documenti), le informazioni contenute nell’area cardData vengono stampate come righe di testo libero a seguito dello scontrino fiscale. Non vi è alcuna separazione tra le due parti. Dettagli per paese: Grecia: per l’elaborazione dei pagamenti elettronici in Grecia sono richiesti campi aggiuntivi, tra cui ProviderSignature, ProviderTransactionId e ProviderSignatureMessage, al fine di garantire la conformità alle normative locali.
	ReceiptCopyCount	O	Numero di copie dello scontrino
	ricevuta	O	Array delle righe di testo della ricevuta
	CardNumberMasked	O	Numero di carta mascherato per motivi di sicurezza (ad es., ****1234)
	IdentificationToken	O	Token di identificazione univoco per la transazione
	MerchantCopyCount	O	Numero di copie della ricevuta del commerciante
	MerchantReceipt	O	Array delle righe di testo della ricevuta del commerciante
	CardType	O	Il tipo di carta utilizzato per la transazione di pagamento (ad es. VISA, MASTERCARD, ecc.)
	AuthorizationCode	O	Il codice di autorizzazione relativo alla transazione di pagamento
	terminalId	O	L'ID del terminal utilizzato per il pagamento
	MerchantId	O	L'ID (fornito dall'acquirente) dell'esercente
	transactionId	O	ID univoco della transazione
	firma del fornitore	O/M*	La firma crittografica del fornitore di servizi di pagamento per la procedura di pagamento in Grecia
	ProviderTransactionId	O/M*	L’identificativo della transazione (TransactionId) del provider di pagamento per il processo di pagamento in Grecia
	ProviderSignatureMessage	O/M*	Il messaggio di firma del fornitore di servizi di pagamento per la procedura di pagamento in Grecia
	TransactionDate	O	La data dell’operazione di pagamento
	TransactionNumber	O	Il numero della transazione di pagamento elettronico

Nota: a partire dal 1° marzo 2023, il campo «IsCash» è stato rimosso dal modello a oggetti. È ancora possibile trasmetterlo, ma non attiva più alcuna funzione. I tipi di pagamento vengono gestiti tramite il campo «PaymentType».

Questo articolo è stato tradotto automaticamente.

Oggetto «payments»

Articoli correlati