OData síun

Follow

REST-líkt API / OData uppspretta

RESTful API frá Uniconta með takmarkaðri OData samhæfni hentar fyrir: • Útdráttur aðalgagna og færslna. • Samþætting við skýrslugerðartól (Excel, Power BI, o.s.frv.) • Gagnagreining og einfaldar API lausnir. • Samþætting við kerfi sem eru ekki byggð á Windows.

Til að fá aðgang að öllum eiginleikum skaltu skoða .NET API Uniconta.

ATH: Þjónustuver styður ekki API-beiðnir, vinsamlegast hafið samband við endursöluaðila okkar:

Listi yfir söluaðila sem bjóða upp á API aðstoð

 

Öryggi og áreiðanleiki

Öll samskipti fara fram í gegnum HTTPS og eru varin með TLS (Transport Layer Security) dulkóðun . Þetta tryggir:

API-ið notar sjálfgefið HTTP Basic Authentication , en þegar það er notað úr tólum eins og Excel eða Power BI gerist þetta sjálfkrafa og á öruggan hátt í bakgrunni.

Inntökuskilyrði - Innskráning

Til að fá aðgang að API-inu þarftu: - Notandinn hefur réttindi í viðkomandi fyrirtæki - Ef þú ert Univisor, þá verður viðkomandi fyrirtæki að hafa: • Samþættingarpakkinn eða • Sjálfvirknipakki

Þú getur þá skráð þig inn með HTTP Basic Auth (venjulegri HTTP notendanafns-/lykilorðsstaðfestingu) annað hvort í vafranum þínum, í Excel eða annars staðar.

Nota í Excel

  1. Gögn> Sækja gögn> Frá öðrum aðilum> Úr OData-straumi 2. Sláðu inn vefslóð 3. Innskráning með Uniconta notanda 4. Hlaða gögnum sem töflu eða snúningstöflu

Lesið meira hér - ítarleg uppsetningarleiðbeining

vefslóðauppbygging

Grunnbygging:

https://odata.uniconta.com/odata/<FIRMAID>/<ENDPOINT>?<URLPARAMETRE>

Akur Útskýring Skyldubundið
FYRIRTÆKISKENNI Fyrirtækjakenni þitt

Nei (annars venjulegt fyrirtæki)
ENDAPUNKT Taflan í Uniconta. Ef ekkert er tilgreint birtist listi yfir tiltæka endapunkta.

Nei
Slóðarbreytur Síun, flokkun, síðuskipting

Nei

Til dæmis:

Vinsælir endapunktar

Færibreytur Lýsing
SkuldariViðskiptavinur Skuldara
LánardrottinnViðskiptavinur Kröfuhafar
DebtorTransClient Viðskiptakröfufærslur
GLTransClient Fjárhagsfærslur
GLBudgetLineClient Fjárhagsáætlunarlínur
Reikningarviðskiptavinur Vörulisti
SkuldarapöntunViðskiptavinur Sölupantanir
Notandi reikningsskilaboða Sérsniðnar vörur
 

Vefslóðarbreytur

Færibreytur Lýsing
$sía Sía gögn út frá reitgildum
$pöntun eftir Raða eftir reit
$top Hámarksfjöldi raða sem skilað er
$sleppa Sleppa röðum (blaðsíðuskipti)

Síun með $filter

Með $filter er hægt að takmarka niðurstöður fyrirspurnarinnar þannig að aðeins þær upplýsingar sem þarf – til dæmis tiltekinn viðskiptavin, færslur innan tímabils eða vörur í tilteknum hópi. Þetta sparar tíma, net og kerfisauðlindir.

Samanburðarvirkjar

Rekstraraðili Lýsing Dæmi

Grunngögn * 1

Færsla *2
jöfnu Liggðu með Account eq '1000' Já Já
nei Ekki jafnt og Costmodel ne 'FIFO' Já Já
gt Stærra en Balance gt 0 Já Já
gefa Stærra en eða jafnt og OrderNumber ge 100 Já Já
það Minna en Amount lt 1000 Já Já
hlátur Minna en eða jafnt og Amount le 5000 Já Já
byrjar með () Byrjar með startswith(Name, 'ABC') Já Já
endar með() Endar með endswith(Name, 'ApS') Já Já
undirstrengur() Inniheldur substringof(Email, '.com') Já Já
að lækka() Breytir í lágstafi tolower(Name) eq 'john' Já
toppur() Breytir í hástafi toupper(Code) eq 'ABC123' Já
lengd() Lengd strengs length(Name) gt 5 Já
undirstrengur() Undirstrengur substring(Name, 0, 3) eq 'Joh' Já
vísitala() Vísitala undirstrengs índexof(Name, 'x') gt 0 Já
snyrta() Að snyrta eyður trim(Name) eq 'Alice' Já
  • 1) Grunngagnatöflur - Vísitölur

