Saltar al contenido
Factuplan
Colección oficial

Colección Postman facturación SRI: API de Factuplan

Los endpoints principales, variables pre-configuradas y bodies de ejemplo listos. Importa en Postman y prueba la API de facturación electrónica SRI Ecuador en minutos.

45 peticiones en 8 carpetas Variables pre-configuradas Bodies de ejemplo Actualización oficial

Endpoints incluidos en la colección

45 peticiones organizadas en 8 carpetas: facturas, notas de crédito, notas de débito, retenciones, clientes, productos, uso y certificado. Las de emisión traen un body de ejemplo y 15 incluyen respuestas de ejemplo guardadas.

Facturas (carpeta invoices)

  • POST /v1/developer/invoices — emitir factura (Modo A: XML + firma + SRI + PDF)
  • GET /v1/developer/invoices — listar facturas emitidas (paginado)
  • GET /v1/developer/receipts/:id — detalle de la factura
  • GET /v1/developer/receipts/:id/status — estado actual
  • GET /v1/developer/receipts/:id/xml — URL de descarga del XML autorizado
  • GET /v1/developer/receipts/:id/pdf — URL de descarga del PDF (RIDE)
  • POST /v1/developer/receipts/:id/void — anular factura
  • POST /v1/developer/invoices/import — importar por clave de acceso (solo con ak_live_*)
  • PATCH /v1/developer/invoices/sequential — actualizar secuencial

Notas de crédito (carpeta credit-notes)

  • POST /v1/developer/credit-notes — emitir nota de crédito
  • GET /v1/developer/credit-notes — listar notas de crédito (paginado)
  • GET /v1/developer/receipts/:id — detalle de la nota de crédito
  • GET /v1/developer/receipts/:id/status — estado
  • GET /v1/developer/receipts/:id/xml — URL de descarga del XML
  • GET /v1/developer/receipts/:id/pdf — URL de descarga del PDF (RIDE)
  • POST /v1/developer/receipts/:id/void — anular nota de crédito
  • PATCH /v1/developer/credit-notes/sequential — actualizar secuencial

Notas de débito (carpeta debit-notes)

  • POST /v1/developer/debit-notes — emitir nota de débito
  • GET /v1/developer/debit-notes — listar notas de débito (paginado)
  • GET /v1/developer/receipts/:id — detalle de la nota de débito
  • GET /v1/developer/receipts/:id/status — estado
  • GET /v1/developer/receipts/:id/xml — URL de descarga del XML
  • GET /v1/developer/receipts/:id/pdf — URL de descarga del PDF (RIDE)
  • POST /v1/developer/receipts/:id/void — anular nota de débito
  • PATCH /v1/developer/debit-notes/sequential — actualizar secuencial

Retenciones (carpeta withholdings)

  • POST /v1/developer/withholdings — emitir comprobante de retención
  • GET /v1/developer/withholdings — listar retenciones (paginado)
  • GET /v1/developer/receipts/:id — detalle de la retención
  • GET /v1/developer/receipts/:id/status — estado
  • GET /v1/developer/receipts/:id/xml — URL de descarga del XML
  • GET /v1/developer/receipts/:id/pdf — URL de descarga del PDF (RIDE)
  • POST /v1/developer/receipts/:id/void — anular retención

Clientes (carpeta customers)

  • POST /v1/developer/customers — crear cliente
  • GET /v1/developer/customers — listar clientes
  • GET /v1/developer/customers/:id — obtener cliente
  • PATCH /v1/developer/customers/:id — actualizar cliente
  • DELETE /v1/developer/customers/:id — eliminar cliente

Productos (carpeta products)

  • POST /v1/developer/products — crear producto o servicio
  • GET /v1/developer/products — listar productos
  • GET /v1/developer/products/:id — obtener producto
  • PATCH /v1/developer/products/:id — actualizar producto
  • DELETE /v1/developer/products/:id — eliminar producto

Uso (carpeta usage)

  • GET /v1/developer/usage — uso de tu API key en el mes actual

Certificado (carpeta certificate)

  • GET /v1/developer/certificate/status — estado del certificado P12
  • POST /v1/developer/certificate — subir firma electrónica (P12)

La colección no incluye los Modos B y C (sign-and-authorize y sign), validate-xml, verify, authorize-signed, liquidaciones de compra, compras, contribuyentes ni los reintentos. Tampoco trae peticiones de guías de remisión: la API no tiene endpoint para emitirlas ni listarlas (se emiten desde el panel o enviando tu propio XML a sign-and-authorize o authorize-signed). Para la referencia técnica completa con schemas, validaciones y casos de error, abre /docs/api.

Cómo importar en Postman (5 pasos)

