Ideal CSV Structure

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

This section contains detailed specifications of how a CSV file should be prepared for import. We will explain the file structure of four modules: owner, property, unit and tenants. Each module corresponds to a different type of data that can be imported into the 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 you follow all the guidelines properly then you don't need to use mappers.

Note that for import you should have all 4 modules in CSV and missing of file results in failure of import. For formatting guidelines read our helper section

Recommended Owner File Structure

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

owner_id should be unique and it should be your owner_id 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
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	Yes	-	owner's city
country	country	String	Yes	-	owner's country

Recommended Property File Structure

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

property_id should be unique and it should be your property_id 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	No	BUILDING	property type
category	property_category	String	No	RESIDENTIAL_AND_COMMERCIAL	property category
street	street	String	No		property street name
streetNumber	street_number	String	No		property street number
zipCode	zip_code	String	No		property zipcode
city	city	String	Yes		property city
country	country	String	Yes		property country
noOfFloors	number_of_floors	Decimal	Yes	0	number of floors for the property
yearBuilt	year_built	Number	Yes		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 should be unique and it should be your unit_id 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	No	RESIDENTIAL	unit category
type	type	String	No	APARTMENT	unit type
subType	sub_type	String	No	NO_INFORMATION	unit subtype
surfaceCommercial	surface_commercial	Decimal	Yes	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	No	0	no of bathrooms
bedrooms	bedrooms	Decimal	No	0	no of bedrooms
hasMainStorage	has_main_storage	Boolean	Yes		does it has main storage
floorNo	floor_number	Decimal	Yes	0	floor number of unit

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 should be unique and it should be your tenant_id 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	Yes	-	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	Yes	-	contract end date

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: property.csv, unit.csv, tenant.csv and owner.csv. 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 tenant.csv file has a column called unit_id that is used to link the tenants to the unit.

Please make sure the file names and CSV headers are not changed when mutating the data, in those cases it will not work. You can use these sample files as a template to create your own data and import it to EverReal.

7KB

MasterDataSample.zip

archive