Preskoči na sadržaj
Sursa Developers

POST/v1/finance/report

Dohvaćanje financijskog zbirnog izvješća

finance_report

Vraća ukupne iznose računa ili plaćanja organizacije, grupirane po najviše tri dimenzije (kategorija, grupa, djelatnost dobavljača, dobavljač, kupac, poslovni partner, smjer, valuta, mjesec, tromjesečje, godina), s pokazateljima invoiced, paid, unpaid i tax. Ukupni iznosi uključuju samo dokumente vidljive korisniku (zbirke i kategorije njegova podatkovnog profila te postavku „Answer only from verified cards” – odgovor samo iz provjerenih kartica); filtri zahtjeva sužavaju taj skup, ali ga nikad ne proširuju.

U načinu reporting (zadano) iznosi se preračunavaju u izvještajnu valutu organizacije po tečaju na datum dokumenta, a iznosi bez tečaja navode se u conversion.unconverted. U načinu original iznosi u različitim valutama ne zbrajaju se, a valuta postaje dimenzija retka. Ako ima više redaka od limit, truncated je true, a totals i dalje obuhvaćaju sve retke. Zahtijeva podatkovni profil s pristupom financijskim podacima (finance.forbidden).

Izvješće, popisi računa i plaćanja te njihovi izvozi operacije su čitanja iako koriste POST: dostupni su u načinu „View as” i API ključevima s opsegom read (i, kao i prije, ključevima s opsegom write).

Autentifikacija

Pošaljite API ključ u zaglavlju Authorization: Authorization: Bearer <ključ>.

Parametri zaglavlja

  • X-View-Asstring

    Samo za API ključeve s ulogom admin. Izvodi zahtjev kao podatkovni profil <profile>[:viewer|verifier|editor], na primjer employee:viewer. Ključ instalacije ne može koristiti ovo zaglavlje (403).

Parametri kolačića

  • kb_view_asstring

    Kolačić načina „View as” za sesiju. Postavlja ga POST /auth/view-as, a briše DELETE /auth/view-as.

Tijelo zahtjeva

application/json

Objekt: FinanceReportRequest

  • basisstring

    invoices: računi, knjižna odobrenja i blagajnički računi. payments: zapisnik plaćanja (novčani tok). Uz payments jedini je pokazatelj paid, a dimenzija direction i ukupni iznos prikazuju kretanje novca, in ili out, dok je prijenos između vaših vlastitih pravnih osoba internal.

    Dopuštene vrijednosti: invoicespayments

    Zadano: "invoices"

  • group_byarray of FinanceDimension

    items ≤ 3

  • measuresarray of FinanceMeasure

    Zadano: invoiced (paid za payments).

  • currency_modeFinanceCurrencyMode
  • date_basisstring

    Koji datum određuje razdoblje i filtar from/to: datum dokumenta ili datum plaćanja.

    Dopuštene vrijednosti: documentpayment

    Zadano: "document"

  • filtersFinanceFilter
  • order_bystring

    Pokazatelj ili dimenzija za sortiranje. Zadano: prvi pokazatelj silaznim redoslijedom.

  • order_descboolean

    Zadano: true

  • limitinteger

    Zadano: 1000≥ 1, ≤ 10000

  • languagestring

    Jezik naziva kategorija i grupa, en|ru. Zadano: en.

Odgovori

200Izvješće

Zaglavlja odgovora

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: FinanceReport

  • currency_modeFinanceCurrencyModeobavezno
  • currencystring

    Izvještajna valuta (način reporting).

  • rowsarray of FinanceReportRowobavezno
  • totalsarray of FinanceReportTotalobavezno

    Ukupni iznosi po svim redcima prije skraćivanja, jedan zapis po valuti (u izvješću razdvojenom po smjeru – po valuti i smjeru, FinanceReportTotal.direction).

  • truncatedbooleanobavezno
  • limitintegerobavezno
  • total_rowsintegerobavezno

    Broj grupiranih redaka prije skraćivanja.

  • conversionFinanceConversion
  • warningsarray of string

    Kodovi upozorenja: profile_missing – podaci o tvrtki organizacije nisu postavljeni, pa je smjer računa zadano in; catalog_missing – imenik tvrtki nije učitan; fx_rate_missing – za dio iznosa nema tečaja (conversion.unconverted); fx_rate_stale – dio tečajeva je zastario; enrichment_pending – dio dokumenata još se obrađuje i nije uključen u ukupne iznose. Nepoznat kod prikažite općenitom porukom.

400Zahtjev nije valjan: vrijednost parametra ili stanje objekta ne dopušta radnju (`detail` je poruka).

Zaglavlja odgovora

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

401Vjerodajnice nisu poslane (ni kolačić sesije ni API ključ) ili ključ nije pronađen.

Zaglavlja odgovora

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

403Radnja nije dopuštena: uloga nije dovoljna, nema pristupa zbirci ili kartici, zahtjev se izvodi u načinu „View as” ili je organizacija suspendirana ili izbrisana (`detail` je objekt s `code: org_suspended | org_deleted`).

Zaglavlja odgovora

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

429Previše zahtjeva (`api.rate_limited`), kvota organizacije za minutu, dan ili mjesec je potrošena (`api.quota_exceeded`; `error.details` sadrži `quota`, `limit` i `reset_at`), dosegnuto je ograničenje organizacije ili je usluga odgovora zauzeta (`answers.engine_busy`). Pričekajte vrijeme navedeno u zaglavlju `Retry-After`.

Zaglavlja odgovora

  • Retry-After

    Broj sekundi koje treba pričekati prije ponovnog pokušaja zahtjeva.

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

503Usluga o kojoj ovaj zahtjev ovisi privremeno nije dostupna. Pokušajte ponovno kasnije.

Zaglavlja odgovora

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

Kodovi pogrešaka

Kodovi koje ova operacija može vratiti u error.code, uz opće kodove svakog zahtjeva.

Sigurni ponovni pokušaji

Uz svaki POST i PATCH pošaljite zaglavlje Idempotency-Key (na primjer UUID). Ponovni pokušaj s istim ključem unutar 24 sata vraća spremljeni odgovor umjesto da ponovno izvrši zahtjev.

Ograničenja učestalosti

Odgovori sadrže zaglavlja RateLimit i RateLimit-Policy te ranija zaglavlja X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Odgovor 429 sadrži zaglavlje Retry-After u sekundama: pričekajte i pokušajte ponovno.

← finance · Referenca API-ja