Bāzes URL
https://freebillgen.com/api/v1Autentifikācija
Katram pieprasījumam tiek izmantots „Bearer“ žetons. Izveidojiet to sadaļā „Iestatījumi“ → „API atslēgas“, piešķiriet tam nepieciešamās lasīšanas/rakstīšanas tiesības katram resursam, iestatiet neobligātu derīguma termiņu un nosūtiet to katrā pieprasījumā:
Authorization: Bearer <your-api-key>Pieprasījumi tiek autentificēti kontā, kas izveidoja atslēgu, un pārbaudīti atbilstoši tai piešķirtajām tiesībām. Glabājiet atslēgu slepenībā un atsauciet to, ja tā ir kļuvusi publiski pieejama vai vairs nav nepieciešama.
Ko jūs varat darīt
- Lasīt rēķinus, klientus, uzņēmumus, maksājumus un periodiskos grafikus
- Izveidot un atjaunināt tos (rakstīšanas API - Pro)
- Lejupielādējiet PVN un parādu novecojuma pārskatus JSON formātā
- Izlasiet to pašu ierobežoto „Nākamās darbības” rindu, ko izmanto vadības panelis
- Lasīt piegādātāju e-rēķinu failus, kurus esat manuāli augšupielādējis iesūtņu kastē (nevis Peppol/e-pasta saņemšanas galapunktā)
- Lejupielādējiet vispārējās OASIS UBL un UN/CEFACT CII atbilstības tabulas pārskatīšanai (nav pārbaudītas atbilstoši profilam)
- Reģistrējiet webhook galapunktus rēķinu un maksājumu notikumiem (Pro)
- Idempotency-Key atbalstītajās rakstīšanas darbībās - mainīti pieprasījuma dati ar to pašu atslēgu atgriež 409
- Kursora paginācija, izmantojot links.next, regulējama ar per_page (maksimums 100)
- Ļaujiet AI aģentiem lasīt jebkuru kopīgotu rēķinu - schema.org/Invoice JSON-LD, kā arī galvene Accept: application/json vai text/markdown katrā parakstītā kopīgošanas saitē
- MCP serveris bez autentifikācijas un tikai lasīšanai, kas atrodas https://freebillgen.com/api/mcp (get_invoice, verify_invoice), paredzēts AI aģentiem
Konvencijas
- Idempotence
- Atbalstītajos izveides un darbības izsaukumos nosūtiet unikālu Idempotency-Key galvenes vērtību. Atkārtota identiska pieprasījuma datu nosūtīšana atgriež sākotnējo veiksmīgo atbildi; mainīti pieprasījuma dati atgriež kļūdu 409.
- Lappušu numerācija
- Saglabātie resursu saraksti tiek lappotēti pēc kursora - izmantojiet links.next (vai norādiet ?cursor=...) un pielāgojiet ?per_page= (maksimums 100). Ierobežotais darbību plūsmas ziņojums norāda savu limitu un saīsināto stāvokli.
- Nauda
- Naudas summas ir precīzas JSON virknes, kas formatētas atbilstoši valūtas ISO 4217 skalai, piemēram, "121.00" valūtai EUR vai "500" valūtai JPY. Vienības cenām var saglabāt papildu ievades precizitāti.
- ID
- Katrs resurss tiek adresēts ar necaurspīdīgu identifikatoru (opaque id), nekad ar secīgu numuru.
Piemērs: uzskaitiet savus rēķinus
curl https://freebillgen.com/api/v1/invoices \
-H "Authorization: Bearer $FREEBILLGEN_API_KEY"Atveriet pilnu interaktīvo API atsauci →
Jautājumi par rēķinu API
Vai rēķinu API ir bezmaksas?
Jā - lasīšanas API ir iekļauts bezmaksas pakalpojumu līmenī. Rakstīšanas API un izejošie webhooki ir iekļauti „49 € Lifetime Pro“ versijā ar nodokļiem iekļautiem: viens maksājums, bez ikmēneša maksas vai ikgadējas atjaunošanas.
Kā veikt autentifikāciju?
Izveidojiet „Bearer“ tokenu sadaļā „Iestatījumi“ -> „API atslēgas“, piešķiriet tam lasīšanas/rakstīšanas tiesības katram resursam un nosūtiet to kā „Authorization: Bearer“ galvenes rindu katrā pieprasījumā. Atslēgas ir saistītas ar jūsu paša kontu. Tās var atsaukt; to derīguma termiņš var arī beigties.
Vai es varu izveidot rēķinus, izmantojot programmēšanu?
Jā, izmantojot rakstīšanas API, kas ir daļa no „Pro“ paplašinājuma. Tas ģenerē tādus pašus profesionālus rēķinus kā tīmekļa lietotne, ar secīgu numurāciju un konfigurējamu PVN apstrādi, kas tiek piemērota servera pusē. API negarantē atbilstību vietējiem likumiem.
Kā izvairīties no rēķinu dublikātu izveides atkārtotā mēģinājumā?
Nosūtiet unikālu Idempotency-Key galvenes vērtību izveides izsaukumā. Atkārtota identiska pieprasījuma datu nosūtīšana ar šo vērtību atgriež sākotnējo rezultātu. Šīs vērtības atkārtota izmantošana ar mainītiem pieprasījuma datiem atgriež kļūdu 409, nevis bez brīdinājuma atgriež citu rēķinu.
Vai es varu lasīt saņemtos rēķinus?
Jā, bez maksas. GET /api/v1/inbox uzskaita atbalstītos UBL/CII piegādātāju failus, kurus esat manuāli augšupielādējuši un kurus FreeBillGen ir analizējis, saglabājot oriģinālu revīzijas vajadzībām; GET /api/v1/inbox/{id} atgriež vienu failu. Sintakses atpazīšana nav profila validācija, un šie galapunkti nepadara FreeBillGen par Peppol, valsts tīkla vai e-pasta saņemšanas galapunktu.
Vai AI aģents var izlasīt rēķinu bez konta?
Jā. Katrs rēķins, kuru jūs kopīgojat, izmantojot tā parakstīto publisko saiti, aģentam ir lasāms tajā pašā URL: lapā ir iebūvēts JSON-LD schema.org/Invoice, un, nosūtot Accept: application/json, tiek atgriezts strukturēts rēķins (puses, pozīcijas, kopsummas, atlikusī maksājamā summa, maksājumu iespējas), savukārt, nosūtot Accept: text/markdown, tiek atgriezts tīrs attēlojums ar mazāku tokenu skaitu. Tāpat ir pieejams Model Context Protocol (MCP) serveris bez autentifikācijas un tikai lasīšanai, kas atrodas https://freebillgen.com/api/mcp un kurā ir pieejami rīki get_invoice un verify_invoice. Saites paraksts ir piekļuves žetons. Pilno URL jāuzskata par slepenu informāciju, jo ikviens, kurš to saņem, var atvērt rēķinu.