> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleariflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introducción

> La API de validación de IVA de Cleariflow ofrece soluciones integrales de cumplimiento fiscal a través de una interfaz JSON RESTful moderna y simplificada, permitiendo la validación y el cálculo para operaciones comerciales nacionales e internacionales.

## Primeros pasos

<Card title="Endpoint de validación de IVA" icon="tag" href="vat/validate">
  Verifique la autenticidad de los números de IVA y obtenga información completa de la empresa, incluido el país, el nombre comercial, la dirección y los datos de registro.
</Card>

<Card title="Endpoint de cálculo de IVA" icon="tags" href="vat/calculate">
  Calcule precios conformes al IVA según las regulaciones específicas del país, el tipo de compra y el valor de la transacción para cálculos financieros precisos.
</Card>

<Card title="Endpoint de categorías de IVA" icon="globe" href="vat/categories">
  Acceda a las tasas de IVA actuales y a las categorías fiscales de países específicos para garantizar el cumplimiento de las regulaciones fiscales locales.
</Card>

### Arquitectura REST

La API de validación de IVA sigue los principios REST, utilizando URL predecibles orientadas a recursos y códigos de estado HTTP estándar para una integración fluida y el manejo de errores. Todos los endpoints de la API deben terminar con una barra diagonal (/) y solo admiten solicitudes GET.

### Seguridad HTTPS

Todas las comunicaciones de la API están protegidas mediante protocolos de cifrado TLS 1.2 o superior para garantizar la integridad y privacidad de los datos.

### Versionado de la API

La API de validación de IVA mantiene la compatibilidad hacia atrás mediante versionado y actualmente opera en la versión 1, con mejoras futuras planificadas.

### Autenticación

Su clave API sirve como credencial exclusiva para acceder a la API de validación de IVA. Cada servicio de Cleariflow requiere una clave única, lo que garantiza un acceso seguro y aislado entre las distintas APIs. La API implementa limitación de velocidad para garantizar un uso equitativo entre todos los usuarios.

## Códigos de respuesta y error

Cuando las solicitudes fallan, la API devuelve respuestas de error JSON estructuradas con códigos y descripciones específicos para una resolución de problemas eficaz.

| Code | Type                  | Details                                                                                                                                                                            |
| ---- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 200  | OK                    | Todo funcionó como se esperaba.                                                                                                                                                    |
| 400  | Bad request           | Solicitud incorrecta.                                                                                                                                                              |
| 401  | Unauthorized          | La solicitud no fue aceptable. Normalmente debido a que la clave API falta o es incorrecta.                                                                                        |
| 422  | Quota reached         | La solicitud se abortó por créditos API insuficientes. (Planes gratuitos)                                                                                                          |
| 429  | Too many requests     | La solicitud se abortó porque se alcanzó el número de solicitudes permitidas por segundo. Esto ocurre en planes gratuitos, ya que las solicitudes están limitadas a 1 por segundo. |
| 500  | Internal server error | La solicitud no pudo completarse debido a un error en el servidor.                                                                                                                 |
| 503  | Service unavailable   | El servidor no estaba disponible.                                                                                                                                                  |

## Códigos de país

A continuación se muestra la lista de países admitidos por los endpoints de IVA

| Country code | Country name    |
| ------------ | --------------- |
| AT           | Austria         |
| BE           | Bélgica         |
| BG           | Bulgaria        |
| CY           | Chipre          |
| CZ           | República Checa |
| DE           | Alemania        |
| DK           | Dinamarca       |
| EE           | Estonia         |
| FI           | Finlandia       |
| FR           | Francia         |
| GB           | Reino Unido     |
| GR           | Grecia          |
| HR           | Croacia         |
| HU           | Hungría         |
| IE           | Irlanda         |
| IT           | Italia          |
| LT           | Lituania        |
| LU           | Luxemburgo      |
| LV           | Letonia         |
| MT           | Malta           |
| NL           | Países Bajos    |
| PL           | Polonia         |
| PT           | Portugal        |
| RO           | Rumanía         |
| SE           | Suecia          |
| SI           | Eslovenia       |
| SK           | Eslovaquia      |
