Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

TablaCampoDescripciónTipo de Dato

Rango o valores que permite el campo

cardHistory_idIdentificador del registro.string
amount

Monto actual asociado a esta operación. 

doublestring
amountPrevSaldo del elemento de fidelidad previo a la operación.double
appliedPromotionDetailsDetalle de promociones involucradas en el incremento/decremento del monto por aplicación de un beneficio.array 
applyErrorError en la transacción.booleantrue/false
card

Identificador del registro del elemento de fidelidad.

string


cardActionAcción asociada al movimiento del elemento de fidelidad.string

CREATE, CHARGE, ACTIVATION, SALE, UPDATE, CANCEL,

INACTIVACION, CONSUME,

ASSIGN_CUSTOMER,

REMOVE_CUSTOMER, QUERY, RECHARGE,

AMOUNT_UPDATE, PARTIAL_REDEMPTION,

TOTAL_REDEMPTION, TRANSFER,

ROLLBACK, EXPIRED, EXTENDED_POINTS,

ASSIGN_CONTRACT,CVVCHANGE,CVVRESET

companyIdCompañía desde la que se envía el movimiento de elemento de fidelidad.string
confirmationDateReservado.

confirmationStateReservado.

createdAt
Fecha de creación del elemento de fidelidad.
ISOdate Ej."2023-04-10T163200.787-0300"
customerCodecódigo del cliente asociado al elemento de fidelidadstring
dateFecha del movimiento que se informa del elemento de fidelidad.ISOdate Ej."2023-04-10T163200.787-0300"
detailedActionReservado.

extendedPointsReservado.

extraMessageArgsIndica los argumentos de error cuando el campo applyError es true.array de string
extraMessageCodeIndica el código de error informado cuando el campo applyError es true.string
operationFromConsoleIndica si la operación se realizó por medio de la consola y no por medio de la api.booleantrue, false
pointsExpirationDateFecha expiración de los puntos del elemento de fidelidad (si es que corresponde).date
reasonCódigo de justificación informado para esta transacción.string
remainingAmountReservado.

storeCodeCódigo de la tienda.string
terminalCodeCódigo de la terminal .string
transactionIdidentificador único de la transacción en la que participó el elemento de fidelidad.string
versionReservado.

...

TablaCampoDescripciónTipo de datoRango o valores que permite el campo

viewTicketHeader

_idIdentificador del registro en la tabla viewTicketHeader string
canceledCouponsAmountMonto Total de los cupones canceladosdouble
canceledCouponsQuantityCantidad de cupones canceladosinteger
canceledPointsQuantityCantidad de puntos canceladosinteger
channelCodeCódigo de canal string
companyIdCódigo de compañíastring
customerCodeCódigo de Clientestring
emittedCouponsQuantityCantidad de cupones emitidosinteger
emittedPointsQuantityCantidad de puntos emitidosinteger
emittedCouponsAmountMonto total de cupones emitidosdouble
iTransactionDateFecha de la transacción integerrepresentación entera de la fecha ( Ej.:20231006)
redeemedCouponsAmountMonto total de cupones redimidosdouble
redeemedCouponsQuantityCantidad de cupones redimidosinteger
redeemedPointsAmountMonto total de puntos redimidosdouble
redeemedPointsQuantityCantidad total de puntos redimidosinteger
storeCodeCódigo de tiendastring
subtotalSubtotal de la transacción double
terminalCodeCódigo de la terminal string
totalBenefitsQuantityCantidad total de beneficiosinteger
totalDiscountsTotal de descuentosinteger
totalItemsMagnitudeMagnitud total de productosdouble
totalItemsSoldCantidad total de ítems vendidosinteger
totalTransactionTotal de la transaccióndouble
transactionDateFecha de la transacciónISOdate Ej."2023-04-10T163200.787-0300"
transactionIdIdentificador del registro de la transacciónstring
transactionTypeTipo de la transacción stringVENTA, DEVOLUCION

...


viewTicketBenefitTotal:

Tabla que se alimenta de los datos correspondientes a los beneficios otorgados por las transaccionespromociones , almacenados en la tabla TransactionFlatten, luego de ejecutar un proceso de aplanado de transacciones. Se la usa para mostrar los datos del detalle de transacciones en el reporte Transacciones por TiendasDetalle de Promociones.

TablaCampoDescripciónTipo de datoRango o valores que permite el campo
viewTicketItem

viewTicketBenefitTotal

_











id

Identificador
identificador único del registro
de la tabla viewTicketItem 
string
code

storeCodeCódigo
del producto
de la tiendastring
companyId

