Recibo de Cobro

Esta API es esencial para la gestión de cuentas por cobrar, permitiendo tanto el registro de nuevos recibos de cobranza como la generación de listados de saldos pendientes. Un recibo se considera con saldo pendiente si aún no se ha vinculado a las facturas o notas de crédito que lo generan.

URL y Servicio

• Descripción del WSDL: https://api.zetasoftware.com/z.apis.asoapreciboscobranzav2?wsdl
• URL del Servicio: https://api.zetasoftware.com/z.apis.asoapreciboscobranzav2

Método QueryPendientes

Este método es su herramienta para consultar y generar listados de saldos pendientes en los recibos de cobro.

Filtros

• Anio (N(AAAA)): El año es un filtro obligatorio, y debe ser un nùmero de 4 dìgitos. .
• ClienteCodigo (T(10)): Identificador del cliente.
• Id: Este campo debe enviarse vacío. Representa el secuencial interno de la aplicación, crucial para los métodos subsiguientes.
• ComprobanteCodigo (N(13)): Código del comprobante.
• FechaDesde y FechaHasta (AAAA-MM-DD): Rango de fechas dentro del año seleccionado para filtrar los registros.
• Serie (T(6)) y Numero (N(10)): Detalles del comprobante.
• MonedaCodigo (N(2)), LocalCodigo (N(3)), CobradorCodigo (N(3)): Más filtros para especificidad.
• SaldoDesde (N(6)) y SaldoHasta (N(6)): Definen el rango de saldos de los comprobantes.
• Emitido (T(1)): Obligatorio. Indica si el comprobante ha sido emitido. Valores admitidos son ‘S’ para sí y ‘N’ para no.
• Page (N(2)): Obligatorio. Controla la paginación de los resultados.

Datos de Salida

• RegistroId: Identificador único 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: Si ‘true’, indica que se está mostrando la última página con registros.

Consideraciones

Este método, como se puede apreciar, es altamente configurable mediante el uso de múltiples filtros. Los desarrolladores deben estar conscientes de la necesidad de filtrar de forma adecuada para obtener resultados precisos y útiles. La paginación controlada a través del parámetro Page facilita el manejo de grandes conjuntos de datos y permite un rendimiento optimizado de la aplicación. Sin un entendimiento profundo de estos filtros y parámetros, uno podría enfrentar desafíos en la interpretación y manejo de los datos financieros, lo cual es crítico en el contexto de cuentas por cobrar.

Método Data

El método Data está diseñado para proporcionar un conjunto detallado de datos relativos a un recibo de cobranza en particular. A diferencia del método QueryPendientes, que es útil para obtener listados de registros, Data se enfoca en desplegar la información completa de un único registro.

Filtros

• RegistroId (N(6)): Este parámetro es obligatorio y representa el numerador secuencial generado por la aplicación. La clave para este campo es el valor que se obtiene al ejecutar el método QueryPendientes. En otras palabras, primero debe consultar el listado de saldos pendientes para luego obtener el detalle de un recibo en específico utilizando este método.

Datos de Salida

Los resultados que se obtienen son idénticos en estructura a los del método QueryPendientes, pero en este caso, cada campo estará relacionado con un único recibo de cobranza. Estos son:

• ComprobanteCodigo, ComprobanteAbreviacion, ComprobanteNombre
• ClienteCodigo, ClienteNombre, ClienteRazonSocial
• Fecha, Serie, Numero, MonedaCodigo, MonedaSimbolo, MonedaNombre
• Descripcion, CobradorCodigo, CobradorNombre, CajaCodigo, CajaNombre, LocalCodigo, LocalNombre
• Total, TotalSigno, Saldo, SaldoSigno, Emitido

Consideraciones Prácticas

Es esencial que los desarrolladores comprendan la necesidad de ejecutar primero el método QueryPendientes para poder utilizar Data de manera efectiva. Este procedimiento asegura que se está consultando información detallada de un recibo que efectivamente se desea examinar. Es especialmente útil cuando se necesita realizar una revisión exhaustiva o una auditoría de un recibo en particular, ya que proporciona todos los datos necesarios para una comprensión completa del estado de la cobranza.

