POST/v1/finance/payments

Zobraziť platby

finance_payments

Vráti zoznam platieb organizácie po stránkach (bankové výpisy, súpisy platieb, výplatné listiny, uhradené faktúry a pokladničné doklady; neuhradené faktúry a kópie dokladov sa nezahŕňajú) s rovnakými filtrami, zoradením a prepočtom ako zoznam faktúr. Zahrnuté sú len doklady viditeľné pre používateľa. Vyžaduje dátový profil s prístupom k finančným údajom.

Autentifikácia

Odošlite kľúč API v hlavičke Authorization: Authorization: Bearer <kľúč>.

Parametre hlavičky

X-View-Asstring
Len pre kľúče API s rolou admin. Vykoná požiadavku v mene dátového profilu <profile>[:viewer|verifier|editor], napríklad employee:viewer. Inštalačný kľúč túto hlavičku použiť nemôže (403).

Parametre cookie

kb_view_asstring
Súbor cookie režimu „View as“ pre reláciu. POST /auth/view-as ho nastaví a DELETE /auth/view-as ho odstráni.

Telo požiadavky

application/json

Objekt: FinanceListRequest

filtersFinanceFilter
date_basisstring
Povolené hodnoty: documentpayment
Predvolené: "document"
orderstring
Povolené hodnoty: date_descdate_ascamount_descamount_asc
Predvolené: "date_desc"
currency_modeFinanceCurrencyMode
limitinteger
Predvolené: 100≥ 1, ≤ 1000
cursorstring
languagestring
Jazyk názvov kategórií, en|ru.

Odpovede

200Stránka platieb

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: FinancePaymentPage

paymentsarray of FinancePaymentRowpovinné
totalintegerpovinné
Celkový počet platieb, ktoré zodpovedajú filtrom.
next_cursorstring
Kurzor ďalšej stránky. Ak pole chýba, ide o poslednú stránku.
currencystring
Vykazovacia mena polí reporting (režim reporting).
warningsarray of string
Kódy upozornení, rovnaké ako vo FinanceReport.warnings.
has_moreboolean
Či existuje ďalšia stránka. Je prítomné, keď požiadavka odovzdá limit alebo cursor.

400Požiadavka je neplatná: hodnota parametra alebo stav objektu akciu nedovoľuje (`detail` je správa).

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

401Neboli odoslané žiadne prihlasovacie údaje (ani cookie relácie, ani kľúč API) alebo sa kľúč nenašiel.

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

403Akcia nie je povolená: rola nestačí, chýba prístup ku kolekcii alebo karte, požiadavka beží v režime „View as“ alebo je organizácia pozastavená či odstránená (`detail` je objekt s `code: org_suspended | org_deleted`).

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

429Príliš veľa požiadaviek (`api.rate_limited`), vyčerpaná kvóta organizácie na minútu, deň alebo mesiac (`api.quota_exceeded`; `error.details` obsahuje `quota`, `limit` a `reset_at`), dosiahnutý limit organizácie alebo zaneprázdnená služba odpovedí (`answers.engine_busy`). Počkajte čas uvedený v hlavičke `Retry-After`.

Hlavičky odpovede

Retry-After
Počet sekúnd, ktoré treba počkať pred opakovaním požiadavky.
RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

503Služba, od ktorej táto požiadavka závisí, je dočasne nedostupná. Skúste to znova neskôr.

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

Chybové kódy

Kódy, ktoré táto operácia môže vrátiť v error.code, okrem všeobecných kódov každej požiadavky.

Bezpečné opakovanie

S každou požiadavkou POST a PATCH odošlite hlavičku Idempotency-Key (napríklad UUID). Opakovaná požiadavka s rovnakým kľúčom do 24 hodín vráti uloženú odpoveď namiesto toho, aby sa požiadavka vykonala znova.

Limity frekvencie

Odpovede obsahujú hlavičky RateLimit a RateLimit-Policy a staršie X-RateLimit-Limit, X-RateLimit-Remaining a X-RateLimit-Reset. Odpoveď 429 má hlavičku Retry-After v sekundách: počkajte a požiadavku zopakujte.

← finance · Referencia API

curl -X POST 'https://api.sursa.com/v1/finance/payments' \
  -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"

Vyskúšať

Kľúč API

Kľúč zostáva v pamäti tejto karty prehliadača a odosiela sa len na https://api.sursa.com.

Požiadavky pracujú so skutočnými údajmi vašej organizácie.

X-View-As header

Idempotency-Key

Ak je pole prázdne, pre každú požiadavku sa vygeneruje nový kľúč.

Telo požiadavky (JSON)