Endpoints y OpenAPI
Descargá el esquema OpenAPI 3.1 para generar clientes, colecciones de prueba o documentación interactiva. Los permisos y parámetros de cada ruta están especificados en el contrato.
| Método | Ruta | Scope | Propósito | Ayuda |
|---|---|---|---|---|
| GET | /api/v1/companies | documents:read | Empresas propias | Ver guía |
| GET | /api/v1/companies/{id}/cae | documents:read | Rangos de CAE | Ver guía |
| GET | /api/v1/companies/{id}/issuance-readiness | documents:read | Prechequeo de emisión | Ver guía |
| GET | /api/v1/documents | documents:read | Listar CFE | Ver guía |
| POST | /api/v1/documents | documents:write | Crear borrador | Ver guía |
| POST | /api/v1/documents/issue-and-submit | documents:write + documents:submit | Emisión y envío one-shot | Ver guía |
| GET | /api/v1/documents/lookup | documents:read | Buscar por externalId | Ver guía |
| GET | /api/v1/documents/{id} | documents:read | Detalle | Ver guía |
| POST | /api/v1/documents/{id}/issue | documents:issue | CAE, firma y XSD | Ver guía |
| POST | /api/v1/documents/{id}/submit | documents:submit | Enviar a DGI | Ver guía |
| POST | /api/v1/documents/{id}/status | documents:status | Consultar estado DGI | Ver guía |
| GET | /api/v1/documents/{id}/xml | documents:read | XML firmado | Ver guía |
| GET | /api/v1/documents/{id}/pdf | documents:read | PDF firmado/validado | Ver guía |
| GET | /api/v1/uy/electronic-issuers | documents:read | Directorio DGI | Ver guía |
| GET | /api/v1/received-documents | received:read | CFE recibidos | Ver guía |
| GET | /api/v1/received-documents/{id} | received:read | Detalle recibido | Ver guía |
| GET | /api/v1/received-documents/{id}/xml | received:read | XML original recibido | Ver guía |
| GET | /api/v1/webhooks | webhooks:manage | Listar endpoints | Ver guía |
| POST | /api/v1/webhooks | webhooks:manage | Crear webhook / secreto | Ver guía |
| GET | /api/v1/webhooks/{id} | webhooks:manage | Consultar endpoint | Ver guía |
| PATCH | /api/v1/webhooks/{id} | webhooks:manage | Actualizar endpoint | Ver guía |
| DELETE | /api/v1/webhooks/{id} | webhooks:manage | Archivar endpoint | Ver guía |
| POST | /api/v1/webhooks/{id}/rotate-secret | webhooks:manage | Rotar secreto HMAC | Ver guía |
Probar con ejemplos
Ver ejemplos curl y la colección Postman, preparada con las 23 operaciones de la API v1. Los POST de la colección se bloquean si la clave no es de TEST.
Descargar colección Postman JSON ↗
SDKs oficiales
Podés integrar los endpoints desde PHP/Laravel o JavaScript/Node.js. Los clientes conservan el esquema de errores y nunca repiten un POST fiscal automáticamente.
Paginación
Los listados utilizan limit (1–100, por defecto 50) y cursor. La respuesta contiene data, hasMore y nextCursor. No reutilices cursores entre organizaciones, ambientes o filtros distintos.
Cuotas y tamaños de solicitud
Se aplican cuotas por API key, clase de operación y minuto: lecturas 120/min, creación 30/min y operaciones fiscales 12/min por defecto. Ante 429, respetá Retry-After; el contador es compartido entre réplicas. El body JSON de creación admite hasta 1 MiB (413 si se excede). El tipo de contenido debe ser JSON (415).
Contrato y campos de creación
En el OpenAPI están tipados los campos de compras y ventas, referencias a otros CFE, notas, descuentos de línea, ajustes globales Zona D, retenciones y medios de pago. El servidor hace controles fiscales adicionales; una estructura JSON válida no garantiza que un CFE se pueda emitir.
Errores y estados
Usá el campo error y el código HTTP como indicadores programáticos, no el texto libre de message. Para un CFE enviado, diferenciá el estado local y la respuesta fiscal de DGI. Con timeout o resultado de transporte desconocido, conciliá antes de reintentar.
La referencia OpenAPI representa los endpoints de la API v1 implementados. No promete compatibilidad automática con el formato de Pymo ni sustituye el proceso de homologación o las especificaciones técnicas de DGI.