Mine sisu juurde
Sursa Developers

POST/v1/finance/report

Finantskokkuvõtte aruande pärimine

finance_report

Tagastab organisatsiooni arvete või maksete summad, rühmitatud kuni kolme dimensiooni järgi (kategooria, rühm, tarnija tegevusala, tarnija, ostja, tehingupartner, suund, valuuta, kuu, kvartal, aasta), mõõdikutega invoiced, paid, unpaid ja tax. Summad hõlmavad ainult kasutajale nähtavaid dokumente (tema andmeprofiili kogud ja kategooriad ning seade „vasta ainult kontrollitud kaartide põhjal“); päringu filtrid kitsendavad seda valikut, kuid ei laienda seda kunagi.

Režiimis reporting (vaikimisi) konverteeritakse summad organisatsiooni aruandlusvaluutasse dokumendi kuupäeva kursiga ja kursita summad loetletakse väljal conversion.unconverted. Režiimis original ei liideta eri valuutades summasid ja valuutast saab rea dimensioon. Kui ridu on rohkem kui limit, on truncated väärtusega true ja totals hõlmab endiselt kõiki ridu. Nõuab andmeprofiili, millel on juurdepääs finantsandmetele (finance.forbidden).

Aruanne, arvete ja maksete loendid ning nende ekspordid on lugemistoimingud, kuigi need kasutavad meetodit POST: need on saadaval režiimis „View as“ ja ulatusega read API-võtmetele (ning nagu varemgi, ulatusega write võtmetele).

Autentimine

Saatke API-võti päises Authorization: Authorization: Bearer <võti>.

Päiseparameetrid

  • X-View-Asstring

    Ainult rolliga admin API-võtmetele. Teeb päringu andmeprofiili <profile>[:viewer|verifier|editor] nimel, näiteks employee:viewer. Paigaldusvõti seda päist kasutada ei saa (403).

Küpsiseparameetrid

  • kb_view_asstring

    Seansi režiimi „View as“ küpsis. POST /auth/view-as määrab selle ja DELETE /auth/view-as kustutab selle.

Päringu keha

application/json

Objekt: FinanceReportRequest

  • basisstring

    invoices: arved, kreeditarved ja kviitungid. payments: maksete logi (rahavoog). Valikuga payments on ainus mõõdik paid ning dimensioon direction ja kokkuvõte näitavad raha liikumist, in või out, kusjuures ülekanne teie enda juriidiliste isikute vahel on internal.

    Lubatud väärtused: invoicespayments

    Vaikimisi: "invoices"

  • group_byarray of FinanceDimension

    items ≤ 3

  • measuresarray of FinanceMeasure

    Vaikimisi invoiced (payments puhul paid).

  • currency_modeFinanceCurrencyMode
  • date_basisstring

    Milline kuupäev määrab perioodi ja filtri from/to: dokumendi kuupäev või makse kuupäev.

    Lubatud väärtused: documentpayment

    Vaikimisi: "document"

  • filtersFinanceFilter
  • order_bystring

    Mõõdik või dimensioon, mille järgi sorteeritakse. Vaikimisi esimene mõõdik kahanevas järjekorras.

  • order_descboolean

    Vaikimisi: true

  • limitinteger

    Vaikimisi: 1000≥ 1, ≤ 10000

  • languagestring

    Kategooriate ja rühmade nimetuste keel, en|ru. Vaikimisi en.

Vastused

200Aruanne

Vastuse päised

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: FinanceReport

  • currency_modeFinanceCurrencyModekohustuslik
  • currencystring

    Aruandlusvaluuta (režiim reporting).

  • rowsarray of FinanceReportRowkohustuslik
  • totalsarray of FinanceReportTotalkohustuslik

    Kokkuvõtted kõigi ridade kohta enne kärpimist, üks kirje valuuta kohta (suundade kaupa jaotatud aruandes valuuta ja suuna kohta, FinanceReportTotal.direction).

  • truncatedbooleankohustuslik
  • limitintegerkohustuslik
  • total_rowsintegerkohustuslik

    Rühmitatud ridade arv enne kärpimist.

  • conversionFinanceConversion
  • warningsarray of string

    Hoiatuskoodid: profile_missing – organisatsiooni ettevõtte andmed ei ole määratud, seega on arve suund vaikimisi in; catalog_missing – ettevõtete register ei ole laaditud; fx_rate_missing – mõnel summal puudub vahetuskurss (conversion.unconverted); fx_rate_stale – mõned kursid on vananenud; enrichment_pending – mõnda dokumenti alles töödeldakse ja need ei ole kokkuvõtetesse arvatud. Näidake tundmatut koodi üldise teatega.

400Päring on vigane: parameetri väärtus või objekti olek ei võimalda toimingut (`detail` on teade).

Vastuse päised

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: Error

401Autentimisandmeid ei saadetud (ei seansiküpsist ega API-võtit) või võtit ei leitud.

Vastuse päised

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: Error

403Toiming ei ole lubatud: rollist ei piisa, puudub juurdepääs kogule või kaardile, päring töötab režiimis „View as“ või organisatsioon on peatatud või kustutatud (`detail` on objekt väärtusega `code: org_suspended | org_deleted`).

Vastuse päised

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: Error

429Liiga palju päringuid (`api.rate_limited`), organisatsiooni minuti-, päeva- või kuukvoot on ära kasutatud (`api.quota_exceeded`; `error.details` sisaldab välju `quota`, `limit` ja `reset_at`), organisatsiooni limiit on täis või vastuseteenus on hõivatud (`answers.engine_busy`). Oodake päises `Retry-After` antud aeg.

Vastuse päised

  • Retry-After

    Sekundite arv, mida oodata enne päringu kordamist.

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: Error

503Teenus, millest see päring sõltub, ei ole ajutiselt kättesaadav. Proovige hiljem uuesti.

Vastuse päised

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: Error

Veakoodid

Koodid, mida see lõpp-punkt võib lisaks iga päringu üldistele koodidele tagastada väljal error.code.

Turvalised korduskatsed

Saatke iga POST- ja PATCH-päringuga päis Idempotency-Key (näiteks UUID). Sama võtmega korduskatse 24 tunni jooksul tagastab salvestatud vastuse ega käivita päringut uuesti.

Sageduspiirangud

Vastustes on päised RateLimit ja RateLimit-Policy ning varasemad X-RateLimit-Limit, X-RateLimit-Remaining ja X-RateLimit-Reset. Vastuses 429 on päis Retry-After sekundites: oodake ja proovige uuesti.

← finance · API teatmik