Portal de desarrolladores
REST SOAP Cliente local

Catálogo de campos de la bandeja REST

Referencia técnica para catálogo de campos de la bandeja rest dentro del cliente local.

Bandeja REST localArquitecturaFFIRecuperación

Objetivo

Esta guía resume los campos más relevantes que aparecen en los requests y responses de la bandeja REST local.

No reemplaza la referencia endpoint por endpoint, pero sirve como mapa rápido para el integrador.

Campos frecuentes de request

tipo_cfe

Tipo de comprobante a procesar.

Usos típicos:

uuid

Identificador externo estable del comprobante.

Recomendaciones:

xml

Contiene el XML CFE base sin firma.

Buenas prácticas:

cod_comercio

Código de comercio del punto de emisión.

Se usa para rutear la operación al perfil correcto cuando no alcanza con el perfil activo.

cod_terminal

Código de terminal del punto de emisión.

Regla operativa:

adenda

Texto adicional asociado al comprobante.

Su presencia depende del caso de negocio y del formato de impresión que se utilice.

emails

Lista de destinatarios asociada al comprobante.

No reemplaza por sí sola la lógica de correo del sistema integrador, pero permite dejar esa información junto al procesamiento local.

impresora

Especificación textual del destino de impresión.

Ejemplos:

send_now

Indica si el sistema debe intentar avanzar inmediatamente con el flujo posterior a la firma o dejar la persistencia para cola local según la operación.

variant

Permite elegir una variante de salida, normalmente asociada a plantillas o formato de representación.

fallback_copies

Cantidad de copias de respaldo a usar en determinadas operaciones de impresión o PDF.

serie

Serie del comprobante cuando se consulta o reimprime sin usar uuid.

numero

Número del comprobante cuando se consulta o reimprime sin usar uuid.

Campos frecuentes de response

ok

Resultado técnico de la operación.

Suele aparecer en:

codigo_respuesta

Resultado funcional del procesamiento.

Es especialmente importante en POST /sign-cfe.

Valores documentados de mayor uso:

mensaje_respuesta

Glosa descriptiva complementaria al codigo_respuesta.

No conviene tomar decisiones automáticas basadas solo en el texto libre.

serie

Serie asignada o encontrada por la operación.

numero

Número asignado o encontrado por la operación.

cfe_firmado

XML final firmado devuelto por POST /sign-cfe.

datos_codigo_qr

Datos o URL del QR asociado al CFE firmado.

codigo_seguridad

Código de seguridad fiscal del comprobante.

fecha_firma_cfe

Fecha y hora de firma del comprobante.

numero_inicial_cae

Inicio del rango CAE usado durante la numeración.

numero_final_cae

Fin del rango CAE usado durante la numeración.

vencimiento_cae

Fecha de vencimiento del CAE utilizado o del rango consultado.

stored_path

Ruta local donde quedó persistido un request aceptado por POST /enqueue.

queued

Confirma que la operación fue aceptada para ejecución posterior, típicamente en reimpresión.

existe

Indica si una constancia o persistencia local fue encontrada.

Campos mínimos a persistir del lado integrador

Para una operación emitida se recomienda guardar:

Campos mínimos para reimpresión o PDF

El integrador debería poder localizar un comprobante por:

o, alternativamente:

Relación con otras guías