Aller au contenu principal

Requêtes

Objectif

Objectif : Lire dans l'ERP, dans un 1er temps. Les fonctionnalités d'écriture seront ajoutées ultérieurement.

🌐 Configuration​

Port​

Le serveur HTTP tourne sur le port 2001. Il n'est pour l'instant pas paramétrable.

Adresse de base​

L'adresse de chaque requête commence par : http://localhost:2001/api/v3

Performance

Performance : Architecture optimisée pour des temps de réponse ultra-rapides grâce à l'absence d'ouverture/fermeture de société.

📋 Requêtes de base​

📊 Entités​

/api/v3/$model

🔧 Version du Web Service​

/api/v3/version/webservice

🖥️ Version de Windows​

/api/v3/version/windows

🛒 GESTION COMMERCIALE​

📄 Achats et ventes​

Requêtes principales :

Tables de référence :

🎯 Actions​

Tables de référence :

💼 Affaires​

Tables de référence :

📦 Articles​

Requêtes principales :

Tables de référence :

👥 Commerciaux​

📞 Contacts​

Tables de référence :

🏪 Dépôts​

🎨 Gammes​

📊 Natures comptables​

📦 Stock​

Requêtes principales :

Tables de référence :

💰 Tarifs​

👥 Tiers​

Requêtes principales :

Tables de référence :

📊 GESTION COMPTABLE​

💳 Comptes​

📈 Comptes de reporting​

📋 Déclarations de TVA​

[à venir]

📝 Écritures comptables​

Tables de référence :

📖 Guides​

🏢 Immobilisations​

Requêtes principales :

Tables de référence :

📚 Journaux​

📊 Sections analytiques​

Tables de référence :

🏢 ERP​

🔧 Champs personnalisés​

💱 Devises​

💰 Encaissements et décaissements​

Requêtes principales :

🧮 Formules​

🚚 Frais​

🌍 Pays​

Tables de référence :

⚙️ Préférences​

Tables de référence :

👨‍💼 Salariés​

Tables de référence :

🏢 Services​

👤 Utilisateurs​

🏙️ Villes​

🔧 Options des requêtes​

Documentation complète

Documentation complète : Options de requêtes TMS XData

📝 Exemples d'utilisation​

RequêteDescription
http://localhost:2001/api/v3/documents-ventesRetourne tous les documents de ventes
http://localhost:2001/api/v3/documents-ventes/$countRetourne le nombre de documents de ventes
http://localhost:2001/api/v3/documents-ventes('0000000216')Retourne le document de vente dont le N° interne est '0000000216'
http://localhost:2001/api/v3/documents-ventes('0000000216')?$expand=LignesRetourne le document de vente et développe l'objet "Lignes"
http://localhost:2001/api/v3/documents-ventes('0000000216')?$expand=Depot,Tiers,Payeur,ModeReglement,LignesRetourne le document de vente et développe plusieurs objets
Performance

Performance : Par défaut les objets ne sont pas développés, pour des raisons de performances. Utilisez $expand uniquement si nécessaire.

🚀 Fonctionnalités à venir​

Roadmap

Roadmap : Les requêtes marquées [à venir] seront disponibles dans les prochaines versions.


API Web Service Gestimum ERP 3.0 - Documentation complète des requêtes