transactionDate
Código
Fecha de la
compañía
transacción
stringdescriptionDescripción del productostringdiscountDescuentosdouble
date00:00:00
iTransactionDateFecha de la
transacción integerrepresentación entera de la fecha ( Ej.:20231006)magnitudeSi el artículo es mensurable por otra unidad que no sea la cantidad, deberá ser expresada en esta propiedad.doublequantityCantidad de artículos en la línea.integersequenceNúmero identificador único del elemento dentro de la transacción.integertotalTotal del producto doubletotalBenefitsQuantityCantidad Total de beneficiosintegertransactionDateFecha de la transacción ISOdate Ej
transacción, en formato enterodate00:00:00
benefitTypeCódigo del tipo de beneficiostring
isMonetaryIndica si el beneficio es monetario, aplica para beneficios de tipo →  PercentageDiscount, FixedDiscount, CalculatedCouponApplicationBenefit, NewPrice, RedeemPointsBenefit, CatalogRedeemBenefit. boolean
promotionNameNombre de la promoción.string
promotionCode Código de la promociónstring
campaignCódigo de la campañastring
appliedDiscountMonto del descuento aplicado por el beneficiodouble
emittedCouponsQtyCantidad de cupones emitidosinteger
emittedCouponsAmountMonto de puntos emitidosdouble
redeemedCouponsQtyCantidad de cupones redimidosinteger
redeemedCouponsAmountMonto de cupones redimidosdouble
emittedPointsQtyCantidad de puntos emitidosinteger
emittedPointsAmountMonto de puntos emitidosdouble
redeemedPointsQtyCantidad de puntos redimidosinteger
redeemedPointsAmountMonto de puntos redimidosdouble
appliedBenefitQty Cantidad de beneficios aplicadosinteger
emittedCouponId:Identificador único  del cupón emitidostring
emittedCouponTypeCódigo del tipo de cupón emitidostring
loyaltyCardIdIdentificador único del elemento de fidelidad.string
loyaltyCardTypeCódigo del tipo de elemento de fidelidadstring

viewExpiredCoupons

Tabla que se alimenta de la tarea programada "Proceso de activación e inactivación de cupones". Se la usa para mostrar los datos del reporte Dasboard de Cupones Vencidos y Detalle de Cupones Vencidos.

TablaCampoDescripciónTipo de datoRango o valores que permite el campo

viewExpiredCoupons

ididentificador único del registro, compuesto por "companyId-couponTypeCode-iDate"string
couponTypeCodeCódigo del tipo de cupónstring
couponTypeNameNombre del tipo de cupónstring
couponTypeFormatCódigo del formato del tipo de cupónstring
dateFecha fin de vigencia (validTo) del tipo de cupónISOdate Ej."2023-04-10T163200.787-0300"
iDateFecha fin de vigencia (validTo) del tipo de cupón en formato entero añoMesDiainteger Ej:20230410
monthIndica el mes  fin de vigencia (validTo) del tipo de cupón.integer
yearFin de vigencia (validTo) del tipo de cupón.integer
couponsQuantityCantidad de cupones vencidosinteger

viewExpiredPoints

Tabla que se alimenta de la tarea programada "Proceso de vencimiento de puntos". Se la usa para mostrar los datos del reporte Dashboard de Cupones Vencidos y Detalle de Cupones Vencidos.

TablaCampoDescripciónTipo de datoRango o valores que permite el campo

viewExpiredPoints

ididentificador único del registrostring
dateFecha de expiración de los puntosdateEj:" 4/11/2023 0:00:00"
iDateFecha de expiración de los puntos, en formato entero(añoMesDia)integerEj: 20231104
cardTypeCodeCódigo del tipo de elemento de fidelidadstring
cardTypeNameNombre del tipo de elemento de fidelidadstring
cardTypeIdIdentificador del tipo de elemento de fidelidadstring
qtyCantidad de puntos vencidos, esta cantidad se encuentra acumulada por díainteger
monthMes asociado a la expiración de los puntosinteger
yearAño asociado a la expiración de los puntosinteger

viewTicketItem

Tabla que se alimenta de los datos correspondientes a las transacciones, almacenados en la tabla TransactionFlatten, luego de ejecutar un proceso de aplanado de transacciones. Se la usa para mostrar los datos del detalle de transacciones en el reporte Transacciones por Tiendas.

TablaCampoDescripciónTipo de datoRango o valores que permite el campo

viewTicketItem

