Documentation API v1

Vérification de disponibilité simple. Retourne le statut de la base de données. Idéal pour la surveillance.

Réponse :

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

Retourne tous les profils pris en charge avec les métadonnées (champs obligatoires, type d'export).

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

Soumettre une facture en JSON → générer un XML valide (et générer optionnellement un PDF hybride).

Corps de la requête :

{
  "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
}

Réponse réussie (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.

Même corps que /invoices, mais retourne uniquement le résultat de validation — pas de XML, pas de PDF.

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

Envoie une facture PDF en multipart/form-data. Le scanner extrait tous les champs reconnaissables et retourne directement un XML valide.

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

Champs de réponse :

• confidence – Qualité de reconnaissance 0–100
• warnings – Champs qui n'étaient pas clairs
• checklist – Vérification de complétude avec codes BT
• xml_base64 – XML XRechnung complet
• zugferd_base64 – PDF hybride (si profil ZUGFERD)