Ideal CSV Structure

This page help you understand how your csv should be structured and helpers guidelines that helps you started

This section contains detailed specifications for preparing CSV files for import. We explain the required file structure for five modules: Owner (owners.csv), Property (objects.csv), Unit (units.csv), Tenant (tenants.csv), and Bank Account (bank_accounts.csv). Each module corresponds to a different type of data that can be imported into the EverReal system.

Each module has its own CSV file with a specific set of columns and values that must be followed for a successful import. If all guidelines are correctly followed, mappers are not required.

Important: All core modules (owner, property, unit, tenant) must be included in every import. Missing any of these files will result in import failure. The bank_accounts.csv file is optional. For formatting guidelines, please see our helper section

If you would like to use a CSV template, there is one attached at the end of the page. For the most up-to-date version, please contact our support team at [email protected]

Recommended Owner File Structure

The owner module contains information about the owners of the properties and following are the field requirements.

owner_id must be unique and serves as the external identifier.

Everreal Field	CSV Field	Data Type	Required	Default	Description
ownerId	owner_id	String	Yes	-	external owner_id reference
firstName	first_name	String	Yes	-	owner's first name
lastName	last_name	String	Yes	-	owner's last name
email	email	Email	No	-	owner's email
companyName	company_name	String	No	-	owner's company name
street	street	String	No	-	owner's street name
streetNumber	street_number	String	No	-	owner's street number
zipCode	zip_code	String	No	-	owner's zipcode
city	city	String	No	-	owner's city
country	country	String	No	-	owner's country

Recommended Property File Structure

The property module contains information about the properties themselves, such as the address and type. The following are the field requirements.

property_id must be unique and serves as the external identifier.

Everreal Field	CSV Field	Data Type	Required	Default	Description
propertyId	property_id	String	Yes	-	external property_id reference
ownerId	owner_id	String	No	-	external owner_id reference
name	property_name	String	Yes		property name
type	property_type	String	Yes	BUILDING	property type
category	property_category	String	Yes	RESIDENTIAL_AND_COMMERCIAL	property category
street	street	String	Yes		property street name
streetNumber	street_number	String	Yes		property street number
zipCode	zip_code	String	Yes		property zipcode
city	city	String	Yes		property city
country	country	String	Yes		property country
noOfFloors	number_of_floors	Decimal	No	0	number of floors for the property
yearBuilt	year_built	Number	No		year of build for the property
ownershipType	ownership_type	String	Yes	INDIVIDUAL	propery ownership type

Recommended Unit File Structure

The unit module contains information about the individual units within a property, such as number, size and rent. Following are the field requirements.

unit_id must be unique and serves as the external identifier.

Everreal Field	CSV Field	Data Type	Required	Default Value	Description
unitId	unit_id	String	Yes	-	external unit_id reference
propertyId	property_id	String	Yes	-	external property_id reference
ownerId	owner_id	String	Yes	-	external owner_id reference
name	unit_name	String	Yes		unit name
category	category	String	Yes	RESIDENTIAL	unit category
type	type	String	Yes	APARTMENT	unit type
subType	sub_type	String	Yes	NO_INFORMATION	unit subtype
surfaceCommercial	surface_commercial	Decimal	No	0	surface if unit type is commercial
livingSurfaceResidential	living_surface_residential	Decimal	No	0	surface if unit type is residential
rooms	rooms	Decimal	Yes	0	no of rooms
bathrooms	bathrooms	Number	Yes	0	no of bathrooms
bedrooms	bedrooms	Decimal	Yes	0	no of bedrooms
hasMainStorage	has_main_storage	Boolean	Yes	FALSE	does it has main storage
floorNo	floor_number	Decimal	Yes	0	floor number of unit
currentRent	current_rent	Decimal	No		current rent of unit
hasParking	has_parking	Boolean	Yes	FALSE	parking available for this unit
energyEfficiencyClass	energy_efficiency_class	String	No		energy efficiency class on energy certificate(Possible values can be found under enum mapping for ENERGY_EFFICIENCY_CLASS)
buildingEnergyRatingType	building_energy_rating_type	String	No		building energy rating type on energy certificate(Possible values can be found under enum mapping for BUILDING_ENERGY_RATING_TYPE)
energyCertificateCreationDate	energy_certificate_creation_date	String	No		energy certificate creation date(Possible values can be found under enum mapping for ENERGY_CERTIFICATE_CREATION_DATE)
energyPerformanceCertificateAvailability	energy_performance_certificate_availability	String	No		is energy performance certificate available(Possible values can be found under enum mapping for ENERGY_SOURCE_TYPE)
mainEnergySource	main_energy_source	String	No		main energy source according to energy certificate(possible values can be found in unit mutation under ENERGY_SOURCE_TYPE)
heatingType	heating_type	String	No		heating type according to energy certificate(possible values can be found in unit mutation under HEATING_TYPE)
condition	condition	String	No		condition of unit(possible values can be found in enum mapping under AMENITIES_CONDITION)
qualityOfAmenities	quality_of_amenities	String	No		quality of amenities in unit(possible values can be found in unit mutation under QUALITY_OF_AMENITIES)
amenitiesIncluded	amenities_included	String	No		amenities included in unit (comma separated and possible values can be found in unit mutation under AMENITIES_INCLUDED)

