VmOnline ApiBackoffice

Interfaces para obtener información del Backoffice de Vendemas

Consulta de Abonos

POST /api.backoffice/v2/abonos

Consulta de Transacciones

POST /api.backoffice/v2/transacciones

Solicitud Envío Detalle Abono

POST /api.backoffice/v2/envioDetalleAbono

Solicitud Envío Estado Cuenta

POST /api.backoffice/v2/envioEstadoCuenta

Solicitud Envío Estado Cuenta Histórico

POST /api.backoffice/v2/envioEstadoCuentaHistorico

POST /api.backoffice/v2/abonos

Este método nos permitirá obtener los abonos realizados a un cliente, se obtendrán los abonos ordenados por “fechaDeAbono” descendente

Request body

Consulta Abono Request

Responses

200 OK

Respuesta Exitosa

Body

Consulta Abono Response

401 Unauthorized

Autenticación no válida

POST /api.backoffice/v2/transacciones

Este método nos permite consultar transacciones, ordenadas por “fechaTransaccion” descendente

Request body

Consulta Transacciones Request

Responses

200 OK

Respuesta exitosa

Body

Consulta Transacciones Response

401 Unauthorized

Autenticación no válida

POST /api.backoffice/v2/envioDetalleAbono

Este método nos permite solicitar el envío a un correo del detalle de transacciones de un abono

Request body

Mail Abono Transacciones Request

Responses

200 OK

Respuesta Exitosa

Body

Mail Abono Transacciones Response

401 Unauthorized

Autenticación no válida

POST /api.backoffice/v2/envioEstadoCuenta

Este método nos permite solicitar el envío a un correo de un estado de cuenta

Request body

Mail Estado Cuenta Request

Responses

200 OK

Respuesta exitosa

Body

Mail Estado Cuenta Response

401 Unauthorized

Autenticación no válida

POST /api.backoffice/v2/envioEstadoCuentaHistorico

Este método nos permite solicitar el envío de estados de cuenta históricos a un correo

Request body

Mail Estado Cuenta Historico Request

Responses

200 OK

Respuesta exitosa

Body

Mail Estado Cuenta Historico Response

401 Unauthorized

Autenticación no válida

Estructuras de entrada y salida para la consulta de abonos

Estructura de la petición para consultar abonos, se listará ordenado por fecha de abono de forma descendente

Object

fecha

string required

Fecha en que se realizó la petición en formato YYYY-MM-DD

Example:

2020-01-13

hora

string required

Hora en que se realizó la petición en formato de 24 horas HH:MI:SS

Example:

10:00:00

datos

Object required

codigoComercio

string required

Código NBO en el backend

Example:

001105563

fechaAbonoDesde

string

Fecha de inicio para el rango de busqueda de los abonos

Example:

01/09/2019

fechaAbonoHasta

string

Fecha de fin para el rango de busqueda de los abonos

Example:

30/09/2019

estadoAbono

string

Proceso actual del pago del abono, si no se quiere especificar enviar el caracter de string vacio “”, de lo contrario enviar concatenado con “,” cualquiera de estos valores, ejemplo “1,2” o “4,6”

Enumeration:

PAGO NO PROCESADO

PAGO ENVIADO

PAGO CONFIRMADO

PAGO RECHAZADO

PAGO REPROCESADO (M)

PAGO REPROCESADO (A)

PAGO RETENIDO

codigoAbono

string

Código del abono en backoffice Vendemas, si no se quiere espeficar enviar el caracter de string vacio

Example:

20190718_394_001105563

montoMinimo

string

Busca los abonos cuyo monto no sea menor a este parámetro, si no se quiere espeficar enviar el caracter de string vacio

Example:

1520.51

montoMaximo

string

Busca los abonos cuyo monto sea menor o igual a este paramétro, si no se quiere espeficar enviar el caracter de string vacio “”

Example:

2040.13

pagina

integer required

Total de paginas a traer, si no se quiere especificar colocar -1

filasXPagina

integer required

Total de filas por pagina a traer, si no se quiere especificar colocar -1

Examples

Ejemplo de consulta de abono

