API Formatos de Impresión

Esta API permite gestionar los formatos de impresión utilizados en los comprobantes, incluyendo su diseño, estructura y configuración de salida.

La funcionalidad asociada en el sistema se encuentra en Configuración > Formatos de Impresión.

Casos de uso

  • Consultar formatos de impresión disponibles.
  • Crear nuevos formatos de documentos.
  • Modificar diseños existentes.
  • Integrar formatos con sistemas externos de impresión.

Endpoint del servicio

Método Query

Permite obtener un listado paginado de formatos de impresión.

Parámetros de entrada

ParámetroTipoObligatorioDescripción
CodigoDesdeT(3)NoCódigo inicial del rango.
CodigoHastaT(3)NoCódigo final del rango.
NombreContieneT(20)NoTexto a buscar dentro del nombre.
PageN(2)Número de página.

Estructura del response

Codigo
Nombre
TopeLineas
CodigoDisenio
ArchivoDisenio
Via1
Via2
Via3
Via4
CodigoNumerador
NombreNumerador

Campos devueltos

CampoDescripción
CodigoCódigo del formato.
NombreNombre del formato.
TopeLineasCantidad máxima de líneas.
CodigoDisenioCódigo del diseño asociado.
ArchivoDisenioArchivo de diseño.
Via1Descripción de la primera vía de impresión.
Via2Descripción de la segunda vía.
Via3Descripción de la tercera vía.
Via4Descripción de la cuarta vía.
CodigoNumeradorCódigo del numerador.
NombreNumeradorNombre del numerador.

Método Load

Permite obtener un formato de impresión específico.

Parámetro

  • Codigo – Obligatorio.

Resultado

Codigo
Nombre
ArchivoDisenio
CodigoDisenio
Via1
Via2
Via3
Via4
TopeLineas
CodigoNumerador

Método Save

Permite crear o actualizar un formato de impresión.

Al actualizar un formato de impresión, los campos que no se envían en el payload no conservan automáticamente su valor anterior.

El sistema toma como referencia únicamente la información recibida. Por este motivo, los campos que no se incluyen en  la solicitud quedan sin valor.

Por lo tanto, al realizar una actualización, es necesario enviar también los datos que se desean conservar.

Parámetros de entrada

CampoTipoObligatorioDescripción
CodigoT(3)Código del formato.
NombreT(50)Nombre del formato.
ArchivoDisenioT(20)NoArchivo de diseño.
CodigoDisenioN(2)NoCódigo del diseño.
Via1T(20)NoPrimera vía de impresión.
Via2T(20)NoSegunda vía.
Via3T(20)NoTercera vía.
Via4T(20)NoCuarta vía.
TopeLineasN(3)NoCantidad máxima de líneas.
CodigoNumeradorT(3)NoCódigo del numerador.

Resultado

Succeed
Error
Mensaje

Método Delete

Permite eliminar un formato de impresión.

Parámetro

  • Codigo – Obligatorio.

Resultado

Succeed
Error
Mensaje

Observaciones

  • Los formatos definen la estructura de impresión de comprobantes.
  • Las vías permiten múltiples copias del documento.
  • El diseño impacta directamente en la presentación del comprobante.

Consideraciones de integración

  • Validar consistencia entre diseño y numerador.
  • Probar formatos antes de usarlos en producción.
  • Evitar eliminar formatos en uso.
  • Gestionar versiones de diseños si hay cambios frecuentes.
Compartir

API Formatos de Impresión

O copia el enlace

CONTENIDO