Exemples de requêtes Ventes
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 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.
EndPoint | ClientsListe de tous les clients |
$filter | |
$select |
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é.
EndPoint | ClientsListe de tous les clients |
$select | |
$orderby | |
$top |
Liste des interlocuteurs d’un client qui ont une adresse email renseignée
- Filtrer la collection de sous ressources contacts de la ressource client en testant la propriété eMail du type telecom des contacts.
- Un expand sur service permet aussi de récupérer le service du contact.
- Notez que pour identifier le paramètre client il faut mentionner son ID et non pas son numéro.
EndPoint | ClientsGetContactsContacts du client |
$expand | |
$filter | |
$select |
Liste des clients actifs de la ville de Nantes du représentant Tiffany PANDAN
- Filtrer la sous ressource adresse/ville, les booléens prospect et sommeil et le représentant PANDAN.
- Notez que pour identifier le client il faut mentionner son ID et non pas son numéro.
EndPoint | ClientsListe de tous les clients |
$filter | |
$select |
Liste des devis du client CARAT pas date décroissante
- Filtre des devis sur le code tiers d’un client.
- expand pour récupérer le motif du devis.
- Notez que pour identifier le client dans un filtre il faut mentionner son numéro et non pas son ID.
EndPoint | DocumentsVenteDevisListe des devis |
$expand | |
$filter | |
$select | |
$orderby |
Liste des factures validées des clients de Nantes dont le N° de pièce commence par FA00
- Filtrer les factures de statut ‘Acomptabiliser’ dont les clients sont dans la ville de Nantes
- Notez la syntaxe pour exprimer dans le filtre la ville du client : client/adresse/ville
EndPoint | DocumentsVenteFactureListe des factures |
$filter | |
$select | |
$orderby |
Liste des représentants
- Filtrer la liste des collaborateurs dont la propriété vendeur est vraie.
EndPoint | CollaborateursListe des collaborateurs |
$filter | |
$select |
Liste des articles de la famille BIJOUXOR contenant dans l’intitulé le terme OR
- Filtrer les articles d’une famille et tester si l’intitulé contient un terme.
- Récupérer uniquement l’intitulé, la référence, le prix de Vente et l’ID.
EndPoint | ArticlesListe des articles |
$filter | |
$select | |
$orderby |