> ## Documentation Index
> Fetch the complete documentation index at: https://api-doc.fidly.be/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Lire et écrire les données d'une entreprise via une interface HTTP stable.

L'API Fidly permet à un partenaire ou à une intégration tierce de lire et d'écrire
les données d'une entreprise : documents (factures, notes de crédit, documents
reçus), tiers, comptes bancaires, journaux et identités visuelles.

## URL de base

```
https://api.fidly.be
```

Toutes les requêtes utilisent HTTPS et JSON (sauf les endpoints d'envoi et de
téléchargement de fichiers, en `multipart/form-data` et octets bruts).

## Ressources

| Ressource                                                | Lecture | Écriture | Modification | Suppression |
| -------------------------------------------------------- | :-----: | :------: | :----------: | :---------: |
| [Documents](/fr/concepts/documents)                      |    ✅    |     ✅    |       ✅      |      ✅      |
| [Relations](/fr/concepts/relations)                      |    ✅    |     ✅    |       ✅      |      ✅      |
| [Adresses de livraison](/fr/concepts/delivery-locations) |    ✅    |     ✅    |       ✅      |      ✅      |
| [Comptes bancaires](/fr/concepts/bank-accounts)          |    ✅    |     ✅    |       ✅      |      ❌      |
| [Journaux](/fr/concepts/journals)                        |    ✅    |     ✅    |       ✅      |      ❌      |
| [Brandings](/fr/concepts/brandings)                      |    ✅    |     ❌    |      🟠      |      ❌      |
| [Listes de référence](/fr/concepts/reference-lists)      |    ✅    |     ❌    |       ❌      |      ❌      |

**Légende** :

* ✅ disponible
* 🟠 partiellement implémenté — l'endpoint n'expose qu'une partie de la ressource
* ❌ indisponible

🟠 **Brandings** — le `PATCH` ne permet que de désigner le branding par défaut,
aucun autre champ n'est modifiable.

Les conditions métier d'une action (verrou de modification d'un document envoyé,
champs figés d'un journal, suppression refusée tant que d'autres objets font
référence à celui visé...) sont détaillées sur la page de chaque ressource.

<Warning>
  L'API est plus permissive que l'interface. Un document créé via l'API peut donc
  contenir des combinaisons que l'application web ou mobile ne sait pas représenter,
  et son affichage ou sa modification depuis l'application peut alors poser problème.
  C'est notamment le cas des taux de TVA autres que les taux légaux belges (0, 6, 12
  et 21 %), ou des remises et majorations dès qu'il y en a plus d'une par ligne ou
  par document — sans que cela se limite à ces deux exemples.
</Warning>

## Environnements

Chaque client d'API travaille dans l'un de deux environnements :

* **Live** — les données réelles de l'entreprise, en lecture comme en écriture.
* **Sandbox** — un environnement cloisonné pour développer et tester : des données
  de démonstration, les mêmes validations et les mêmes codes d'erreur qu'en live,
  et aucune modification stockée. Voir [Sandbox](/fr/sandbox).

L'environnement est déterminé par vos identifiants : une paire
`client_id` / `client_secret` appartient soit au live, soit au sandbox, et
s'obtient dans l'interface Fidly.

## Authentification

L'authentification repose sur le flux OAuth2 *client credentials*. Un appel à
`POST /auth/token` avec votre paire `client_id` / `client_secret` renvoie vos clés
`access_token` et `refresh_token` ; chaque appel à l'API porte ensuite
l'`access_token` dans l'en-tête `Authorization`. Voir
[Authentification](/fr/authentication).

## Erreurs

Toutes les erreurs partagent la même enveloppe, avec un `code` machine-readable et
un `message` lisible. Voir [Erreurs](/fr/errors).