PROMO 7.4 - Manual Modelo de Datos
Capítulo 1 - Acerca del manual
Propósito y alcance
El presente manual tiene como finalidad brindar al usuario el modelo de datos de las tablas de MongoDb, que intervienen en la realización de los diferentes reportes que dispone Promo.
Capítulo 2 - Modelo de Datos
Las tablas de las cuales se alimentan los distintos reportes de Promo son:
CardType
Tabla que almacena los datos correspondientes a los tipo de Elemento de Fidelidad
| cardType | _id | Identificador del registro | string | |
| amountChargeLimit | Monto límite de consumo | double | ||
| cardNumberLength | Longitud del número del elemento de fidelidad | integer | ||
| cardPreCharge | Identifica si el elemento de fidelidad es precargable o no. | string | SI/NO | |
| cardTransferable | Identifica si el tipo de elemento de fidelidad es transferible o no. | string | NO,TOTAL, PARTIAL | |
| cardTypePrefixRange | Tipo de rango de prefijos | array | ||
| cardValidityType | Tipo de validez del elemento de fidelidad | string | WITHOUTEXPIRATION, RANGE,DAYSFROM | |
| code | Código único del tipo de elemento de fidelidad | string | ||
| companyId | Código de la compañía que emitió el elemento de fidelidad | string | ||
| createdAt | Fecha de creación del elemento de fidelidad. | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| customerValidation | Validación del cliente. | string | NO,FILE,API | |
| dateUntilPointExpiration | Fecha de vencimiento de puntos del elemento de fidelidad. Se usa sólo cuando el vencimiento de la carga es por Fecha. | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| daysFromActivation | Cantidad de días desde la activación del tipo de elemento de fidelidad. Se usa cuando el tipo vencimiento es "Días desde la Activación". | integer | ||
| daysUntilPointExpiration | Cantidad de días desde la carga para que se realice el vencimiento de los puntos de la tarjeta. Se tiene en cuenta cuando se selecciona vencimiento de la carga "Días desde la carga". | integer | ||
| eachNumberOfDaysPointsExp | Cantidad de días desde la activación para que se realice el vencimiento de los puntos de la tarjeta. Se tiene en cuenta cuando se selecciona vencimiento de la carga "Días desde la activación". | integer | ||
| frequencyExpiration | Frecuencia de expiración | string | MONTHLY | |
| isActive | Indica si el tipo de elemento de fidelidad está activo o no. | boolean | true/false | |
| isAssignableByApi | Reservado. | |||
| isEditable | Indica si un tipo de elemento de fidelidad es editable o no. | boolean | true/false | |
| isCVVRequired | Indica si se requiere código de seguridad del elemento de fidelidad. | boolean | true/false | |
| isExternal | Indica si el tipo de elemento de fidelidad es externo o no. | boolean | true/false | |
| isNominated | Identifica si el tipo de elemento de fidelidad es nominado o no. | boolean | true/false | |
| isRechargeable | Identifica si el tipo de elemento de fidelidad es recargable o no. | boolean | true/false | |
| name | Nombre del tipo de elemento de fidelidad. | string | ||
| pointsExpirationType | Tipo de expiración de los puntos. | string | NO_EXPIRE, FROM_DAYS, FROM_DATE,NUMBER_DAYS, FREQUENCY | |
| trxLimit | Reservado. | |||
| usePartialAmount | Indica si se puede consumir el saldo parcialmente. | boolean | true/false | |
| validFrom | Fecha de inicio de validez del tipo de elemento de fidelidad. | ISOdate | Ej. "2023-04-10T163200.787-0300" | |
| validTo | Fecha de fin de validez del tipo del elemento de fidelidad. | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| version | Reservado. | |||
| campaign | Id de campaña. | string | ||
| cardPreChargeCustomValue | Valor de precarga del tipo de elemento de fidelidad. | string | ||
| cvvExceptionChannel | Canal de excepción de CVV. | string | ||
| description | Descripción del tipo de elemento de fidelidad. | string | ||
| paymentCode | Código del tipo de pago. | string | ||
| prefixEnd | Prefijo de fin. | integer | ||
| prefixStart | Prefijo de inicio. | integer | ||
| Tabla | Campo | Descripción | Tipo de Dato | Rango o valores que permite el campo |
|---|
Card
Tabla que almacena los datos correspondientes a los Elementos de Fidelidad
| Tabla | Campo | Descripción | Tipo de Dato | Rango o valores que permite el campo |
|---|---|---|---|---|
| card | _id | Identificador del registro | string | |
| activation | Fecha de activación del elemento de fidelidad | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| amount | Monto o cantidad de puntos del elemento de fidelidad | double | ||
| code | Código o nro. de elemento de fidelidad | string | ||
| companyId | Identificador del registro de la compañía que emitió el elemento de fidelidad | string | ||
| created | Fecha de creación del elemento de fidelidad | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| isConsumed | Indica si el total del elemento de fidelidad fue consumido | boolean | true/false | |
| lastPurchaseDate | Última fecha de compra relacionada al elemento de fidelidad | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| status | Estado del elemento de fidelidad | string | ENABLED, DISABLED, CANCELED. BLOCKED, EXPIRED | |
| storeCode | Código de la tienda | string | ||
| terminalCode | Código de la terminal | string | ||
| transactionId | Identificador del registro de la transacción que emitió el elemento de fidelidad | string | ||
| type | Identificador del registro del Tipo de elemento a la que pertenece el elemento de fidelidad. | string | ||
| versión | Reservado | |||
| contractCode | Código de convenio asociado al elemento de fidelidad | string | ||
| customerId | Código del cliente asociado al elemento de fidelidad | string | ||
| cvv | Código de validación. | string | ||
| validFrom | Fecha desde que el elemento de fidelidad entrará en vigencia | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| validTo | Fecha hasta que el elemento de fidelidad estará vigente | ISOdate | Ej."2023-04-10T163200.787-0300" |
CardHistory
Tabla que almacena datos históricos de los elementos de fidelidad.
| 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. | string | ||
| amountPrev | Saldo del elemento de fidelidad previo a la operación. | string | ||
| 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. |
CouponType
Tabla que almacena datos correspondientes al tipo de cupón
Tabla | Campo | Descripción | Tipo de Dato | Rango o valores que permite el campo |
|---|---|---|---|---|
| couponType | _id | Identificador del registro | string | |
| activationFromEmissionInDays | Días desde la activación; sólo si se selecciona el tipo de Fin de Vigencia "Días luego de la activación". | integer | Ej. 1,10,50 | |
| allowsOffline | Indica si se permite la generación de tipo de cupón sin conexión. | boolean | true/false | |
| calculated | Indica si el tipo de cupón es calculado o no. | boolean | true/false | |
| campaign | Reservado. | |||
| code | Código del cupón. | string | ||
| coding | Codificación del cupón. | string | EAN13,UPCA,CODE128, CUSTOM | |
| companyId | Identificador de la compañía desde la que se envía el movimiento del cupón. | string | ||
| couponFormat | Formato de cupón. | string | PRINTED, ELECTRONIC, EXTERNAL, PRE-PRINTED, INFORMATIVE. | |
| couponTemplate | Identificador de la plantilla de tipo de cupón. | string | ||
| couponValidityFromType | Tipo de inicio de validez del tipo de cupón. | string | Ej. DATE, EMITED, DAYS | |
| couponValidityToType | Tipo de fin de validez del tipo de cupón. | string | Ej. DATE, WITHOUTEXPIRATION, DAYS, HOURS | |
| customCoding | Si se selecciona codificación personalizada, mantiene el valor del campo "Identificador del cupón" | string | ||
| description | Descripción del tipo de cupón | string | ||
| expirationFromActivationInDays | Cantidad de días hasta la expiración de un tipo de cupón, desde su activación. | integer | Ej. 1,10,50 | |
| expirationHours | Cantidad de horas que el tipo de cupón estará vigente. Sólo disponible si se selecciona Tipo de Fin de vigencia, "Horas de Vigencia". | integer | ||
| expirationMinutes | Cantidad de minutos que el tipo de cupón estará vigente. Sólo disponible si se selecciona Tipo de Fin de vigencia, "Horas de Vigencia". | integer | ||
| fields | Reservado. | |||
| htmlGenerated | Reservado. | |||
| isActive | Indica si el tipo de cupón está activo o no. | boolean | true/false | |
| isEditable | Indica si el tipo de cupón es editable o no. | boolean | true/false | |
| isExternal | Indica si el tipo de cupón es externo o no. | boolean | true/false | |
| isNominated | identifica si el tipo de cupón es nominado o no. | boolean | true/false | |
| maxUsageTimes | Tiempo máximo de uso. | integer | ||
| name | Nombre del tipo de cupón. | string | ||
| prefix | Prefijo. | integer | ||
| supplier | Proveedor | string | ||
| useTotalAmount | Indica si se puede consumir total o parcialmente el tipo de cupón | Boolean | true/false | |
| validFrom | Fecha de inicio de validez del cupón. | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| validTo | Fecha de fin de validez del cupón. | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| version | Reservado. | |||
| xmlGenerated | Reservado. |
Coupon
Tabla que almacena datos correspondientes a cupones
Tabla | Campo | Descripción | Tipo de Dato | Rango o valores que permite el campo |
|---|---|---|---|---|
| coupon | _id | Identificador del registro | string | |
| amount | Total que se acreditó o debitó | double | ||
| barcode | Código de barras del cupón. | string | ||
| companyId | Identificador único de la compañía que emitió el cupón. | string | ||
| consumed | Indica si el cupón fue consumido o no. | booleano | true/false | |
| couponFormat | Indica el formato del cupón. | string | PRINTED, ELECTRONIC, EXTERNAL, PRE-PRINTED, INFORMATIVE. | |
| couponStatus | Indica el estado del cupón. | string | ACTIVE, EXPIRED, REJECTED, | |
| couponType | Identificador del tipo de cupón. | string | ||
| customerId | Indica el identificador del cliente asociado al cupón. | string | ||
| emitPromotion | ID de la promoción que otorgó el cupón | string | ||
| generatedHTML | Representación HTML del cupón electrónico | string | ||
| issuedDate | Fecha de creación del cupón | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| lastRedeemedDate | Última fecha de redención del cupón | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| maxUsageTimes | Límite de usos del cupón | integer | ||
| storeCode | Código de la tienda. | string | ||
| terminalCode | Código de la terminal. | string | ||
| transactionId | Indica el identificador del registro de la transacción en la que participó el cupón. | string | ||
| usedTimes | Cantidad de usos del cupón. | integer | ||
| validFrom | Fecha desde que el elemento de fidelidad entrará en vigencia. | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| validTo | Fecha hasta que el elemento de fidelidad estará vigente. | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| Reservado. | ||||
| redeemPromotion | Id de la promoción que redime el cupón. | string | ||
| version | Reservado. |
CouponHistory
Tabla que almacena datos históricos de los cupones
Tabla | Campo | Descripción | Tipo de Dato | Rango o valores que permite el campo |
|---|---|---|---|---|
| couponHistory | _id | identificador del registro | string | |
| companyId | Identificador único de la compañía que emitió la tarjeta | string | ||
| coupon | identificador único de un cupón | string | ||
| couponAction | acción llevada a cabo con el cupón | string | EXPIRATE, ACTIVE, REDEEM, CREATE, UPDATE_VALIDTO, BOTH, VOID, UPDATE. | |
| customerCode | código del cliente asociado al cupón | string | ||
| date | Fecha de creación del histórico de movimientos | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| exportProcessed | Reservado. | |||
| exportProcessedDate | Reservado. | |||
| storedCode | Código de la tienda, donde se llevó a cabo la transacción en la que participó el cupón | string | ||
| terminalCode | Código de la terminal en la tienda donde se llevó a cabo la transacción en la que participó el cupón | string | ||
| transactionId | identificador único de la transacción en la que participó el cupón. | string | ||
| version | Reservado. | |||
| customData | Colección de datos de un cupón asociado a un cliente | array | ||
| customData.couponPreviousValidoTo | Fecha de vigencia de un cupón anterior a una modificación. Sólo si se tiene la opción de modificar la fecha de validez del cupón. | ISOdate | Ej."2023-04-10T163200.787-0300" | |
customData.couponUpdateValidoTo
| Fecha de validez de un cupón después de su modificación. Sólo si se tiene la opción de modificar la fecha de validez del cupón. | ISOdate | Ej."2023-04-10T163200.787-0300" |
TransactionFlatten
Tabla que almacena los datos correspondientes a las transacciones. Esta es una tabla dinámica; ya que los datos que almacene dependerán del tipo de transacción.
Importante
El contenido de los campos con * es variable, dependiendo de la transacción.
| Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
|---|---|---|---|---|
| transactionFlaten | _id | Identificador del registro de la transacción. | string | |
| benefitTotal | Beneficio Total de la transacción. | double | ||
| channelCode | Código del canal. | string | ||
| companyId | Código de la empresa. | string | ||
| coupons[ | Array de datos, que contiene información de cupones* | array | ||
| type | Tipo de cupón que participa en la transacción. | string | ||
| QTY | Reservado. | |||
| qty | Cantidad de beneficios otorgados. | integer | ||
| sequence | Número identificador único del elemento dentro de la transacción. | integer | ||
| valuesAsMap | Reservado | |||
| id | Identificador del cupón. | string | ||
| AMOUNT | Reservado. | |||
| amount | Valor del cupón cuando es calculado. | double | ||
| externalId | Reservado. | |||
| participants[ | Colección de datos de participantes | array | ||
| promoID | Identificador de la promoción que genera o redime el cupón. | string | ||
| promoName | Nombre de la promoción que genera o redime el cupón. | string | ||
| campaignName | Nombre de la campaña. | string | ||
| qty | Cantidad de beneficios otorgados. | integer | ||
| magnitude | Cantidad del producto. | integer | ||
xprice ] ] | Precio extendido del artículo en cuestión. Es igual a la cantidad por el precio unitario. | double | ||
customers[ | Colección de datos de Clientes.* | array | ||
cardNumber | Número del elemento de fidelidad asociado al cliente. | integer | ||
sequence | Número identificador único del elemento dentro de la transacción. | integer | ||
balances | Límite externo que indica si se debe aplicar o no el beneficio. | double | ||
valuesAsMap[ | Reservado. | |||
id | Identificador del cliente. | string | ||
points | Saldo en puntos de fidelidad que posee el cliente. | double | ||
POINTS | Reservado. | |||
creditCampaingCode | Crédito de la campaña crediticia. | string | ||
haslimitsError | Reservado. | |||
name | Nombre del cliente. | string | ||
raffleData | Datos para imprimir en cupones informativos, orientado principalmente a sorteos. | string | ||
REMAININGAMOUNT | Reservado. | |||
type | Tipo de cliente. | string | ||
redeemPointsPriceFactor | Reservado. | |||
identifierType | Tipo de identificación del cliente. (en caso de "Validar catálogos relacionados al catálogo de clientes" este es "true", el dato definido en este campo deberá coincidir con alguno de los códigos de tipo de identificación "catalogIdType" previamente cargados.). | string | ||
lastname | Apellido del cliente. | string | ||
AMOUNT | Reservado. | |||
segment | Lista de Códigos de Segmentos Externos a los cuales pertenece el cliente. | array | ||
amount | Indica el saldo de un cliente. | double | ||
balance | Límite externo que indica el saldo y en base a eso otorgar el beneficio hasta que se consuma el saldo en su totalidad, sin otorgar demás. | double | ||
profileCode | Código del perfil del cliente. | string | ||
limitedBenefits | Consiste en un listado de Limites asociados a Convenios. El mismo es del tipo limitedBenefits"limite1valor1;limite2valor2;limite3valor3.....". Estos valores pueden ser informados desde el Punto de Venta o bien son obtenidos mediante una respuesta a LoyaltyValidation y reinjectados por parte del punto de venta como han sido recibidos. | string | ||
| Correo electrónico del cliente. | string | |||
identifier | Numero de identificación del cliente. | string | ||
externalId | Reservado. | |||
remainingAmount ] ] | Indica el saldo a favor o en contra del cliente en cuestión. | double | ||
| engineVersion | Versión del Motor | string | Ej "7.2.4#264" | |
| events | Colección de eventos de la transacción. | array | ||
| headerExtraFields | Reservado. | |||
| IDate | Año, mes y día en que se realizó la transacción. | integer | Ej"20230317" | |
| IHour | Hora en que se realizó la transacción. | integer | Ej."18" | |
items[ | Colección de elementos que forman parte de la transacción.* | array | ||
magnitude | Se aplica el descuento a cada unidad de cantidad. | double | ||
supplierItemAmount | Es el monto que el proveedor reconoce (monto del recupero). | double | ||
qty | Número que identifica la Cantidad del ítem. | integer | ||
sequence | Número identificador único del elemento dentro de la transacción. | integer | ||
taxes | Valor de los impuestos discriminados respecto al precio unitario. | double | ||
code | Código del ítem. | string | ||
level4 | Subcategoría del producto. | string | ||
discontinuable | Indica si el artículo puede recibir descuentos o no. | boolean | true/false | |
lowTurnover | Determina si el producto es un producto de baja rotación. | boolean | true/false | |
redeemOption | Informara las opciones entre las que puede elegir el cliente para acceder a un determinado beneficio canjeando una determinada cantidad de puntos (del cliente y/o elemento de fidelidad). | string | ||
level1 | Departamento al que pertenece un producto. | string | ||
xpriceOriginal | Reservado. | |||
supplier | Proveedor al que pertenece el artículo. | string | ||
qty3 | Cantidad del producto a superar para otorgar el precio 3 (price3). Solo para Promociones de Nuevo Precio que indican usar monto externo. | double | ||
XPRICE | Reservado | |||
qty2 | Cantidad del producto a superar para otorgar el precio 2 (price2). Solo para Promociones de Nuevo Precio que indican usar monto externo. | double | ||
supplierFinancial | Código del proveedor financiero del ítem. | string | ||
MAGNITUDE | Reservado. | |||
unitprice3 | Reservado. | |||
level2 | Familia a la que pertenece el articulo. | string | ||
valuesAsMap | Reservado. | |||
brand | Marca del artículo. | string | ||
applyCatalogRedeem | Determina si el producto participa en el Canje de Puntos por Catálogo. | boolean | true/false | |
supplierItem | Reservado. | |||
unitprice | Es precio del ítem consultado al motor. | double | ||
priceListLastUpdate | Reservado. | |||
calCouponVal | Reservado. | |||
barcode | Código de barras generado para el cupón (según su tipo). | double | ||
level3 | Categoría del producto. | string | ||
unitprice2 | Reservado. | |||
productCode | Código de producto. | string | ||
discontinuous | Determina si el producto es un producto discontinuo | boolean | true/false | |
xprice | Precio extendido del artículo en cuestión. Es igual a la cantidad por el precio unitario. | double | ||
seqOriginalQty | Reservado. | |||
QTY | Reservado. | |||
originalDiscountable | Reservado. | |||
supplierFinancialAmount | Es el monto que el proveedor Financiero reconoce. | double | ||
seqOriginalXprice | Reservado. | |||
PRICE_WITH_TAXES | Reservado. | |||
priceswithtaxes | Reservado. | |||
seqOriginalXpriceOriginal | Reservado. | |||
keyProduct | Determina si el producto es un producto estrella. | boolean | true/false | |
manualDiscount | Determina si el ítem admite descuento manual. | boolean | true/false | |
externalId | Reservado. | |||
seqOriginal | Reservado. | |||
benefitApplies[ | Colección de beneficios aplicados al item | array | ||
type | Tipo de beneficio aplicado. | string | ||
hasLimit | Reservado. | |||
qty | Reservado. | |||
benefitNro | Número del beneficio aplicado | string | ||
transactionComboParticipants | Colección de combos que participan en la promoción | array | ||
additionalData | Datos adicionales | string | ||
promotionName | Nombre de la promoción que otorga el beneficio | string | ||
benefitType | Indica el tipo de beneficio a generar.
| string | ||
transactionBenefitApplies[ | Colección de datos de los beneficios aplicados en la transacción | array | ||
magnitude | Se aplica el descuento a cada unidad de cantidad. | |||
value | Reservado. | |||
stagger | Corresponde al valor del escalón aplicado si es aplicable, en promociones escalonadas. | string | ||
valueWhitTaxes | Reservado. | |||
xprices | Precio extendido del artículo en cuestión. Es igual a la cantidad por el precio unitario. | double | ||
seq | Número que identifica la cantidad del ítem. | integer | ||
qty | Reservado. | |||
points | Cantidad total de puntos, dinero, millas, etc. que otorga la secuencia identificada por seq. Aparece siempre que el elemento de aplicación forme parte de un beneficio LoyaltyBenefit, PercentLoyaltyBenefit o FactorLoyalBenefit para los cuales se calculan los puntos, dinero, millas, etc. | double | ||
balancedApplied | Reservado. | |||
minimumApplied ] | Reservado. | |||
promotionNro | Número de la promoción que otorga beneficios en la transacción. | sting | ||
promotionCode ] | Código de la promoción que otorga beneficios en la transacción. | string | ||
participants[ | Colección de componentes, que indica los elementos que influyeron en la condición y que provocaron que se otorgue el beneficio. | array | ||
promoId | Identificador de la promoción . | string | ||
promoName | Nombre de la promoción. | string | ||
campaignName | Nombre de la campaña asociada a la promoción. | string | ||
qty | Número que identifica la cantidad del ítem. | integer | ||
magnitude | Se aplica el descuento a cada unidad de cantidad. | double | ||
xprice ] ] | Precio extendido del artículo en cuestión. Es igual a la cantidad por el precio unitario. | double | ||
| iTime | Hora, minutos y segundos en que se realizó la transacción. | integer | Ej."180500" | |
| loyaltyCards[ | Colección de datos que representan un detalle de los elementos de fidelidad presentadas en la transacción. Es un listado de objetos que contienen atributos.* | array | ||
| contract | Código de convenio al que pertenece el elemento de fidelidad. | string | ||
| sequence | Número identificador único del elemento dentro de la transacción. | integer | ||
| id | Identificador único del elemento de fidelidad. | string | ||
| valuesAsMap | Reservado. | |||
| consumeAmount | Saldo a debitar a un elemento de fidelidad loyalty. | double | ||
| validTo | Fecha de fin de vigencia . Formato "YYYY-MM-DD" (Año-Mes-Dia). | string | Ej."2021-07-16" | |
| type | Tipo de elemento a la que pertenece el elemento de fidelidad. | string | ||
| status | Estado del elemento de fidelidad. | string | ENABLED, DISBLED, CANCELED | |
| AMOUNT | Reservado. | |||
| amount | Monto a asignar al elemento. Si su tipo indica que es precargada por archivo, este campo es requerido. | double | ||
| reason | Código del motivo por el cual se está realizando el chargeAmount o consumeAmount pertinente. Este código corresponde a los valores de motivos definidos en la consola de Promo. | string | ||
| validFrom | Fecha de inicio de vigencia . Formato "YYYY-MM-DD" (Año-Mes-Dia) . | string | Ej."2021-07-16". | |
| chargeAmount | Saldo a acreditar a un elemento de fidelidad loyalty. | double | ||
| trxLimit | Reservado. | |||
| externalId | Reservado. | |||
| originalAmount | Reservado. | |||
cvv ] ] | Código de seguridad asociado al elemento de fidelidad. | integer | ||
| mapVersion | Reservado. | |||
| messageId | Identificador del mensaje | string | ||
| offline | Reservado. | |||
| originalTransactionId | Identificador de la transacción procesada. | string | ||
| payments[ | Colección que contiene información del pago.* | array | ||
| plan | Plan del medio de pago. | string | ||
| sequence | Número identificador único del elemento dentro de la transacción. | integer | ||
| id | Identificador del pago. | string | ||
| valuesAsMap | Reservado. | |||
| balance | Indica si con este medio de pago se cancela el saldo de la transacción. Si el valor es true, entonces no es necesario enviar el amount o itemamount. | double | ||
| prefix | Indica el Prefijo asociado al pago. | string | ||
| payCreditCampaign | Campaña Crediticia asociada al pago. | string | ||
| type | Tipo de medio de pago. | string | ||
| Amount | Reservado. | |||
| bank | Banco relacionado con el medio de pago. | string | ||
| amount | Dinero que se utiliza con ese medio de pago. Dado que el monto del pago (PA) se calcula como PA = PIA (1 - %desc) o PA = PIA * (1+%recargo)* se obtiene que el monto de los ítems que se desea pagar (PIA) se calcula como PIA = PA / (1 - %desc) o PIA = PA / (1+%recargo). | double | ||
| prefixGroup | Indica el grupo de Prefijos asociado al pago. | integer | ||
| prefixGroupstr | Reservado. | |||
| installments | Indica la cantidad de cuotas asociadas al pago. | integer | ||
| itemamount | Dinero que representa el monto de ítems que se desea pagar. | double | ||
| externalId | Reservado. | |||
] | Indica el Bolsillo asociado al pago. | string | ||
| processDate | Fecha en que ingresó el registro en esta tabla | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| processedViewTPromotion | Reservado. | |||
| processedViewTStore | Reservado. | |||
| Promotions[ | Colección de datos de la/s promoción/es que otorgan beneficios en la transacción.* | array | ||
| promoId | Identificador único de la promoción. | string | ||
| promoName | Nombre de la promoción. | string | ||
| campaingName | Nombre de la campaña. | string | ||
| promoCode | Código de la promoción. | string | ||
| benefits[ | Colección de beneficios de la promoción. | array | ||
| benefitNro | Identifica al beneficio que aplica la promoción. | string | ||
| benefitType | Identifica al tipo de beneficio que aplica la promoción. | string | ||
| hasLimit | Indica si un beneficio posee limites. | boolean | true/false | |
| qty | Cantidad de elementos que fueron involucrados en la promoción. | integer | ||
| value | Reservado. | |||
| valueWithTaxes | Reservado. | |||
| tipoPromo | Tipo de promoción. | string | ||
| printerMessage | Mensaje a la impresora | string | ||
cuponid ] | Identificador del cupón. | string | ||
discount ] | Monto total de descuentos. | double | ||
| stroreChainCode | Código de la cadena a la que pertenece la transacción | string | ||
| storeCode | Código de la tienda. | string | ||
| storeTerminal | Concatenado entre la compañía, la tienda y la terminal. | string | ||
| subtotal | Subtotal de la transacción. | double | ||
| subZoneCode | Código de la subzona. | string | ||
| terminalCode | Código de la terminal. | string | ||
| total | Total de la transacción. | double | ||
| totalItemsSold | Reservado. | |||
| emittedCoupons [ | Colección de cupones emitidos | array | ||
| _id | Identificador del cupón, de Mongo | string | ||
| barcode | Código de barras del cupón | string | ||
amount ] | Monto del cupón | double | ||
| transactionDate | Fecha en que se llevó a cabo la transacción. | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| transactionId | Identificador del registro de la transacción | string | ||
| transactionType | Tipo de transacción | string | LOYALTY_TRANSFER, LOYALTY_VOID, LOYALTY_ASSIGN | |
| zoneCode | Código de la zona. | string | ||
| resent | Indica si la transacción fue reenviada a la cola RabbitMQ. Si la transacción no fue reenviada el campo no aparece. | boolean | true/false | |
| resentDate | Indica la fecha en la que fue reenviada la transacción a la cola RabbitMQ. Si la transacción no fue reenviada el campo no aparece. | ISOdate | Ej."2023-04-10T163200.787-0300" |
viewTicketHeader
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 detallar los datos de la cabecera del reporte Transacciones por Tiendas.
| 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 | double | ||
| 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 | double | ||
| 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 | double | ||
| 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 | double | ||
| totalItemsMagnitude | Magnitud total de productos | double | ||
| totalItemsSold | Cantidad total de ítems vendidos | double | ||
| 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 |
viewTicketBenefitTotals:
Tabla que se alimenta de los datos correspondientes a los beneficios otorgados por las promociones , 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 Detalle de Promociones.
| Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
|---|---|---|---|---|
viewTicketBenefitTotals | _id | identificador único del registro | ObjectId | |
| storeCode | Código de la tienda | string | ||
| companyId | Código de la compañía | string | ||
| transactionDate | Fecha de la transacción | date | 00:00:00 | |
| iTransactionDate | Fecha de la transacción, en formato entero | integer | Ej.:20240118 | |
| 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 | double | ||
| 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 | |
| companyId | Código de la compañía | 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) | |
| storeCode | Código de la tienda donde se realizó la transacción | string | ||
| 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. | double | ||
| sequence | Número identificador único del elemento dentro de la transacción. | integer | ||
| total | Total del producto | double | ||
| totalBenefitsQuantity | Cantidad Total de beneficios | double | ||
| 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 | ||
| emittedCouponType | 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 | double | ||
| 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 | string |
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" | |
| iTransactionDate | Fecha de la transacción | integer | representación entera de la fecha ( Ej.:20231006) |
.
viewTotalPromotion
Tabla que se alimenta de 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 Promociones
| Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
|---|---|---|---|---|
viewTotalPromotion | _id | Identificador único del registro, compuesto por "companyId-storeCode-campaign-iTransactionDate" | string | |
| storeCode | Código de la tienda | string | ||
| campaign | Código de la campaña | string | ||
| companyId | Código de la compañía | string | ||
| 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 luego de ejecutar un proceso de aplanado de la tabla transaction. Se la usa para 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 | ||
| date | Fecha de la transacción | ISODate | Ej: "2023-12-18T00:00:00.000-03:00" | |
| emittedCouponsQuantity | Cantidad de Cupones emitidos | integer | ||
| emittedPointsQuantity | Cantidad de puntos emitidos | double | ||
| emittedCouponsAmount | Monto de los cupones emitidos | double | ||
| iDate | Fecha de la transacción | string | Ej.:"20231006" | |
| redeemedCouponsAmount | Monto de cupones redimidos | double | ||
| redeemedCouponsQuantity | Cantidad de cupones redimidos | integer | ||
| redeemedPointsAmount | Monto de puntos redimidos | double | ||
| redeemedPointsQuantity | Cantidad de puntos redimidos | double | ||
| total | Monto Total de la transaccion | double | ||
| totalDiscounts | MontoTotal de descuentos | double | ||
| totalItemsSold | Cantidad de items beneficiados | double | ||
| 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 |
viewStoreWithIncreasedBenefit
| Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
|---|---|---|---|---|
| viewStoreWithIncreasedBenefit | _id | Identificador único del registro | string | |
appliedBenefitAmount | Monto de los beneficios aplicado | double | ||
| appliedBenefitQty | Cantidad de beneficios aplicados | integer | ||
| companyId | identificador de la compañía | string | ||
| date | Fecha de la transacción | ISOdate | Ej."2023-04-10T163200.787-0300" | |
| iDate | Fecha de la transacción en formato entero | integer | Ej.:20231006 | |
| month | Mes de la transacción | integer | EJ: 10 | |
| redeemedCouponsAmount | Monto de cupones redimidos | double | ||
| redeemedCouponsQty | Cantidad de cupones redimidos | integer | ||
| redeemedPointsAmount | Monto de puntos redimidos | double | ||
| redeemedPointsQty | Cantidad de puntos redimidos | integer | ||
| storeCode | Identificador de la tienda donde se realizó la transacción | string | ||
| year | año de la transacción | integer | Ej:2024 |
viewCardDetailSummary
| Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
|---|---|---|---|---|
viewCardDetailSummary | _id | Identificador único del registro | string | |
| cardTypeCode | Código del tipo de elemento de fidelidad | string | ||
| companyId | Código de la compañía | string | ||
| date | Fecha en que se emitieron o redimieron puntos | ISODate | Ej.: "2024-11-15T00:00:00.000-03:00" | |
| emittedPointsQuantity | Cantidad de puntos emitidos | double | ||
| promotionName | Nombre de la promoción que emitió o redimió los puntos | string | ||
| redeemedPointsQuantity | Cantidad de puntos redimidos | double |
viewCardDetail
| Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
|---|---|---|---|---|
viewCardDetail | _id | Identificador único del registro | string | |
| date | Fecha de la transacción que generó la emisión/redención de puntos | ISODate | Ej.: "2024-11-15T00:00:00.000-03:00" | |
| companyId | Código de la compañía | string | ||
| promotionName | Nombre de la promoción que otorgó o redimió los puntos | string | ||
| benefitClassCode | Clase de beneficio que otorgó o redimió los puntos. | string | ||
| cardTypeCode | Código del Tipo de Elemento de Fidelidad. | string | ||
| appliedQuantity | Cantidad de aplicaciones del beneficio: numero de veces en que fue aplicado el beneficio que otorgó o redimió los puntos | integer | ||
| emittedPointsQuantity | Cantidad de puntos emitidos | double | ||
| redeemedPointsQuantity | Cantidad de puntos redimidos | double | ||
| redeemedPointsAmount | Monto total de puntos redimidos | double |
viewStorePromotionActive
| Tabla | Campo | Descripción | Tipo de dato | Rango o valores que permite el campo |
|---|---|---|---|---|
viewStorePromotionActive | _id | Identificador único del registro | string | |
| comapnyId | Código de la compañía | string | ||
| date | Fecha de inicio de la consulta | ISODate | Ej: "2024-01-10T14:20:31.865-03:00" | |
| emittedCouponsQty | Cantidad de Promociones que emiten cupones | double | ||
| emittedPointsQty | Cantidad de Promociones que emiten puntos | double | ||
| iDate | Fecha de inicio de la consulta en formato entero | integer | ||
| mapVersion | Número de versión del mapa | integer | ||
| monetaryQty | Cantidad de beneficios monetarios | double | ||
| notMonetaryQty | Cantidad de beneficios no monetarios | double | ||
| promotionQty | Cantidad de Promociones | integer | ||
| redeemedCouponsQty | Cantidad de Promociones que redimen cupones | double | ||
| redeemedPointsQty | Cantidad de Promociones que redimen puntos | double | ||
| storeCode | Código de tienda | string | ||
| storeName | Nombre de la tienda | string |