Companies
Entité métier utilisée comme identité du marchand, acheteur, fournisseur, client onboardé ou contrepartie de paiement.
Objet métier
Vue d’ensemble
Les endpoints companies servent à créer, retrouver, enrichir et suspendre les entités métier. Une company est rattachée au périmètre du marchand, peut représenter son identité propre et référence les objets liés par leurs identifiants dans les relations API.
Voir aussi la page du modèle métier company pour la sémantique, les relations et le cycle de vie fonctionnel.
Contrat JSON
Objet company
Les réponses utilisent l’identifiant préfixé cmp_ et le champ object pour rendre le type explicite.
Identifiant du marchand qui délimite le périmètre de la company.
Nom légal de l’entreprise. Requis à la création.
Nom commercial optionnel.
Lecture seule : trade_name lorsqu’il existe, sinon legal_name.
Pays ISO 3166-1 alpha-2 utilisé avec le numéro ou le tax ID.
Numéro d’immatriculation local.
Identifiant fiscal.
Lecture seule. Vaut true pour la company référencée par le marchand.
Qualifications commerciales explicites et obligatoires à la création.
REST
Endpoints
| Méthode | Endpoint | Usage |
|---|---|---|
| POST | /v1/companies | Créer une company. |
| GET | /v1/companies | Lister les companies, avec filtres merchant_id, source_reference, is_buyer, is_supplier ou group_id. |
| GET | /v1/companies/search | Résoudre une company unique par source_reference, registration_number, tax_identifier ou legal_name. |
| GET | /v1/companies/{id} | Récupérer une company. |
| POST | /v1/companies/{id} | Mettre à jour les champs métier de la company. |
| POST | /v1/companies/{id}/suspend | Suspendre une company. |
| POST | /v1/companies/{id}/reactivate | Réactiver une company suspendue. |
| GET | /v1/companies/{id}/contacts | Lister les contacts rattachés. |
| GET | /v1/companies/{id}/contacts/resolve | Résoudre les contacts par rôle et niveau de certification. |
| GET | /v1/companies/{id}/company-groups | Lister les groupes de l’entreprise. |
| POST | /v1/companies/{id}/company-group-links | Remplacer les appartenances aux groupes. |
Événements
Événements associés
Ces événements peuvent être consommés via les webhooks plateforme lorsque le compte est configuré pour les recevoir.
Comportement
Points d’attention
- is_self est calculé à partir du lien exposé par merchant.company_id et ne se modifie pas via l’API Company.
- La recherche retourne un objet company_search_result avec company et matched_by.
- registration_number, tax_identifier et legal_name exigent aussi country dans la recherche.
- Les endpoints receivable/payable sont des vues calculées rattachées à la company, pas une mutation de la company elle-même.