POST/v1/finance/invoices/export

Eksportēt rēķinu sarakstu

finance_invoices_export

Eksportē visus rēķinus, kas atbilst POST /v1/finance/invoices filtriem (bez lapām), CSV vai XLSX failā: numurs, datumi, virziens, puses, kategorija, valūta, summas, maksājums un summa pārskatu valūtā ar kursu, tā datumu un avotu. Ja rindu ir vairāk nekā 100000, atbilde ir finance.export_too_large; sašauriniet filtrus.

Autentifikācija

Nosūtiet API atslēgu galvenē Authorization: Authorization: Bearer <atslēga>.

Vaicājuma parametri

formatstring
Finanšu eksporta faila formāts: csv (noklusējums) vai xlsx.
Atļautās vērtības: csvxlsx
Noklusējums: "csv"

Galvenes parametri

X-View-Asstring
Tikai API atslēgām ar lomu admin. Izpilda pieprasījumu datu profila <profile>[:viewer|verifier|editor] vārdā, piemēram, employee:viewer. Instalācijas atslēga šo galveni lietot nevar (403).

Sīkdatņu parametri

kb_view_asstring
Režīma „View as“ (skatīt kā) sīkdatne sesijai. POST /auth/view-as to iestata, un DELETE /auth/view-as to notīra.

Pieprasījuma saturs

application/json

Objekts: FinanceListRequest

filtersFinanceFilter
date_basisstring
Atļautās vērtības: documentpayment
Noklusējums: "document"
orderstring
Atļautās vērtības: date_descdate_ascamount_descamount_asc
Noklusējums: "date_desc"
currency_modeFinanceCurrencyMode
limitinteger
Noklusējums: 100≥ 1, ≤ 1000
cursorstring
languagestring
Kategoriju nosaukumu valoda, en|ru.

Atbildes

200Rēķinu saraksta fails (Content-Disposition: attachment)

Atbildes galvenes

RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

text/csv

string

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

string (binary)

400Pieprasījums nav derīgs: parametra vērtība vai objekta stāvoklis neļauj veikt darbību (`detail` ir ziņojums).

Atbildes galvenes

RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

401Nav nosūtīti akreditācijas dati (ne sesijas sīkdatne, ne API atslēga), vai atslēga nav atrasta.

Atbildes galvenes

RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

403Darbība nav atļauta: loma nav pietiekama, nav piekļuves kolekcijai vai kartītei, pieprasījums izpildās režīmā „View as“ vai organizācija ir apturēta vai dzēsta (`detail` ir objekts ar `code: org_suspended | org_deleted`).

Atbildes galvenes

RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

413Pieprasījuma saturs pārsniedz atļauto izmēru.

Atbildes galvenes

RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

429Pārāk daudz pieprasījumu (`api.rate_limited`), organizācijas minūtes, dienas vai mēneša kvota ir izlietota (`api.quota_exceeded`; `error.details` satur `quota`, `limit` un `reset_at`), sasniegts organizācijas limits vai atbilžu pakalpojums ir aizņemts (`answers.engine_busy`). Pagaidiet galvenē `Retry-After` norādīto laiku.

Atbildes galvenes

Retry-After
Sekunžu skaits, kas jāpagaida, pirms atkārtojat pieprasījumu.
RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

503Pakalpojums, no kura atkarīgs šis pieprasījums, īslaicīgi nav pieejams. Atkārtojiet vēlāk.

Atbildes galvenes

RateLimit-Policy
Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.
RateLimit
Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).
X-RateLimit-Remaining
Atlikušo pieprasījumu skaits stingrākā limita ietvaros.
X-RateLimit-Reset
Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

Kļūdu kodi

Kodi, ko šī operācija var atgriezt laukā error.code papildus vispārīgajiem kodiem, kas iespējami jebkuram pieprasījumam.

Droši atkārtojumi

Ar katru POST un PATCH pieprasījumu nosūtiet galveni Idempotency-Key (piemēram, UUID). Atkārtots pieprasījums ar to pašu atslēgu 24 stundu laikā atgriež saglabāto atbildi, nevis izpilda pieprasījumu vēlreiz.

Pieprasījumu biežuma limiti

Atbildēs ir galvenes RateLimit un RateLimit-Policy, kā arī agrākās X-RateLimit-Limit, X-RateLimit-Remaining un X-RateLimit-Reset. Atbildē 429 ir galvene Retry-After sekundēs: nogaidiet un atkārtojiet pieprasījumu.

← finance · API rokasgrāmata

curl -X POST 'https://api.sursa.com/v1/finance/invoices/export' \
  -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"}' \
  -o download.csv \
  -H "Authorization: Bearer $SURSA_API_KEY"

Izmēģināt

API atslēga

Atslēga glabājas tikai šīs cilnes atmiņā un tiek sūtīta tikai uz https://api.sursa.com.

Pieprasījumi darbojas ar jūsu organizācijas reālajiem datiem.

X-View-As header

format query

Idempotency-Key

Ja lauks ir tukšs, katram pieprasījumam tiek ģenerēta jauna atslēga.

Pieprasījuma saturs (JSON)