OData filterfunktion

Følg

REST-Like API / OData Kilde

Unicontas RESTful API med begrænset odata kompatibilitet er egnet til: • Udtræk af masterdata og transaktioner. • Integration med rapporteringsværktøjer (Excel, Power BI, mv.) • Dataanalyse og simple API løsninger. • Integration til systemer der ikke ikke er baseret på Windows.

For fuld adgang til alle funktioner henvises til Unicontas .NET API.

OBS: Supporten supporterer ikke API forespørgsler, der henvises til vores forhandlere:

Liste over forhandlere der tilbyder API assistance

 

Sikkerhed og pålidelighed

Al kommunikation foregår over HTTPS og er beskyttet med TLS-kryptering (Transport Layer Security). Det sikrer:

API’et bruger som udgangspunkt HTTP Basic Authentication, men når det anvendes fra værktøjer som Excel eller Power BI, sker dette automatisk og sikkert i baggrunden.

Adgangskrav - Log på

For at tilgå API’et kræves: - Brugeren har rettigheder i det ønskede firma - Hvis du er Univisor, skal det pågældende firma have: • Integrationspakken eller • Automatiseringspakken

Herefter kan logges på med HTTP Basic Auth (Normal HTTP brugernavn/adgangskode validering) enten i din browser, i Excel eller andet.

Brug i Excel

  1. Data > Hent data > Fra andre kilder > Fra OData-feed 2. Indtast URL 3. Log ind med Uniconta-bruger 4. Indlæs data som tabel eller pivottabel

Læs mere her - en detaljeret opsætningsguide

URL-struktur

Grundstruktur:

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

Felt Forklaring Obligatorisk
FIRMAID Dit Firma ID

Nej (ellers standardfirma)
ENDPOINT Tabellen i Uniconta. Hvis intet angivet vises liste over tilgængelige endpoints.

Nej
URLPARAMETRE Filtrering, sortering, paginering

Nej

Eksempler:

Populære Endpoints

Parameter Beskrivelse
DebtorClient Debitorer
CreditorClient Kreditorer
DebtorTransClient Debitortransaktioner
GLTransClient Finansposteringer
GLBudgetLineClient Budgetlinjer
InvItemClient Vareliste
DebtorOrderClient Salgsordrer
InvItemClientUser Brugerdefinerede varer
 

URL-parametre

Parameter Beskrivelse
$filter Filtrér data baseret på feltværdier
$orderby Sortér efter felt
$top Maks. antal returnerede rækker
$skip Spring rækker over (paging)

Filtrering med $filter

Med $filter kan du begrænse resultatet af din forespørgsel, så du kun henter de data, du har brug for – fx en bestemt kunde, posteringer inden for en periode, eller varer i en bestemt gruppe. Dette sparer både tid, netværk og systemressourcer.

Sammenligningsoperatorer

Operator Beskrivelse Eksempel

Stamdata * 1

Transaktion *2
eq Lig med Account eq '1000' Ja Ja
ne Ikke lig med Costmodel ne 'FIFO' Ja Ja
gt Større end Balance gt 0 Ja Ja
ge Større eller lig med OrderNumber ge 100 Ja Ja
lt Mindre end Amount lt 1000 Ja Ja
le Mindre eller lig med Amount le 5000 Ja Ja
startswith() Starter med startswith(Name, 'ABC') Ja Ja
endswith() Slutter med endswith(Name, 'ApS') Ja Ja
substringof() Indeholder substringof(Email, '.com') Ja Ja
tolower() Konverterer til små karakterer tolower(Name) eq 'john' Ja
toupper() Konverterer til store karakterer toupper(Code) eq 'ABC123' Ja
length() Længden på en string length(Name) gt 5 Ja
substring() Substring substring(Name, 0, 3) eq 'Joh' Ja
indexof() Index af substring indexof(Name, 'x') gt 0 Ja
trim() Trimmer mellemrum trim(Name) eq 'Alice' Ja
  • 1) Stamdatatabeller - Kartoteker

Stamdatatabeller understøtter alle ovenstående operationer.

Du kan finde en liste over disse tabeller i Uniconta Under Firma - Alle notater - Her vises så en liste over Kartoteker som nedenfor:

  • 2) Transaktionstabeller

Transaktionstabeller understøtter kun de mest basale operationer. Eksempler på transaktionstabeller:

  • GLTransClient
  • GLDebtorTransClient
 

Logiske operatorer

Operator Beskrivelse Eksempel
And Alle betingelser skal være opfyldt Account eq '1000' and Balance gt 0
Or Mindst én betingelse skal være opfyldt Group eq 'A' or Group eq 'B'
Not Benyttes sammen med andre operators til at ekskludere CostModel NOT 'FIFO'

Eksempel-URL:

https://odata.uniconta.com/odata/FIRMAID/DebtorClient?$filter=Account eq '1000' and Balance gt 0
Beskrivelse Tabel $filter URL
Find debitor med konto 1101798 DebtorClient Account eq '1101798' Link
Debitorer med balance > 0 DebtorClient Balance gt 0 Link
Transaktioner i 2024 DebtorTransClient Date ge datetime'2024-01-01T00:00:00' and Date le datetime'2024-12-31T23:59:59' Link
Vareliste uden spærrede varer InvItemClient Blocked eq false Link

Sortering med $orderby

Med $orderby kan du sortere resultatet efter ét eller flere felter. Du kan angive både stigende (asc) og faldende (desc) sortering.

Eksempler i tabel

For at hente de 10 seneste debitorer, sorteret efter navn i stigende rækkefølge, kan du bruge en kombineret URL:

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

Top / Skip - Paginering - Spar på data

Brug paginering for at hente store datasæt i bidder og undgå unødig belastning.

OBS kun på transaktionstabeller, ikke på Stamdatatabeller, se info om stamdatatabeller vs transaktionstabeller længere oppe.

Eksempler:

Beskrivelse URL-parametre
Første 10 debitorer $top=10
Side 2 (rækker 11-20) $top=10&$skip=10
Finansposteringer side 3 $orderby=Date desc&$top=50&$skip=100
Kun sidste måneds posteringer $filter=Date ge datetime'2024-05-01T00:00:00' and Date le datetime'2024-05-31T23:59:59'

Kombinér gerne $filter, $orderby, $top, $skip for hurtigere og mere målrettede forespørgsler.

Endpointsdokumentation

Unicontas REST-lignende API er opbygget, så hver kaldbar endpoint returnerer sine egne felter direkte i svaret. Det betyder, at du kan:

  • Få hurtigt overblik over endpoints på https://odata.uniconta.com/odata/ via din browser, excel, powerbi eller andet

  • Få vist datastrukturen ved blot at kalde endpointet (fx med $top=1)

  • Se feltnavne, datatyper og indhold i JSON-format

  • Afkode strukturen uden separat skema eller dokumentation

Eksempel:

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

Returdata vil indeholde alle tilgængelige felter for en debitor, inkl. systemfelter og brugerfelter.

Brugerdefinerede felter

Hvis firmaet har tilføjet brugerfelter via Unicontas tilpasningsfunktioner (fx ekstra tekstfelter eller dropdowns), skal du benytte de udvidede endpoints med suffikset User.

Eksempler:

Links

API assistance - Uniconta

Developers - Uniconta