Documentación API v1

Comprobación de disponibilidad simple. Devuelve el estado de la base de datos. Ideal para monitorización.

Respuesta:

{ "status": "ok", "db": true }

Devuelve todos los perfiles compatibles con metadatos (campos obligatorios, tipo de exportación).

{ "profiles": ["XRECHNUNG", "B2B_UBL", "ZUGFERD"] }

Enviar factura como JSON → generar XML válido (y generar opcionalmente un PDF híbrido).

Cuerpo de la solicitud:

{
  "profile":          "XRECHNUNG",
  "invoice_number":   "RE-2026-0042",
  "issue_date":       "2026-04-20",
  "due_date":         "2026-05-04",
  "currency":         "EUR",
  "buyer_reference":  "04011000-1234567-89",
  "seller": {
    "name":   "Mustermann IT GmbH",
    "vat_id": "DE123456789",
    "address": { "street":"Musterstraße 12","postal_code":"70173",
                 "city":"Stuttgart","country_code":"DE" }
  },
  "buyer": {
    "name": "Landratsamt Musterhausen",
    "address": { "street":"Rathausplatz 1","postal_code":"70173",
                 "city":"Musterhausen","country_code":"DE" }
  },
  "lines": [{
    "name": "Webentwicklung", "quantity": "12",
    "unit": "HUR", "unit_price": "120.00", "tax_percent": "19"
  }],
  "bank_account": { "iban": "DE89370400440532013000" },
  "include_zugferd": false
}

Respuesta correcta (200):

{
  "invoice":      { ... },
  "validation":   { "ok": true, "errors": [] },
  "xml_base64":   "PD94bWwgdmVyc2lvbj0iMS4wIi4uLg==",
  "zugferd_base64": null
}

ⓘ unit = UN/CEFACT-Code: HUR Stunde, C62 Stück, KGM kg. Bei XRechnung ist buyer_reference (Leitweg-ID) Pflicht.

Mismo cuerpo que /invoices, pero devuelve solo el resultado de validación — sin XML, sin PDF.

{
  "ok":     false,
  "errors": [
    { "level": "error", "code": "BR-04",
      "message": "Seller VAT identifier is mandatory." }
  ]
}

Envía una factura PDF como multipart/form-data. El escáner extrae todos los campos reconocibles y devuelve directamente XML válido.

curl -X POST https://rechnung.syypro.com/api/v1/extract \
     -H "X-API-Key: $XR_KEY" \
     -F "file=@rechnung.pdf" \
     -F "profile=ZUGFERD"

Campos de respuesta:

• confidence – Calidad de reconocimiento 0–100
• warnings – Campos que no estaban claros
• checklist – Verificación de completitud con códigos BT
• xml_base64 – XML XRechnung completo
• zugferd_base64 – PDF híbrido (si el perfil es ZUGFERD)