Clozo para desarrolladores

Una API HTTP con esquema publicado

Emite, entrega y concilia facturas desde tu propio sistema. El esquema está publicado y se puede explorar; claves, webhooks y consumo los gestionas tú mismo en tu espacio de trabajo.

Abrir la referencia de la API

La referencia se genera desde el servicio en ejecución, así que no puede describir una versión anterior.

Inicio rápido

curl https://api.useclozo.com/b2b/v1/documents \
  -X POST \
  -H "Authorization: Bearer clz_live_<keyid>_<secret>" \
  -H "Idempotency-Key: order-4471-v1" \
  -H "Content-Type: application/json" \
  -d '{
    "issuer_id": "3f6c1b8e-2d4a-4e7b-9a15-6c0d2e8f7a41",
    "customer": {
      "name": "Kestrel Logistics GmbH",
      "country": "DE",
      "vat_number": "DE123456789"
    },
    "currency": "EUR",
    "line_items": [
      {
        "description": "Consulting, October",
        "quantity": "1",
        "unit_amount": 395000,
        "tax_rate": 0,
        "tax_category": "AE"
      }
    ]
  }'

HTTP/1.1 201 Created
{
  "object": "document",
  "id": "doc_5Hq2m8Zr4Kd9",
  "issuer_id": "3f6c1b8e-2d4a-4e7b-9a15-6c0d2e8f7a41",
  "issuer_country": "NL",
  "currency": "EUR",
  "subtotal": 395000,
  "tax_total": 0,
  "total": 395000,
  "reverse_charge": true,
  "status_bucket": "created",
  "status_detail": "draft",
  "invoice_number": ""
}
// ...

Crea una clave de API en tu espacio de trabajo y envíala como token Bearer. Las peticiones que crean o emiten documentos o registran movimientos de dinero llevan un Idempotency-Key, así que un reintento nunca crea un duplicado. issuer_id es el UUID de una de tus entidades jurídicas.

Una regla que conviene leer antes

La organización se resuelve a partir de la credencial, nunca de un parámetro de la petición. Una clave emitida para una organización no puede dirigirse a otra: no hay identificador de organización que enviar ni forma de ampliar el alcance cambiando la petición. Los límites de uso se devuelven en cabeceras X-RateLimit, tanto en éxito como en un 429.

Qué cubre la API

Lo que aparece aquí está disponible hoy, salvo lo marcado como Acceso anticipado.

Esquema publicado y un navegador para él

Un esquema OpenAPI y una interfaz Swagger, servidos por la propia API. Genera tu cliente a partir del esquema en lugar de transcribir endpoints a mano.

Claves de API autogestionadas, con ámbitos y rotación

Crea, rota y revoca claves en tu espacio de trabajo. La rotación emite la nueva clave antes de que la anterior deje de funcionar, así que un despliegue no tiene que ser simultáneo.

Webhooks firmados con registro de entrega y reenvío

Registra endpoints, envía un evento de ejemplo, consulta el registro de entregas y reenvía un evento o toda la cola de fallidos. Una entrega perdida se recupera sin tener que pedírnoslo.

Consumo que puedes consultar tú mismo

Lo que la organización ha consumido, incluido el correo, es un endpoint y no una consulta a soporte.

Exportaciones filtradas

Extractos CSV y XLSX de los mismos datos que puedes listar con la API, para los casos en que una hoja de cálculo sigue siendo la respuesta.

Entrega de factura electrónica por PeppolAcceso anticipado. Acceso anticipado: el envío y la recepción por Peppol, KSeF y SdI se están activando con los clientes de acceso anticipado.

Entrega de un documento al participante Peppol del destinatario, con el estado de entrega consultable mediante la misma API. La página de países indica dónde está disponible la facturación electrónica.

Qué hace el espacio de trabajo Facturación electrónica por país