Venvers

API Comprobantes

Venvers cuenta con una API REST diseñada para simplificar la integración con sistemas ERP u otras plataformas. Esta interfaz permite consultar y descargar comprobantes, así como gestionar y programar los pagos mediante el consumo de endpoints específicos.

Navegación del tema

Venvers

API Comprobantes

API Órdenes de compra

Ambientes productivo y demo

A continuación se presentan los enlaces a los ambientes Productivo y Demo de la API de Comprobantes.

URL productiva

https://app.venvers.com/services/api/

URL demo

https://venvers.detecnodev.mx/integration/api/

Endpoints

Trae la lista de los comprobantes cargados /api/Comprobante/GetComprobantesServicio
Descarga los comprobantes /api/Comprobante/DescargaArchivo
Actualiza el estatus comercial /api/Comprobante/ActualizarEstatusComercial
Programa un pago /api/Comprobante/ProgramacionPago
Publica un pago /api/Conciliacion/PublicarPago
1. 1. - Registra información adicional /api/Comprobante/CamposExtra
    - Registra un usuario /api/Usuario/AgregarUsuarios
    - Actualiza un usuario /api/Usuario/EditarUsuario
    - Elimina un usuario /api/Usuario/BorrarUsuario
    - Registra un proveedor /api/Proveedor/AgregarProveedorUsuarios
    - Trae la lista de los porveedores registrados /api/Proveedor/GetProveedoresParams
    - Actualiza un proveedor /api/Proveedor/EditarProveedor
    - Elimina un proveedor /api/Proveedor/BorrarProveedor

Funciones de la API

A continuación, se describen las funciones de la API de Comprobantes.

Comprobante

GetComprobantesServicio

Obtiene la lista de comprobantes cargados por el proveedor en el portal de Venvers.

Se especifican algunos de los parámetros de búsqueda.

Se obtiene una lista de los comprobantes cargados.

DescargaArchivo

Descarga el archivo XML o PDF del comprobante.

Se le envía el idComprobante y el tipo de archivo deseado (XML, PDF o Todos).

Se obtiene el XML, el PDF, o un archivo ZIP conteniendo ambos formatos.

ActualizarEstatusComercial

Modifica el estatus comercial de un comprobante.

Se le envía: idComprobante, estatus, mensaje, usuario, fecha y hora.

Se obtiene una respuesta de la solicitud (success, responseCode y mensaje).

ProgramacionPago

Asigna la fecha programada de pago a un comprobante.

Se envía la fecha estimada de pago y el idComprobante.

Se obtiene el estatus del pago programado.

CamposExtra

Registra información adicional de un comprobante.

Se le envía: idComprobante, EtiquetaExtra1, ValorExtra1, EtiquetaExtra2, ValorExtra2.

Se obtiene una respuesta de la solicitud (success, message, responseCode, y data).

Conciliacion

PublicarPago

Publica la información de un pago aplicado a uno o varios comprobantes.

Se le envía: fechaPago, montoPagado, parcialidad, uuidPrincipal.

Se obtiene el uuidPrincipal del comprobante relacionado y un mensaje con el resultado de la operación.

Usuario

AgregarUsuarios

Registra uno o varios usuarios en el sistema.

Se le envía: nombre, apellido, correo, rol, cc, cco, filtroRfcReceptor y filtroRfcEmisor.

Se obtiene una respuesta de la solicitud (success, message, id, insertados y cuentaUsuario).

EditarUsuario

Actualiza los datos de un usuario.

Se envía la información actualizada con estructura JSON.

Se obtiene un archivo JSON con la información actualizada.

BorrarUsuario

Elimina un usuario registrado en el sistema.

Se envía el id del usuario.

Se obtiene una respuesta que indica que la eliminación fue exitosa.

Proveedor

AgregarProveedorUsuarios

Registra un nuevo proveedor con o sin un usuario asociado a una o a todas las empresas del grupo.

Se envía un archivo con estructura JSON con la información del proveedor y de forma opcional el usuario asociado.

Se obtiene una respuesta de la solicitud (success, responseCode, mensaje y data).

GetProveedoresParams

Consulta la lista de proveedores registrados en el sistema.

Se envía uno de los siguientes valores de la empresa: id, rfc, taxId o idErp.

Se obtiene la información de los proveedores asociados a la empresa.

EditarProveedor

Actualiza los datos de un proveedor.

Se envía la información actualizada con estructura JSON.

Se obtiene una respuesta de la solicitud (success, responseCode, mensaje y data).

BorrarProveedor

Elimina un proveedor registrado en el sistema.

Se envía el Id del proveedor.

Se obtiene una respuesta que indica que la eliminación fue exitosa.

Documentación interactiva Swagger

Swagger es una herramienta que permite visualizar y probar los endpoints de la API directamente desde el navegador. Esta interfaz facilita a los desarrolladores conocer cómo funciona cada método, qué parámetros requiere, qué respuesta devuelve, y realizar pruebas sin necesidad de herramientas externas.

Swagger Productivo

https://app.venvers.com/services/swagger/index.html

Swagger Demo

https://venvers.detecnodev.mx/integration/swagger/index.html

Prueba rápida con Postman

Podrá probar la API de Comprobantes sin necesidad de realizar desarrollos utilizando la herramienta Postman. Para facilitar las pruebas, le proporcionamos una colección de solicitudes preconfiguradas con la URL, parámetros y datos de ejemplo, lista para su ejecución. Para descargar la colección, haga clic en el siguiente enlace y, una vez abierta, seleccione la opción de descarga.

Colección de peticiones de la API de Comprobantes