{
"fecha": "2020-05-29",
    "hora": "10:44:00",
    "datos": {
        "codigoComercio": "001105563",
        "fechaAbonoDesde": "01/01/2020",
        "fechaAbonoHasta": "31/01/2020",
        "estadoAbono": "1,2",
        "codigoAbono": "20190718_394_001105563",
        "montoMinimo": "1520.51",
        "montoMaximo": "2040.13",
        "pagina":-1,
        "filasXPagina":-1
    }
}

Estructura de salida de la respuesta de consulta de abonos

Object

fecha

string

Fecha en que se obtuvo la respuesta en formato YYYY-MM-DD

Example:

2019-11-28

hora

string

Hora en que se obtuvo la respuesta en formato de 24 horas HH:MI:SS

Example:

16:07:58

codigoRespuesta

string

Código interno del tipo de respuesta

Enumeration:

Consulta exitosa, con datos

Error Interno del servidor

Petición con formato incorrecto

Token de seguridad inválido

Consulta exitosa, pero no existen datos de abonos

mensajeRespuesta

string

Descripcion de la respuesta

Example:

EXITO

operacion

string

Endpoint que fue consultado

datos

ObjAbonosInformacion

Si hay error en la petición no devolverá este atributo

Examples

Consulta con 2 abonos en respuesta

{
	"fecha": "2020-06-06",
	"hora": "23:56:01",
	"codigoRespuesta": "00",
	"mensajeRespuesta": "EXITO",
	"operacion": "api.backoffice/v2/abonos",
	"datos": {
		"lista": [{
			"rowNum": "1",
			"id": "5735",
			"codigoAbono": "20190724_397_001105563",
			"codigoNbo": "001105563",
			"cuentaAbono": "****************2344",
			"fechaTransaccionInicial": "26-06-2019 12:00:00",
			"fechaTransaccionFinal": "28-06-2019 12:00:00",
			"fechaProceso": "20190724",
			"fechaRegistro": "24-07-2019 02:31:37",
			"fechaRegularizacion": "01-01-1900 12:00:00",
			"fechaRetencion": "01-01-1900 12:00:00",
			"fechaDeAbono": "24-07-2019 02:31:37",
			"idMoneda": "604",
			"importeNetoDepositar": "14.27",
			"importeVenta": "14.6",
			"igv": "14.6",
			"comisionPorVenta":"3.2",
			"nombrePropietarioCuenta": "ESTEBAN ROMERO VELASTEGUI",
			"nombreBanco": "BANCO INTERBANK",
			"tipoCuentaBancaria": "CUENTA CORRIENTE",
			"tipoPago": "CUENTA BANCARIA",
			"tipoDocumentoPago": "CARNE EXTRANJERO",
			"numeroDocumentoPago": "001105563",
			"razonSocial": "TI VENDEMAS  LEGAL",
			"representanteLegal": "ESTEBAN ROMERO VELASTEGU_",
			"totalTransacciones": 12,
			"estadoAbono":"4",
			"descripcionEstadoAbono": "PAGO RECHAZADO"
			"codigoRechazo": "01"
			"descripcionRechazo": "Cuenta no existe"
		}, {
			"rowNum": "2",
			"id": 5945,
			"codigoAbono": "20190718_394_001105563",
			"codigoNbo": "001105563",
			"cuentaAbono": "****************2344",
			"fechaTransaccionInicial": "17-07-2019 12:00:00",
			"fechaTransaccionFinal": "17-07-2019 12:00:00",
			"fechaProceso": "20190718",
			"fechaRegistro": "18-07-2019 02:33:29",
			"fechaRegularizacion": "01-01-1900 12:00:00",
			"fechaRetencion": "01-01-1900 12:00:00",
			"fechaDeAbono": "24-07-2019 02:31:37",
			"idMoneda": 604,
			"importeNetoDepositar": "0.98",
			"importeVenta":"1",
			"igv": "14.6",
			"comisionPorVenta":"3.2",
			"nombrePropietarioCuenta": "ESTEBAN ROMERO VELASTEGUÍ",
			"nombreBanco": "BANCO INTERBANK",
			"tipoCuentaBancaria": "CUENTA CORRIENTE",
			"tipoPago": "CUENTA BANCARIA",
			"tipoDocumentoPago": "CARNE EXTRANJERO",
			"numeroDocumentoPago": "001105563",
			"razonSocial": "TI VENDEMAS  LEGAL",
			"representanteLegal": "ESTEBAN ROMERO VELASTEGUÍ",
			"totalTransacciones": 1,
			"estadoAbono":"4",
			"descripcionEstadoAbono": "PAGO RECHAZADO",
			"codigoRechazo": "01"
			"descripcionRechazo": "Cuenta no existe"
		}]
	}
}

