POST/v1/finance/invoices

Listează facturile

finance_invoices

Returnează facturile, notele de credit și chitanțele organizației pagină cu pagină, cu filtre (perioadă, direcție, categorie, partener, monedă, tipul documentului, plătită, cu termen depășit, necesită revizuire, căutare după număr și parte), sortare și suma în moneda de raportare, cu cursul de conversie. Sunt incluse doar documentele vizibile pentru utilizator. Pentru pagina următoare, transmiteți next_cursor ca cursor, cu aceleași filtre. Necesită un profil de date cu acces la datele financiare.

Autentificare

Trimiteți o cheie API în antetul Authorization: Authorization: Bearer <cheie>.

Parametri de antet

X-View-Asstring
Doar pentru cheile API cu rolul admin. Execută cererea cu profilul de date <profile>[:viewer|verifier|editor], de exemplu employee:viewer. Cheia de instalare nu poate folosi acest antet (403).

Parametri cookie

kb_view_asstring
Cookie-ul modului „View as” (vizualizare ca alt utilizator) pentru o sesiune. POST /auth/view-as îl setează, iar DELETE /auth/view-as îl șterge.

Corpul cererii

application/json

Obiect: FinanceListRequest

filtersFinanceFilter
date_basisstring
Valori permise: documentpayment
Implicit: "document"
orderstring
Valori permise: date_descdate_ascamount_descamount_asc
Implicit: "date_desc"
currency_modeFinanceCurrencyMode
limitinteger
Implicit: 100≥ 1, ≤ 1000
cursorstring
languagestring
Limba etichetelor categoriilor, en|ru.

Răspunsuri

200O pagină de facturi

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: FinanceInvoicePage

invoicesarray of FinanceInvoiceRowobligatoriu
totalintegerobligatoriu
Numărul total de facturi care corespund filtrelor.
next_cursorstring
Cursorul paginii următoare. Dacă lipsește câmpul, aceasta este ultima pagină.
currencystring
Moneda de raportare a câmpurilor reporting (modul reporting).
warningsarray of string
Coduri de avertizare, aceleași ca în FinanceReport.warnings.
has_moreboolean
Dacă există o pagină următoare. Prezent când cererea transmite limit sau cursor.

400Cererea este invalidă: valoarea unui parametru sau starea obiectului nu permite acțiunea (`detail` este un mesaj).

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

401Nu au fost trimise date de autentificare (nici cookie de sesiune, nici cheie API) sau cheia nu a fost găsită.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

403Acțiunea nu este permisă: rolul este insuficient, nu există acces la colecție sau la fișă, cererea rulează în modul „View as” (vizualizare ca alt utilizator) sau organizația este suspendată ori ștearsă (`detail` este un obiect cu `code: org_suspended | org_deleted`).

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

429Prea multe cereri (`api.rate_limited`), cota organizației pentru minut, zi sau lună este epuizată (`api.quota_exceeded`; `error.details` conține `quota`, `limit` și `reset_at`), limita organizației este atinsă sau serviciul de răspunsuri este ocupat (`answers.engine_busy`). Așteptați timpul indicat în antetul `Retry-After`.

Antetele răspunsului

Retry-After
Numărul de secunde de așteptat înainte de a reîncerca cererea.
RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

503Un serviciu de care depinde această cerere este temporar indisponibil. Reîncercați mai târziu.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

Coduri de eroare

Codurile pe care acest endpoint le poate returna în error.code, pe lângă codurile generale ale oricărei cereri.

Reîncercări sigure

Trimiteți un antet Idempotency-Key (de exemplu, un UUID) cu fiecare POST și PATCH. O reîncercare cu aceeași cheie în decurs de 24 de ore returnează răspunsul salvat, fără să execute din nou cererea.

Limite de frecvență

Răspunsurile conțin antetele RateLimit și RateLimit-Policy, precum și antetele anterioare X-RateLimit-Limit, X-RateLimit-Remaining și X-RateLimit-Reset. Un răspuns 429 conține Retry-After în secunde: așteptați și reîncercați.

← finance · Referința 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"

Încercați

Cheie API

Cheia rămâne în memoria acestei file a browserului și este trimisă doar către https://api.sursa.com.

Cererile se execută pe datele reale ale organizației.

X-View-As header

Idempotency-Key

Dacă acest câmp este gol, pentru fiecare cerere se generează o cheie nouă.

Corpul cererii (JSON)