Démarrer

Toutes les interactions avec l'OD se font via une API HTTP RESTful. Pour faire des requêtes, vous pouvez utiliser n'importe quel client HTTP tel que cURL en ligne de commande, ou Axios avec Typescript

Pour commencer vous devez connaître l'URL de base de l'API. Par exemple:

https://od.apifirst.fr:3000

La première étape est de créer un compte utilisateur OD et de récupérer l'URI de la ressource correspondante, par exemple:

v1/users/1d16af39-8aa6-4ab7-abc1-0b2093f9888b

La deuxième étape est de créer une connexion à une PDP ou au PPF et de récupérer l'URI de la ressource correspondante, par exemple:

v1/connexions/6392f6ff-69d1-4161-98c6-a92f1943d960

Une fois les première et deuxième étape complétées, vous pouvez utiliser librement les autres fonctionnalités de l'OD:

• Connexions

  • Ajouter une entreprise
  • Ajouter un régime fiscal
  • Parcourir les connexions
  • Consulter une connexion

• Ventes

  • Créer une facture
  • Envoyer une facture
  • Créer une vente
  • Supprimer une vente
  • Parcourir les ventes
  • Consulter une vente
  • Enregistrer des paiements sur une facture de vente ou une vente

• Achats

  • Recevoir et éventuellement refuser des factures
  • Transmettre un fichier
  • Créer un achat
  • Supprimer un achat
  • Parcourir les achats
  • Consulter un achat
  • Enregistrer des paiements sur une facture d'achat ou un achat

• E-Reporting

  • Consulter les déclarations
  • Valider une déclaration à venir

Références

Au delà de la présente documentation, L'API de l'OD est également disponible aux formats HTML et OpenAPI aux chemins d'accès suivants:

<url de base>/api // Documentation au format HTML
<url de base>/api-json // Fichier OpenAPI au format JSON