API Facturación

Endpoints de la API

Esta página proporciona una lista completa de todos los endpoints disponibles en la API, junto con su descripción y funcionalidad.

URL Base

Todos los endpoints de API deben usarse con la URL base correspondiente al entorno:

  • https://tudominio:7319/api/v1

Autenticación requerida

Todos los endpoints requieren autenticación mediante token JWT. Consulta la sección de Autenticación para más detalles.

Estructura de la API

La API está organizada en diferentes grupos de endpoints según su funcionalidad:

Autenticación

Endpoints para registro y autenticación de usuarios.

  • POST /api/v1/auth/register - Registro de usuarios
  • POST /api/v1/auth/login - Obtener token JWT
Ver documentación →

Emisión de DTE

Endpoints para gestionar documentos tributarios electrónicos (DTE).

  • POST /api/v1/dte/invoices - Crear factura
  • POST /api/v1/dte/ccf - Crear Comprobante de Crédito Fiscal
  • POST /api/v1/dte/creditnote - Crear Nota de Crédito
  • POST /api/v1/dte/retention - Crear Comprobante de Retención
Ver documentación →

Invalidación

Endpoints para invalidar documentos emitidos.

  • POST /api/v1/dte/invalidate - Invalidar documento
Ver documentación →

Consulta de DTE

Endpoints para consultar documentos emitidos.

  • GET /api/v1/dte/{"id"} - Consultar documento por ID
  • GET /api/v1/dte - Listar documentos con filtros
Ver documentación →

Monitoreo

Endpoints para monitorear el estado del sistema.

  • GET /api/v1/health - Health check
  • GET /api/v1/metrics - Métricas del sistema
  • GET /api/v1/test - Test del sistema
Ver documentación →

Eventos

Endpoints para monitorear los eventos del sistema.

  • Aún trabajando en ello...

Formatos de Respuesta

Todas las respuestas de la API siguen un formato estándar en JSON:

Respuestas Exitosas

{"success": true,"data": {"}}

Respuestas de Error

{"success": false,"error": {"message": "Mensaje descriptivo del error","details": ["Detalle 1", "Detalle 2"],"code": "CÓDIGO_ERROR"}}

Códigos de Estado HTTP

La API utiliza los siguientes códigos de estado HTTP:

  • 200 OK - La solicitud se completó correctamente
  • 201 Created - El recurso se creó correctamente
  • 400 Bad Request - Error en los parámetros o datos enviados
  • 401 Unauthorized - Falta de autenticación o token inválido
  • 403 Forbidden - No tiene permisos para acceder al recurso
  • 404 Not Found - El recurso solicitado no existe
  • 500 Internal Server Error - Error interno del servidor

Documentación Completa

Para más detalles sobre cada endpoint, consulta las secciones específicas de la documentación.