Exemples de requêtes Comptabilité
Ne jamais oublier que les requêtes de lecture ne renvoient au maximum qu'un lot de 100 enregistrements. Pensez à utiliser $count et $skip pour parcourir la totalité du résultat de la requête.
Vous pouvez mentionner ci-dessous un ID de société d'une société de test Sage 100 ainsi que l'ID et le numéro d'un client dans cette société.
Les valeurs saisies remplaceront les jokers {datasetId}
et {clientId}
dans les urls de requête.
Accès rapide
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.
EndPoint | companiesListe des sociétés |
$select | |
$orderby |
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.
EndPoint | JournauxListe des journaux |
$filter | |
$select | |
$orderby |
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
EndPoint | ComptesListe des comptes |
$filter | |
$select | |
$orderby | |
$top | |
$skip | |
$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.
EndPoint | ComptesListe des comptes |
$filter | |
$select | |
$orderby |
Extrait de compte du client CARAT entre deux dates
- Liste des écritures entre deux dates du client CARAT
- 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
EndPoint | EcrituresListe des écritures comptables |
$expand | |
$filter | |
$skip | |
$count |
Récupération dates exercice courant
- Permet de récupérer dateFin, dateDebut de l’exercice courant filtré depuis la liste des exercices de la société.
- Servira par exemple pour récupérer un extrait de compte client sur l’exercice courant via dateDebut et dateFin.
EndPoint | DossierGetExercicesListe des exercices du dossier |
$filter |
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.
EndPoint | Dossier |
$select |
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
.
EndPoint | ComptesListe des comptes |
$filter | |
$top | |
$count |
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
EndPoint | EcrituresListe des écritures comptables |
$filter |
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.
EndPoint | Ecritures |
$expand | |
$filter |
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
EndPoint | EcrituresListe des écritures comptables |
$filter | |
$select | |
$orderby |