API Request met eigenschappen (module) Financieel

In een API-request verwijst een 'eigenschap' naar een kenmerk of parameter die je aan het verzoek toevoegt om specifieke acties uit te voeren of om te specificeren welke gegevens je wilt ontvangen.

Eigenschappen stellen jou in staat om jouw verzoek te personaliseren en de gewenste resultaten van de API te verkrijgen. Elke API heeft zijn eigen set van ondersteunde eigenschappen, afhankelijk van de functionaliteit die de API aanbiedt. 

Door de juiste eigenschappen aaneen API-request toe te voegen, kun je de API op een doelgerichte manier gebruiken en de gewenste gegevens of acties verkrijgen.

Het is belangrijk om de documentatie van de specifieke API die je gebruikt te raadplegen om te begrijpen welke eigenschappen worden ondersteund en hoe je ze op de juiste manier kunt gebruiken in jouw API-requests.

 

Hieronder vind je de eigenschappen beschreven per record;

Eigenschappen voor record 101: (Relaties)

  • P voor het meesturen van de individuele debiteuren openstaande posten;
  • D voor het meesturen van het totaal van de openstaande debiteurenposten;
  • V voor het meesturen van het totaal van de vervallen debiteurenposten;
  • T voor selectie op basis van een trefwoord (staat in argument 2);
  • B voor het meesturen van initialen & achternaam (Veldnr 1829 & 1831);
  • W|N voor het selecteren van alle mutaties van 101 records van de afgelopen N dagen. 

Eigenschappen voor record 2050 (opvragen nieuw relatienummer)

  • N eerst vrije relatienummer voor het toevoegen van een nieuwe relatie;
  • R eerst vrije relatienummer en reserveert dat relatienummer in de administratie door een write van record101, waardoor een tweede aanvraag van hetzelfde nummer wordt voorkomen. 

Eigenschappen voor record 211 (grootboeksaldi)

  • T voor het meesturen van het resultaat vorige jaren en transitoria;
  • K voor het meesturen van het resultaat vorige jaren en transitoria en saldi per kostenplaats;
  • R zelfde werking als T met RGS codes erbij.

Eigenschappen voor record 301 (grootboekmutaties)

  •  T voor het meegeven van een van en t/m periode, geeft export op volgorde van grootboek; 
    Voorbeeld: 301T|1601|1602 periode in JJMM (kalendermaanden).
  • P voor het zenden van een PDF in base64 formaat wat hangt aan een stuknummer; 
     Voorbeeld: 301P|16|INK|160001|160101 (jaar|dagbk|stuknr|boekd).
  • B maakt een export per boekstuk, kijkt dus niet naar veld 310; 
     Voorbeeld: 301B|2023 alle boekstukken van boekjaar 2023.
  • I voorafgaand aan de index gebruikt een secondaire index; 
    Voorbeeld: I302|22|VERK Boekstukken in boekjaar 22, voor dagboek VERK 
    Voorbeeld: I304|8000 Grootboekmutaties van rekeningnr 8000 
    Voorbeeld: I303|9999 Boekingen van subadministratie Debiteuren van Relatie 9999. 

Eigenschappen voor record 311: (subadministratie Deb/Cred)

  • 311 Geeft alle actuele facturen debiteuren en crediteuren;
  • 311T actuele facturen met extra velden: vervaldatum, factuurbedrag, relatienaam, factuurdatum;
  • 311H|2412 Geeft facturen open staand t/m periode 2024-12;
  • 311H|2412|D Geeft alle debiteurenposten die t/m periode 2024-12 open stonden.

Eigenschappen voor record 450 (artikel uit cash facturering)

V voor het meesturen van het actuele voorraad-aantal. inactief. 


Virtuele record

Voor specifieke informatie niet gebaseerd op recordnummers: 8500, bedoeld om de laatste stuknummers op te vragen van dagboeken. 


Eigenschappen voor record 8500 (opvragen laatste stuknummer per dagboek) 
V laatste stuknummers op vragen van dagboeken vorig jaar. 

Eigenschappen voor record 8504 (opvragen laatste stuknummer per dagboek, variabel boekjaar) 

  • 1ste argument = Boekjaar in formaat JJ.
  • 2de argument = dagboekcode
  • 3de argument = dagboekcode tot 

Voorbeeld: 8504|16|VERK = laatste stuknummer in boekjaar 2016 van dagboekcode VERK.

 

Voorbeelden Financieel:

  • 0101V|2 geeft de stamgegevens van relatie 2 met het totaal van de vervallen debiteurenposten;
  • 0101P geeft alle relaties met van ieder de individuele openstaande debiteurenposten;
  • 0101T|KVKCASH geeft alle relaties met trefwoord KVKCASH;
  • 0450V|BEAMER geeft de stamgegevens van artikel BEAMER met het actuele voorraadaantal;
  • 211T|1509 Geeft de grootboeksaldi,transitoria en resultaat vorige jaren tot en met periode 1509;
  • I302E|16|INK|000001 geeft het opgegeven stuknummer terug;                    
  • I303E|000001|999999|21 geeft alle mutaties van factuurnummer 999999 van rel 1 vanaf periode (JJ.MM) 21.01;
  • 211T|1509 Geeft de grootboeksaldi, transitoria en resultaat vorige jaren tot en met periode 1509;
  • 211K|1509 Geeft de grootboeksaldi, transitoria en resultaat vorige jaren tot en met periode 1509 met kostenplaats;
  • 301P|16|INK|160001|160101 geeft het PDF document wat hoort bij dit stuknummer in base64 formaat;
  • 101W|5 Alle relaties die in de afgelopen 5 dagen een mutatie hebben gehad;
  • 311H|1712|D Geeft alle debiteurenposten die t/m 1712 open stonden.