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é.

📋 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​

  • /api/v3/actions

Tables de référence :

  • /api/v3/etats-actions
  • /api/v3/types-actions

💼 Affaires​

  • /api/v3/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 à 5
  • /api/v3/frais-approche
  • /api/v3/frais-rendus
  • /api/v3/taxes-parafiscales
  • /api/v3/unites-conditionnements

👥 Commerciaux​

  • /api/v3/commerciaux

📞 Contacts​

  • /api/v3/contacts

Tables de référence :

  • /api/v3/criteres-contacts-1
  • /api/v3/criteres-contacts-2
  • /api/v3/fonctions

🏪 Dépôts​

  • /api/v3/depots

🎨 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​

  • /api/v3/grilles-tarifs
  • /api/v3/promotions
  • /api/v3/tarif [à venir]

👥 Tiers​

Endpoints principaux :

  • /api/v3/tiers
  • /api/v3/familles-tiers
  • /api/v3/sous-familles-tiers

Tables de référence :

  • /api/v3/activites-principales-exercees
  • /api/v3/civilites
  • /api/v3/criteres-tiers-1 à 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​

  • /api/v3/comptes

📈 Comptes de reporting​

  • /api/v3/comptes-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 :

  • /api/v3/libelles-automatiques-ecritures

📖 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 à 5

📚 Journaux​

  • /api/v3/journaux

📊 Sections analytiques​

  • /api/v3/sections-analytiques

Tables de référence :

  • /api/v3/couts-analytiques
  • /api/v3/plans-analytiques

🏢 ERP​

🔧 Champs personnalisés​

  • /api/v3/champs-personnalises

💱 Devises​

  • /api/v3/devises
  • /api/v3/cours-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​

  • /api/v3/constantes-numeriques

🚚 Frais​

  • /api/v3/frais
  • /api/v3/transporteurs

🌍 Pays​

  • /api/v3/pays

Tables de référence :

  • /api/v3/continents-pays
  • /api/v3/familles-pays
  • /api/v3/groupements-pays
  • /api/v3/sous-divisions-pays

⚙️ Préférences​

  • /api/v3/preferences-societe
  • /api/v3/preferences-commerciales
  • /api/v3/preferences-comptables

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​

  • /api/v3/salaries

Tables de référence :

  • /api/v3/criteres-salaries-1 à 3
  • /api/v3/indisponibilites-salaries
  • /api/v3/types-absences-salaries

🏢 Services​

  • /api/v3/services
  • /api/v3/divisions

👤 Utilisateurs​

  • /api/v3/utilisateurs
  • /api/v3/groupes-utilisateurs

🏙️ Villes​

  • /api/v3/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 endpoints marqués [à venir] seront disponibles dans les prochaines versions.

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