Informacion de los abonos, lista en forma de array, y datos de paginación

Object

lista

Array of ObjAbono

paginado

ObjPaginado

Estructura de objeto de abono en respuesta de petición de Consulta de Abonos

Object

string

Correlativo interno de la base de datos

Example:

5945

codigoAbono

string

Concatenación de fechaProceso + ‘’ + Lote correlativo que siempre es menor que 999 + '’ + Codigo_nbo

Example:

20190718_394_001105563

codigoNbo

string

Código NBO del comercio

Example:

001105563

cuentaAbono

string

Cuenta de abono registrada por el comercio truncada

Example:

****************2344

fechaTransaccionInicial

string

Fecha de la primera transacción que compone el abono

Example:

2019-07-17 12:00:00

fechaTransaccionFinal

string

Fecha de la última transacción que compone el abono

Example:

2019-07-17 12:00:00

fechaProceso

string

Fecha de cuadre en que se realizó el pago en formato

Example:

2020-03-16 00:00:00

fechaRegistro

string

Fecha de la creación de este registro, similar a la anterior en formato dd-mm-yyyy hh:mm:ss

Example:

2019-07-18 02:33:29

fechaRegularizacion

string

Fecha de regularizacion del abono

Example:

2020-01-01 12:00:00

fechaRetencion

string

Fecha de retencion del abono

Example:

2020-01-01 12:00:00

fechaDeAbono

string

Especifica la fecha del abono

Example:

2020-06-04 00:00:00

idMoneda

string

Código de la moneda del pago,únicamente se trabaja con 604 = soles

Enumeration:

604

Nuevos Soles

importeNetoDepositar

number

Importe que se va a depositar ya con los descuentos respectivos

Example:

32531.21

importeVenta

number

Monto de la suma de las transacciones que se van a depositar

Example:

34096.27

igv

number

Monto del igv del abono, es de la suma del igv de las transacciones

Example:

238.74

comisionPorVenta

number

Comisión de la venta

Example:

1326.32

nombrePropietarioCuenta

string

Nombre de la persona que aparece cómo dueña de la cuenta a la que se va a depositar

Example:

ESTEBAN ROMERO VELASTEGUÍ

nombreBanco

string

Nombre del banco de la cuenta a la cual se va a depositar

Example:

BANCO INTERBANK

tipoCuentaBancaria

string

Tipo de cuenta bancaria especificada por el cliente al momento de ingresar a la base de datos de comercios de VendeMás

Example:

NO DEFINIDA - CUENTA CORRIENTE - CUENTA AHORROS - CUENTA ESPECIAL - TARJETA

tipoPago

string

Identifica porque medios se va a realizar el pago, el dueño del negocio lo especifica al momento de crear su cuenta.

Example:

COBRO CON QR - CUENTA BANCARIA - MÁS TARDE - TARJETA VENDEMÁS

tipoDocumentoPago

string

Tipo del documento de identificación del dueño del negocio al momento de inscribirse en Vendemas

Example:

DNI - PASAPORTE - PERMISO TEMPORAL PERMANENCIA - RUC - NO DEFINIDO

numeroDocumentoPago

string

Forma de identificar al dueño de la empresa que debe coincidir con el dueño de la cuenta bancaria

Example:

001105563

razonSocial

string

Nombre de la empresa registrada en VendeMás especificada por el dueño al momento de registrarse.

Example:

TI VENDEMAS LEGAL

representanteLegal

string

Nombre del dueño de la empresa

