API Externa

QPOS expone una API REST para que sistemas externos puedan emitir comprobantes electrónicos, consultar documentos, gestionar productos, clientes y más.

Información general

Concepto	Detalle
Base URL	https://{dominio-tenant}/api/
Autenticación	Bearer Token (Authorization: Bearer {token})
Content-Type	application/json
Formato de respuesta	JSON

Obtener token

Todos los endpoints (salvo los marcados como públicos) requieren un token de autenticación.

POST /api/login

Campo	Tipo	Requerido	Descripción
email	string	Sí	Correo del usuario
password	string	Sí	Contraseña

Respuesta exitosa:

{
  "success": true,
  "user_id": 1,
  "name": "Admin",
  "company_name": "Mi Empresa S.A.C.",
  "token": "api-token-string",
  "ruc": "20123456789",
  "percentage_igv": 18,
  "modules": [...]
}

Usa el campo token en todas las peticiones posteriores:

Authorization: Bearer {token}

Probar login

POST

Body JSON{ "email": "admin@gmail.com", "password": "123456" }

Configura la Base URL con ⚙

Formato de respuesta estándar

Éxito:

{
  "success": true,
  "data": { ... },
  "links": { ... },
  "response": { "code": "0", "description": "..." }
}

Error de validación (422):

{
  "campo": ["Mensaje de error"]
}

Error general:

{
  "success": false,
  "message": "Descripción del error"
}

Secciones de la API

Sección	Descripción
Documentos Electrónicos	Facturas, boletas, notas de crédito/débito
Guía Remitente	Guía de remisión remitente (09)
Guía Transportista	Guía de remisión transportista (31)
Resúmenes Diarios	Resúmenes diarios de boletas
Anulaciones	Comunicaciones de baja
Notas de Venta	Notas de venta internas
Cotizaciones	Cotizaciones
Pedidos	Pedidos y notas de pedido
Productos	CRUD de productos y servicios
Clientes	CRUD de clientes/personas
Caja	Apertura, cierre y reportes de caja
Catálogos	Series, métodos de pago, ubigeos, tipos
Servicios SUNAT	Consulta RUC/DNI, validación CPE, estado CDR
Percepciones	Documentos de percepción
Liquidaciones de Compra	Liquidaciones de compra
Pagos	Registrar, listar y eliminar pagos de documentos y notas de venta