...
Tabla | Campo | Descripción | Tipo de Dato | Rango o valores que permite el campo |
---|---|---|---|---|
cardHistory | _id | Identificador del registro. | string | |
amount | Monto actual asociado a esta operación. | doublestring | ||
amountPrev | Saldo del elemento de fidelidad previo a la operación. | double | ||
appliedPromotionDetails | Detalle de promociones involucradas en el incremento/decremento del monto por aplicación de un beneficio. | array | ||
applyError | Error en la transacción. | boolean | true/false | |
card | Identificador del registro del elemento de fidelidad. | string | ||
cardAction | Acció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 | |
companyId | Compañía desde la que se envía el movimiento de elemento de fidelidad. | string | ||
confirmationDate | Reservado. | |||
confirmationState | Reservado. | |||
createdAt | Fecha de creación del elemento de fidelidad. | ISOdate | Ej."2023-04-10T163200.787-0300" | |
customerCode | código del cliente asociado al elemento de fidelidad | string | ||
date | Fecha del movimiento que se informa del elemento de fidelidad. | ISOdate | Ej."2023-04-10T163200.787-0300" | |
detailedAction | Reservado. | |||
extendedPoints | Reservado. | |||
extraMessageArgs | Indica los argumentos de error cuando el campo applyError es true. | array de string | ||
extraMessageCode | Indica el código de error informado cuando el campo applyError es true. | string | ||
operationFromConsole | Indica si la operación se realizó por medio de la consola y no por medio de la api. | boolean | true, false | |
pointsExpirationDate | Fecha expiración de los puntos del elemento de fidelidad (si es que corresponde). | date | ||
reason | Código de justificación informado para esta transacción. | string | ||
remainingAmount | Reservado. | |||
storeCode | Código de la tienda. | string | ||
terminalCode | Código de la terminal . | string | ||
transactionId | identificador único de la transacción en la que participó el elemento de fidelidad. | string | ||
version | Reservado. |
...
Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
---|---|---|---|---|
viewTicketHeader | _id | Identificador del registro en la tabla viewTicketHeader | string | |
canceledCouponsAmount | Monto Total de los cupones cancelados | double | ||
canceledCouponsQuantity | Cantidad de cupones cancelados | integer | ||
canceledPointsQuantity | Cantidad de puntos cancelados | integer | ||
channelCode | Código de canal | string | ||
companyId | Código de compañía | string | ||
customerCode | Código de Cliente | string | ||
emittedCouponsQuantity | Cantidad de cupones emitidos | integer | ||
emittedPointsQuantity | Cantidad de puntos emitidos | integer | ||
emittedCouponsAmount | Monto total de cupones emitidos | double | ||
iTransactionDate | Fecha de la transacción | integer | representación entera de la fecha ( Ej.:20231006) | |
redeemedCouponsAmount | Monto total de cupones redimidos | double | ||
redeemedCouponsQuantity | Cantidad de cupones redimidos | integer | ||
redeemedPointsAmount | Monto total de puntos redimidos | double | ||
redeemedPointsQuantity | Cantidad total de puntos redimidos | integer | ||
storeCode | Código de tienda | string | ||
subtotal | Subtotal de la transacción | double | ||
terminalCode | Código de la terminal | string | ||
totalBenefitsQuantity | Cantidad total de beneficios | integer | ||
totalDiscounts | Total de descuentos | integer | ||
totalItemsMagnitude | Magnitud total de productos | double | ||
totalItemsSold | Cantidad total de ítems vendidos | integer | ||
totalTransaction | Total de la transacción | double | ||
transactionDate | Fecha de la transacción | ISOdate | Ej."2023-04-10T163200.787-0300" | |
transactionId | Identificador del registro de la transacción | string | ||
transactionType | Tipo de la transacción | string | VENTA, 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.
Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
---|
viewTicketBenefitTotal |
id |
identificador único del registro |
string |
storeCode | Código |
de la tienda | string |
transactionDate |
Fecha de la |
transacción |
date | 00:00:00 |
iTransactionDate | Fecha de la |
transacción, en formato entero | date | 00:00:00 | |
benefitType | Código del tipo de beneficio | string | |
isMonetary | Indica si el beneficio es monetario, aplica para beneficios de tipo → PercentageDiscount, FixedDiscount, CalculatedCouponApplicationBenefit, NewPrice, RedeemPointsBenefit, CatalogRedeemBenefit. | boolean | |
promotionName | Nombre de la promoción. | string | |
promotionCode | Código de la promoción | string | |
campaign | Código de la campaña | string | |
appliedDiscount | Monto del descuento aplicado por el beneficio | double | |
emittedCouponsQty | Cantidad de cupones emitidos | integer | |
emittedCouponsAmount | Monto de puntos emitidos | double | |
redeemedCouponsQty | Cantidad de cupones redimidos | integer | |
redeemedCouponsAmount | Monto de cupones redimidos | double | |
emittedPointsQty | Cantidad de puntos emitidos | integer | |
emittedPointsAmount | Monto de puntos emitidos | double | |
redeemedPointsQty | Cantidad de puntos redimidos | integer | |
redeemedPointsAmount | Monto de puntos redimidos | double | |
appliedBenefitQty | Cantidad de beneficios aplicados | integer | |
emittedCouponId: | Identificador único del cupón emitido | string | |
emittedCouponType | Código del tipo de cupón emitido | string | |
loyaltyCardId | Identificador único del elemento de fidelidad. | string | |
loyaltyCardType | Código del tipo de elemento de fidelidad | string |
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.
Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
---|---|---|---|---|
viewExpiredCoupons | id | identificador único del registro, compuesto por "companyId-couponTypeCode-iDate" | string | |
couponTypeCode | Código del tipo de cupón | string | ||
couponTypeName | Nombre del tipo de cupón | string | ||
couponTypeFormat | Código del formato del tipo de cupón | string | ||
date | Fecha fin de vigencia (validTo) del tipo de cupón | ISOdate | Ej."2023-04-10T163200.787-0300" | |
iDate | Fecha fin de vigencia (validTo) del tipo de cupón en formato entero añoMesDia | integer | Ej:20230410 | |
month | Indica el mes fin de vigencia (validTo) del tipo de cupón. | integer | ||
year | Fin de vigencia (validTo) del tipo de cupón. | integer | ||
couponsQuantity | Cantidad de cupones vencidos | integer |
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.
Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
---|---|---|---|---|
viewExpiredPoints | id | identificador único del registro | string | |
date | Fecha de expiración de los puntos | date | Ej:" 4/11/2023 0:00:00" | |
iDate | Fecha de expiración de los puntos, en formato entero(añoMesDia) | integer | Ej: 20231104 | |
cardTypeCode | Código del tipo de elemento de fidelidad | string | ||
cardTypeName | Nombre del tipo de elemento de fidelidad | string | ||
cardTypeId | Identificador del tipo de elemento de fidelidad | string | ||
qty | Cantidad de puntos vencidos, esta cantidad se encuentra acumulada por día | integer | ||
month | Mes asociado a la expiración de los puntos | integer | ||
year | Año asociado a la expiración de los puntos | integer |
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.
Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo | |||||
---|---|---|---|---|---|---|---|---|---|
viewTicketItem | _id | Identificador del registro de la tabla viewTicketItem | string | ||||||
code | Código del producto | string | |||||||
companyId | Código de la compañía | string | |||||||
description | Descripción del producto | string | |||||||
discount | Descuentos | double | |||||||
iTransactionDate | Fecha de la transacción | integer | representación entera de la fecha ( Ej.:20231006) | ||||||
magnitude | Si el artículo es mensurable por otra unidad que no sea la cantidad, deberá ser expresada en esta propiedad. | double | |||||||
quantity | Cantidad de artículos en la línea. | integer | |||||||
sequence | Número identificador único del elemento dentro de la transacción. | integer | |||||||
total | Total del producto | double | |||||||
totalBenefitsQuantity | Cantidad Total de beneficios | integer | |||||||
transactionDate | Fecha de la transacción | ISOdate | Ej."2023-04-10T163200.787-0300" | transactionId | Identificador de la transacción | string | unitPrice | Precio Unitario | double |
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.
Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo | viewTicketBenefit | _id | Identificador del registro de la tabla viewTicketBenefit | string | appliedBenefitQty | Cantidad de beneficios aplicados | integer | appliedDiscount | Descuentos aplicados (monto) | double | benefitType | Tipo de beneficio | string | campaign | Nombre de la campaña | string | companyId | Código de la compañía | string | emittedCouponsAmount | Monto total de los cupones emitidos | double | emittedCouponsQty | Cantidad de cupones emitidos | integer | emittedCouponsType | Tipo de cupones emitidos | string | emittedPointsAmount | Monto de puntos emitidos | double | emittedPointsQty | Cantidad de puntos emitidos | integer | isMonetary | Indica si el beneficio es monetario o no | boolean | itemCode | Código de producto | string | itemDescription | Descripción del producto | string | itemQty | Cantidad de producto | integer |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
iTransactionDate | Fecha de la transacción | integer | representación entera de la fecha ( Ej.:20231006) | ||||||||||||||||||||||||||||
loyaltyCardId | Identificador del elemento de fidelidad | string | loyaltyCardType | Tipo del elemento de fidelidad | string | promotionCode | Código de la promoción | string | promotionName | Nombre de la promoción | string | redeemedCouponsAmount | Monto redimido de cupones | double | redeemedCouponsQty | Cantidad de cupones redimidos | integer | redeemedPointsAmount | Monto de puntos redimidos | double | redeemedPointsQty | Cantidad de puntos redimidos | integer | sequence | Número identificador único del elemento dentro de la transacción. | integer | storeCode | Código de Tienda | string | transactionDate | Fecha de la transacción |
transactionId | Identificador de la transacción | string | |||||||||||||||||||||||||||||
unitPrice | Precio Unitario | double |
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.
Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
---|---|---|---|---|
viewTicketBenefit | _id | Identificador del registro de la tabla viewTicketBenefit | string | |
appliedBenefitQty | Cantidad de beneficios aplicados | integer | ||
appliedDiscount | Descuentos aplicados (monto) | double | ||
benefitType | Tipo de beneficio | string | ||
campaign | Nombre de la campaña | string | ||
companyId | Código de la compañía | string | ||
emittedCouponsAmount | Monto total de los cupones emitidos | double | ||
emittedCouponsQty | Cantidad de cupones emitidos | integer | ||
emittedCouponsType | Tipo de cupones emitidos | string | ||
emittedPointsAmount | Monto de puntos emitidos | double | ||
emittedPointsQty | Cantidad de puntos emitidos | integer | ||
isMonetary | Indica si el beneficio es monetario o no | boolean | ||
itemCode | Código de producto | string | ||
itemDescription | Descripción del producto | string | ||
itemQty | Cantidad de producto | integer | ||
iTransactionDate | Fecha de la transacción | integer | representación entera de la fecha ( Ej.:20231006) | |
loyaltyCardId | Identificador del elemento de fidelidad | string | ||
loyaltyCardType | Tipo del elemento de fidelidad | string | ||
promotionCode | Código de la promoción | string | ||
promotionName | Nombre de la promoción | string | ||
redeemedCouponsAmount | Monto redimido de cupones | double | ||
redeemedCouponsQty | Cantidad de cupones redimidos | integer | ||
redeemedPointsAmount | Monto de puntos redimidos | double | ||
redeemedPointsQty | Cantidad de puntos redimidos | integer | ||
sequence | Número identificador único del elemento dentro de la transacción. | integer | ||
storeCode | Código de Tienda | string | ||
transactionDate | Fecha de la transacción | ISOdate | Ej."2023-04-10T163200.787-0300" | |
transactionId | Identificador 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
Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo | ||
---|---|---|---|---|---|---|
viewTotalTransaction | _id | Identificador del registro de la tabla viewTotalTransaction | string | |||
companyId | Código de la compañía | string | ||||
storeCode | Código de la tienda | string | ||||
transactionMonth | Mes de la transacción | integer | ||||
transactionYear | Año de la transacción | integer | ||||
totalTransaction | Monto total de la transacción | double | ||||
transactioDate | Fecha de la transacción | ISOdate | Ej."2023-04-10T163200.787-0300" | transactionId | Identificador del registro de la tabla TransactionFlatten |
...
iTransactionDate | Fecha de la transacción | integer | representació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
Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo | viewTotalTransaction|||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
viewTotalPromotion | _idIdentificador del registro de la tabla viewTotalTransaction | Identificador únicodel registro, compuesto por "companyId-storeCode-campaign-iTransactionDate" | string | ||||||||||||||||
companyIdstoreCode | Código de Código de la compañía tienda | string | |||||||||||||||||
storeCode campaign | Código de la tiendacampaña | string | transactionMonth | Mes de la transacción | integer | transactionYear | Año de la transacción | integer | totalTransaction | Monto total de la transacción | double | transactioDate | Fecha de la transacción | ISOdate | Ej."2023-04-10T163200.787-0300" | iTransactionDate | Fecha de la transacción | integer | representación entera de la fecha ( Ej.:20231006) |
...
subTotal | Suma de los precios unitarios de los productos que participaron en la promoción | double | ||
appliedDiscount | Monto Total de descuentos otorgados | double | ||
total | Monto resultante del subtotal mas el descuento aplicado | double | ||
transactionDate | Fecha de la transacción. | date | 00:00:00 | |
iTransactionDate | Fecha de la transacción, en formato entero. | integer | ||
transactionMonth | Mes en formato numérico | integer | ||
transactionYear | Año en formato numérico | integer |
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.
Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
viewCustomerPurchase | _id | Identificador del registro de la tabla viewCustomerPurchase | string | |||||||||||||||||||||
companyId | Código de la compañía | string | ||||||||||||||||||||||
customerCode | Código de la tienda | string | ||||||||||||||||||||||
customerIdentifier | Identificador del cliente | string | ||||||||||||||||||||||
customerLastName | Apellido del Cliente | string | ||||||||||||||||||||||
customerName | Nombre del Cliente | string | ||||||||||||||||||||||
emmitedCouponsQuantity | Cantidad de Cupones emitidos | integer | ||||||||||||||||||||||
emmitedPointsQuantity | Cantidad de puntos emitidos | integer | ||||||||||||||||||||||
emmitedCouponsAmount | Monto de los cupones emitidos | double | ||||||||||||||||||||||
iDate | Fecha de la transacción | integer | representación entera de la fecha ( Ej.:20231006) | |||||||||||||||||||||
reedemCouponsAmount | Monto de cupones redimidos | double | ||||||||||||||||||||||
reedemCouponsQuantity | Cantidad de cupones redimidos | integer | reedemPointsAmount | Monto de puntos redimidos | double | reedemPointsQuantity | Cantidad de puntos redimidos | integer | total | Monto Total de la transaccion | double | totalDiscount | MontoTotal de descuentos | double | totalItemsSold | Cantidad de items beneficiados | integer | transactionType | Tipo de transaccion | string | Cantidad de cupones redimidos | integer | ||
reedemPointsAmount | Monto de puntos redimidos | double | ||||||||||||||||||||||
reedemPointsQuantity | Cantidad de puntos redimidos | integer | ||||||||||||||||||||||
total | Monto Total de la transaccion | double | ||||||||||||||||||||||
totalDiscount | MontoTotal de descuentos | double | ||||||||||||||||||||||
totalItemsSold | Cantidad de items beneficiados | integer | ||||||||||||||||||||||
transactionType | Tipo de transaccion | string |
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.
Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
---|---|---|---|---|
viewStorePurchase | _id | Identificador del registro de la tabla viewStorePurchase | string | |
companyId | Código de la compañía | string | ||
date | Fecha de la transacción | ISOdate | Ej."2023-04-10T163200.787-0300" | |
storeCode | Código de la tienda | string | ||
totalTransaction | Monto total de la transacción que se llevó a cabo en la tienda | double |