Example:

ESTEBAN ROMERO VELASTEGUÍ

totalTransacciones

integer

Total de transacciones que están involucradas en el pago

Example:

estadoAbono

string

Estado del proceso del abono

Enumeration:

PAGO NO PROCESADO

PAGO ENVIADO

PAGO CONFIRMADO

PAGO RECHAZADO

PAGO REPROCESADO (M)

PAGO REPROCESADO (A)

PAGO RETENIDO

descripcionEstadoAbono

string

Descripción de acuerdo al código de “estadoAbono”

nota

string

Descripción del rechazo de un abono

recaudos

number

Monto de pagos de prestamos

desembolsos

number

Monto prestado

contracargos

number

ajustes_positivos

number

Ajustes a favor de comercio

ajustes_negativos

number

Ajustes a favor de Niubiz

Estructura de la petición para consultar transacciones

Object

fecha

string required

Fecha en que se realizó la petición en formato YYYY-MM-DD

Example:

2020-01-13

hora

string required

Hora en que se realizó la petición en formato de 24 horas HH:MI:SS

Example:

10:00:00

datos

Object required

codigoComercio

string required

Código NBO al que pertenece la transacción, si no se quiere espeficar enviar el caracter de string vacio “”

codigoAbono

string

Código del abono en backoffice Vendemas, si no se quiere espeficar enviar el caracter de string vacio “”

Example:

20190902_424_840468052

fechaTransaccionDesde

string

Fecha para buscar transacciones desde una fecha determinada, si no se quiere espeficar enviar el caracter de string vacio

Example:

01/09/2019

fechaTransaccionHasta

string

Fecha para buscar transacciones hasta una fecha determinada (todas las que ocurrieron en dicha fecha hasta las 23:59:59), si no se quiere espeficar enviar el caracter de string vacio

Example:

01/10/2019

idTransaccion

string

ID de Transacción, si no se quiere espeficar enviar el caracter de string vacio “”

estadoTransaccion

string

Tipo de proceso actual de la transacción, si no se quiere espeficar enviar el caracter de string vacio “”

Enumeration:

NO PROCESADA

SIN PROCESAR

LIBERADA

CONFIRMACION ABONO

CUADRE DIARIO

TRANSACCION A PAGAR/COBRAR

PAGO ENVIADO

PAGADA

RETENIDA AUTOMATICAMENTE

REGULARIZADO

ANULADO

tipoTransaccion

string

Tipo de transacción,si no se quiere espeficar enviar el caracter de string vacio “”

Enumeration:

AJUSTE

ANULACION

CONTRACARGO

TARJETA

montoMinimo

string

Busca las transacciones cuyo monto no sea menor a este parámetro, si no se quiere espeficar enviar el caracter de string vacio “”

Example:

1520.50

montoMaximo

string

Busca las transacciones cuyo monto sea menor o igual a este paramétro, si no se quiere espeficar enviar el caracter de string vacio “”

Example:

2045.24

pagina

integer required

Total de paginas a traer, si no se quiere especificar colocar -1

filasXPagina

integer required

Total de filas por pagina a traer, si no se quiere especificar colocar -1

Examples

{
    "fecha": "2020-01-13",
    "hora": "10:00:00",
    "datos": {
        "codigoComercio": "",
        "codigoAbono": "20190225_292_849099088",
        "fechaTransaccionDesde": "01/09/2019",
        "fechaTransaccionHasta": "01/10/2019",
        "idTransaccion": "",
        "estadoTransaccion": "4",
        "tipoTransaccion": "CONTRACARGO",
        "montoMinimo": "",
        "montoMaximo": "",
        "maxFilas":20
    }
}

Object

fecha

string

Fecha en que se obtuvo la respuesta en formato YYYY-MM-DD

Example:

2019-11-28

hora

string

Hora en que se obtuvo la respuesta en formato de 24 horas HH:MI:SS

Example:

16:07:58

codigoRespuesta

string

Código de respuesta

Enumeration:

Consulta exitosa, con datos de transacciones

Error Interno del servidor

Petición con formato incorrecto

Token de seguridad inválido

