Documentación del API API de Consulta de Representación Gráfica (PDF)

Este endpoint permite consultar y descargar la representación gráfica (PDF) de documentos fiscales electrónicos generados en el proceso de facturación electrónica. Los documentos disponibles incluyen:

  • Facturas electrónicas (FE)
  • Notas crédito (NC)
  • Notas débito (ND)

El PDF retornado contiene:

  • Código CUFE / CUNE
  • Código QR
  • Datos fiscales exigidos por la DIAN

El acceso se realiza mediante el identificador único del documento (UUID / CUFE / LDF).

Información General

Nombre del API Consulta Representación Gráfica por UUID
Método HTTP POST
URL https://{host}/DocumentReadOnly/RepresentacionGrafica/GetBinaryByUUID
Autorización
  • Bearer Token (JWT)
  • Subscription Key (x-who)
Descripción Permite obtener el archivo PDF de un documento fiscal electrónico mediante su identificador único (UUID/CUFE).

Parámetros

Headers

Nombre Tipo Obligatorio Valor Descripción
Content-Type string application/json Formato del cuerpo de la petición
Authorization string Bearer {token} Token JWT válido
x-who string {subscription-key} Clave de suscripción de APIM

Body

Nombre Tipo Obligatorio Valor Descripción
uuid string {UUID/CUFE} Identificador único del documento

Ejemplo

{
  "uuid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

Ejemplo de Request

POST /DocumentReadOnly/RepresentacionGrafica/GetBinaryByUUID
curl --location 'https://{host}/DocumentReadOnly/RepresentacionGrafica/GetBinaryByUUID' \
--header 'Authorization: Bearer <token>' \
--header 'x-who: <subscription-key>' \
--header 'Content-Type: application/json' \
--data '{
  "uuid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}'

Ejemplo de Response

Respuesta exitosa

Status code: 200 OK

(Binario PDF)

Error de validación (400 Bad Request)

{
  "success": false,
  "message": "UUID inválido o formato incorrecto"
}

No autorizado (401 Unauthorized)

{
  "success": false,
  "message": "Token inválido o expirado"
}

Error interno (500 Internal Server Error)

{
  "success": false,
  "message": "Error interno del servidor"
}

Rate Limit (429 Too Many Requests)

Header Descripción
Retry-After Tiempo en segundos para reintentar
X-RateLimit-Limit Límite de solicitudes
X-RateLimit-Remaining Solicitudes restantes
{
  "success": false,
  "message": "Límite de consumo excedido"
}

Políticas de Consumo

  • Quota mensual: 10.000 solicitudes por suscripción
  • Rate limit configurado para evitar abuso
  • Respuesta 429 al exceder límites
  • Control por subscription key (x-who)

Consideraciones

  • El UUID debe corresponder a un documento previamente emitido y aprobado.
  • El servicio retorna contenido binario (PDF).
  • Se recomienda implementar reintentos ante errores transitorios.
  • Evitar ráfagas masivas sin control (puede generar 429).
  • Compatible con cargas de 150–300 documentos diarios por compañía.
  • Soporta picos de cierre de mes con control de rate limit.