Recibo de Cobro

Esta API permite la gestión de recibos de cobranza en ZetaSoftware, ofreciendo métodos para consultar, obtener detalles específicos, cargar o modificar datos y registrar nuevos recibos en la base de datos.

WSDL URL: https://api.zetasoftware.com/z.apis.asoapreciboscobranzav2?wsdl
Servicio URL: https://api.zetasoftware.com/z.apis.asoapreciboscobranzav2

Métodos Disponibles

1. QueryPendientes: Genera un listado de recibos con saldos pendientes.
2. Data: Obtiene detalles completos de un recibo específico.
3. Load: Carga o modifica datos de un recibo existente.
4. Save: Registra un nuevo recibo en la base de datos.
5. QueryComprobantes: Consulta y filtra comprobantes de cobro registrados.

1. Método QueryPendientes

Este método permite listar los recibos de cobranza que tienen saldos pendientes. Es ideal para obtener una visión general de los recibos que necesitan seguimiento.

Filtros

• ClienteCodigo: Código del cliente.
• Id: Dejar vacío; representa el secuencial interno para métodos posteriores.
• ComprobanteCodigo: Código del comprobante.
• FechaDesde y FechaHasta: Rango de fechas para los registros.
• Serie y Numero: Detalles del comprobante.
• MonedaCodigo, LocalCodigo, CobradorCodigo: Filtros adicionales para especificar moneda, local y cobrador.
• SaldoDesde y SaldoHasta: Rango de saldo de los comprobantes.
• Emitido: Obligatorio, indica si el comprobante fue emitido. Usar «S» (Sí) o «N» (No).
• Page: Obligatorio para la paginación de resultados.

Datos de Salida

• RegistroId: ID del registro.
• ComprobanteCodigo, ComprobanteAbreviacion, ComprobanteNombre
• ClienteCodigo, ClienteNombre, ClienteRazonSocial
• Fecha, Serie, Numero, MonedaCodigo, MonedaSimbolo, MonedaNombre
• Descripcion, CobradorCodigo, CobradorNombre, CajaCodigo, CajaNombre, LocalCodigo, LocalNombre
• Total, TotalSigno, Saldo, SaldoSigno, Emitido
• IsLastPage: Indica si se muestra la última página.

Consideraciones: Los filtros permiten ajustar los resultados según las necesidades. La paginación es esencial para consultas grandes.

2. Método Data

Data obtiene los detalles completos de un recibo de cobranza específico, ideal para revisar información a nivel de registro individual.

Filtro

• RegistroId: Obligatorio, el ID único del recibo. Este valor se obtiene al ejecutar QueryPendientes.

Datos de Salida

La estructura de los datos es idéntica a la de QueryPendientes, pero detallada para un solo recibo. Cada campo proporciona información precisa sobre el estado de cobranza.

Consideraciones: QueryPendientes debe ejecutarse antes para obtener el RegistroId necesario. Este método es útil para auditorías y revisiones en profundidad.

3. Método Load

Este método permite cargar o actualizar datos de un recibo existente en la base de datos. Es necesario ejecutar QueryPendientes para obtener el RegistroId.

Filtro

• RegistroId: Obligatorio, identifica el recibo que se desea actualizar.

Datos de Salida

La estructura de salida es similar a QueryPendientes y Data, con la intención de cargar o actualizar registros:

• RegistroId, ComprobanteCodigo, ClienteCodigo, Fecha, Serie, Numero, MonedaCodigo, Cotizacion
• Descripcion, CobradorCodigo, CajaCodigo, LocalCodigo, UsuarioCodigo
• Total, Notas

Consideraciones: Load se utiliza para modificar recibos existentes. Asegúrate de probar y validar los cambios para evitar inconsistencias en la información.

4. Método Save

Save permite registrar un nuevo recibo de cobranza en la base de datos. Es importante notar que este método no asigna formas de pago directamente; para ello, debe utilizarse la API de Facturas de Cliente.

Filtros

• RegistroId: Enviar como cero para que el sistema asigne un valor secuencial automáticamente.
• ComprobanteCodigo: Obligatorio, identifica el comprobante.
• Serie y Numero: Opcionales, especifican detalles del comprobante.
• Fecha: Obligatorio, fecha del recibo.
• MonedaCodigo: Obligatorio, moneda del cobro.
• Cotizacion: Opcional, cotización de la moneda.
• ClienteCodigo: Obligatorio, identifica al cliente.
• Descripcion y CobradorCodigo: Opcionales, detalles adicionales y código del cobrador.
• LocalCodigo y CajaCodigo: Obligatorios, indican el local y la caja.
• Total: Obligatorio, monto total del cobro.
• UsuarioCodigo: Obligatorio, usuario que realiza la operación.
• Notas y ReciboEmitido: Opcional y obligatorio respectivamente, para anotaciones y estado del recibo.

Datos de Salida

• Succeed / Mensaje: Indica si la operación fue exitosa o no. Si falla, proporciona un mensaje descriptivo.

Consideraciones: Save es esencial para agregar nuevos recibos. Debido a la naturaleza crítica de la información financiera, verifica que todos los datos sean correctos antes de su uso en producción.

5. Método QueryComprobantes

QueryComprobantes permite consultar y filtrar los comprobantes de cobro registrados en el sistema, proporcionando un resumen detallado.

Filtros

• Anio: Año de emisión del comprobante. Obligatorio.
• Mes: Mes de emisión. Obligatorio.
• FechaDesde y FechaHasta: Rango de fechas para la consulta.
• ClienteCodigo: Código del cliente.
• ComprobanteCodigo: Código del tipo de comprobante.
• MonedaCodigo: Código de la moneda.
• LocalCodigo: Código del local de emisión.
• CobradorCodigo: Código del cobrador.
• Page: Obligatorio, controla la paginación.

Datos de Salida

Cada registro devuelto contiene información clave sobre el comprobante de cobro:

• RegistroId: ID único del comprobante.
• ComprobanteCodigo, ComprobanteAbreviacion, ComprobanteNombre
• ClienteCodigo, ClienteNombre, ClienteRazonSocial
• Fecha, Serie, Numero
• MonedaCodigo, MonedaSimbolo, MonedaNombre
• Descripcion
• CobradorCodigo, CobradorNombre
• CajaCodigo, CajaNombre
• LocalCodigo, LocalNombre
• Total, TotalSigno
• Saldo, SaldoSigno
• Emitido

IsLastPage: Indica si es la última página de resultados.

Consideraciones: Este método permite consultar comprobantes detalladamente, siendo ideal para gestionar y analizar el historial de transacciones y gestionar pendientes.

Conexión y Seguridad

Todos los métodos requieren una conexión autenticada con los siguientes parámetros en SDTConnection:

• DesarrolladorCodigo y DesarrolladorClave: Credenciales del desarrollador.
• EmpresaCodigo y EmpresaClave: Identificación de la empresa.
• UsuarioCodigo y UsuarioClave: Identificación y contraseña del usuario que ejecuta la API.
• RolCodigo: Código del rol asignado al usuario.

Este sistema asegura que solo usuarios y desarrolladores autorizados accedan y manipulen los datos financieros, garantizando la seguridad del sistema.

Esta documentación de la API de Recibos de Cobranza de ZetaSoftware está diseñada para una implementación eficiente y un control seguro de los recibos de cobranza, proporcionando a los desarrolladores la información necesaria para optimizar sus operaciones y asegurar la precisión en la gestión de datos financieros.