Recommended Tenant File Structure

The tenants module contains information about the tenants who occupy the units, such as name, lease term. Following are the field requirements.

tenant_id must be unique and serves as the external identifier.

Everreal Field	CSV Field	Data Type	Required	Default	Description
tenantId	tenant_id	String	Yes	-	external tenant_id reference
unitId	unit_id	String	Yes	-	external unit_id reference
firstName	first_name	String	Yes	-	tenant's first name
lastName	last_name	String	Yes	-	tenant's last name
email	email	Email	No	-	tenant's email
basicRent	basic_rent	Decimal	No	-	contract's basic rent
utilityCosts	utility_costs	Decimal	No	-	contract's utility costs
heatingCosts	heating_costs	Decimal	No	-	contract's heating cost
totalRent	total_rent	Decimal	Yes	-	contract's total rent
deposit	deposit	Decimal	Yes	-	contract's deposit
contractStartDate	contract_start_date	String	Yes	-	contract start date
contractEndDate	contract_end_date	String	No	-	contract end date

Recommended Bank Account File Structure

The bank accounts module contains information about the bank accounts associated with owners, properties, or units. This file is optional and only required if you want to import bank account details into EverReal.

Each bank account must be linked to at least one of the following IDs: owner_id, property_id, or unit_id. You can provide multiple IDs to associate an account with more than one entity.

EverReal Field	CSV Field	Data Type	Required	Default	Descriptions
accountId	account_id	String	Yes		Unique identifier for the bank account
accountName	account_name	String	No		Name of the account
accountIban	account_iban	String	Yes		IBAN number of the account
accountBic	account_bic	String	Yes		BIC code of the account
accountBankName	account_bank_name	String	No		Name of the bank
accountType	account_type	String	No
accountHolder	account_holder	String	No		Name of the account holder
accountReferenceNumber	account_reference_number	String	No		Reference number associated with the account
ownerId	owner_id	String	No*		External owner_id reference
propertyId	property_id	String	No*		External property_id reference
unitId	unit_id	String	No*		External unit_id reference

* At least one of owner_id, property_id, or unit_id must be provided per row to establish a valid link.

Sample Dataset for imports

This section contains sample files that can be used as a reference or can be used to import data to EverReal. The sample files are in a zip file that contains four CSV files:

• owners.csv (Owner data)

• objects.csv (Property data)

• units.csv (Unit data)

• tenants.csv (Tenant data)

• bank_accounts.csv (Bank Account data, optional)

Each CSV file has a header row that specifies the column names. The data in each file is related to the data in the other files by using unique identifiers. For example, the tenants.csv has a column called unit_id that is used to link the tenants to the unit.

Please ensure that file names and CSV headers remain unchanged when modifying the data. Otherwise, the import will fail. You can use these sample files as a template to create your own data and import it to EverReal.

Note: All CSV files must be saved in UTF-8 encoding.

6KB

ImportSample.zip

archive