_idIdentificador del registro de la tabla viewTicketItem string
codeCódigo del productostring
companyIdCódigo de la compañíastring
descriptionDescripción del productostring
discountDescuentosdouble
iTransactionDateFecha de la transacción integerrepresentación entera de la fecha ( Ej.:20231006)
magnitudeSi el artículo es mensurable por otra unidad que no sea la cantidad, deberá ser expresada en esta propiedad.double
quantityCantidad de artículos en la línea.integer
sequenceNúmero identificador único del elemento dentro de la transacción.integer
totalTotal del producto double
totalBenefitsQuantityCantidad Total de beneficiosinteger
transactionDateFecha de la transacción ISOdate Ej."2023-04-10T163200.787-0300"transactionIdIdentificador de la transacciónstringunitPricePrecio Unitariodouble

viewTicketBenefit

Tabla que se alimenta de los datos correspondientes a las transacciones, almacenados en la tabla TransactionFlatten, luego de ejecutar un proceso de aplanado de transacciones. Se la usa para detallarlos datos en el reporte Detalle de Promociones.

TablaCampoDescripciónTipo de datoRango o valores que permite el campo

viewTicketBenefit

_idIdentificador del registro de la tabla viewTicketBenefit stringappliedBenefitQtyCantidad de beneficios aplicadosintegerappliedDiscountDescuentos aplicados (monto)doublebenefitTypeTipo de beneficiostringcampaignNombre de la campañastringcompanyIdCódigo de la compañíastringemittedCouponsAmountMonto total de los cupones emitidosdoubleemittedCouponsQtyCantidad de cupones emitidosintegeremittedCouponsTypeTipo de cupones emitidosstringemittedPointsAmountMonto de puntos emitidosdoubleemittedPointsQtyCantidad de puntos emitidosintegerisMonetaryIndica si el beneficio es monetario o nobooleanitemCodeCódigo de productostringitemDescriptionDescripción del productostringitemQtyCantidad de productointeger
iTransactionDateFecha de la transacción integerrepresentación entera de la fecha ( Ej.:20231006)
loyaltyCardIdIdentificador del elemento de fidelidadstringloyaltyCardTypeTipo del elemento de fidelidadstringpromotionCodeCódigo de la promociónstringpromotionNameNombre de la promociónstringredeemedCouponsAmountMonto redimido de cuponesdoubleredeemedCouponsQtyCantidad de cupones redimidosintegerredeemedPointsAmountMonto de puntos redimidosdoubleredeemedPointsQtyCantidad de puntos redimidosintegersequenceNúmero identificador único del elemento dentro de la transacción.integerstoreCodeCódigo de TiendastringtransactionDateFecha de la transacción
transactionIdIdentificador de la transacciónstring
unitPricePrecio Unitariodouble


viewTicketBenefit

Tabla que se alimenta de los datos correspondientes a las transacciones, almacenados en la tabla TransactionFlatten, luego de ejecutar un proceso de aplanado de transacciones. Se la usa para detallarlos datos en el reporte Detalle de Promociones.

TablaCampoDescripciónTipo de datoRango o valores que permite el campo

viewTicketBenefit

_idIdentificador del registro de la tabla viewTicketBenefit string
appliedBenefitQtyCantidad de beneficios aplicadosinteger
appliedDiscountDescuentos aplicados (monto)double
benefitTypeTipo de beneficiostring
campaignNombre de la campañastring
companyIdCódigo de la compañíastring
emittedCouponsAmountMonto total de los cupones emitidosdouble
emittedCouponsQtyCantidad de cupones emitidosinteger
emittedCouponsTypeTipo de cupones emitidosstring
emittedPointsAmountMonto de puntos emitidosdouble
emittedPointsQtyCantidad de puntos emitidosinteger
isMonetaryIndica si el beneficio es monetario o noboolean
itemCodeCódigo de productostring
itemDescriptionDescripción del productostring
itemQtyCantidad de productointeger
iTransactionDateFecha de la transacción integerrepresentación entera de la fecha ( Ej.:20231006)
loyaltyCardIdIdentificador del elemento de fidelidadstring
loyaltyCardTypeTipo del elemento de fidelidadstring
promotionCodeCódigo de la promociónstring
promotionNameNombre de la promociónstring
redeemedCouponsAmountMonto redimido de cuponesdouble
redeemedCouponsQtyCantidad de cupones redimidosinteger
redeemedPointsAmountMonto de puntos redimidosdouble
redeemedPointsQtyCantidad de puntos redimidosinteger


sequenceNúmero identificador único del elemento dentro de la transacción.integer


storeCodeCódigo de Tiendastring


transactionDateFecha de la transacciónISOdate Ej."2023-04-10T163200.787-0300"


transactionIdIdentificador del registro de la tabla TransactionFlatten


viewTotalTransaction

Tabla que se alimenta de los datos correspondientes a las transacciones, almacenados en la tabla TransactionFlatten, luego de ejecutar un proceso de aplanado de transacciones. Se la usa para detallarlos datos en el reporte Total Mensual de Transacciones