Método Load

El método Load es fundamental cuando se trata de cargar o modificar datos de un recibo de cobranza específico en la base de datos. Al igual que el método Data, Load también requiere que se haya ejecutado previamente el método QueryPendientes para obtener el RegistroId necesario.

Filtros

• RegistroId (N(6)): Es un parámetro obligatorio y corresponde al numerador secuencial generado por la aplicación. Este identificador único se adquiere a través de la ejecución del método QueryPendientes.

Datos de Salida

La estructura de los datos de salida es similar a los métodos previos, QueryPendientes y Data. Sin embargo, la finalidad aquí es diferente, ya que este método se emplea para cargas o modificaciones:

• ComprobanteCodigo, ComprobanteAbreviacion, ComprobanteNombre
• ClienteCodigo, ClienteNombre, ClienteRazonSocial
• Fecha, Serie, Numero, MonedaCodigo, MonedaSimbolo, MonedaNombre
• Descripcion, CobradorCodigo, CobradorNombre, CajaCodigo, CajaNombre, LocalCodigo, LocalNombre
• Total, TotalSigno, Saldo, SaldoSigno, Emitido

Consideraciones para Desarrolladores

Aunque Load ofrece una salida de datos similar a Data, es crucial entender que este método está diseñado para modificar o cargar nuevos datos. Por tanto, su ejecución debe ser cuidadosamente planificada y validada. De lo contrario, podrían introducirse errores que afecten la integridad de los datos de la aplicación. Es altamente recomendable realizar pruebas exhaustivas antes de implementar cambios en un entorno de producción.

Método Save

El método Save está diseñado específicamente para registrar nuevos recibos de cobro en la base de datos de la empresa. Es vital tener en cuenta que este método no proporciona funcionalidades para asignar forma ni documentos de pago. Para tales propósitos, los desarrolladores deben recurrir a la API de Facturas de Cliente.

Filtros

• RegistroId: Este campo debe enviarse con un valor de cero. Se asignará de manera automática y secuencial por ZetaSoftware.
• ComprobanteCodigo (N(3)): Es un campo obligatorio que identifica el código del comprobante.
• Serie (T(6)), Numero (N(10)): Campos opcionales relacionados con la serie y número del comprobante.
• Fecha (AAAA-MM-DD): Es un campo obligatorio que indica la fecha del recibo de cobro.
• MonedaCodigo (N(2)): Obligatorio, para especificar la moneda en la que se realiza el cobro.
• Cotizacion (N(7.7)): Campo opcional para la cotización de la moneda.
• ClienteCodigo (T(10)): Obligatorio, identifica al cliente.
• Descripcion (T(30)), CobradorCodigo (N(3)): Campos opcionales para detalles adicionales y el código del cobrador.
• LocalCodigo (N(3)), CajaCodigo (N(3)): Son campos obligatorios que indican el local y la caja donde se realiza el cobro.
• Total (N(12.2)): Obligatorio, indica la cantidad total del cobro.
• UsuarioCodigo (N(3)): Obligatorio, identifica al usuario que realiza la operación.
• Notas (T(50)), ReciboEmitido (T(1)): Son campos opcionales y obligatorios respectivamente, para anotaciones y estado del recibo.

Datos de Salida

• Succeed / Mensaje: Este resultado indica si la operación fue exitosa o no, y en caso de fallo, proporciona un mensaje descriptivo.

Consideraciones para Desarrolladores

El método Save es una herramienta potente pero restrictiva. La imposibilidad de asignar formas y documentos de pago directamente hace esencial una comprensión profunda del flujo de trabajo antes de su implementación. Debido a la naturaleza crítica de la información financiera, es crucial asegurar que los datos ingresados sean precisos. Esto requiere un rigoroso proceso de validación y pruebas antes de su utilización en entornos de producción. Cualquier error podría llevar a inconsistencias en los datos financieros, lo cual es inaceptable en cualquier sistema empresarial.