Dokumentácia API

API InvoiceHD umožňuje integráciu vašich aplikácií s našou fakturačnou službou. Môžete získať zoznam faktúr, získať podrobné údaje, nahrať PDF na spracovanie a spravovať svoje spoločnosti.

Autentifikácia

Všetky požiadavky na API vyžadujú kľúč API odoslaný v HTTP hlavičke X-API-Key.

1. Generovanie kľúča API: Prejdite na stránku API kľúče vo vašom profile a kliknite na tlačidlo "Nový kľúč API".
2. Použitie: Zahrňte hlavičku do svojich požiadaviek: X-API-Key: inv-vas-api-kluc-tu.

Základná URL

Základná URL adresa API je https://invoicehd.madcon.sk/api.

Automaticky generovaná dokumentácia (Swagger/Redoc) je dostupná na https://invoicehd.madcon.sk/api/doc.

Koncové body (Endpoints)

1. Zoznam faktúr

GET /invoice

Vráti zoznam indexovaných faktúr so základnými metadátami.

• Parametre dopytu:
  • from_datetime (Voliteľné): ISO 8601 dátum a čas. Používa sa na stránkovanie (uložte hodnotu created poslednej faktúry).
  • to_datetime (Voliteľné): ISO 8601 dátum a čas.
  • max_items (Voliteľné): Maximálny počet vrátených položiek (predvolené: 20).
  • company_reg_id (Voliteľné): Filtrovať podľa IČO spoločnosti.
• Odpoveď: Zoznam súhrnov faktúr.

Príklad: bash curl -H "X-API-Key: inv-..." "https://invoicehd.madcon.sk/api/invoice?max_items=10"

2. Získanie detailov faktúry

GET /invoice/<invoice_id>

Získa všetky údaje o konkrétnej faktúre vrátane úplných metadát, údajov o dodávateľovi/odberateľovi a súm.

• Odpoveď: Podrobný objekt faktúry.

Príklad: bash curl -H "X-API-Key: inv-..." "https://invoicehd.madcon.sk/api/invoice/ABC123XYZ"

3. Získanie URL pôvodnej faktúry

GET /invoice-url/<invoice_id>

Vráti dočasnú pre-signed URL adresu na stiahnutie pôvodného PDF súboru faktúry.

• Odpoveď: Reťazec obsahujúci URL.

4. Spracovanie PDF (Asynchrónne)

POST /parse-invoice

Nahrajte súbor PDF na asynchrónne spracovanie naším systémom.

• Content-Type: multipart/form-data
• Dáta formulára:
  • file: Súbor PDF, ktorý chcete nahrať.
• Odpoveď: job_id na sledovanie priebebu.

Príklad: bash curl -X POST -H "X-API-Key: inv-..." -F "file=@invoice.pdf" "https://invoicehd.madcon.sk/api/parse-invoice"

5. Kontrola stavu spracovania

GET /parse-invoice-status/<job_id>

Kontrola stavu asynchrónnej úlohy spracovania.

• Odpoveď: Stav úlohy vrátane result_code a invoice_id (ak bolo spracovanie úspešne dokončené).

6. Zoznam spoločností

GET /company

Vráti zoznam vašich registrovaných spoločností.

Koncové body ISDOC

Generovanie ISDOC XML

GET /gen-isdoc/<invoice_id>

Vráti reprezentáciu faktúry vo formáte ISDOC XML.

Generovanie PDF s ISDOC

GET /gen-isdoc-invoice/<invoice_id>

Vráti URL adresu na súbor PDF, ktorý má priložený súbor ISDOC XML.