De cero a primera factura emitida desde Postman en menos de 10 minutos.

  1. Paso 1. Descarga el archivo JSON

    Haz clic en el botón de descarga arriba. El archivo factuplan-developer.postman_collection.json pesa menos de 1 MB y contiene 45 peticiones en 8 carpetas.

  2. Paso 2. Abre Postman e importa

    En Postman, clic en Import (esquina superior izquierda) → arrastra el archivo JSON descargado o usa File → Upload. La colección aparece en el panel izquierdo como 'Factuplan API'.

  3. Paso 3. Reemplaza el apiKey y el RUC

    Abre la colección 'Factuplan API' → pestaña 'Variables'. baseUrl ya viene en https://api-rest.factuplan.com.ec. Reemplaza apiKey con tu ak_test_xxx (o ak_live_xxx) y taxpayerRuc con un RUC de 13 dígitos registrado en tu workspace (en una cuenta nueva, el del contribuyente de pruebas: 9999999990001). Guarda con Ctrl/Cmd + S.

  4. Paso 4. Ejecuta tu primera request

    Abre la carpeta v1 → developer → customers → Listar clientes. Haz clic en Send. Si todo está bien, ves un response 200 con tus clientes. Si te devuelve 401, revisa que el apiKey esté correcto en las variables; si te devuelve 400, revisa que el taxpayerRuc sea un RUC de tu workspace.

  5. Paso 5. Emite tu primera factura desde Postman

    Abre v1 → developer → invoices → Emitir comprobante electrónico. El body trae un ejemplo con un item de USD 100 con IVA 15%: reemplaza los tres marcadores del cliente (<ruc-del-cliente>, <razon-social> y <email>) por datos reales y haz Send. La respuesta llega de inmediato con el accessKey de 49 dígitos y status DRAFT; la emisión sigue en segundo plano hasta COMPLETED.

Variables del environment

La colección ya trae 3 variables a nivel de colección. Solo tienes que reemplazar el valor de apiKey por tu key real y el de taxpayerRuc por un RUC registrado en tu workspace: con el de ejemplo la API responde 400.

Variable Valor de ejemplo Notas
baseUrl https://api-rest.factuplan.com.ec URL base de la API. Ya viene pre-configurada en la colección — no cambia entre pruebas y producción, solo la API key.
apiKey ak_test_xxx o ak_live_xxx Tu API key del workspace. Genérala en Dashboard → Developer → Create API key. ak_test_* para pruebas, ak_live_* para producción. La colección la envía como header X-API-Key.
taxpayerRuc 0950194407001 RUC del contribuyente emisor de 13 dígitos. El valor que trae la colección es de ejemplo: reemplázalo por un RUC registrado en tu workspace (tu RUC, el de tu cliente en arquitecturas multi-tenant o, en una cuenta nueva, el del contribuyente de pruebas: 9999999990001). Con un RUC que no está en tu workspace la API responde 400. Se envía como header x-taxpayer-ruc.

Tips para aprovechar Postman al máximo

4 patrones que usan los developers experimentados para acelerar su integración.

  • Usa Postman Runner para tests automáticos

    Crea una carpeta con escenarios típicos (emitir factura, listar, anular con NC) y ejecútalos en Runner cada vez que pruebes un cambio. Te asegura no romper integraciones.

  • Comparte el environment con tu equipo

    Exporta el environment con las variables (sin la apiKey real, claro) y compártelo. Cada developer importa y completa su propia key. Onboarding técnico en 5 minutos.

  • Genera snippets en cualquier lenguaje

    En Postman, panel derecho → Code (icono '</>'). Te genera el snippet equivalente en cURL, Node.js, Python, PHP, Go, Ruby, etc. Útil para empezar tu integración rápido.

  • Empieza siempre en sandbox

    Usa ak_test_* hasta que el flujo funcione completo. Los comprobantes de sandbox se eliminan automáticamente cada hora y, al borrarse, te devuelven el cupo que ocuparon en tu plan.

FAQ

Preguntas frecuentes

¿No encuentras tu respuesta? Escríbenos.

¿Cómo descargo la colección Postman de Factuplan?

Hay dos formas: 1) Desde esta página, haz clic en el botón 'Descargar colección Postman' del hero — descarga el archivo factuplan-developer.postman_collection.json directamente; 2) Desde la documentación técnica en /docs/api hay un link de descarga al inicio. El archivo pesa menos de 1 MB y contiene los endpoints principales de la API para desarrolladores: comprobantes, catálogos, uso y certificado. Los webhooks se configuran desde el panel, no con la API key. Es la misma colección oficial mantenida por el equipo de Factuplan.

¿Qué endpoints incluye la colección?

45 peticiones de la API REST de Factuplan organizadas en 8 carpetas (dentro de v1 → developer): 1) invoices: POST /invoices (emitir, Modo A: XML + firma + SRI + PDF), GET /invoices (listar facturas), POST /invoices/import (importar por clave de acceso), PATCH /invoices/sequential y, para una factura por su ID, GET /receipts/:id, GET /receipts/:id/status, GET /receipts/:id/xml, GET /receipts/:id/pdf y POST /receipts/:id/void; 2) credit-notes y 3) debit-notes: emitir, listar, actualizar el secuencial y las mismas consultas por ID; 4) withholdings: emitir, listar y las consultas por ID; 5) customers y 6) products: CRUD completo (POST, GET listar, GET por id, PATCH, DELETE); 7) usage: GET /usage; 8) certificate: GET /certificate/status y POST /certificate (subir P12). No incluye los Modos B y C (POST /sign-and-authorize y POST /sign), validate-xml, verify, authorize-signed, liquidaciones de compra, compras, contribuyentes ni los reintentos. Tampoco trae peticiones de guías de remisión, porque la API no tiene endpoint para emitirlas ni listarlas: se emiten desde el panel o enviando tu propio XML a /sign-and-authorize (sin firmar) o /authorize-signed (ya firmado). Las peticiones de emisión traen un body de ejemplo y 15 de las 45 incluyen respuestas de ejemplo guardadas.

