Dokumentacja API faktur

Dokumentacja API do fakturowania: REST API, które tworzy faktury, zarządza klientami i udostępnia linki.

Ta dokumentacja opisuje REST API QuickBilling. Produkcyjny adres bazowy to https://app.quickbilling.io/api. Ten sam opis jest opublikowany jako OpenAPI w pliku /openapi.yaml. Interaktywna dokumentacja poniżej wczytuje ten plik w przeglądarce.

Klucze API są częścią planu Unlimited. Wyślij klucz w nagłówku Authorization jako Bearer sk_live_... albo Bearer sk_test_.... Większość endpointów wymaga obszaru roboczego. Wyślij nagłówek X-Workspace-Id z UUID obszaru roboczego albo użyj klucza API, który jest już powiązany z obszarem roboczym.

Endpointy pod /agent należą do asystenta w aplikacji. Przyjmują wyłącznie zalogowaną sesję (JWT). Klucz API otrzymuje odpowiedź 403 JWT_AUTH_REQUIRED. Tylko /agent/usage oraz endpointy /agent/byok działają bez obszaru roboczego, ponieważ limit wiadomości i zapisane klucze należą do osoby, a nie do obszaru roboczego. Pozostałe endpointy /agent (czat, wątki, konfiguracja, pliki) wymagają nagłówka X-Workspace-Id, tak jak reszta API.

Tabela to mapa najważniejszych endpointów. Nie jest pełną specyfikacją. Pola żądania i odpowiedzi znajdują się w pliku OpenAPI i w dokumentacji poniżej. Publiczne endpointy, bez klucza, to GET /templates/system, GET /subscriptions/plans i GET /storage/view.

API dla deweloperów · openapi.yaml

Utwórz fakturę za pomocą curl

POST /invoices tworzy fakturę albo ją aktualizuje, jeśli identyfikator id już istnieje. Identyfikator id (UUID) wybiera się samodzielnie, dzięki czemu ponowione żądanie nie utworzy drugiej faktury.

curl

curl -X POST https://app.quickbilling.io/api/invoices \
  -H "Authorization: Bearer sk_live_..." \
  -H "X-Workspace-Id: 0b6f2c1e-8d4a-4f3b-9c7e-2a5d1e8f4b90" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "5f0c9a3e-2b7d-4c1a-8e6f-3d9b7a1c2e44",
    "number": "INV-0001",
    "issueDate": "2026-10-20",
    "dueDate": "2026-11-03",
    "currency": "USD",
    "customerDetails": { "name": "Bluebird Studio", "email": "billing@bluebird.example" },
    "items": [
      { "id": "1", "description": "Website design", "quantity": 3, "unit": "days", "price": 600 }
    ]
  }'

Zastąp sk_live_... swoim kluczem, a UUID własnymi. Faktura zostanie zapisana jako szkic (Draft). Opis wszystkich pól: InvoiceInput w pliku OpenAPI.

Przegląd endpointów

Przegląd endpointów
Metoda	Ścieżka	Krótki opis
Faktury
GET	/invoices	Lista faktur
POST	/invoices	Utwórz lub zaktualizuj fakturę
POST	/invoices/new	Utwórz szkic faktury
GET	/invoices/{id}	Pobierz jedną fakturę
POST	/invoices/{id}/share	Utwórz link do udostępnienia
DELETE	/invoices/{id}/share	Unieważnij link do udostępnienia
POST	/send-invoice	Wyślij fakturę e-mailem
GET	/invoices/{id}/analytics	Statystyki wyświetleń faktury
GET	/invoices/recurring-rules	Lista cyklicznych reguł faktur
POST	/invoices/recurring-rules	Utwórz cykliczną regułę faktury
Klienci
GET	/customers	Lista klientów
POST	/customers	Utwórz lub zaktualizuj klienta
Wydatki i raporty
GET	/expenses	Lista wydatków
GET	/overview/workspace/financial	Rachunek zysków i strat za wybrany okres
Szablony
GET	/templates/system	Lista wbudowanych szablonów
GET	/templates	Lista szablonów dostępnych w planie
Plany i klucze API
GET	/subscriptions/plans	Lista planów
GET	/auth/workspaces/{workspaceId}/api-keys	Lista kluczy API (JWT, nie klucz API)
POST	/auth/workspaces/{workspaceId}/api-keys	Utwórz klucz API (JWT, nie klucz API)
AsystentWymaga zalogowanej sesji (JWT). Klucz API nie może wywoływać tych endpointów.
GET	/agent/usage	Wiadomości asystenta wykorzystane dziś
POST	/agent/chat	Wyślij jedną turę asystenta (wymaga X-Workspace-Id)

Pełna interaktywna dokumentacja wczytuje się w przeglądarce z pliku OpenAPI.