POST/v1/finance/invoices

Pobieranie listy faktur

finance_invoices

Zwraca faktury, faktury korygujące i paragony organizacji strona po stronie, z filtrami (okres, kierunek, kategoria, kontrahent, waluta, typ dokumentu, zapłacone, po terminie, wymaga przejrzenia, wyszukiwanie według numeru i strony), sortowaniem oraz kwotą w walucie sprawozdawczej z kursem przeliczeniowym. Uwzględniane są tylko dokumenty widoczne dla użytkownika. Aby pobrać następną stronę, przekaż next_cursor jako cursor z tymi samymi filtrami. Wymaga profilu dostępu z dostępem do danych finansowych.

Uwierzytelnianie

Wyślij klucz API w nagłówku Authorization: Authorization: Bearer <klucz>.

Parametry nagłówka

X-View-Asstring
Tylko dla kluczy API z rolą admin. Wykonuje żądanie jako profil dostępu <profile>[:viewer|verifier|editor], np. employee:viewer. Klucz instalacji nie może używać tego nagłówka (403).

Parametry cookie

kb_view_asstring
Plik cookie trybu „View as” dla sesji. POST /auth/view-as go ustawia, a DELETE /auth/view-as usuwa.

Treść żądania

application/json

Obiekt: FinanceListRequest

filtersFinanceFilter
date_basisstring
Dozwolone wartości: documentpayment
Domyślnie: "document"
orderstring
Dozwolone wartości: date_descdate_ascamount_descamount_asc
Domyślnie: "date_desc"
currency_modeFinanceCurrencyMode
limitinteger
Domyślnie: 100≥ 1, ≤ 1000
cursorstring
languagestring
Język etykiet kategorii, en|ru.

Odpowiedzi

200Strona faktur

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: FinanceInvoicePage

invoicesarray of FinanceInvoiceRowwymagane
totalintegerwymagane
Łączna liczba faktur pasujących do filtrów.
next_cursorstring
Kursor następnej strony. Brak pola oznacza ostatnią stronę.
currencystring
Waluta sprawozdawcza pól reporting (tryb reporting).
warningsarray of string
Kody ostrzeżeń, takie same jak w FinanceReport.warnings.
has_moreboolean
Czy istnieje następna strona. Obecne, gdy żądanie przekazuje limit lub cursor.

400Żądanie jest nieprawidłowe: wartość parametru lub stan obiektu nie pozwala na to działanie (`detail` zawiera komunikat).

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

401Nie przesłano danych uwierzytelniających (ani pliku cookie sesji, ani klucza API) lub nie znaleziono klucza.

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

403Działanie jest niedozwolone: rola jest niewystarczająca, brak dostępu do kolekcji lub karty, żądanie jest wykonywane w trybie „View as” albo organizacja jest zawieszona lub usunięta (`detail` to obiekt z `code: org_suspended | org_deleted`).

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

429Zbyt wiele żądań (`api.rate_limited`), wyczerpano przydział organizacji na minutę, dzień lub miesiąc (`api.quota_exceeded`; `error.details` zawiera `quota`, `limit` i `reset_at`), osiągnięto limit organizacji albo usługa odpowiedzi jest zajęta (`answers.engine_busy`). Odczekaj czas podany w nagłówku `Retry-After`.

Nagłówki odpowiedzi

Retry-After
Liczba sekund oczekiwania przed ponowieniem żądania.
RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

503Usługa, od której zależy to żądanie, jest tymczasowo niedostępna. Ponów żądanie później.

Nagłówki odpowiedzi

RateLimit-Policy
Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.
RateLimit
Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).
X-RateLimit-Remaining
Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-Reset
Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

Kody błędów

Kody, które ta operacja może zwrócić w error.code, oprócz ogólnych kodów każdego żądania.

Bezpieczne ponawianie

Wysyłaj nagłówek Idempotency-Key (na przykład UUID) z każdym żądaniem POST i PATCH. Ponowienie z tym samym kluczem w ciągu 24 godzin zwraca zapisaną odpowiedź, zamiast ponownie wykonywać żądanie.

Limity częstotliwości

Odpowiedzi zawierają nagłówki RateLimit i RateLimit-Policy oraz starsze X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Odpowiedź 429 ma nagłówek Retry-After w sekundach: odczekaj i ponów żądanie.

← finance · Dokumentacja API

curl -X POST 'https://api.sursa.com/v1/finance/invoices' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"filters":{"from":"2026-10-24","to":"2026-10-24","directions":["in"]},"date_basis":"document","order":"date_desc"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Wypróbuj

Klucz API

Klucz zostaje w pamięci tej karty przeglądarki i jest wysyłany tylko do https://api.sursa.com.

Żądania działają na prawdziwych danych Twojej organizacji.

X-View-As header

Idempotency-Key

Gdy to pole jest puste, dla każdego żądania generowany jest nowy klucz.

Treść żądania (JSON)