# Organizations API

L'Organizations API est la famille d'API publique One Platform pour les partenaires et intégrateurs système côté client qui opèrent dans le périmètre d'une organisation spécifique.

Utilisez cette API lorsque votre intégration doit gérer ou inspecter des ressources limitées à une organisation, comme les clients, relations commerciales, contrats, éléments de contrat, groupes d'activation de service, consommations et métriques produit.

## Périmètre

La plupart des endpoints utilisent une route limitée à une organisation :

```http
/v1/organizations/{id}/<resource>
```

Le paramètre de chemin `{id}` identifie le contexte d'organisation One Platform. Le jeton d'accès doit être autorisé pour cette organisation et pour l'opération demandée.

La référence actuelle inclut à la fois les anciens endpoints consumer `/v1` et les endpoints consumer `/v2`. Utilisez `/v2/organizations/{id}/consumers` pour les nouveaux parcours client français et représentant légal, car v2 expose `taxCode1`, `taxCode2`, `taxCode3`, `PrivateIndividual` et `ProfessionalIndividual`.

## Capacités principales

| Domaine | Exemples |
|  --- | --- |
| Relations commerciales | Récupérer les relations commerciales et les chemins consommateurs associés. |
| Consumers | Créer et récupérer des clients et représentants légaux dans le périmètre de l'organisation. |
| Contrats | Créer, récupérer, mettre à jour et gérer les contrats d'organisation. |
| Éléments de contrat | Créer et gérer les lignes de service connectées à un contrat. |
| Activation de service | Créer et confirmer des groupes d'activation de service. |
| Consommations | Récupérer les dernières consommations et les consommations agrégées. |
| Métriques produit | Récupérer les métriques produit pour les consumers liés à l'organisation. |


## Notes sur les consumers français

Pour les consumers français, l'Organizations API utilise le modèle de codes fiscaux v2 :

| Champ | Signification française | Notes |
|  --- | --- | --- |
| `taxCode1` | TVA | Optionnel pour `Corporate` et `ProfessionalIndividual` ; doit être vide pour `PrivateIndividual`. |
| `taxCode2` | SIREN | Optionnel pour `Corporate` et `ProfessionalIndividual` ; les SIREN temporaires du représentant légal French eInvoice utilisent `T03` + ULID. |
| `taxCode3` | SIRET | Optionnel pour `Corporate` et `ProfessionalIndividual` ; doit correspondre au SIREN lorsqu'il est présent. |
| `customerType` | Type de client français | Les valeurs supportées sont `PrivateIndividual`, `ProfessionalIndividual` et `Corporate`. |


Pour le parcours d'activation French eInvoice :

- Recherchez le client final avec `GET /v2/organizations/{id}/consumers?taxCode1=<TVA>&country=FR&customerType=Corporate&exact=true&pageSize=1`.
- Recherchez le représentant légal avec `GET /v2/organizations/{id}/consumers?taxCode2=<temporary-siren>&country=<country>&customerType=PrivateIndividual&exact=true&pageSize=1`.
- Créez le client final avec `customerType=Corporate` et la correspondance TVA/SIREN/SIRET ci-dessus.
- Créez le représentant légal avec `customerType=PrivateIndividual`, `firstName`, `lastName`, `taxCode2`, `emails`, `phones` et `mobilePhones` vides, et `billable=false`.
- Utilisez `onboardingExtraParameters.hasDelegate` sur l'élément de contrat pour distinguer l'onboarding d'un délégué de celui du représentant légal. Omettez-le ou définissez-le à `"false"` pour le représentant légal ; définissez-le à `"true"` lorsque la personne d'onboarding est un délégué.
- Lorsque l'élément de contrat French eInvoice inclut la fonctionnalité `dt-portal`, renseignez `onboardingExtraParameters.adminEmail`, `adminFirstName` et `adminLastName` pour identifier l'administrateur du Portail DT. Ne rendez pas ces champs obligatoires lorsque `dt-portal` n'est pas sélectionné.
- Fournissez le contexte d'activation SAG lors de la création du contrat lorsque votre version API expose un champ natif pour cela. Sinon, récupérez ou créez le SAG via les endpoints Service Activation Group avant confirmation.


Le swagger actuel marque `/v2/organizations/{id}/consumers` comme instable et en développement actif. Les intégrations doivent isoler cet endpoint pour absorber plus facilement les futures évolutions de schéma.

## Sections

- [Authentification](/fr/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/organizations-api/authentication)
- [Endpoints](/fr/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/organizations-api/overview)
- [Guides d'intégration](/fr/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/organizations-api/integration-guides/overview)