TablaCampoDescripciónTipo de datoRango o valores que permite el campo

viewTotalTransaction

_idIdentificador del registro de la tabla viewTotalTransactionstring

companyIdCódigo de la compañía string

storeCodeCódigo de la tiendastring

transactionMonthMes de la transaccióninteger 

transactionYearAño de la transaccióninteger

totalTransactionMonto total de la transacción double

transactioDateFecha de la transacción ISOdate Ej."2023-04-10T163200.787-0300"transactionIdIdentificador del registro de la tabla TransactionFlatten

...


iTransactionDateFecha de la transacción integerrepresentación entera de la fecha ( Ej.:20231006)

.

viewTotalPromotion

Tabla que se alimenta de los datos correspondientes a las transacciones, almacenados en la tabla TransactionFlatten, luego de ejecutar un proceso de aplanado de transacciones ViewTotalPromotion y se alimenta de aplanado de las transacciones de la tabla transaction. Se la usa para detallarlos datos en el reporte Total Diario de Promociones y Total Mensual de TransaccionesPromociones

viewTotalTransaction
TablaCampoDescripciónTipo de datoRango o valores que permite el campo

viewTotalPromotion

_idIdentificador del registro de la tabla viewTotalTransaction Identificador únicodel registro, compuesto por "companyId-storeCode-campaign-iTransactionDate"string
companyIdstoreCodeCódigo de Código de la compañía tiendastring
storeCode campaignCódigo de la tiendacampañastringtransactionMonthMes de la transaccióninteger transactionYearAño de la transacciónintegertotalTransactionMonto total de la transacción doubletransactioDateFecha de la transacción ISOdate Ej."2023-04-10T163200.787-0300"iTransactionDateFecha de la transacción integerrepresentación entera de la fecha ( Ej.:20231006)

...


subTotalSuma de los precios unitarios de los productos que participaron en la promocióndouble
 appliedDiscountMonto Total de descuentos otorgadosdouble
totalMonto resultante del subtotal mas el descuento aplicadodouble
transactionDate Fecha de la transacción.date00:00:00


 iTransactionDate Fecha de la transacción, en formato entero.integer


transactionMonthMes en formato numéricointeger


transactionYearAño en formato numéricointeger

viewCustomerPurchase

Tabla que se alimenta de los datos correspondientes a las transacciones, almacenados en la tabla TransactionFlatten, luego de ejecutar un proceso de aplanado de transacciones. Se la tabla transaction. Se la usa para detallarlos detallar los datos en el reporte Clientes con Más Compras.

TablaCampoDescripciónTipo de datoRango o valores que permite el campo
viewCustomerPurchase_idIdentificador del registro de la tabla viewCustomerPurchasestring

companyIdCódigo de la compañía string

customerCodeCódigo de la tiendastring

customerIdentifierIdentificador del clientestring

customerLastNameApellido del Clientestring

customerNameNombre del Clientestring

emmitedCouponsQuantityCantidad de Cupones emitidosinteger

emmitedPointsQuantityCantidad de puntos emitidosinteger

emmitedCouponsAmountMonto de los cupones emitidosdouble

iDateFecha de la transacciónintegerrepresentación entera de la fecha ( Ej.:20231006)

reedemCouponsAmountMonto de cupones redimidosdouble

reedemCouponsQuantityCantidad de cupones redimidosintegerreedemPointsAmountMonto de puntos redimidosdoublereedemPointsQuantityCantidad de puntos redimidosintegertotalMonto Total de la transacciondoubletotalDiscountMontoTotal de descuentosdoubletotalItemsSoldCantidad de items beneficiadosintegertransactionTypeTipo de transaccionstringCantidad de cupones redimidosinteger

reedemPointsAmountMonto de puntos redimidosdouble

reedemPointsQuantityCantidad de puntos redimidosinteger

totalMonto Total de la transacciondouble

totalDiscountMontoTotal de descuentosdouble

totalItemsSoldCantidad de items beneficiadosinteger

transactionTypeTipo de transaccionstring


viewStorePurchase

Tabla que se alimenta luego de ejecutar un proceso de aplanado de la tabla transaction. Se la usa para detallar los datos en el reporte Tiendas con mayor monto en ventas.

TablaCampoDescripciónTipo de datoRango o valores que permite el campo

viewStorePurchase



_idIdentificador del registro de la tabla viewStorePurchasestring
companyIdCódigo de la compañía string
dateFecha de la transacción ISOdate Ej."2023-04-10T163200.787-0300"
storeCodeCódigo de la tiendastring
totalTransactionMonto total de la transacción que se llevó a cabo en la tiendadouble