Documentación API

Tipos de Documento

Gestión de tipos de documento para clasificar y organizar las extracciones.

POST /api/types/

Crea un nuevo tipo de documento para clasificar extracciones.

POST /api/types/

Headers

Content-Type: application/json
Authorization: Bearer JWT_TOKEN

Body (JSON)

{"nombre": "Factura", "descripcion": "Facturas comerciales"}
  • nombre: (obligatorio) Nombre del tipo de documento.
  • descripcion: (opcional) Descripción del tipo.

Ejemplos

curl -X POST https://api-docmind.devol.es/api/types/ \
  -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN" \
  -d '{"nombre": "Factura", "descripcion": "Facturas comerciales"}'

Respuesta

{"message": "Tipo creado exitosamente", "tipo": {"id": "type-uuid", "nombre": "Factura", "descripcion": "Facturas comerciales"}}

Tipo de documento creado.

Errores

400Bad Request

Nombre faltante o duplicado.

{"error": "El nombre es obligatorio"}
409Conflict

Ya existe un tipo con ese nombre.

{"error": "Ya existe un tipo con ese nombre"}

GET /api/types/

Lista todos los tipos de documento del cliente.

GET /api/types/

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/types/ \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"tipos": [{"id": "type-uuid", "nombre": "Factura", "descripcion": "Facturas comerciales", "count": 150}]}

Lista de tipos con el conteo de documentos asociados.

Errores

401Unauthorized

Token inválido.

{"msg": "Token inválido"}

GET /api/types/{type_id}

Obtiene un tipo de documento específico.

GET /api/types/{type_id}

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/types/TYPE_ID \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"tipo": {"id": "type-uuid", "nombre": "Factura", "descripcion": "Facturas comerciales"}}

Detalle del tipo de documento.

Errores

404Not Found

Tipo no encontrado.

{"error": "Tipo no encontrado"}

PUT /api/types/{type_id}

Actualiza un tipo de documento existente.

PUT /api/types/{type_id}

Headers

Content-Type: application/json
Authorization: Bearer JWT_TOKEN

Body (JSON)

{"nombre": "Factura Actualizada", "descripcion": "Nueva descripción"}
  • nombre: (opcional) Nuevo nombre.
  • descripcion: (opcional) Nueva descripción.

Ejemplos

curl -X PUT https://api-docmind.devol.es/api/types/TYPE_ID \
  -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN" \
  -d '{"nombre": "Factura v2"}'

Respuesta

{"message": "Tipo actualizado exitosamente"}

Confirmación de la actualización.

Errores

404Not Found

Tipo no encontrado.

{"error": "Tipo no encontrado"}

DELETE /api/types/{type_id}

Elimina un tipo de documento.

DELETE /api/types/{type_id}

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X DELETE https://api-docmind.devol.es/api/types/TYPE_ID \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"message": "Tipo eliminado exitosamente"}

El tipo se elimina permanentemente.

Errores

404Not Found

Tipo no encontrado.

{"error": "Tipo no encontrado"}

© 2025 Devol. Todos los derechos reservados.