Recibo de Pago

La API de Recibos de Pago proporciona funcionalidades para la gestión financiera, específicamente en el registro de nuevos recibos de pago a proveedores y la generación de listados de recibos con saldos pendientes. Un recibo se considerará con saldo pendiente si no está totalmente vinculado a las facturas de compra a crédito que originaron la deuda.

Endpoints de la API

• Descripción de la URL: https://api.zetasoftware.com/z.apis.asoaprecibospagosv1?wsdl
• Servicio: https://api.zetasoftware.com/z.apis.asoaprecibospagosv1

Método QueryPendientes

Este método permite consultar y obtener una lista de saldos pendientes para los recibos de pago generados.

Filtros de Consulta

• ProveedorCodigo (T(10)): Campo obligatorio. Indica el código del proveedor.
• Id: Debe ser enviado vacío. Sirve como valor secuencial interno que la API generará automáticamente.
• ComprobanteCodigo (N(13)): Código del comprobante, si aplica.
• FechaDesde y FechaHasta (AAAA-MM-DD): Intervalo de fechas para la consulta.
• Serie (T(6)) y Numero (N(10)): Datos adicionales del comprobante.
• MonedaCodigo (N(2)) y LocalCodigo (N(3)): Códigos para moneda y local comercial.
• SaldoDesde y SaldoHasta (N(6)): Establecen un rango de saldos pendientes para filtrar los recibos. Valor mínimo permitido es cero.
• Emitido (T(1)): Obligatorio. Indica si el recibo fue emitido o no (‘S’ para sí, ‘N’ para no).
• Page (N(2)): Para paginación, muestra 500 registros por página.

Resultado de la Consulta

• RegistroId: ID generado por la aplicación.
• ComprobanteCodigo, ComprobanteAbreviacion, ComprobanteNombre: Detalles del comprobante.
• ProveedorCodigo, ProveedorNombre, ProveedorRazonSocial: Información del proveedor.
• Fecha, Serie, Numero, MonedaCodigo, MonedaSimbolo, MonedaNombre: Detalles de la transacción.
• Descripcion, CajaCodigo, CajaNombre, LocalCodigo, LocalNombre, Total, TotalSigno, Saldo, SaldoSigno: Información adicional sobre la transacción.
• IsLastPage: Si es ‘true’, indica que la página mostrada es la última del conjunto de datos.

Método Data

El método Data ofrece una funcionalidad más detallada que complementa al método QueryPendientes. Este método se utiliza para obtener información más específica de un recibo de pago pendiente previamente identificado.

Filtros de Consulta

• RegistroId (N(6)): Campo obligatorio que representa el numerador secuencial generado por la aplicación. Este identificador se obtiene como resultado de ejecutar previamente el método QueryPendientes.

Resultado de la Consulta

Una vez que el método Data se ejecuta con éxito, devuelve la siguiente información:

• ComprobanteCodigo, ComprobanteAbreviacion, ComprobanteNombre: Estos campos describen la información relativa al comprobante asociado con el recibo de pago.
• ProveedorCodigo, ProveedorNombre, ProveedorRazonSocial: Detalles relevantes del proveedor, incluida su identificación y razón social.
• Fecha, Serie, Numero: Estos campos ofrecen datos cronológicos y numéricos del recibo de pago.
• MonedaCodigo, MonedaSimbolo, MonedaNombre: Información relativa a la moneda en la que se realizó la transacción.
• Descripcion, CajaCodigo, CajaNombre: Detalles adicionales de la transacción y el punto de venta.
• LocalCodigo, LocalNombre: Información acerca de la ubicación donde se realizó la transacción.
• Total, TotalSigno, Saldo, SaldoSigno: Campos que indican el monto total del recibo, el saldo pendiente y sus respectivos signos, que pueden ser útiles para cálculos financieros.
• Emitido: Este campo señala si el recibo de pago ha sido emitido o no.

Método Load

El método Load sirve para cargar los datos de un recibo de pago específico en el sistema. Al igual que el método Data, este método también requiere que se ejecute primero el método QueryPendientes para obtener el identificador único, conocido como RegistroId.

Filtros de Consulta

• RegistroId (N(6)): Este es un campo obligatorio. El numerador secuencial, o RegistroId, se genera a través de la aplicación y se obtiene mediante la ejecución previa del método QueryPendientes.

Resultado de la Consulta

Tras la ejecución exitosa del método Load, se devuelve una amplia gama de información relacionada con el recibo de pago:

• ComprobanteCodigo, ComprobanteAbreviacion, ComprobanteNombre: Información específica del comprobante relacionado con el recibo de pago en cuestión.
• ProveedorCodigo, ProveedorNombre, ProveedorRazonSocial: Identificadores y nombres que pertenecen al proveedor asociado.
• Fecha, Serie, Numero: Detalles temporales y numeración del recibo de pago.
• MonedaCodigo, MonedaSimbolo, MonedaNombre: Datos referentes a la moneda en la que se efectuó el pago.
• Descripcion, CajaCodigo, CajaNombre: Información adicional que puede incluir detalles de la transacción o el punto de venta.
• LocalCodigo, LocalNombre: Detalles del lugar donde se procesó la transacción.
• Total, TotalSigno, Saldo, SaldoSigno: Campos que describen el monto total y el saldo pendiente del recibo, así como los signos monetarios correspondientes.
• Emitido: Este campo indica si el recibo de pago ha sido o no emitido.

Método Save

El método Save tiene la finalidad de registrar nuevos recibos de pago dentro del sistema de la empresa. Es fundamental notar que, aunque permite el registro de recibos de pago, este método no posibilita la asignación de formas o documentos de pago. Para tales funciones, es necesario recurrir a la API de Facturas de Proveedor.

Filtros de Entrada

• RegistroId: Debe establecerse con el valor cero. Este identificador se asigna de manera automática y secuencial por ZetaSoftware.
• ComprobanteCodigo (N(3)): Campo obligatorio que identifica el tipo de comprobante.
• Serie (T(6)): Serie del comprobante, si aplica.
• Numero (N(10)): Número asociado al comprobante.
• Fecha (AAAA-MM-DD): Fecha de emisión del recibo, obligatoria para el registro.
• MonedaCodigo (N(2)): Especifica la moneda utilizada, campo obligatorio.
• Cotizacion (N(7.7)): Cotización de la moneda en el momento de la transacción.
• ProveedorCodigo (T(10)): Identificador del proveedor, es un campo obligatorio.
• Descripcion (T(30)): Descripción adicional del recibo.
• LocalCodigo (N(3)): Identificador del local, es un campo obligatorio.
• CajaCodigo (N(3)): Identificador de la caja donde se procesó el recibo, es un campo obligatorio.
• Total (N(12.2)): Monto total del recibo, es un campo obligatorio.
• UsuarioCodigo (N(3)): Identificador del usuario que efectúa el registro, es un campo obligatorio.
• Notas (T(50)): Espacio para añadir notas o comentarios adicionales sobre el recibo.

Resultado de la Operación

• Succeed / Mensaje: Indica si la operación fue exitosa o, en caso contrario, muestra un mensaje de error.