Exemples simples de requêtes

Accès rapide

{API_URL}{datasetid}/{resource}?{options}

{API_URL}companies?{options}

  string token ="xxxxxx"; //Mentionnez ici un token valide par exemple généré par Postman
  HttpClient client = new HttpClient();
  client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
  client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
  const string API_URL = "{API_URL}";
  string qry_company = "{datasetid}";
  string qry_resource = "{resource}";
  string qry_options = "";
  Dictionary<String, String> options = new Dictionary<String, String>();
      options.Add("$expand", "_expand_");
      options.Add("$filter", "_filter_");
      options.Add("$select", "_select_");
      options.Add("$orderby", "_orderby_");
      options.Add("$skip", "_skip_");
      options.Add("$top", "_top_");
      options.Add("$count", "_count_");
  foreach (KeyValuePair<String, String> option in options)
  {
      if (option.Value != "")
          qry_options += option.Key + "=" + option.Value + "&";
  }
  if (qry_options != "")
      qry_options = qry_options.Substring(0,qry_options.Length-1);
  var request = await client.GetAsync(API_URL + qry_company + ((qry_company)?"/":"") + qry_resource + "?" + qry_options);
  var res = request.Content.ReadAsStringAsync();
  Console.WriteLine(res.Result);
  Console.ReadLine();

API_URL = "{API_URL}"
request = ""
qry_company="{datasetid}"
qry_resource="{resource}"
qry_option=""
options = {
	"$expand": "_expand_",
  "$select": "_select_",
	"$filter": "_filter_",
	"$orderby": "_orderby_",
	"$top": "_top_",
	"$skip": "_skip_",
	"$count": "_count_"
}
for key, value in options.items():
   if value != "":
      qry_option+=key+"="+value+"&"

if qry_option != "":
   qry_option="?"+qry_option[0:len(qry_option)-1]

request=API_URL+qry_company+"/"+qry_resource+qry_option

  var token = "xxxxxx"; //Mentionnez ici un token valide par exemple généré par Postman
  var API_URL = "{API_URL}";
  var qry_company = "{datasetid}";
  var qry_resource = "{resource}";

  var options={};
  $.extend(options,{$expand : "_expand_"});
  $.extend(options,{$filter : "_filter_"});
  $.extend(options,{$select : "_select_"});
  $.extend(options,{$orderby : "_orderby_"});
  $.extend(options,{$top : "_top_"});
  $.extend(options,{$skip : "_skip_"});
  $.extend(options,{$count : "_count_"});

  for(key in options)
    if(!options[key])
       delete options[key];

  var request=API_URL + qry_company + ((qry_company)?"/":"") + qry_resource + "?" + decodeURIComponent( $.param( options ));

  $.ajax({
      url: request,
      headers: {
          'Authorization': `Bearer ${token}`,
      },
      method: 'GET',
        success: function(data){
        console.log(data.value);
      }
  });

  var token = "xxxxxx"; //Mentionnez ici un token valide par exemple généré par Postman
  var xmlHttpRequest = new XMLHttpRequest();
  var API_URL = "{API_URL}";
  var qry_company = "{datasetid}";
  var qry_resource = "{resource}";
  var qry_options = "";
  var options=[];

  options["$expand"]  = "_expand_";
  options["$select"]  = "_select_";  
  options["$filter"]  = "_filter_";
  options["$orderby"] = "_orderby_";
  options["$skip"]    = "_skip_";
  options["$top"]     = "_top_";
  options["$count"]   = "_count_";

  for (var i in options) {
    if (options[i])
       qry_options+=i + "=" + options[i] + "&";
  }
  if (qry_options)
      qry_options = qry_options.substr(0,qry_options.length-1);

  var request=API_URL + qry_company + ((qry_company)?"/":"") + qry_resource + "?" + qry_options;

  xmlHttpRequest.onreadystatechange = function() {
      if (this.readyState == 4 && this.status == 200) {
         console.log(JSON.parse(this.response).value);
      }
  };
  xmlHttpRequest.open("GET",request, true);
  xmlHttpRequest.setRequestHeader('Authorization', 'Bearer ' + token);
  xmlHttpRequest.send();

Liste des sociétés

• Liste de toutes les sociétés autorisées pour l’utilisateur authentifié.
• L’important est de récupérer l’id qui sera exigé pour toutes les autres requêtes à l’API.

Liste des journaux de banque

• Intitulé et code de tous les journaux de type ‘Tresorerie’ triés par code.
• On peut considérer qu’il n’y aura pas plus de 100 journaux de ce type, d’où pas nécessité d’utiliser la pagination.

Liste des journaux avec compte et nature de comptes non nul, trié par nature de comptes

• Utilisation d’un $expand pour le détail du compte et un $expand sur compte pour obtenir le détail nature de compte.
• Filtre sur les seuls journaux ayant un compte avec une nature de compte.