Consulta exitosa, pero no existen datos de transacciones

mensajeRespuesta

string

Descripcion de la respuesta

Example:

EXITO

operacion

string

Endpoint que fue consultado

Example:

api.backoffice/v2/transacciones

datos

ObjTransaccionesInformacion

Si hay error en la petición no devolverá este atributo

Examples

{
    "fecha": "2019-11-28",
    "hora": "16:07:58",
    "codigoRespuesta": "12",
    "mensajeRespuesta": "EXITO",
    "operacion": "api.backoffice/v2/transacciones",
    "datos": {
        "lista": [
            {
                "rowNum": "1",
                "codigoAbono": "20190225_292_849099088",
                "codigoComercio": "849099088",
                "codigoLocal": "12785",
                "codigoNbo": "849099088",
                "codigoOperacion": "bfe39502",
                "cuentaAbono": "1931933445046",
                "dispositivo": "SAMSUNG SM-J701M ANDROID 8.1.0",
                "descripcionProducto":"POKET",
                "documentoAbono": "665218",
                "fechaTransaccion": "22-02-2019 10:36:41",
                "idUnico": "1670437",
                "marcaTarjeta": "MASTERCARD",
                "moneda": "604",
                "montoTransaccion": "222.91",
                "igv": "40.12",
                "nombreAbono": "EMPRESA S.A.C.",
                "nombreBanco": "BANCO DE CREDITO",
                "nombreLocal": "BIODERMA",
                "numeroCuentaBancaria": "1931933445046",
                "numeroTarjeta": "511842******7193",
                "tipoPago": "CUENTA BANCARIA",
                "tipoTarjeta": "Débito",
                "tipoTransaccion": "Tarjeta",
                "transactionId": "155084980121",
                "estadoTransaccion": "10",
                "descripcionEstadoTransaccion": "Pagada"
            },
            {
                "rowNum": "2",
                "codigoAbono": "20190225_292_849099088",
                "codigoComercio": "849099088",
                "codigoLocal": "12785",
                "codigoNbo": "849099088",
                "codigoOperacion": "bfe39502",
                "cuentaAbono": "1931933445046",
                "dispositivo": "SAMSUNG SM-J701M ANDROID 8.1.0",
                "descripcionProducto":"POKET",
                "documentoAbono": "665218",
                "fechaTransaccion": "22-02-2019 10:36:41",
                "idUnico": "1670437",
                "marcaTarjeta": "MASTERCARD",
                "moneda": "604",
                "montoTransaccion": "222.91",
                "igv": "40.12",
                "nombreAbono": "EMPRESA S.A.C.",
                "nombreBanco": "BANCO DE CREDITO",
                "nombreLocal": "BIODERMA",
                "numeroCuentaBancaria": "1931933445046",
                "numeroTarjeta": "511842******7193",
                "tipoPago": "CUENTA BANCARIA",
                "tipoTarjeta": "Débito",
                "tipoTransaccion": "Tarjeta",
                "transactionId": "155084980121",
                "estadoTransaccion": "10",
                "descripcionEstadoTransaccion": "Pagada"
            }
        ]
    }
}

Informacion de las transacciones, lista en forma de array, y datos de paginación

Object

lista

Array of ObjTransaccion

paginado

ObjPaginado

Estructura de una transaccion

Object

codigoAbono

string

Código de abono

Example:

20190225_292_849099088

codigoComercio

string

Código de comercio

Example:

849099088

codigoLocal

string

Example:

12785

codigoNbo

string

Example:

849099088

codigoOperacion

string

Example:

bfe39502

cuentaAbono

string

Example:

1931933445046

dispositivo

string

Dispositivo usado

Example:

SAMSUNG SM-J701M ANDROID 8.1.0

documentoAbono

string

Example:

665218

fechaTransaccion

string

Fecha en que se llevó a cabo la transaccion

Example:

2019-02-22 10:36:41

idUnico

string

Example:

1670437

marcaTarjeta

string

Marca de la tarjeta

Example:

MASTERCARD

moneda

string

Tipo de moneda

Example:

604

montoTransaccion

number

Monto de la transacción

