Démarrage rapide

Cinq étapes pour passer de rien à votre première facture en JSON. Il vous faut un compte Ocost dont vous êtes propriétaire ou comptable.

1. Créer un compte

Créez un compte sur https://app.ocost.io/auth/sign-up, ou connectez-vous. Les fichiers que vous envoyez par l'API apparaissent dans Fichiers, comme tout envoi.

2. Créer une clé

  1. Ouvrez Paramètres › Développeurs et choisissez Nouvelle clé.
  2. Nommez la clé d'après son utilisateur, par exemple « Odoo production ».
  3. Gardez les autorisations cochées et choisissez Créer la clé.
  4. Choisissez Copier la clé. La clé commence par ocost_sk_, et Ocost ne la montre qu'une fois.

Gardez-la dans votre shell pour les étapes suivantes :

Shell
export OCOST_KEY="ocost_sk_…"

3. Envoyer un PDF

Envoyez le fichier en multipart/form-data dans le champ file. external_ref est votre propre identifiant, et Ocost vous le rend.

curl -sS https://api.ocost.io/public/v1/files \
  -H "Authorization: Bearer $OCOST_KEY" \
  -F "file=@invoice.pdf" \
  -F "external_ref=account.move,42"

Ocost répond 202 Accepted et commence la lecture :

JSON
{
  "id": "01a1b08c-6e3a-7562-8f4a-7924722667b1",
  "name": "invoice.pdf",
  "status": "received",
  "reason": null,
  "external_ref": "account.move,42",
  "documents": [],
  "sha256": "0edd5593…"
}

4. Attendre la lecture

Demandez le fichier toutes les quelques secondes tant que son status vaut received ou reading. La plupart des PDF prennent moins d'une minute.

curl -sS https://api.ocost.io/public/v1/files/$FILE_ID \
  -H "Authorization: Bearer $OCOST_KEY"

Un fichier lu liste ses documents :

JSON
{
  "id": "01a1b08c-6e3a-7562-8f4a-7924722667b1",
  "status": "read",
  "documents": [
    {
      "id": "01a1b08c-7aa1-7b52-9d4e-2f1f1c0c4f11",
      "kind": "invoice",
      "number": "RE-2026-1187",
      "pages": [1]
    }
  ]
}

Un fichier qui finit en not_read ou failed en donne la raison dans reason. Statuts et raisons les liste.

5. Lire le document

Demandez le premier document du fichier.

curl -sS https://api.ocost.io/public/v1/files/$FILE_ID/document \
  -H "Authorization: Bearer $OCOST_KEY"

La réponse est la facture en ocost.document.v1, abrégée ici :

JSON
{
  "schema": "ocost.document.v1",
  "kind": "invoice",
  "number": "RE-2026-1187",
  "issue_date": "2026-11-03",
  "due_date": "2026-12-03",
  "currency": "EUR",
  "seller": { "name": "Musterbüro Lieferant GmbH", "vat_id": "DE123456789" },
  "totals": { "net": 1068, "tax": 202.92, "gross": 1270.92 }
}

La suite

Voir aussi