Objets et champs
Champs du flux partenaire (export et endpoints). Pour chaque champ : type, format, exemple, valeurs possibles (enums). Sommaire dans le menu de gauche — barre de recherche en haut du menu.
Aucun objet ni enum ne correspond à la recherche.
Programme
curl 'https://api.octave.immo/v1/programs/export?page=1&per_page=5' \
-H 'Authorization: Bearer ACCESS_TOKEN'
Objet programme dans l’export / détail (`ProgramDetail`). Liste légère : `GET /v1/programs`.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
1001
|
— | Identifiant interne. Ne pas utiliser dans les URLs. |
token |
string |
— |
program_fictif-les-lilas-sandbox
|
— | Identifiant stable pour les URLs. |
name |
string |
— |
[FICTIF] Résidence Les Lilas
|
— | Nom commercial. |
slug |
string |
— |
fictif-residence-les-lilas
|
— | Slug URL. |
is_active |
boolean |
— |
true
|
— | Programme actif côté application. |
contrat_type |
string |
— |
veefa
|
— | Type de contrat (nullable). |
cityscan_enabled |
boolean |
— |
false
|
— | Cityscan activé. |
maquette_3d_url |
string |
uri |
null
|
— | URL maquette 3D (nullable). |
addresses |
array<object> |
— |
[{…}]
|
— | Adresses du programme. Voir Adresse. |
fiscalites |
array<object> |
— |
[{…}]
|
— | Dispositifs fiscaux. Voir Fiscalité. |
prestations |
array<object> |
— |
[{…}]
|
— | Prestations. Voir Prestation. |
marketing_tags |
array<object> |
— |
[{…}]
|
— | Tags marketing. Voir Marketing tag. |
descriptions |
array<object> |
— |
[{…}]
|
— | Textes descriptifs. Voir Description. |
argumentaires |
array<object> |
— |
[{…}]
|
— | Argumentaires ordonnés. Voir Argumentaire. |
custom_packs |
array<object> |
— |
[{…}]
|
— | Packs personnalisés. Voir Custom pack. |
ope_coms |
array<object> |
— |
[{…}]
|
— | Opérations commerciales. Voir OpeCom. |
norme_ecos |
array<object> |
— |
[{…}]
|
— | Normes éco. Voir Norme éco. |
dates |
array<object> |
— |
[{…}]
|
— | Dates clés. Voir Date. |
garanties |
array<object> |
— |
[{…}]
|
— | Garanties. Voir Garantie. |
documents |
array<object> |
— |
[{…}]
|
— | Documents. Voir Document. |
images |
object |
— |
{large:[],medium:[],small:[]}
|
— | Images groupées par taille. Voir Images (export). |
lots |
array<object> |
— |
[{…}]
|
— | Lots. Voir Lot. |
annexes_independantes |
array<object> |
— |
[{…}]
|
— | Annexes non rattachées à un lot. Voir Annexe. |
sale_parameter |
object |
— |
null
|
— | Paramètres de vente (nullable). Voir Sale parameter. |
Programme (liste)
curl 'https://api.octave.immo/v1/programs' \
-H 'Authorization: Bearer ACCESS_TOKEN'
Entrée de `GET /v1/programs` — catalogue léger pour sync.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
1001
|
— | Identifiant interne. |
token |
string |
— |
program_fictif-les-lilas-sandbox
|
— | Identifiant stable. |
name |
string |
— |
[FICTIF] Résidence Les Lilas
|
— | Nom commercial. |
slug |
string |
— |
fictif-residence-les-lilas
|
— | Slug URL. |
is_active |
boolean |
— |
true
|
— | Programme actif. |
updated_at |
string |
date-time |
2026-03-01T12:00:00+00:00
|
— | Pour `updated_since` / ETag. |
Lot
curl 'https://api.octave.immo/v1/programs/{program}/lots/{lot}' \
-H 'Authorization: Bearer ACCESS_TOKEN'
Unité à vendre dans l’export ou `GET …/lots/{lot}`.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
2001
|
— | Identifiant interne. |
token |
string |
— |
product_fictif-lot-a01
|
— | Identifiant stable pour les URLs. |
number |
string |
— |
A01
|
— | Numéro commercial. |
category |
string |
— |
lot
|
— | Catégorie produit (`lot`, `custom-pack`, etc.). |
type |
string |
— |
t2
|
ProductTypeCode
|
Typologie. |
type_label |
string |
— |
T2
|
— | Libellé typologie. |
type_icon |
string |
— |
icon-…
|
— | Icône UI (nullable). |
type_color |
string |
— |
primary
|
— | Couleur UI (nullable). |
rooms |
integer |
int32 |
2
|
— | Nombre de pièces dérivé du type (nullable). |
is_pmr |
boolean |
— |
false
|
— | Typologie PMR. |
is_duplex |
boolean |
— |
false
|
— | Typologie duplex. |
is_triplex |
boolean |
— |
false
|
— | Typologie triplex. |
floor |
string |
— |
r+2
|
FloorTypeCode
|
Étage / niveau. |
floor_label |
string |
— |
R+2 - 2ème étage
|
— | Libellé étage. |
floor_short_label |
string |
— |
R+2
|
— | Libellé court. |
floor_icon |
string |
— |
icon-…
|
— | Icône UI. |
floor_color |
string |
— |
primary
|
— | Couleur UI. |
floor_level |
integer |
int32 |
2
|
— | Niveau numérique. |
is_basement |
boolean |
— |
false
|
— | Sous-sol. |
is_ground_level |
boolean |
— |
false
|
— | Rez-de-chaussée / jardin. |
building_number |
string |
— |
A
|
— | Bâtiment (nullable). |
tantieme |
number |
float |
120
|
— | Tantièmes (nullable). |
is_active |
boolean |
— |
true
|
— | Lot actif. |
gender |
string |
— |
appartement
|
ProductTypeCode
|
Genre (nullable). |
diagnostic_dpe |
string |
— |
yes
|
— | Diagnostic DPE (nullable). |
diagnostic_installation_gaz |
string |
— | — | — | Diagnostic gaz (nullable). |
diagnostic_installation_electrique |
string |
— | — | — | Diagnostic électrique (nullable). |
diagnostic_dpe_societe_attestante |
string |
— | — | — | Société attestante DPE (nullable). |
state |
object |
— |
{type,label,…}
|
— | État commercial. Voir État (LabeledEnum). |
surfaces |
array<object> |
— |
[{…}]
|
— | Voir Surface. |
orientations |
array<object> |
— |
[{…}]
|
— | Voir Orientation. |
descriptions |
array<object> |
— |
[{…}]
|
— | Voir Description. |
prices |
array<object> |
— |
[{…}]
|
— | Voir Prix. |
documents |
array<object> |
— |
[{…}]
|
— | Voir Document. |
annexes |
array<object> |
— |
[{…}]
|
— | Annexes liées au lot. Voir Annexe. |
fiscalites |
array<object> |
— |
[{…}]
|
— | Voir Fiscalité. |
ope_coms |
array<object> |
— |
[{…}]
|
— | Voir OpeCom. |
Document
curl 'https://api.octave.immo/v1/programs/{program}/documents' \
-H 'Authorization: Bearer ACCESS_TOKEN'
Document programme ou lot (`DocumentApiSerializer`).
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
token |
string |
uuid |
document_demo_plan_masse
|
— | Identifiant stable. |
type |
string |
— |
plan_masse
|
DocumentTypeProgramCode
|
Type métier (programme ou lot : voir aussi DocumentTypeLotCode). |
name |
string |
— |
Plan de masse.pdf
|
— | Nom affiché. |
file_size |
integer |
int64 |
245760
|
— | Taille en octets (nullable). |
order |
integer |
int32 |
1
|
— | Ordre d’affichage. |
url |
string |
uri |
https://…?X-Amz-Expires=86400
|
— | URL S3 pré-signée (24 h). |
thumbnail_url |
string |
uri |
null
|
— | Vignette signée (nullable). |
created_at |
string |
date-time |
2026-01-15T10:00:00+00:00
|
— | Création (nullable). |
updated_at |
string |
date-time |
2026-01-15T10:00:00+00:00
|
— | Mise à jour (nullable). |
Image (endpoint)
curl 'https://api.octave.immo/v1/programs/{program}/images' \
-H 'Authorization: Bearer ACCESS_TOKEN'
Entrée de `GET /v1/programs/{program}/images`.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
9001
|
— | Identifiant média. |
type |
string |
— |
exterieur
|
ImageTypeCode
|
Catégorie (nullable). |
order |
integer |
int32 |
1
|
— | Ordre d’affichage. |
urls |
object |
— |
{large,medium,small}
|
— | Trois URLs signées. |
urls.large |
string |
uri |
https://…/large.jpg
|
— | Grande taille. |
urls.medium |
string |
uri |
https://…/medium.jpg
|
— | Taille moyenne. |
urls.small |
string |
uri |
https://…/small.jpg
|
— | Vignette. |
Images (export)
curl 'https://api.octave.immo/v1/programs/export?page=1&per_page=5' \
-H 'Authorization: Bearer ACCESS_TOKEN'
Bloc `images` dans le programme exporté.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
large |
array<object> |
— |
[{id,url,type,order}]
|
— | Variantes large. Voir Variante image. |
medium |
array<object> |
— |
[{…}]
|
— | Variantes medium. |
small |
array<object> |
— |
[{…}]
|
— | Variantes small. |
Variante image
curl 'https://api.octave.immo/v1/programs/export?page=1&per_page=5' \
-H 'Authorization: Bearer ACCESS_TOKEN'
Une entrée dans `images.large` / `medium` / `small`.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
9001
|
— | Même id pour les 3 tailles. |
url |
string |
uri |
https://…/large.jpg
|
— | URL S3 pré-signée (24 h). |
type |
string |
— |
exterieur
|
ImageTypeCode
|
Catégorie (nullable). |
order |
integer |
int32 |
1
|
— | Ordre. |
Prix
curl 'https://api.octave.immo/v1/programs/{program}/lots/{lot}/prices' \
-H 'Authorization: Bearer ACCESS_TOKEN'
Ligne de prix d’un lot, d’une annexe ou d’un pack.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
501
|
— | Identifiant interne (souvent présent). |
type |
string |
— |
prix_immo_ttc
|
PriceTypeCode
|
Code prix (annexe : PriceTypeAnnexeCode). |
type_label |
string |
— |
Immo TTC (TVA 20%)
|
— | Libellé. |
type_color |
string |
— |
success
|
— | Couleur UI (nullable). |
value |
number |
float |
295000
|
— | Montant. |
read_only |
boolean |
— |
false
|
— | Inclus dans un autre montant. |
is_active |
boolean |
— |
true
|
— | Ligne active. |
Surface
Surface d’un lot ou d’une annexe.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
301
|
— | Identifiant interne (souvent présent). |
type |
string |
— |
habitable
|
SurfaceTypeCode
|
Type de surface. |
type_label |
string |
— |
Habitable
|
— | Libellé. |
value |
number |
float |
42.5
|
— | Valeur en m². |
Orientation
Orientation d’un lot.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
401
|
— | Identifiant interne (souvent présent). |
type |
string |
— |
sud_est
|
OrientationCode
|
Code orientation. |
type_label |
string |
— |
Sud-Est
|
— | Libellé. |
type_abbreviation |
string |
— |
SE
|
— | Abréviation. |
type_icon |
string |
— |
icon-…
|
— | Icône UI. |
type_color |
string |
— |
warning
|
— | Couleur UI. |
type_bg_color |
string |
— |
bg-warning
|
— | Classe fond UI. |
type_rotation |
integer |
int32 |
135
|
— | Rotation icône (degrés). |
has_good_exposure |
boolean |
— |
true
|
— | Bonne exposition. |
exposure_description |
string |
— |
…
|
— | Texte d’exposition. |
Description
Texte descriptif programme ou lot.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
601
|
— | Identifiant interne (souvent présent). |
type |
string |
— |
descriptif
|
— | Type de description (lot : enum DescriptionLotType). |
type_label |
string |
— |
Descriptif
|
— | Libellé (lots enrichis). |
type_icon |
string |
— |
icon-…
|
— | Icône UI (lots). |
type_color |
string |
— |
primary
|
— | Couleur UI (lots). |
text |
string |
— |
Appartement traversant…
|
— | Contenu. |
État (LabeledEnum)
Bloc `state` d’un lot ou d’une annexe.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
type |
string |
— |
libre
|
ProductStateCode
|
Code état. |
label |
string |
— |
Libre
|
— | Libellé. |
icon |
string |
— |
icon-circle-check
|
— | Icône UI. |
color |
string |
— |
success
|
— | Couleur UI. |
bg_color |
string |
— |
bg-success
|
— | Classe fond. |
text_color |
string |
— |
text-success
|
— | Classe texte. |
description |
string |
— |
Lot disponible à la vente
|
— | Description. |
available |
boolean |
— |
true
|
— | Disponible à la commercialisation. |
Annexe
Annexe liée à un lot, ou `annexes_independantes` du programme.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
3001
|
— | Identifiant interne. |
token |
string |
— |
product_…
|
— | Token (si présent). |
number |
string |
— |
P12
|
— | Numéro. |
category |
string |
— |
annexe
|
— | Catégorie. |
type |
string |
— |
parking
|
ProductTypeCode
|
Type d’annexe. |
type_label |
string |
— |
Parking
|
— | Libellé. |
type_icon |
string |
— |
icon-…
|
— | Icône. |
type_color |
string |
— |
info
|
— | Couleur. |
is_priceable |
boolean |
— |
true
|
— | Annexe tarifable. |
is_active |
boolean |
— |
true
|
— | Active. |
state |
object |
— |
{…}
|
— | Voir État. |
surfaces |
array<object> |
— |
[{…}]
|
— | Voir Surface. |
prices |
array<object> |
— |
[{…}]
|
— | Voir Prix (PriceTypeAnnexeCode). |
OpeCom
Opération commerciale programme ou lot.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
token |
string |
— |
opecom_demo_cuisine
|
— | Token (nullable). |
type |
string |
— |
cuisine_offerte
|
OpeComTypeCode
|
Type. |
recipient_type |
string |
— |
client
|
OpeComRecipientCode
|
Destinataire. |
name |
string |
— |
Cuisine offerte
|
— | Nom (nullable). |
text |
string |
— |
…
|
— | Texte (nullable). |
ratio |
number |
float |
null
|
— | Ratio (nullable). |
rate_calcul |
number |
float |
null
|
— | Taux de calcul (nullable). |
mode_calcul |
string |
— |
null
|
— | Mode de calcul (nullable). |
order |
integer |
int32 |
1
|
— | Ordre. |
is_active |
boolean |
— |
true
|
— | Active. |
all_products |
boolean |
— |
true
|
— | Tous les lots. |
default_products |
boolean |
— |
true
|
— | Produits par défaut. |
date_start |
string |
date |
2026-01-01
|
— | Début (nullable). |
date_end |
string |
date |
2026-12-31
|
— | Fin (nullable). |
prix_limite |
number |
float |
null
|
— | Seuil prix (nullable). |
prix_fixe |
number |
float |
null
|
— | Montant fixe (nullable). |
commission_supplementaire |
number |
float |
null
|
— | Commission boostée (nullable). |
Adresse
Adresse morph du programme.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
11
|
— | Identifiant interne. |
type |
string |
— |
principale
|
— | Type d’adresse (nullable). |
line_1 |
string |
— |
1 impasse Imaginaire
|
— | Ligne 1. |
line_2 |
string |
— |
null
|
— | Ligne 2 (nullable). |
zip_code |
string |
— |
99999
|
— | Code postal. |
city |
string |
— |
Ville-Exemple
|
— | Ville. |
country_id |
integer |
int64 |
null
|
— | Pays (id, nullable). |
latitude |
string |
— |
0.00000000
|
— | Latitude (décimal string). |
longitude |
string |
— |
0.00000000
|
— | Longitude. |
Fiscalité
Dispositif fiscal rattaché.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
21
|
— | Identifiant interne. |
type |
string |
— |
pinel
|
— | Code fiscalité. |
Prestation
Prestation programme.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
31
|
— | Identifiant interne. |
type |
string |
— |
ascenseur
|
— | Code prestation. |
type_label |
string |
— |
Ascenseur
|
— | Libellé. |
type_icon |
string |
— |
icon-…
|
— | Icône. |
type_color |
string |
— |
primary
|
— | Couleur. |
Marketing tag
Tag marketing programme.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
41
|
— | Identifiant interne. |
type |
string |
— |
…
|
— | Code tag. |
type_label |
string |
— |
…
|
— | Libellé. |
type_icon |
string |
— |
icon-…
|
— | Icône. |
type_color |
string |
— |
…
|
— | Couleur. |
type_bg_color |
string |
— |
…
|
— | Fond UI. |
type_text_color |
string |
— |
…
|
— | Texte UI. |
type_description |
string |
— |
…
|
— | Description. |
is_location_tag |
boolean |
— |
false
|
— | Tag localisation. |
is_promotion_tag |
boolean |
— |
false
|
— | Tag promo. |
is_quality_tag |
boolean |
— |
false
|
— | Tag qualité. |
Argumentaire
Argumentaire commercial ordonné.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
51
|
— | Identifiant interne. |
type |
string |
— |
…
|
— | Type (nullable). |
text |
string |
— |
…
|
— | Contenu. |
order |
integer |
int32 |
1
|
— | Ordre. |
Custom pack
Produit `category=custom-pack` du programme.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
4001
|
— | Identifiant interne. |
token |
string |
— |
product_…
|
— | Token. |
number |
string |
— |
PACK1
|
— | Numéro. |
category |
string |
— |
custom-pack
|
— | Toujours `custom-pack`. |
type |
string |
— |
…
|
ProductTypeCode
|
Typologie (nullable). |
type_label |
string |
— |
…
|
— | Libellé. |
type_icon |
string |
— |
icon-…
|
— | Icône. |
type_color |
string |
— |
…
|
— | Couleur. |
prices |
array<object> |
— |
[{…}]
|
— | Voir Prix. |
Date
Date clé programme (morph).
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
61
|
— | Identifiant interne. |
type |
string |
— |
livraison
|
— | Type de date. |
value |
string |
date |
2027-06-30
|
— | Valeur. |
Garantie
Garantie programme.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
71
|
— | Identifiant interne. |
type |
string |
— |
…
|
— | Type de garantie. |
Norme éco
Norme environnementale.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
81
|
— | Identifiant interne. |
type |
string |
— |
…
|
— | Code norme. |
Sale parameter
Paramètres de vente du programme (nullable).
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
91
|
— | Identifiant interne. |
option_duration_day |
integer |
int32 |
7
|
— | Durée d’option (jours). |
option_duration_label |
string |
— |
…
|
— | Libellé durée. |
option_renouvellable |
string |
— |
…
|
— | Renouvellement. |
option_renouvellable_label |
string |
— |
…
|
— | Libellé renouvellement. |
is_renewable |
boolean |
— |
true
|
— | Renouvelable. |
auto_validated_option |
boolean |
— |
false
|
— | Validation auto des options. |
Pagination meta
Objet `meta` des listes / export. `total` et `last_page` indiquent s’il reste des pages à appeler.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
current_page |
integer |
int32 |
1
|
— | Page courante (1-indexée). |
per_page |
integer |
int32 |
25
|
— | Taille de page. |
total |
integer |
int32 |
128
|
— | Nombre total d’éléments (toutes pages). |
last_page |
integer |
int32 |
6
|
— | Dernière page. Continuer tant que current_page < last_page. |
Application
Bloc `application` de l’export.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
id |
integer |
int64 |
12
|
— | Identifiant application. |
name |
string |
— |
Espace Partenaire
|
— | Nom. |
slug |
string |
— |
demo-partenaire
|
— | Slug. |
Réponse export
`GET /v1/programs/export`.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
application |
object |
— |
{…}
|
— | Voir Application. |
programs |
array<object> |
— |
[{…}]
|
— | Programmes de la page courante. |
total |
integer |
int32 |
1
|
— | Nombre total de programmes (toutes pages). Identique à meta.total. |
meta |
object |
— |
{…}
|
— | Pagination (total, last_page). Voir Pagination meta. |
OAuth — requête
`POST /oauth/token` (body JSON).
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
grant_type |
string |
— |
client_credentials
|
— | Toujours `client_credentials`. |
client_id |
string |
— |
oct_demo_sandbox
|
— | Identifiant accès API. |
client_secret |
string |
password |
…
|
— | Secret. |
application |
string |
— |
mon-promoteur
|
— | Slug, token ou id (multi-apps). |
OAuth — réponse
Réponse token.
| Champ | Type | Format | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
access_token |
string |
— |
…
|
— | Bearer opaque. |
token_type |
string |
— |
Bearer
|
— | Type. |
expires_in |
integer |
int32 |
3600
|
— | Secondes. |
Enums (valeurs)
Valeurs listées dans la colonne « Valeurs possibles » ci-dessus.
ProductTypeCode
Exemple : non_defini
| Valeur | Type | Format | Exemple | Libellé |
|---|---|---|---|---|
non_defini |
string |
— | non_defini |
Non défini |
appartement |
string |
— | appartement |
Appartement |
maison |
string |
— | maison |
Maison |
t1 |
string |
— | t1 |
T1 |
t2 |
string |
— | t2 |
T2 |
t3 |
string |
— | t3 |
T3 |
t4 |
string |
— | t4 |
T4 |
t5 |
string |
— | t5 |
T5 |
t6 |
string |
— | t6 |
T6 |
t1_bis |
string |
— | t1_bis |
T1 bis |
t2_bis |
string |
— | t2_bis |
T2 bis |
t3_bis |
string |
— | t3_bis |
T3 bis |
t4_bis |
string |
— | t4_bis |
T4 bis |
t5_bis |
string |
— | t5_bis |
T5 bis |
t6_bis |
string |
— | t6_bis |
T6 bis |
t1_pmr |
string |
— | t1_pmr |
T1 PMR |
t2_pmr |
string |
— | t2_pmr |
T2 PMR |
t3_pmr |
string |
— | t3_pmr |
T3 PMR |
t4_pmr |
string |
— | t4_pmr |
T4 PMR |
t5_pmr |
string |
— | t5_pmr |
T5 PMR |
t6_pmr |
string |
— | t6_pmr |
T6 PMR |
t1_bis_duplex |
string |
— | t1_bis_duplex |
T1 bis Duplex |
t1_duplex |
string |
— | t1_duplex |
T1 Duplex |
t2_duplex |
string |
— | t2_duplex |
T2 Duplex |
t3_duplex |
string |
— | t3_duplex |
T3 Duplex |
t4_duplex |
string |
— | t4_duplex |
T4 Duplex |
t5_duplex |
string |
— | t5_duplex |
T5 Duplex |
t6_duplex |
string |
— | t6_duplex |
T6 Duplex |
t1_triplex |
string |
— | t1_triplex |
T1 Triplex |
t2_triplex |
string |
— | t2_triplex |
T2 Triplex |
t3_triplex |
string |
— | t3_triplex |
T3 Triplex |
t4_triplex |
string |
— | t4_triplex |
T4 Triplex |
t5_triplex |
string |
— | t5_triplex |
T5 Triplex |
t6_triplex |
string |
— | t6_triplex |
T6 Triplex |
local_commercial |
string |
— | local_commercial |
Local commercial |
bureau |
string |
— | bureau |
Bureau |
terrain |
string |
— | terrain |
Terrain |
parking |
string |
— | parking |
Parking |
garage |
string |
— | garage |
Garage |
jardin |
string |
— | jardin |
Jardin |
cour |
string |
— | cour |
Cour |
terrasse |
string |
— | terrasse |
Terrasse |
balcon |
string |
— | balcon |
Balcon |
loggia |
string |
— | loggia |
Loggia |
cave |
string |
— | cave |
Cave |
cellier |
string |
— | cellier |
Cellier |
ProductStateCode
Exemple : non_defini
| Valeur | Type | Format | Exemple | Libellé |
|---|---|---|---|---|
non_defini |
string |
— | non_defini |
Non défini |
libre |
string |
— | libre |
Libre |
option |
string |
— | option |
Optionné |
reserve |
string |
— | reserve |
Réservé |
vendu |
string |
— | vendu |
Vendu |
allote |
string |
— | allote |
Alloté |
locked |
string |
— | locked |
Verrouillé |
FloorTypeCode
Exemple : rdc
| Valeur | Type | Format | Exemple | Libellé |
|---|---|---|---|---|
rdc |
string |
— | rdc |
RDC - Rez-de-chaussée |
ss |
string |
— | ss |
S/S - Sous-sol |
rdj |
string |
— | rdj |
RDJ - Rez-de-jardin |
rdp |
string |
— | rdp |
RDP - Rez-de-pelouse |
rdn |
string |
— | rdn |
RDN - Rez-de-niveau |
rdc-cour |
string |
— | rdc-cour |
RDC - Rez-de-Cour |
r-1 |
string |
— | r-1 |
R-1 - 1er sous-sol |
r-2 |
string |
— | r-2 |
R-2 - 2ème sous-sol |
r-3 |
string |
— | r-3 |
R-3 - 3ème sous-sol |
r-4 |
string |
— | r-4 |
R-4 - 4ème sous-sol |
r-5 |
string |
— | r-5 |
R-5 - 5ème sous-sol |
r-6 |
string |
— | r-6 |
R-6 - 6ème sous-sol |
r+1 |
string |
— | r+1 |
R+1 - 1er étage |
r+2 |
string |
— | r+2 |
R+2 - 2ème étage |
r+3 |
string |
— | r+3 |
R+3 - 3ème étage |
r+4 |
string |
— | r+4 |
R+4 - 4ème étage |
r+5 |
string |
— | r+5 |
R+5 - 5ème étage |
r+6 |
string |
— | r+6 |
R+6 - 6ème étage |
r+7 |
string |
— | r+7 |
R+7 - 7ème étage |
r+8 |
string |
— | r+8 |
R+8 - 8ème étage |
r+9 |
string |
— | r+9 |
R+9 - 9ème étage |
r+10 |
string |
— | r+10 |
R+10 - 10ème étage |
r+11 |
string |
— | r+11 |
R+11 - 11ème étage |
r+12 |
string |
— | r+12 |
R+12 - 12ème étage |
r+13 |
string |
— | r+13 |
R+13 - 13ème étage |
r+14 |
string |
— | r+14 |
R+14 - 14ème étage |
r+15 |
string |
— | r+15 |
R+15 - 15ème étage |
r+16 |
string |
— | r+16 |
R+16 - 16ème étage |
r+17 |
string |
— | r+17 |
R+17 - 17ème étage |
r+18 |
string |
— | r+18 |
R+18 - 18ème étage |
r+19 |
string |
— | r+19 |
R+19 - 19ème étage |
r+20 |
string |
— | r+20 |
R+20 - 20ème étage |
SurfaceTypeCode
Exemple : non_defini
| Valeur | Type | Format | Exemple | Libellé |
|---|---|---|---|---|
non_defini |
string |
— | non_defini |
Non défini |
habitable |
string |
— | habitable |
Habitable |
carrez_avant_travaux |
string |
— | carrez_avant_travaux |
Carrez avant travaux |
carrez |
string |
— | carrez |
Carrez |
totale |
string |
— | totale |
Surface totale |
surface_180 |
string |
— | surface_180 |
Sous 1m80 |
annexe |
string |
— | annexe |
Surface annexe |
OrientationCode
Exemple : non_defini
| Valeur | Type | Format | Exemple | Libellé |
|---|---|---|---|---|
non_defini |
string |
— | non_defini |
Non défini |
nord |
string |
— | nord |
Nord |
nord_est |
string |
— | nord_est |
Nord-Est |
est |
string |
— | est |
Est |
sud_est |
string |
— | sud_est |
Sud-Est |
sud |
string |
— | sud |
Sud |
sud_ouest |
string |
— | sud_ouest |
Sud-Ouest |
ouest |
string |
— | ouest |
Ouest |
nord_ouest |
string |
— | nord_ouest |
Nord-Ouest |
PriceTypeCode
Exemple : non_defini
| Valeur | Type | Format | Exemple | Libellé |
|---|---|---|---|---|
non_defini |
string |
— | non_defini |
Non défini |
prix_fixe |
string |
— | prix_fixe |
Montant fixe reversé |
prix_ttc |
string |
— | prix_ttc |
TTC |
prix_ht |
string |
— | prix_ht |
HT |
prix_immo_ttc |
string |
— | prix_immo_ttc |
Immo TTC (TVA 20%) |
prix_immo_ht |
string |
— | prix_immo_ht |
Immo HT |
prix_immo_ttc_10 |
string |
— | prix_immo_ttc_10 |
Immo TTC (TVA 10%) |
prix_immo_5_5 |
string |
— | prix_immo_5_5 |
Immo TTC (TVA 5,5%) |
prix_tva_immo |
string |
— | prix_tva_immo |
TVA sur immo |
prix_mobilier_ttc |
string |
— | prix_mobilier_ttc |
Mobilier TTC |
prix_mobilier_ht |
string |
— | prix_mobilier_ht |
Mobilier HT |
prix_tva_mobilier |
string |
— | prix_tva_mobilier |
TVA sur mobilier |
prix_foncier_ttc |
string |
— | prix_foncier_ttc |
Foncier TTC |
prix_foncier_ht |
string |
— | prix_foncier_ht |
Foncier HT |
prix_travaux_eligible |
string |
— | prix_travaux_eligible |
Travaux éligibles |
prix_travaux_non_eligible |
string |
— | prix_travaux_non_eligible |
Travaux non éligibles |
prix_tva_5_5 |
string |
— | prix_tva_5_5 |
Immo TTC avec TVA (5.5%) |
prix_tva_10 |
string |
— | prix_tva_10 |
Immo TTC avec TVA (10%) |
mensuel_ttc |
string |
— | mensuel_ttc |
Loyer mensuel TTC |
mensuel_ht |
string |
— | mensuel_ht |
Loyer mensuel HT |
mensuel_denormandie_ttc |
string |
— | mensuel_denormandie_ttc |
Loyer mensuel Denormandie TTC |
mensuel_denormandie_ht |
string |
— | mensuel_denormandie_ht |
Loyer mensuel Denormandie HT |
mensuel_plafonne_dispositif_fiscal |
string |
— | mensuel_plafonne_dispositif_fiscal |
Loyer mensuel plafonné selon dispositif fiscal |
mensuel_social_jean_brun |
string |
— | mensuel_social_jean_brun |
Loyer social Jean Brun |
mensuel_tres_social_jean_brun |
string |
— | mensuel_tres_social_jean_brun |
Loyer très social Jean Brun |
prix_cuisine |
string |
— | prix_cuisine |
Prix cuisine |
frais_notaire |
string |
— | frais_notaire |
Frais de notaire |
frais_notaire_tva_5_5 |
string |
— | frais_notaire_tva_5_5 |
Frais de notaire (TVA 5.5%) |
frais_notaire_tva_10 |
string |
— | frais_notaire_tva_10 |
Frais de notaire avec TVA 10% (LLI) |
frais_pret |
string |
— | frais_pret |
Frais de prêt |
frais_gerance |
string |
— | frais_gerance |
Frais de gérance |
frais_mise_copro |
string |
— | frais_mise_copro |
Frais de mise en copropriété |
montant_depot_garantie |
string |
— | montant_depot_garantie |
Dépôt de garantie |
PriceTypeAnnexeCode
Exemple : non_defini
| Valeur | Type | Format | Exemple | Libellé |
|---|---|---|---|---|
non_defini |
string |
— | non_defini |
Non défini |
prix_ttc |
string |
— | prix_ttc |
Prix TTC |
prix_tva_5_5 |
string |
— | prix_tva_5_5 |
Prix TTC avec TVA 5.5% |
prix_tva_10 |
string |
— | prix_tva_10 |
Prix TTC avec TVA 10% (LLI) |
prix_ht |
string |
— | prix_ht |
Prix HT |
OpeComTypeCode
Exemple : non_defini
| Valeur | Type | Format | Exemple | Libellé |
|---|---|---|---|---|
non_defini |
string |
— | non_defini |
Non défini |
cuisine_offerte |
string |
— | cuisine_offerte |
Cuisine Offerte |
bon_achat |
string |
— | bon_achat |
Bon d'Achat |
frais_notaire_offerts |
string |
— | frais_notaire_offerts |
Frais de Notaire Offerts |
cashback |
string |
— | cashback |
Montant reversé |
boost_de_commission |
string |
— | boost_de_commission |
Boost de commission |
cadeau |
string |
— | cadeau |
Cadeau |
OpeComRecipientCode
Exemple : client
| Valeur | Type | Format | Exemple | Libellé |
|---|---|---|---|---|
client |
string |
— | client |
Client final |
commercialisateur |
string |
— | commercialisateur |
Commercialisateur |
DocumentTypeProgramCode
Exemple : plaquette
| Valeur | Type | Format | Exemple | Libellé |
|---|---|---|---|---|
plaquette |
string |
— | plaquette |
Plaquette |
descriptif_travaux |
string |
— | descriptif_travaux |
Descriptif des travaux |
plan |
string |
— | plan |
Plan |
plan_cadastral |
string |
— | plan_cadastral |
Plan cadastral |
etat_descriptif_division |
string |
— | etat_descriptif_division |
État descriptif de division |
plan_masse |
string |
— | plan_masse |
Plan de masse |
plan_cave |
string |
— | plan_cave |
Plan de cave |
plan_cellier |
string |
— | plan_cellier |
Plan de cellier |
plan_zones_caves |
string |
— | plan_zones_caves |
Plans des zones de caves |
plan_parking |
string |
— | plan_parking |
Plan de parking |
contrat_reservation |
string |
— | contrat_reservation |
Contrat de réservation |
projet_statuts |
string |
— | projet_statuts |
Projet de statuts |
projet_ag |
string |
— | projet_ag |
Projet d'AG |
notice_descriptive |
string |
— | notice_descriptive |
Notice descriptive |
certificat_urbanisme |
string |
— | certificat_urbanisme |
Certificat d'urbanisme |
diagnostics |
string |
— | diagnostics |
Diagnostics |
compte_rendu_visite |
string |
— | compte_rendu_visite |
Compte rendu de visite |
erp |
string |
— | erp |
ERP |
synthese_bases_environnementales |
string |
— | synthese_bases_environnementales |
Synthèse bases environnementales |
dtg |
string |
— | dtg |
DTG |
informations_mobilier |
string |
— | informations_mobilier |
Informations mobilier |
reserve_professionnels |
string |
— | reserve_professionnels |
Réservé aux professionnels |
autre |
string |
— | autre |
Autre |
DocumentTypeLotCode
Exemple : non_defini
| Valeur | Type | Format | Exemple | Libellé |
|---|---|---|---|---|
non_defini |
string |
— | non_defini |
Non défini |
plan_lot |
string |
— | plan_lot |
Plan du lot |
plan_niveau |
string |
— | plan_niveau |
Plan de niveau |
plan_cadastral |
string |
— | plan_cadastral |
Plan cadastral |
plan_masse |
string |
— | plan_masse |
Plan de masse |
plan_cave |
string |
— | plan_cave |
Plan de cave |
plan_cellier |
string |
— | plan_cellier |
Plan de cellier |
plan_zones_caves |
string |
— | plan_zones_caves |
Plans des zones de caves |
plan_parking |
string |
— | plan_parking |
Plan de parking |
plan_3d |
string |
— | plan_3d |
Plan 3D |
plan_annexe |
string |
— | plan_annexe |
Plan d'annexe |
diagnostics |
string |
— | diagnostics |
Diagnostics |
reserve_professionnels |
string |
— | reserve_professionnels |
Réservé aux professionnels |
autre |
string |
— | autre |
Autre |
ImageTypeCode
Exemple : exterieur
| Valeur | Type | Format | Exemple | Libellé |
|---|---|---|---|---|
exterieur |
string |
— | exterieur |
Extérieur |
interieur |
string |
— | interieur |
Intérieur |