Liste des comptes de charges

• Intitulé et numéro des 50 premiers comptes de classe 6 triés par code.
• Pour obtenir des lots suivants de 50, passez $skip à 50, puis à 100, puis à 150.
• Pour connaître le nombre maximum de résultats, affectez $count à true et récupérer la valeur dans @odata.count

Liste des comptes de charges de personnel dont l’intitulé contient cotisation

• Intitulé et numero des comptes de classe 64, de type ‘Detail’ et dont l’intitulé contient le terme Cotisation
• OData étant sensible à la casse, on utilise ici tolower pour filtrer aussi bien Cotisation, cotisation, COTISATION.

Liste des comptes de nature de comptes ‘Banque’

• Obtenir la liste des comptes filtrés sur la nature de comptes de nature ‘Banque’
• Notez le $filter nature/nature (sous ressource nature / propriété nature)
• Le $expand est facultatif, il permet ici de vérifier que les natures sont bien filtrées.

Extrait de compte du client CARAT entre deux dates

• Liste des écritures entre deux dates d’un client
• Attention, dans les filtres pour retrouver un tiers, il faut tester son numero et non pas son ID.
• Mettre $count à true pour récupérer le nombre de lignes, itérez avec $skip par lots de 100 à concurrence de @odata.count

Récupération des conditions de règlement d’un client

• Récupérer la sous ressource reglements de la ressource client.
• Notez que pour identifier le client il faut mentionner son ID et non pas son numéro.

Récupération dates exercice courant

• Permet de récupérer les dates début et fin de l’exercice courant filtré depuis la liste des exercices de la société.
• Renvoie les dates de l’exercice non clôturé le plus récent, servira par exemple pour récupérer un extrait de compte client sur l’exercice courant via dateDebut et dateFin.
• A noter la syntaxe particulière avec $select, $filter, $orderby, $top sur exercices séparés par des ; à l’intérieur du $select de company.

Raison sociale et exercices

• Récupération, depuis les informations company de la société, de la raison sociale et de la collection de tous les exercices dont l’exercice courant.
• Notez que exercices mentionné dans $select correspond ici la collection de tous les exercices comme le renverrait company/exercices.

Nombre de comptes de vente

• Obtenir uniquement le nombre de comptes de classe 70 sans renvoyer de données concernant les comptes.
• Ici un exemple de syntaxe différente pour filtrer les comptes avec utilisation de supérieur ou égal et inférieur ou égal.
• Notez le $top=0 pour ne pas renvoyer d’enregistrements puisqu’on souhaite uniquement le nombre total qui sera renvoyé dans @odata.count.

Liste des clients hors ville Paris qui ne sont pas en sommeil

• Obtenir uniquement la liste des clients hors ville de Paris avec récupération de l’intitulé, numéro et adresse.
• Servira d’exemple pour exclure des données en utilisant la syntaxe ne.

Liste des 10 premiers clients classés par ordre alphabétique

• Obtenir le nom et numéro des 10 premiers clients classés par ordre alphabétique.
• Le tri $orderby s’effectuera sur l’intitulé.
• Appel de la ressource tiers filtrée sur le type ‘Client’ (permet par exemple d’avoir un filtre client/fournisseur/Salarié/Autre)

Liste de 10 clients classés par ordre décroissant de pays/ville

• Obtenir le nom, numéro et adresse des 10 premiers clients classés par ordre alphabétique décroissant de pays puis, pour chaque pays, par ordre décroissant de ville.
• Le tri $orderby s’effectuera sur le pays puis la ville. Notez le desc à ajouter à chaque critère de tri pour tout avoir en ordre décroissant.
• Appel de la ressource client, contrairement à l’exemple précédent ne permettra pas de filtrer sur fournisseur/Salarié/Autre

Liste des écritures pour le code journal VTE

• Obtenir uniquement la liste des écritures saisies dans le code journal VTE.
• Le filtre sur le code journal se fait en utilisant le caractère / indiquant que code est une propriété de la sous ressource journal

Liste des écritures pour le code journal VTE avec les propriétés de la sous-ressource journal

• Obtenir uniquement la liste des écritures saisies dans le code journal VTE.
• $Expand permet d’afficher les propriétés d’une sous ressource.

Liste des 2000 premières lignes d’écritures avec limitation des valeurs retournées

• Limiter les propriétés retournées à : code journal, N° et intitulé compte, N° tiers, intitulé, sens et montant.
• Il est fortement recommandé d’utiliser $select pour limiter le volume des valeurs à retourner.

Liste des n° de pièce avec un montant inférieur à 50000 classée par montant

• Obtenir les n° de pièce avec un montant strictement inférieur à 50000 triés du plus grand au plus petit montant
• Notez la syntaxe lt pour inférieur à et desc pour trier par ordre décroissant