Aller au contenu
Envoyer des données/Créer une entité

Créer une entité

Crée une entité : la société dont le budget est piloté.

L'entité est créée tout de suite, sans attendre une validation : c'est une règle de calcul, écrite au nom du membre de la clé comme une nouvelle version des règles. Par MCP, cet appel est refusé.

Une deuxième entité demande l'offre Groupe.

Appel

RepèreValeur
AdressePOST /api/v1/entities
Par son nomPOST /api/v1/tools/create_entity, la réponse sous data
Nom de l'outilcreate_entity
Droit demandéModifier les règles de calcul (rules.set)
Rôles qui ont ce droit par défautPropriétaire, CMO
Par MCPNon : cet appel écrit des données. Une application connectée par MCP propose, une personne valide.

Paramètres

Les paramètres sont dans le corps de la requête, en JSON.

ParamètreRequisType et limitesÀ quoi il sert
nameouitexte, 1 à 120 caractèresLe nom de la société.
sirennontexteSon SIREN, neuf chiffres. Facultatif.
fiscalYearStartMonthouinombre entier, de 1 à 12Le premier mois de son exercice : 1 pour janvier.

Exemple

curl -X POST "$MARVESTO_URL/api/v1/entities" \
  -H "x-api-key: $MARVESTO_API_KEY" \
  -H "content-type: application/json" \
  -d @corps.json

Le fichier corps.json :

{
  "name": "Lumen Analytics SAS",
  "fiscalYearStartMonth": 1
}

Réponse

entityId : l'identifiant de l'entité créée.

{
  "entityId": "ENTITY_ID"
}

Refus

Un refus répond { "message": "…" }, en français, avec son statut HTTP : voir Droits et erreurs.