Requêtes
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 : Architecture optimisée pour des temps de réponse ultra-rapides grâce à l'absence d'ouverture/fermeture de société.
📋 Endpoints de base
📊 Modèle
/api/v3/$model
Liste des entités disponibles
🔧 Version WS
/api/v3/version/webservice
Version du Web Service
🖥️ Version Windows
/api/v3/version/windows
Version de Windows
🛒 GESTION COMMERCIALE
📄 Achats et ventes
Endpoints principaux :
/api/v3/documents-achats/api/v3/documents-ventes/api/v3/adresses-facturation-documents-achats-ventes/api/v3/adresses-livraison-documents-achats-ventes/api/v3/lignes-documents-achats-ventes/api/v3/composants-lignes-documents-achats-ventes/api/v3/pieds-documents-achats-ventes
Tables de référence :
/api/v3/motifs-abandons-reliquats/api/v3/origines-documents-achats-ventes/api/v3/periodicites-regroupements/api/v3/refus-documents-achats-ventes
🎯 Actions
Tables de référence :
💼 Affaires
Tables de référence :
/api/v3/categories-affaires/api/v3/etats-affaires/api/v3/sous-categories-affaires/api/v3/sous-types-frais-affaires/api/v3/sous-types-main-oeuvre-affaires/api/v3/types-frais-affaires/api/v3/types-main-oeuvre-affaires
📦 Articles
Endpoints principaux :
/api/v3/articles/api/v3/composants-articles/api/v3/familles-articles/api/v3/sous-familles-articles
Tables de référence :
/api/v3/criteres-articles-1,/api/v3/criteres-articles-2,/api/v3/criteres-articles-3,/api/v3/criteres-articles-4,/api/v3/criteres-articles-5/api/v3/frais-approche/api/v3/frais-rendus/api/v3/taxes-parafiscales/api/v3/unites-conditionnements
👥 Commerciaux
📞 Contacts
Tables de référence :
🏪 Dépôts
🎨 Gammes
/api/v3/gammes/api/v3/composantes-gammes[à venir]/api/v3/valeurs-composantes-gammes[à venir]
📊 Natures comptables
/api/v3/natures-comptables[à venir]
📦 Stock
Endpoints principaux :
/api/v3/documents-stocks/api/v3/lignes-documents-stocks/api/v3/stock/actuel[à venir]/api/v3/stock/date[à venir]/api/v3/mouvements-stock[à venir]
Tables de référence :
/api/v3/etats-assemblages/api/v3/types-alterations-documents-stocks/api/v3/types-pertes-documents-stocks
💰 Tarifs
👥 Tiers
Endpoints principaux :
Tables de référence :
/api/v3/activites-principales-exercees/api/v3/civilites/api/v3/criteres-tiers-1,/api/v3/criteres-tiers-2,/api/v3/criteres-tiers-3,/api/v3/criteres-tiers-4,/api/v3/criteres-tiers-5/api/v3/fourchettes-ca/api/v3/fourchettes-effectif/api/v3/langues/api/v3/natures-inscriptions/api/v3/risques/api/v3/statuts-juridiques/api/v3/types-cartes-bancaires/api/v3/types-coordonnees-bancaires
📊 GESTION COMPTABLE
💳 Comptes
📈 Comptes de reporting
📋 Déclarations de TVA
[à venir]
📝 Écritures comptables
/api/v3/ecritures[à venir]/api/v3/grand-livre[à venir]/api/v3/balance[à venir]/api/v3/extrait-compte[à venir]
Tables de référence :
📖 Guides
/api/v3/guides[à venir]
🏢 Immobilisations
Endpoints principaux :
/api/v3/immobilisations/api/v3/familles-immobilisations/api/v3/lieux-immobilisations/api/v3/adresses-lieux-immobilisations
Tables de référence :
/api/v3/criteres-immobilisations-1,/api/v3/criteres-immobilisations-2,/api/v3/criteres-immobilisations-3,/api/v3/criteres-immobilisations-4,/api/v3/criteres-immobilisations-5
📚 Journaux
📊 Sections analytiques
Tables de référence :
🏢 ERP
🔧 Champs personnalisés
💱 Devises
💰 Encaissements et décaissements
Endpoints principaux :
/api/v3/banques/api/v3/comptes-bancaires/api/v3/modes-reglements/api/v3/echeances/api/v3/reglements/api/v3/remises-banque/api/v3/remises-encaissement/api/v3/remises-escompte/api/v3/paiements/api/v3/emissions-paiements
🧮 Formules
🚚 Frais
🌍 Pays
Tables de référence :
⚙️ Préférences
Tables de référence :
/api/v3/types-modes-reglements/api/v3/motifs-impayes/api/v3/motifs-non-payes-differes/api/v3/types-ecarts-reglements
👨💼 Salariés
Tables de référence :
/api/v3/criteres-salaries-1,/api/v3/criteres-salaries-2,/api/v3/criteres-salaries-3/api/v3/indisponibilites-salaries/api/v3/types-absences-salaries
🏢 Services
👤 Utilisateurs
🏙️ Villes
🔧 Options des requêtes
Documentation complète : Options de requêtes TMS XData
📝 Exemples d'utilisation
| Requête | Description |
|---|---|
http://localhost:2001/api/v3/documents-ventes | Retourne tous les documents de ventes |
http://localhost:2001/api/v3/documents-ventes/$count | Retourne 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=Lignes | Retourne le document de vente et développe l'objet "Lignes" |
http://localhost:2001/api/v3/documents-ventes('0000000216')?$expand=Depot,Tiers,Payeur,ModeReglement,Lignes | Retourne le document de vente et développe plusieurs objets |
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 : Les endpoints marqués [à venir] seront disponibles dans les prochaines versions.
API Web Service Gestimum ERP 3.0 - Documentation complète des requêtes