Objet de paiement « payments » – RetailForce

Cet article concerne l’objet « Payment » (« paiements ») au sein de l’objet « Document ».

Une description complète du RetailForce DOM (Document Object Model), ainsi qu’une description des différents éléments, est disponible dans la section « Téléchargements » du site Web RetailForce (Documentation sur le modèle d’objet.pdf) dans le répertoire correspondant à la version concernée.

L’objet « paiement » peut bien sûr contenir plusieurs paiements différents (= différents moyens de paiement – PaymentType) pour un même bon.

Objet « payments »

L’objet « payment » suivant contient des données d’exemple.

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

L'objet « payments » ci-dessous contient des données d'exemple.

Informations dans la colonne « Type » :

M … obligatoire / requis
M* ... obligatoire / requis dans certains pays ou sous certaines conditions
R ... recommandé
O... facultatif

Éléments		Type	Description
quantité		M	Total de la position de paiement
CurrencyIsoCode		M	Code de devise ISO 4217
caption		M	Désignation du mode de paiement / moyen de paiement
UniqueReadablePaymentIdentifier		M	Identifiant unique (arbitraire) du type de paiement. Exemples : « cash », « paiement en espèces », « VISA », « cash-EUR », etc. Attention : il n’est pas possible d’utiliser deux abréviations de devises différentes pour un même UniqueReadablePaymentIdentifier au sein d’un même relevé quotidien (rapport Z) ! Si plusieurs devises sont utilisées, un UniqueReadablePaymentIdentifier doit être utilisé pour chaque devise. Par exemple : « CashEUR », « CashUSD », « CashDKK », « paiement en espèces EUR »,…
ForeignAmount		O	Total si le paiement est effectué en devise étrangère
ForeignAmountExchangeRate		O	Taux de change de la devise étrangère
AdditionalFields		M*
	VoucherId	M*	Types : MultiPurposeVoucher, SinglePurposeVoucher. Remarque : `VoucherId` doit être imbriqué sous l’ `AdditionalFields` objet.
	additionalProp1-x	M*
PaymentType		M	Mode de paiement / Moyen de paiement
~~IsCash~~		-	L'élément « IsCash » n'est plus pris en charge à compter du 1er mars 2023. Le type de paiement est défini par l'élément PaymentType. Attention : la propriété « IsCash » a été supprimée à compter de la version 1.7.6 de Fiscal Client.
CreateDate		O	Date de création du type de paiement (le cas échéant)
VatIdentification		M*	Identifiant de la classe de VAT (selon l’affectation RF), voir : GET /api/v1/information/client/{clientId}/getVatIdentification Attention : pour certains types de paiement, des informations relatives à la Vat doivent être fournies. Par exemple, pour les acomptes (dépôt), les bons d'achat, etc. Nous vous recommandons de toujours inclure les détails relatifs à la Vat.
VatPercent		M*	Pourcentage / taux de TVA
VatPercent2		O	Deuxième pourcentage / taux de TVA (pour les paiements à taux de TVA mixtes)
TaxValue		M*	Montant de la TVA
TaxValue2		O	Deuxième montant de Vat (pour les paiements à taux de Vat mixtes)
ExternalIdentifier		O
utilisateur		O/M*	Coordonnées de l’utilisateur de la caisse enregistreuse (peuvent être précisées si elles diffèrent de celles figurant dans l’en-tête du document ou dans les lignes d’écriture).
	ID	O/M*	Identifiant d'authentification de l'utilisateur de la caisse enregistreuse
	légende	O/M*	Nom de l'utilisateur de la caisse enregistreuse
	firstName	O	Prénom de l'utilisateur de la caisse enregistreuse
	lastName	O	Nom de famille de l'utilisateur de la caisse
	taxNumber	O/M*	Numéro d'identification fiscale de l'utilisateur de la caisse Informations relatives au pays : dans certaines juridictions (par exemple en Slovénie), le numéro d'identification fiscale du caissier doit être indiqué.
SalesPerson		O/M*	Informations relatives au SalesPerson (peuvent être indiquées si elles diffèrent de celles figurant dans l'header du document ou dans les lignes individuelles)
	ID	O/M*	Numéro d'identification du SalesPerson
	légende	O/M*	Fonction du SalesPerson
	prénom	O	Prénom du SalesPerson
	lastName	O	Nom de famille du SalesPerson
	taxNumber	O/M*	Numéro d'identification fiscale du SalesPerson Informations relatives au pays : dans certaines juridictions (par exemple, en Slovénie), le numéro d’identification fiscale du caissier doit être indiqué.
PaymentTerminalReferenceId		O/M*	ID de transaction renvoyé par le terminal de paiement (si le terminal de paiement est intégré au système de point de vente et que l’ID de transaction doit être imprimé sur le document). Informations spécifiques au pays : Danemark : le « PaymentTerminalReferenceId » doit être inclus dans la requête en cas de paiement par carte. Vous trouverez de plus amples informations au point 7 des exigences relatives aux caisses enregistreuses au Danemark .
cardData		O	Les reçus émis par des terminaux de paiement par carte (dépourvus de fonction d’impression native) peuvent être intégrés au reçu via cardData. Dans les pays où des « imprimantes fiscales » sont utilisées (le RetailForce System contrôle l’impression des documents), les informations contenues dans la zone cardData sont imprimées sous forme de lignes de texte libre à la suite du ticket de caisse fiscal. Il n’existe aucune séparation entre les deux parties. Informations par pays : Grèce : des champs supplémentaires sont requis pour le traitement des paiements électroniques en Grèce, notamment ProviderSignature, ProviderTransactionId et ProviderSignatureMessage, afin de se conformer à la réglementation locale.
	ReceiptCopyCount	O	Nombre de copies du ticket de caisse
	reçu	O	Tableau des lignes de texte du reçu
	CardNumberMasked	O	Numéro de carte masqué pour des raisons de sécurité (par exemple, ****1234)
	IdentificationToken	O	Jeton d'identification unique pour la transaction
	MerchantCopyCount	O	Nombre d'exemplaires du reçu du commerçant
	MerchantReceipt	O	Tableau des lignes de texte du reçu du commerçant
	CardType	O	Type de carte utilisé pour la transaction de paiement (par exemple, VISA, MASTERCARD, etc.)
	AuthorizationCode	O	Le code d'autorisation de la transaction
	terminalId	O	L'ID du terminal de paiement
	MerchantId	O	L'ID (fournis par l'acquéreur) du commerçant
	transactionId	O	ID unique de la transaction
	ProviderSignature	O/M*	Signature du prestataire de paiement pour le traitement du paiement en Grèce
	ProviderTransactionId	O/M*	L'identifiant de transaction (transactionId) du prestataire de paiement pour le traitement des paiements en Grèce
	ProviderSignatureMessage	O/M*	Message de signature du prestataire de paiement pour le traitement des paiements en Grèce
	TransactionDate	O	La date de la transaction de paiement
	TransactionNumber	O	Le numéro de transaction du paiement électronique

Remarque : depuis le 1er mars 2023, le champ « IsCash » a été supprimé du modèle d’objet. Il peut toujours être transmis, mais ne déclenche plus aucune fonction. Les types de paiement sont gérés via le champ « PaymentType ».

Cet article a été traduit automatiquement.

Objet « payments »

Articles associés