API v1
REST API dla Factuur.software. Część subskrypcji Pro. JSON w i out, uwierzytelnianie Bearer.
Uwierzytelnianie
Prześlij swój klucz API w nagłówku Authorization:
Authorization: Bearer JOUW_SLEUTEL
Wygeneruj swój klucz przez Profil, w sekcji Dostęp API. Klucz jest widoczny tylko raz - potem przechowujemy tylko hash. Zgubiony? Cofnij go i wygeneruj nowy.
Limit zapytań
1000 zapytań na godzinę na użytkownika. Powyżej następuje HTTP 429.
Endpoints
| Metoda | Ścieżka | Opis |
|---|---|---|
| GET | /api/v1/me | profil, subskrypcja, funkcje i zużycie |
| GET | /api/v1/invoices | faktury (niearchiwalne); zapytanie: od, do (YYYY-MM-DD), limit (max 1000), offset |
| GET | /api/v1/invoices/{id} | jedna faktura z pozycjami i klientem |
| POST | /api/v1/invoices | utwórz fakturę; invoice_number puste = automatyczne numerowanie, linie opcjonalne |
| PUT | /api/v1/invoices/{id} | zmień status, invoice_number, issue_date, due_date, notes lub customer_id |
| DELETE | /api/v1/invoices/{id} | archiwizuje fakturę (obowiązek przechowywania, brak ostatecznego usunięcia) |
| GET | /api/v1/customers | klienci; zapytanie: limit, offset |
| GET | /api/v1/customers/{id} | jeden klient |
| POST | /api/v1/customers | dodaj klienta; nazwa jest wymagana |
| PUT | /api/v1/customers/{id} | zmień pola klienta |
| DELETE | /api/v1/customers/{id} | usuń klienta; 409 dopóki są powiązane faktury |
| GET | /api/v1/expenses | wydatki; zapytanie: od, do (RRRR-MM-DD), limit, offset |
| GET | /api/v1/expenses/{id} | jeden wydatek |
| POST | /api/v1/expenses | dodaj wydatek |
| PUT | /api/v1/expenses/{id} | zmień wydatek; kwoty i VAT będą przeliczone |
| DELETE | /api/v1/expenses/{id} | usuń wydatek |
Kody statusu
200/201udało się401Brak tokena Bearer lub jest nieprawidłowy403subskrypcja nie daje dostępu do API404nie znaleziono409konflikt, na przykład usunięcie klienta z fakturami422nieprawidłowy ładunek429przekroczono limit szybkości
Przykłady
curl -H "Authorization: Bearer JOUW_SLEUTEL" https://factuur.software/api/v1/me
curl "https://factuur.software/api/v1/invoices?from=2026-01-01&limit=50" -H "Authorization: Bearer JOUW_SLEUTEL"
curl -X POST -H "Authorization: Bearer JOUW_SLEUTEL" -H "Content-Type: application/json" -d '{"customer_id":1,"lines":[{"description":"Consultancy","quantity":8,"unit_price":95,"tax_rate":21}]}' https://factuur.software/api/v1/invoices
curl -X PUT -H "Authorization: Bearer JOUW_SLEUTEL" -H "Content-Type: application/json" -d '{"status":"betaald"}' https://factuur.software/api/v1/invoices/123