¿Necesito una API key para usar la colección?

Sí. La colección usa variables ({{baseUrl}}, {{apiKey}}, {{taxpayerRuc}}) ya declaradas a nivel de colección — solo tienes que reemplazar el valor de apiKey con tu key real y el de taxpayerRuc con un RUC de tu workspace. Para obtenerla gratis: crea cuenta en app.factuplan.com.ec (sin tarjeta de crédito, 2 minutos), anda a Developer → Create API key, copia la clave generada (solo se muestra una vez). El prefijo indica el ambiente: ak_test_* para pruebas (comprobantes ficticios que se eliminan cada hora) y ak_live_* para producción (facturas reales firmadas y enviadas al SRI). La colección la envía como header X-API-Key automáticamente.

¿Cómo configuro las variables en Postman?

La colección viene con 3 variables a nivel de colección, ya pre-creadas: baseUrl=https://api-rest.factuplan.com.ec, apiKey (vacía), taxpayerRuc=0950194407001 (de ejemplo). Para usarla: 1) Abre la colección 'Factuplan API' en el panel izquierdo; 2) Pestaña 'Variables'; 3) Reemplaza la columna 'Current value' del apiKey con tu key real y del taxpayerRuc con un RUC registrado en tu workspace (con el de ejemplo la API responde 400); 4) Ctrl/Cmd + S para guardar. Si prefieres separar pruebas y producción, crea environments adicionales con las mismas tres claves y usa el dropdown superior derecho para alternar.

¿Puedo emitir facturas reales desde Postman?

Sí, si usas una API key de producción (ak_live_*) con un RUC con firma electrónica P12 vigente cargada en tu workspace. Cuidado: las facturas emitidas desde Postman con ak_live_* son REALES, se firman, se envían al SRI y se autorizan oficialmente. Después no se pueden borrar sin emitir nota de crédito (excepto consumidor final que desde 2026 ni siquiera con NC). Para developers que están probando la integración, recomendamos fuertemente usar primero ak_test_* (sandbox) hasta que el flujo esté validado, y solo después cambiar a ak_live_*. Esto evita errores costosos en producción real.

¿La colección Postman se actualiza automáticamente cuando cambian los endpoints?

No automáticamente — debes descargar la nueva versión cuando publiquemos cambios. El changelog en /desarrolladores documenta cambios técnicos de la API y avisa cuando hay una nueva versión de la colección. Cambios mayores (versión 2.x) son raros y se anuncian con margen de tiempo. Cambios menores son aditivos (nuevos endpoints, nuevos campos opcionales) y no rompen integraciones existentes.

¿Puedo generar code snippets desde Postman?

Sí, es una de las features más útiles. Una vez que tienes una request configurada con tu environment, abre el panel derecho de Postman → ícono '</>' (Code). Postman te genera el snippet equivalente en aproximadamente 20 lenguajes: cURL, Node.js (vanilla y axios), Python (requests, http.client), PHP (cURL y Guzzle), Go, Ruby, Java, C#, Swift, etc. Es la forma más rápida de empezar tu integración: pruebas con Postman primero, copias el snippet generado y lo pegas en tu código real. Aclaración: para Node.js/TypeScript la opción ideal sigue siendo el SDK oficial (paquete factuplan en npm) por el tipado completo y el manejo de errores estructurado.

¿Hay forma de testear flujos completos (factura + NC + verificación)?

Sí, con Postman Collection Runner. Selecciona la colección de Factuplan, clic en 'Run' → te abre Runner. Ahí puedes seleccionar requests específicas en orden, configurar iteraciones, agregar delays entre requests y pasar variables entre ellas (ej: el accessKey de la factura creada se pasa automáticamente a la nota de crédito). Crear scripts en la pestaña 'Tests' de cada request permite validar el response antes de pasar a la siguiente. Es la forma estándar de armar suites de regression para tu integración. Para CI/CD, puedes ejecutar Runner desde línea de comandos con Newman (CLI de Postman) integrado en GitHub Actions, GitLab CI o Jenkins.

Empieza a facturar electrónicamente hoy

1 mes gratis al comprar tu firma electrónica con FirmaOK. Sin tarjeta de crédito.

Empresas activas
+1.000
Calificación clientes
4.9/5
Tiempo de onboarding
<1 día
Disponibilidad SRI
24/7
  • Configuración en minutos
  • Cancela cuando quieras
  • Soporte en español ecuatoriano