Taflur með aðalgögnum styðja allar ofangreindar aðgerðir.

Þú getur fundið lista yfir þessar töflur í Uniconta undir Fyrirtæki - Allar athugasemdir - Hér birtist listi yfir vísitölur eins og hér að neðan:

  • 2) Færslutöflur

Færslutöflur styðja aðeins grunnaðgerðir. Dæmi um færslutöflur:

  • GLTransClient
  • GLDobtorTransClient
 

Rökfræðilegir rekstraraðilar

Rekstraraðili Lýsing Dæmi
Andi Öllum skilyrðum verður að vera fullnægt Account eq '1000' and Balance gt 0
Eða Að minnsta kosti eitt skilyrði verður að vera uppfyllt Group eq 'A' or Group eq 'B'
Hak Notað með öðrum rekstraraðilum til að útiloka CostModel NOT 'FIFO'

Dæmi um vefslóð:

https://odata.uniconta.com/odata/FIRMAID/DebtorClient?$filter=Account eq '1000' and Balance gt 0
Lýsing Tafla $sía Vefslóð
Finna skuldara með reikning 1101798 SkuldariViðskiptavinur Account eq '1101798' Tengill
Skuldarar með innistæðu> 0 DebtorClient Balance gt 0 Hlekkur
Viðskipti árið 2024 DebtorTransClient Date ge datetime'2024-01-01T00:00:00' and Date le datetime'2024-12-31T23:59:59' Tengill
Atriðalisti án lokaðra atriða Reikningarviðskiptavinur Blocked eq false Tengill

Röðun með $orderby

Með$orderby Þú getur raðað niðurstöðunni eftir einum eða fleiri reitum. Þú getur tilgreint bæði hækkandi (asc ) og minnkandi (desc ) flokkun.

Dæmi í töflu

Til að sækja 10 nýjustu skuldara, raðað eftir nafni í hækkandi röð, er hægt að nota sameinaða vefslóð:

https://odata.uniconta.com/odata/123456/DebtorClient?$orderby=Name asc&$top=10

Efst / Sleppa - Síðuskipti - Vista gögn

Notaðu síðuskiptingu til að sækja stór gagnasöfn í klumpum og forðast óþarfa álag.

Athugið aðeins um færslutöflur, ekki um aðalgagnatöflur, sjá upplýsingar um aðalgagnatöflur samanborið við færslutöflur lengra upp.

Til dæmis:

Lýsing Vefslóðarbreytur
Fyrstu 10 skuldarar $top=10
Síða 2 (raðir 11-20) $top=10&$skip=10
Fjárhagsfærslur síða 3 $orderby=Date desc&$top=50&$skip=100
Aðeins færslur síðasta mánaðar $filter=Date ge datetime'2024-05-01T00:00:00' and Date le datetime'2024-05-31T23:59:59'

Feel frjáls til að sameina$filter ,$orderby ,$top ,$skip fyrir hraðari og markvissari fyrirspurnir.

Skjölun á endapunkti

REST-líkt forritaskil (API) Uniconta er uppbyggt þannig að hver kallanlegur endapunktur skilar sínum eigin reitum beint í svarinu. Þetta þýðir að þú getur:

  • Fáðu fljótlegt yfirlit yfir endapunkta á https://odata.uniconta.com/odata/ í gegnum vafrann þinn, Excel, PowerBI eða annað.

  • Skoðaðu gagnaskipanina með því einfaldlega að kalla á endapunktinn (t.d. með$top=1 )

  • Skoða nöfn reita, gagnategundir og efni í JSON-sniði

  • Afkóða uppbygginguna án sérstaks skemas eða skjala

Dæmi:

https://odata.uniconta.com/odata/DebtorClientUser

Skilagögn munu innihalda alla tiltæka reiti fyrir skuldara, þar á meðal kerfisreiti og notendareiti.

Mínir reitir

Ef fyrirtækið hefur bætt við notendareitum í gegnum sérstillingaraðgerðir Uniconta (t.d. auka textareiti eða fellilista), verður þú að nota útvíkkaða endapunkta með viðskeytinuUser .

Til dæmis:

Tenglar

API aðstoð - Uniconta

Forritarar - Uniconta