# Réservations & ventes
# Lister les réservations et les ventes
Permet de récupérer la liste des réservations et des ventes d'un programme.
UTILE
Pour obtenir la fiche détaillée d'une réservation ou d'une vente il est nécessaire de consulter directement sa fiche.
Il n'est possible d'afficher que 50 réservations par requête, un système de pagination est en place.
# Requête HTTP
GET https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/purchases
# Paramètres d'URL
| Nom de la clé | Description |
|---|---|
| {tenantKey} | Clé de l'espace client - Détails |
| {programId} | ID du programme |
# curl
curl --location --request GET 'https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/purchases' \
--header 'Accept: application/json' \
--header 'X-API-Key: VOTRE_CLE_API'
# Body de réponse
DETAILS
{
"success": true,
"message": null,
"data": [
{
"id": 4,
"lead_id": 88,
"owner": {
"id": 1,
"fullname": "Jean Dupont",
"shortname": "J. Dupont",
"email": "jean.dupont@promoteur.fr"
},
"deposit_amount": 3000,
"price_including_vat": 188882,
"cancellation_type": null,
"contacts": [
{
"id": 111,
"title": "mr",
"title_display": "Monsieur",
"name": "Durand",
"firstname": "Tristan",
"email1": "michele86@example.com",
"email2": "roger30@example.net",
"phone1": "+33632342298",
"phone2": "+33136542298",
"city": "Lyon",
"zipcode": "69002",
"country": "FR",
"address1": "11, boulevard Barbier",
"address2": null,
"legal_entity": false,
"legal_status": null,
"company_name": null,
"company_siret": null,
"resides_since": 2018,
"optin_email": false,
"optin_phone": true,
"optin_sms": false,
"birthdate": "1994-03-04",
"birthplace": "Fleuryboeuf",
"nationality": "FR",
"marital_status": "civil",
"marital_status_display": "Pacsé(e)",
"profession": null,
"vehicles": 3,
"children": 2,
"primary_residence": "owner",
"primary_residence_display": "Propriétaire",
"own_secondary_residence": true,
"first_time_homeowner": false,
"has_already_invested": false,
"has_already_invested_comment": null,
"bank_name": null,
"insurance_name": "Société Générale",
"has_broker": true,
"updated_at": "2020-09-04T10:19:58.000000Z"
},
{
"id": 112,
"title": "ms",
"title_display": "Madame",
"name": "Pages",
"firstname": "Aurélie",
"email1": "pages.aurelie@example.org",
"email2": null,
"phone1": "+33691839246",
"phone2": "+33191408246",
"city": "Lyon",
"zipcode": "69002",
"country": "FR",
"address1": "11, boulevard Barbier",
"address2": null,
"legal_entity": false,
"legal_status": null,
"company_name": null,
"company_siret": null,
"resides_since": 2010,
"optin_email": true,
"optin_phone": false,
"optin_sms": false,
"birthdate": "1996-11-12",
"birthplace": "Robin-sur-Mer",
"nationality": "FR",
"marital_status": "civil",
"marital_status_display": "Pacsé(e)",
"profession": null,
"vehicles": 3,
"children": 2,
"primary_residence": "other",
"primary_residence_display": "Autre",
"own_secondary_residence": true,
"first_time_homeowner": true,
"has_already_invested": true,
"has_already_invested_comment": null,
"bank_name": "Crédit Agricole",
"insurance_name": "Société Générale",
"has_broker": false,
"updated_at": "2020-09-04T10:19:58.000000Z"
}
],
"lots": [
{
"id": 41,
"reference": "A313",
"is_primary": true,
"type": "apartment",
"type_display": "Appartement",
"typology": "T3",
"typology_display": "3 pièces",
"subtype": null,
"subtype_display": null,
"vat_rate": 20,
"discount_including_vat": null,
"price_excluding_vat": 157401.67,
"price_including_vat": 188882,
"discounted_price_including_vat": 188882,
"status": "booked",
"status_display": "Réservé",
"updated_at": "2020-09-04T10:20:04.000000Z"
}
],
"booking_contract_signed_at": "2020-08-15T04:00:00.000000Z",
"withdrawal_period_expires_at": "2020-08-29T04:00:00.000000Z",
"notary_appointment_set_at": "2020-10-28T21:00:00.000000Z",
"sale_deed_signed_at": null,
"canceled_at": null,
"status": "notary-appointment-set",
"updated_at": "2020-09-04T10:20:04.000000Z"
}
],
"links": {
"first": "https://api.adlead.immo/v1/client-a/programs/1/purchases?page=1",
"last": "https://api.adlead.immo/v1/client-a/programs/1/purchases?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://api.adlead.immo/v1/client-a/programs/1/purchases?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://api.adlead.immo/v1/client-a/programs/1/purchases",
"per_page": 50,
"to": 3,
"total": 3
}
}
# Consulter la réservation ou la vente
Permet de récupérer la fiche détaillée d'une réservation ou d'une vente
# Requête HTTP
GET https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/purchases/{purchaseId}
# Paramètres d'URL
| Nom de la clé | Description |
|---|---|
| {tenantKey} | Clé de l'espace client - Détails |
| {programId} | ID du programme |
| {purchaseId} | ID de la réservation ou de la vente |
# Paramètres de requête
| Nom du paramètre | Description | Exemple | Format des données | Valeur par défaut |
|---|---|---|---|---|
| page | Numéro de la page à afficher | 1 | 1 | |
| per_page | Nombre d'enregistrements par page | 20 50 | Entre 1 et 100 | 50 |
# curl
curl --location --request GET 'https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/purchases/{purchaseId}?page=1&per_page=50' \
--header 'Accept: application/json' \
--header 'X-API-Key: VOTRE_CLE_API'
# Body de réponse
DETAILS
{
"success": true,
"message": null,
"data": {
"id": 4,
"lead_id": 88,
"owner": {
"id": 1,
"fullname": "Jean Dupont",
"shortname": "J. Dupont",
"email": "jean.dupont@promoteur.fr"
},
"deposit_amount": 3000,
"price_including_vat": 188882,
"cancellation_type": null,
"contacts": [
{
"id": 111,
"title": "mr",
"title_display": "Monsieur",
"name": "Durand",
"firstname": "Tristan",
"email1": "michele86@example.com",
"email2": "roger30@example.net",
"phone1": "+33632342298",
"phone2": "+33136542298",
"city": "Lyon",
"zipcode": "69002",
"country": "FR",
"address1": "11, boulevard Barbier",
"address2": null,
"legal_entity": false,
"legal_status": null,
"company_name": null,
"company_siret": null,
"resides_since": 2018,
"optin_email": false,
"optin_phone": true,
"optin_sms": false,
"birthdate": "1994-03-04",
"birthplace": "Fleuryboeuf",
"nationality": "FR",
"marital_status": "civil",
"marital_status_display": "Pacsé(e)",
"profession": null,
"vehicles": 3,
"children": 2,
"primary_residence": "owner",
"primary_residence_display": "Propriétaire",
"own_secondary_residence": true,
"first_time_homeowner": false,
"has_already_invested": false,
"has_already_invested_comment": null,
"bank_name": null,
"insurance_name": "Société Générale",
"has_broker": true,
"updated_at": "2020-09-04T10:19:58.000000Z"
},
{
"id": 112,
"title": "ms",
"title_display": "Madame",
"name": "Pages",
"firstname": "Aurélie",
"email1": "pages.aurelie@example.org",
"email2": null,
"phone1": "+33691839246",
"phone2": "+33191408246",
"city": "Lyon",
"zipcode": "69002",
"country": "FR",
"address1": "11, boulevard Barbier",
"address2": null,
"legal_entity": false,
"legal_status": null,
"company_name": null,
"company_siret": null,
"resides_since": 2010,
"optin_email": true,
"optin_phone": false,
"optin_sms": false,
"birthdate": "1996-11-12",
"birthplace": "Robin-sur-Mer",
"nationality": "FR",
"marital_status": "civil",
"marital_status_display": "Pacsé(e)",
"profession": null,
"vehicles": 3,
"children": 2,
"primary_residence": "other",
"primary_residence_display": "Autre",
"own_secondary_residence": true,
"first_time_homeowner": true,
"has_already_invested": true,
"has_already_invested_comment": null,
"bank_name": "Crédit Agricole",
"insurance_name": "Société Générale",
"has_broker": false,
"updated_at": "2020-09-04T10:19:58.000000Z"
}
],
"lots": [
{
"id": 41,
"reference": "A313",
"is_primary": true,
"type": "apartment",
"type_display": "Appartement",
"typology": "T3",
"typology_display": "3 pièces",
"subtype": null,
"subtype_display": null,
"vat_rate": 20,
"discount_including_vat": null,
"price_excluding_vat": 157401.67,
"price_including_vat": 188882,
"discounted_price_including_vat": 188882,
"status": "booked",
"status_display": "Réservé",
"updated_at": "2020-09-04T10:20:04.000000Z"
}
],
"booking_contract_signed_at": "2020-08-15T04:00:00.000000Z",
"withdrawal_period_expires_at": "2020-08-29T04:00:00.000000Z",
"notary_appointment_set_at": "2020-10-28T21:00:00.000000Z",
"sale_deed_signed_at": null,
"canceled_at": null,
"status": "notary-appointment-set",
"updated_at": "2020-09-04T10:20:04.000000Z"
}
}
# Modèle
# Réservation / vente
| Champ | Type | Description | Exemple | Format des données |
|---|---|---|---|---|
| id | int | ID de la réservation ou de la vente | 1 | |
| lead_id | int | ID du lead associé | 406 | |
| owner | object | Utilisateur propriétaire | ||
| vat_rate | float | Taux de TVA appliquée (en %) | 20 | 5.5 20 |
| deposit_amount | float | Montant du dépôt de garantie | 3000 | |
| price_including_vat | float | Prix de vente total (TVA et remise incluses) | 188882.23 | |
| cancellation_type | string | Type de désistement | funding-refused | Accéder au tableau |
| contacts | array | Liste du ou des acquéreurs | Accéder au tableau | |
| lots | array | Liste du ou des lots réservés / vendus | Accéder au tableau | |
| option_expires_at | string | Date d'expiration de l'option | 2020-09-04T10:20:04.000000Z | ISO 8601 |
| pre_booking_confirmed_at | string | Date de confirmation de la pré-réservation | 2020-09-04T10:20:04.000000Z | ISO 8601 |
| booking_contract_signed_at | string | Date de signature du contrat de réservation | 2020-09-04T10:20:04.000000Z | ISO 8601 |
| withdrawal_period_expires_at | string | Date d'expiration du délai de rétractation | 2020-09-04T10:20:04.000000Z | ISO 8601 |
| notary_appointment_set_at | string | Date prévue pour de la signature notaire | 2020-09-04T10:20:04.000000Z | ISO 8601 |
| sale_deed_signed_at | string | Date de signature de l'acte de vente notarié | 2020-09-04T10:20:04.000000Z | ISO 8601 |
| canceled_at | string | Date d'annulation / rétractation | 2020-09-04T10:20:04.000000Z | ISO 8601 |
| status | string | Statut de la réservation ou de la vente | notary-appointment-set | Accéder au tableau |
| updated_at | string | Dernière mise à jour | 2020-09-04T10:20:04.000000Z | ISO 8601 |
# Lot réservé ou vendu
| Champ | Type | Description | Exemple | Format des données |
|---|---|---|---|---|
| id | int | ID du lot | 1 | |
| reference | string | Référence unique du lot | A01 | |
| type | string | Type de bien | apartment | Accéder au tableau |
| typology | string | Typologie du bien | T2 | Accéder au tableau |
| discount_including_vat | float | Remise TTC | 2000 | |
| price_excluding_vat | float | Prix de vente HT | 166666.67 | |
| price_including_vat | float | Prix de vente TTC | 200000 | |
| discounted_price_including_vat | float | Prix de vente TTC (remise incluse) | 198000 | |
| status | string | Statut du lot | booked | Accéder au tableau |
| updated_at | string | Dernière mise à jour | 2020-09-04T10:20:04.000000Z | ISO 8601 |
# Annexes
# Statuts
Liste des statuts de réservation ou de vente
DETAILS
[
{
"key": "pending-pre-booking",
"name": "Pré-réservation en attente"
},
{
"key": "pre-booked",
"name": "Pré-réservé"
},
{
"key": "booked",
"name": "Réservé"
},
{
"key": "withdrawal-period",
"name": "Période de rétractation"
},
{
"key": "awaiting-funding",
"name": "En attente de financement"
},
{
"key": "notary-appointment-to-be-set",
"name": "Signature notaire à planifier"
},
{
"key": "notary-appointment-set",
"name": "Signature notaire planifiée"
},
{
"key": "canceled",
"name": "Réservation annulée"
},
{
"key": "signed",
"name": "Acte de vente signé"
}
]
# Type de désistement
Liste des types de désistement
DETAILS
[
{
"key": "withdrawal-period",
"name": "Délai de rétractation"
},
{
"key": "funding-refused",
"name": "Refus de crédit"
},
{
"key": "other",
"name": "Autre"
}
]