Example:

55.69

igv

number

IGV de la transacción

Example:

0.39

nombreAbono

string

Nombre de a quien se abonará

Example:

EMPRESA S.A.C.

nombreBanco

string

Nombre de local

Example:

BANCO DE CREDITO

nombreLocal

string

Nombre de local

Example:

BIODERMA

numeroCuentaBancaria

string

Número de cuenta bancaria

Example:

1931933445046

numeroTarjeta

string

Número de tarjeta truncada

Example:

511842******7193

tipoPago

string

Tipo de pago

Example:

CUENTA BANCARIA

tipoTarjeta

string

Tipo de tarjeta usada

Example:

Débito

tipoTransaccion

string

Tipo de la transacción

Example:

Tarjeta

transactionId

string

Id de transaccion

Example:

155084980121

estadoTransaccion

string

Código identificador del estado de una transaccion

Enumeration:

NO PROCESADA

SIN PROCESAR

LIBERADA

CONFIRMACION ABONO

CUADRE DIARIO

TRANSACCION A PAGAR/COBRAR

PAGO ENVIADO

PAGADA

RETENIDA AUTOMATICAMENTE

REGULARIZADO

ANULADO

descripcionEstadoTransaccion

string

Descripción del estado de la transacción de acuerdo al código anterior

Example:

Pagada

terminalId

string

Examples:

MPOS0001079050604524236K342344

tipoCaptura

string

Example:

Chip

Estructura para solicitar el envio de un estado de cuenta

Object

fecha

string required

Fecha en que se realizó la petición en formato YYYY-MM-DD

Example:

2020-01-13

hora

string required

Hora en que se realizó la petición en formato de 24 horas HH:MI:SS

Example:

10:00:00

datos

Object

correo

string required

Correo para enviar el estado de cuenta

Example:

jonathan.camacho@vendemas.com.pe

codigoNbo

string required

Código Nbo del comercio

Example:

001105563

anio

string required

Año del estado de cuenta

Example:

2020

mes

string required

Mes del estado de cuenta

Enumeration:

Enero

Febrero

Marzo

Abril

Mayo

Junio

Julio

Agosto

Setiembre

Octubre

Noviembre

Diciembre

Examples

{
    "fecha": "2020-01-13",
    "hora": "10:00:00",
    "datos": {
        "correo": "jonathan.camacho@vendemas.com.pe",
        "codigoNbo": "001105563",
        "anio": "2020",
        "mes": "08"
    }
}

Estructura de respuesta de la solicitud de envío de un estado de cuenta

Object

fecha

string

Fecha en que se obtuvo la respuesta en formato YYYY-MM-DD

Example:

2019-11-28

hora

string

Hora en que se obtuvo la respuesta en formato de 24 horas HH:MI:SS

Example:

16:07:58

codigoRespuesta

string

Código interno del tipo de respuesta

Enumeration:

Se registró solicitud

No se registró solicitud. Error Interno del servidor

No se registró solicitud. Petición con formato incorrecto

No se registró solicitud. Token de seguridad inválido

No se registró solicitud. No existen datos para enviar

mensajeRespuesta

string

Descripcion de la respuesta

Example:

EXITO

operacion

string

Endpoint que fue consultado

Example:

api.backoffice/v2/envioEstadoCuenta

Examples

{
    "fecha": "2019-11-28",
    "hora": "16:07:58",
    "codigoRespuesta": "12",
    "mensajeRespuesta": "EXITO",
    "operacion": "api.backoffice/v2/envioEstadoCuenta"
}

Estructura para solicitar el envío del detalle completo de un abono al correo electrónico

Object

fecha

string required

Fecha en que se realizó la petición en formato YYYY-MM-DD

Example:

2020-01-13

hora

string required

Hora en que se realizó la petición en formato de 24 horas HH:MI:SS

Example:

10:00:00

datos

Object

correo

string required

Correo para enviar el estado de cuenta

Example:

jonathan.camacho@vendemas.com.pe

codigoNbo

string required

Código Nbo del comercio

Example:

001105563

codigoAbono

string required

Código de abono del comercio

Example:

