Gestion des transactions

Une transaction est identifiée par une adresse email et un identifiant unique. Une transaction permet de gérer l’état d’un pré-état date dans notre système.

Créer une transaction

Crée une nouvelle commande dans le système.

Endpoint

URL : /order/
Méthode : POST
Content-Type : application/json

Paramètres de la requête

Les paramètres doivent être fournis dans le corps de la requête sous forme de JSON :

address (string) : Adresse principale de la commande.
additional (string, optionnel) : Adresse supplémentaire de la commande.
city (string) : Ville de la commande.
zipcode (string) : Code postal de la commande.
owners (array d’objets) : Liste des propriétaires.
- firstname (string, optionnel) : Prénom du propriétaire.
- lastname (string) : Nom du propriétaire.
- address (string, optionnel) : Adresse du propriétaire. Par défaut, l’adresse principale est utilisée.
- additional (string, optionnel) : Adresse supplémentaire du propriétaire.
- city (string, optionnel) : Ville du propriétaire.
- zipcode (string, optionnel) : Code postal du propriétaire.
- phone (string, optionnel) : Téléphone du propriétaire.
- email (string, optionnel) : Adresse email du propriétaire.
invoice (objet, optionnel) : Informations de facturation.
- address (string) : Adresse de facturation.
- city (string) : Ville de facturation.
- zipcode (string) : Code postal de facturation.
- lastname (string) : Nom de la société de facturation.
method (string) : Méthode de traitement de la commande. Les valeurs acceptées sont email, extranet, upload.
syndic (objet, optionnel) : Informations du syndic (nécessaire pour method = extranet).
- name (string) : Nom du syndic.
- username (string) : Nom d’utilisateur du syndic.
- password (string) : Mot de passe du syndic.
- url (string, optionel) : URL de l’espace client du syndic.
documents (array d’objets, optionnel) : Liste des documents (nécessaire pour method = upload).
- path (string) : Chemin du document.
- size (integer) : Taille du document en octets.
- link (string) : Lien du document.
lots (string, optionnel) : Lot associé à la commande.
comment (string, optionnel) : Commentaire sur la commande.
all_due_paid (boolean, optionnel) : Par défaut à False. Indique si le propriétaire est à jour de ses paiements. Si False, les informations seront récupérées depuis l’espace extranet ou à partir du dernier appel de fonds.
external_id (string, optionnel) : Identifiant métier fourni par le client. Il sera renvoyé au format string dans toutes les réponses des webhooks, afin de faciliter le suivi ou le rapprochement avec vos systèmes internes.
test_mode (boolean, optionnel) : Force l’utilisation du mode test pour la tansaction.

Exemple de requête

curl -X POST https://api.pre-etat.date/order/ \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -H "X-Auth-Key: $API_KEY" \
    -d '{
        "address": "4 BIS RUE DE LA FERME",
        "additional": "",
        "city": "CALUIRE ET CUIRE",
        "zipcode": "69300",
        "owners": [{"firstname": "Jean", "lastname": "Dupont"}],
        "invoice": {"address": "64, avenue Kleber", "city": "PARIS", "zipcode": "75116", "lastname": "PLAISIR NOTAIRES"},
        "method": "extranet",
        "syndic": {
            "name": "Syndic Name",
            "username": "syndic_user",
            "password": "syndic_pass"
        }
    }'

Réponses

200 OK

La commande a été créée avec succès.

Exemple de réponse :

{
  "message": "Transaction creée avec succsée", 
  "payload": {
    "account": "utilisateur@mail.com", 
    "billing_mode": null, 
    "created": "Tue, 25 Mar 2025 17:32:39 GMT", 
    "external_id": "1221", 
    "orderid": "C7HOF2", 
    "pending": true, 
    "refreshed": false, 
    "sso_provider": null, 
    "state": "confirmed", 
    "test_mode": true, 
    "updated": "Tue, 25 Mar 2025 17:32:39 GMT"
  }, 
  "success": true
}

400 Bad Request

La requête contient des erreurs de validation.

Exemple de réponse :

{
  "message": "Informations du syndic manquantes ou incorrectes pour la méthode 'extranet'", 
  "payload": null, 
  "success": false
}

500 Internal Server Error

Une erreur serveur est survenue.

Exemple de réponse :

{
  "message": "Failed to decode JSON object: Expecting ',' delimiter: line 14 column 6 (char 563)", 
  "payload": null, 
  "success": false
}

Notes supplémentaires

Assurez-vous de remplacer $TOKEN par un jeton d’authentification valide.

Assurez-vous de remplacer $API_KEY par une clé API valide.

En mode test, la commande est enregistrée mais aucun email de confirmation n’est envoyé.

Demande de Rafraîchissement

Cet endpoint permet de demander un rafraîchissement pour une commande spécifique dans notre système.

Créer une Demande de Rafraîchissement

Endpoint

URL : /order/<orderid>/refresh
Méthode : POST
Content-Type : application/json

Paramètres de la Requête

Les paramètres doivent être fournis dans le corps de la requête sous forme de JSON :

comment (string, optionnel) : Commentaire sur la commande.
all_due_paid (boolean, optionnel) : Par défaut à False. Indique si le propriétaire est à jour de ses paiements. Si False, les informations seront récupérées depuis l’espace extranet ou à partir du dernier appel de fonds.
method (string) : Méthode de traitement de la demande. La valeur acceptée est extranet.
syndic (objet, optionnel) : Informations du syndic (nécessaire uniquement si method est extranet).
- name (string) : Nom du syndic.
- username (string) : Nom d’utilisateur du syndic.
- password (string) : Mot de passe du syndic.

Notes

Actuellement seule la méthode syndic est supportée

Exemple de Requête

curl -X POST https://api-pre-etat.date/order/needrefresh \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -H "X-Auth-Key: $API_KEY" \
    -d '{
        "all_due_paid": true,
        "comment": "",
        "method": "extranet",
        "syndic": {
            "name": "Syndic Name",
            "username": "syndic_user",
            "password": "syndic_pass"
        }
    }'

Exemple de réponse :

{
  "message": null, 
  "payload": {
    "account": "utilisateur@mail.com", 
    "billing_mode": null, 
    "created": "Tue, 25 Mar 2025 17:39:25 GMT", 
    "external_id": "1221", 
    "orderid": "SD28Z5", 
    "pending": true, 
    "refreshed": false, 
    "sso_provider": null, 
    "state": "need-refresh", 
    "test_mode": true, 
    "updated": "Wed, 26 Mar 2025 08:18:39 GMT"
  }, 
  "success": true
}

Endpoint (déprécié)

URL : /order/needrefresh
Méthode : POST
Content-Type : application/json

Paramètres de la Requête

Les paramètres doivent être fournis dans le corps de la requête sous forme de JSON :

orderid (string) : Identifiant unique de la commande.
account (string) : Adresse email associée au compte de la commande.
method (string) : Méthode de traitement de la demande. La valeur acceptée est extranet.
syndic (objet, optionnel) : Informations du syndic (nécessaire uniquement si method est extranet).
- name (string) : Nom du syndic.
- username (string) : Nom d’utilisateur du syndic.
- password (string) : Mot de passe du syndic.

Exemple de Requête

curl -X POST https://api-pre-etat.date/order/needrefresh \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -H "X-Auth-Key: $API_KEY" \
    -d '{
        "orderid": "xxx",
        "account": "xxx@gmail.com",
        "method": "extranet",
        "syndic": {
            "name": "Syndic Name",
            "username": "syndic_user",
            "password": "syndic_pass"
        }
    }'