Objeto de pago «payments» – RetailForce

Este artículo trata sobre el objeto «Pago» («payments») dentro del objeto «Documento».

En la sección de descargas del sitio web de RetailForce (Documentación del modelo de objetos.pdf), dentro del directorio de la versión correspondiente, se puede encontrar una descripción completa del RetailForce DOM, así como una descripción de los elementos individuales.

Por supuesto, el objeto «pago» puede contener varios pagos diferentes (= diferentes medios de pago —PaymentType—) para un mismo comprobante.

objeto-pagos

El siguiente objeto de pago contiene datos de ejemplo.

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

El siguiente objeto de pago contiene datos de ejemplo.

Información de la columna «Tipo»:

M ... obligatorio / requerido
M* ... obligatorio / requerido en determinados países o bajo determinadas condiciones
R ... recomendado
O... opcional

Elementos		Tipo	Descripción
cantidad		M	Total de la posición de pago
CurrencyIsoCode de la moneda		M	Código de moneda ISO 4217
legenda		M	Denominación del método de pago / medio de pago
UniqueReadablePaymentIdentifier		M	Identificador único (arbitrario) del tipo de pago. Ejemplos: «efectivo», «pago en efectivo», «VISA», «efectivo-EUR»,... Importante: no es posible utilizar dos códigos de divisa diferentes para un mismo UniqueReadablePaymentIdentifier dentro de un mismo extracto diario (informe Z). En caso de emplearse múltiples divisas, deberá definirse un UniqueReadablePaymentIdentifier específico para cada una de ellas. Por ejemplo: «EfectivoEUR», «EfectivoUSD», «EfectivoDKK», «Pago en efectivo EUR»,...
ForeignAmount		O	Total si el pago se realiza en una moneda extranjera
ForeignAmountExchangeRate		O	Tipo de cambio de la moneda extranjera
AdditionalFields		M*
	VoucherId	M*	Tipos: MultiPurposeVoucher, SinglePurposeVoucher. Nota: `VoucherId` debe anidarse bajo el `AdditionalFields` objeto.
	additionalProp1-x	M*
PaymentType		M	Método de pago / Medio de pago
~~IsCash~~		-	El elemento «IsCash» dejará de ser compatible a partir del 1 de marzo de 2023. El tipo de pago se define mediante el elemento PaymentType. Atención: la propiedad «IsCash» se ha eliminado a partir de la versión 1.7.6 de Fiscal Client.
CreateDate		O	Fecha en la que se creó el tipo de pago (si está disponible)
VatIdentification		M*	ID de clase de VAT (según la asignación de RF); véase: GET /api/v1/information/client/{clientId}/getVatIdentification Atención: Para determinados tipos de pago, es necesario facilitar información sobre el Vat. Por ejemplo, en el caso de anticipos (depósitos), vales, etc. Le recomendamos que incluya siempre los datos relativos al Vat.
VatPercent		M*	Porcentaje o tipo de Vat
VatPercent2		O	Segundo porcentaje o tipo del Vat (para pagos con tipos de Vat mixtos)
TaxValue		M*	Importe del Vat
TaxValue2		O	Segundo importe del Vat (para pagos con tipos de Vat mixtos)
ExternalIdentifier		O
usuario		O/M*	Datos del usuario del sistema de punto de venta (se pueden especificar si difieren de los datos que figuran en la cabecera del documento o en las partidas individuales).
	ID	O/M*	ID del usuario del punto de venta
	caption	O/M*	Nombre del usuario del punto de venta
	nombreDePila	O	Nombre del usuario del sistema de punto de venta
	lastName	O	Apellidos del usuario del sistema de punto de venta
	taxNumber	O/M*	Número de identificación fiscal del usuario de la caja registradora Datos del país: en determinadas jurisdicciones (por ejemplo, Eslovenia), debe indicarse el número de identificación fiscal del cajero.
SalesPerson		O/M*	Datos del SalesPerson (pueden indicarse si difieren de los que figuran en el header del documento o en las partidas individuales)
	ID	O/M*	ID del vendedor
	legenda	O/M*	Cargo del SalesPerson
	nombre	O	Nombre del SalesPerson
	lastName	O	Apellidos del SalesPerson
	taxNumber	O/M*	Número de identificación fiscal del SalesPerson Datos del país: en determinadas jurisdicciones (por ejemplo, Eslovenia), debe indicarse el número de identificación fiscal del cajero.
PaymentTerminalReferenceId		O/M*	ID de la transacción devuelta por el terminal de pago (si el terminal de pago está integrado con el sistema TPV y el ID de la transacción debe imprimirse en el documento). Detalles por país: Dinamarca: el «PaymentTerminalReferenceId» debe incluirse en la solicitud en el caso de los pagos con tarjeta. Puede encontrar más información en el punto 7 de los requisitos para las cajas registradoras en Dinamarca .
cardData		O	Los comprobantes generados por terminales de tarjetas de crédito (sin función de impresión propia) pueden integrarse en un recibo mediante cardData. En los países en los que se utilizan «impresoras fiscales» (= el RetailForce system controla la impresión de documentos), la información incluida en el área cardData se imprime como líneas de texto libre a continuación del recibo fiscal. No existe separación entre ambas partes. Detalles por país: Grecia: Se requieren campos adicionales para el procesamiento de pagos electrónicos en Grecia, entre ellos ProviderSignature, ProviderTransactionId y ProviderSignatureMessage, a fin de cumplir con la normativa local.
	ReceiptCopyCount	O	Número de copias del recibo
	recibo	O	Matriz de líneas de texto del recibo
	CardNumberMasked	O	Número de tarjeta enmascarado por motivos de seguridad (p. ej., ****1234)
	IdentificationToken	O	Token de identificación único para la transacción
	MerchantCopyCount	O	Número de copias del recibo del comerciante
	MerchantReceipt	O	Matriz de líneas de texto del recibo del comerciante
	CardType	O	El tipo de tarjeta de la transacción de pago (p. ej., VISA, MASTERCARD, etc.)
	AuthorizationCode	O	El código de autorización de la transacción
	terminalId	O	El ID del terminal de pago
	MerchantId	O	El ID (proporcionado por el adquirente) del comerciante
	transactionId	O	ID único de la transacción
	firma del proveedor	O/M*	La firma del proveedor de pagos para el proceso de pago en Grecia
	ProviderTransactionId	O/M*	El «transactionId» del proveedor de pagos para el proceso de pago en Grecia
	ProviderSignatureMessage	O/M*	El mensaje de firma del proveedor de pagos para el proceso de pago en Grecia
	TransactionDate	O	La fecha de la operación de pago
	TransactionNumber	O	El identificador único de la transacción de pago electrónico.

Nota: A partir del 1 de marzo de 2023, el campo «IsCash» se ha eliminado del modelo de objetos. Aunque todavía se puede transmitir, ya no activa ninguna función. Los tipos de pago se controlan a través del campo «PaymentType».

Este artículo ha sido traducido automáticamente.

objeto-pagos

Artículos relacionados