20190906_428_001105563

Examples

{
    "fecha": "2020-01-13",
    "hora": "10:00:00",
    "datos": {
        "correo": "jonathan.camacho@vendemas.com.pe",
        "codigoNbo": "001105563",
        "codigoAbono": "20190906_428_001105563"
    }
}

Estructura de respuesta al solicitar el envío del mail del detalle de transacciones de un abono.

Object

fecha

string

Fecha en que se obtuvo la respuesta en formato YYYY-MM-DD

Example:

2019-11-28

hora

string

Hora en que se obtuvo la respuesta en formato de 24 horas HH:MI:SS

Example:

16:07:58

codigoRespuesta

string

Código interno del tipo de respuesta

Enumeration:

Se registró solicitud

No se registró solicitud. Error Interno del servidor

No se registró solicitud. Petición con formato incorrecto

No se registró solicitud. Token de seguridad inválido

No se registró solicitud. No existen datos para enviar

mensajeRespuesta

string

Descripcion de la respuesta

Example:

EXITO

operacion

string

Endpoint que fue consultado

Example:

api.backoffice/v2/envioDetalleAbono

Examples

{
    "fecha": "2019-11-28",
    "hora": "16:07:58",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "api.backoffice/v2/envioDetalleAbono"
}

Estructura para solicitar el envio de estados de cuenta históricos

Object

fecha

string

Fecha en que se realizó la petición en formato YYYY-MM-DD

Example:

2020-01-13

hora

string

Hora en que se realizó la petición en formato de 24 horas HH:MI:SS

Example:

10:00:00

datos

Object

correo

string required

Correo para enviar los estados de cuenta

Example:

jonathan.camacho@vendemas.com.pe

codigoNbo

string required

Código Nbo del comercio

Example:

001105563

anioInicio

string required

Año para el rango de inicio de los estados de cuenta a enviar

Example:

2019

mesInicio

string required

Mes para el rango de inicio de los estados de cuenta a enviar

Enumeration:

Enero

Febrero

Marzo

Abril

Mayo

Junio

Julio

Agosto

Setiembre

Octubre

Noviembre

Diciembre

anioFin

string

Año para el rango de fin de los estados de cuenta a enviar

Example:

2020

mesFin

string

Mes para el rango de fin de los estados de cuenta a enviar

Enumeration:

Enero

Febrero

Marzo

Abril

Mayo

Junio

Julio

Agosto

Setiembre

Octubre

Noviembre

Diciembre

Examples

{
    "fecha": "2020-01-13",
    "hora": "10:00:00",
    "datos": {
        "correo": "jonathan.camacho@vendemas.com.pe",
        "codigoNbo": "001105563",
        "anioInicio": "2019",
        "mesInicio": "10",
        "anioFin": "2020",
        "mesFin": "09"
    }
}

Estructura de respuesta al solicitar el envío del mail de estado de cuenta históricos

Object

fecha

string

Fecha en que se obtuvo la respuesta en formato YYYY-MM-DD

Example:

2019-11-28

hora

string

Hora en que se obtuvo la respuesta en formato de 24 horas HH:MI:SS

Example:

16:07:58

codigoRespuesta

string

Código interno del tipo de respuesta

Enumeration:

Se registró solicitud

No se registró solicitud. Error Interno del servidor

No se registró solicitud. Petición con formato incorrecto

No se registró solicitud. Token de seguridad inválido

No se registró solicitud. No existen datos para enviar

mensajeRespuesta

string

Descripción de la respuesta

Example:

EXITO

operacion

string

Endpoint que fue consultado

Example:

api.backoffice/v2/envioEstadoCuentaHistorico

Examples

{
    "fecha": "2019-11-28",
    "hora": "16:07:58",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "api.backoffice/v2/envioEstadoCuentaHistorico"
}

Objeto indicador de datos de paginación de una consulta realizada

Object

totalRegistros

integer

En base a los parámetros ingresados, cuantos registros hay en total en la base de datos de acuerdo a la consulta

Example:

totalPaginas

integer

En base a los parámetros de consulta ingresados, cuantas páginas se obtienen

Example: