OData filterfunctie

  • Bijgewerkt
Volgen

REST-achtige API / OData-bron

Unicontas RESTful API met beperkte gegevenscompatibiliteit is geschikt voor: - Extractie van stamgegevens en transacties. - Integratie met rapportagetools (Excel, Power BI, enz.) - Gegevensanalyse en eenvoudige API-oplossingen. - Integratie met niet op Windows gebaseerde systemen.

Raadpleeg de Unicontas .NET API voor volledige toegang tot alle functies.

Opmerking: Ondersteuning biedt geen ondersteuning voor API-verzoeken, neem hiervoor contact op met onze wederverkopers:

Lijst van resellers die API-ondersteuning bieden

 

Veiligheid en betrouwbaarheid

Alle communicatie verloopt via HTTPS en is beveiligd met TLS-encryptie (Transport Layer Security). Dit garandeert:

Standaard gebruikt de API HTTP Basic Authentication, maar bij gebruik vanuit tools zoals Excel of Power BI gebeurt dit automatisch en veilig op de achtergrond.

Toegangseisen - Aanmelden

Om toegang te krijgen tot de API heb je nodig: - De gebruiker heeft rechten in het gewenste bedrijf - Als je Univisor bent, moet het bedrijf beschikken over: - Integratiepakket of - Automatiseringspakket.

Je kunt dan inloggen met HTTP Basic Auth (normale HTTP gebruikersnaam/wachtwoord validatie) in je browser, in Excel of een andere toepassing.

Gebruik in Excel

  1. Gegevens > Gegevens ophalen > Uit andere bronnen > Uit OData-feed 2. URL invoeren 3. URL invoeren Log in met Uniconta-gebruiker 4. Gegevens laden als tabel of draaitabel

Lees hier meer - een gedetailleerde installatiegids

URL-structuur

Basisstructuur:

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

Veld Uitleg Verplicht veld
FIRMAID Uw bedrijfs-ID

Nee (anders standaardbedrijf)
EINDPUNT De tabel in Uniconta. Als dit niet wordt opgegeven, wordt de lijst met beschikbare eindpunten weergegeven.

Nee, dat kun je niet.
URLPARAMETER Filteren, sorteren, pagineren

Nee, dat kun je niet.

Voorbeelden:

Populaire eindpunten

Parameter Beschrijving van de parameter
DebiteurKlant Debiteuren
Schuldeiser-Klant Schuldeisers
DebiteurTransCliënt Debiteur transacties
GLTransClient Financiële boekingen
GLBudgetLineClient Budgetlijnen
InvItemClient Item lijst
DebiteurOrderClient Verkooporders
InvItemClientUser Aangepaste items
 

URL-parameters

Parameter Beschrijving van parameter
$filter Filter gegevens op basis van veldwaarden
$orderby Sorteren op veld
Bovenste Max aantal rijen dat wordt geretourneerd
$skip Rijen overslaan (pagineren)

Filteren met $filter

Met $filter kun je het resultaat van je query beperken, zodat je alleen de gegevens ophaalt die je nodig hebt - bijvoorbeeld een specifieke klant, items binnen een periode of items in een specifieke groep. Dit bespaart tijd en netwerk- en systeembronnen.

Vergelijkingsoperatoren

Exploitant Beschrijving Voorbeeld van een voorbeeld

Stamgegevens * 1

Transactie *2
eq Gelijk aan Account eq '1000' Ja, dat kan Ja, dat kan
geen Niet gelijk aan Costmodel ne 'FIFO' Ja, dat kan Ja, dat kan
gt Groter dan Balance gt 0 Ja, dat kan Ja, dat kan
ge Groter dan of gelijk aan OrderNumber ge 100 Ja, dat kan Ja, dat kan
Het Minder dan Amount lt 1000 Ja, dat kan Ja, dat kan
de Minder dan of gelijk aan Amount le 5000 Ja, dat kan Ja, dat kan
begint() Begint met startswith(Name, 'ABC') Ja, dat kan Ja, dat kan
endswith() Eindigt met endswith(Name, 'ApS') Ja, dat kan Ja, dat kan
substringof() Bevat substringof(Email, '.com') Ja, dat kan Ja, dat kan
tolower() Converteert naar kleine tekens tolower(Name) eq 'john' Ja, dat doet het
touperen() Converteert naar grote tekens toupper(Code) eq 'ABC123' Ja, dat doet het
lengte() De lengte van een tekenreeks length(Name) gt 5 Ja, het is
substring() substring substring(Name, 0, 3) eq 'Joh' Ja
indexof() Index van substring indexof(Name, 'x') gt 0 Ja
trim() Ruimtes trimmen trim(Name) eq 'Alice' Ja, je kunt
  • 1) Stamgegevenstabellen - Indexen

Stamgegevenstabellen ondersteunen alle bovenstaande bewerkingen.

Je vindt een lijst van deze tabellen in Uniconta onder Bedrijf - Alle notities - Hier zie je een lijst met indexen zoals hieronder:

  • 2) Transactietabellen

Transactietabellen ondersteunen alleen de meest elementaire operaties. Voorbeelden van transactietabellen:

  • GLTransClient
  • GLDebtorTransClient
 

Logische operatoren

Operator Beschrijving van de operator Voorbeeld
Eend Aan alle voorwaarden moet worden voldaan Account eq '1000' and Balance gt 0
Goud Er moet aan minstens één voorwaarde worden voldaan Group eq 'A' or Group eq 'B'
Opmerking Gebruikt in combinatie met andere operatoren om uit te sluiten CostModel NOT 'FIFO'

Voorbeeld URL:

https://odata.uniconta.com/odata/FIRMAID/DebtorClient?$filter=Account eq '1000' and Balance gt 0
Beschrijving van de tabel Tabel $filter URL
Debiteur met rekening 1101798 vinden DebiteurKlant Account eq '1101798' Koppeling naar
Debiteuren met saldo > 0 DebiteurKlant Balance gt 0 Link
Transacties in 2024 DebiteurTransCliënt Date ge datetime'2024-01-01T00:00:00' and Date le datetime'2024-12-31T23:59:59' Koppeling naar
Itemlijst zonder geblokkeerde items InvItemClient Blocked eq false Link

Sorteren met $orderby

Met $orderby kun je het resultaat sorteren op een of meer velden. Je kunt zowel oplopend (asc) als aflopend (desc) sorteren.

Voorbeelden in tabel

Om de 10 meest recente debiteuren op te halen, gesorteerd op naam in oplopende volgorde, kun je een gecombineerde URL gebruiken:

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

Boven / Overslaan - Pagineren - Gegevens opslaan

Gebruik paginering om grote datasets in brokken op te halen en onnodige belasting te voorkomen.

Let alleen op transactietabellen, niet op stamgegevenstabellen, zie info over stamgegevenstabellen vs transactietabellen verderop.

Voorbeelden:

Beschrijving URL-parameters
Eerste 10 debiteuren $top=10
Pagina 2 (rijen 11-20) $top=10&$skip=10
Financiële posten pagina 3 $orderby=Date desc&$top=50&$skip=100
Alleen berichten van de afgelopen maand $filter=Date ge datetime'2024-05-01T00:00:00' and Date le datetime'2024-05-31T23:59:59'

Voel je vrij om $filter, $orderby, $top, $skip te combineren voor snellere en meer gerichte zoekopdrachten.

Eindpuntdocumentatie

Uniconta's REST-achtige API is zo gebouwd dat elk oproepbaar eindpunt zijn eigen velden direct in het antwoord retourneert. Dit betekent dat u kunt:

  • Krijg snel een overzicht van eindpunten op https://odata.uniconta.com/odata/ via uw browser, excel, powerbi of een andere functie.

  • Geef de gegevensstructuur weer door eenvoudig het eindpunt aan te roepen (bijvoorbeeld met $top=1)

  • Veldnamen, gegevenstypen en inhoud in JSON-indeling bekijken

  • Decodeer de structuur zonder een apart schema of documentatie

Voorbeeld:

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

Retourgegevens bevatten alle velden die beschikbaar zijn voor een debiteur, inclusief systeemvelden en gebruikersvelden.

Aangepaste velden

Als uw bedrijf gebruikersvelden heeft toegevoegd via de aanpassingsfuncties van Uniconta (bijvoorbeeld extra tekstvelden of vervolgkeuzelijsten), gebruik dan de uitgebreide eindpunten met het achtervoegsel User.

Voorbeelden:

Links

API-ondersteuning - Uniconta

Ontwikkelaars - Uniconta