Importing data
Learn how to import data into Yorlet during onboarding.
We’ll walk you through the process of importing data into Yorlet during onboarding. It follows a step-by-step approach to ensure that you can import your data correctly.
Import steps
Owners
This is your landlord, leaseholder, and supplier data.
Buildings and units
This is your building and unit data. You can use the owner data imported in step one to attach the units to their owners.
Active tenancies
These are your active tenancies. You can use the unit data imported in step two to attach the tenancies to their units.
Owners
The owner record is used to store the details of the people or businesses that own the properties.
Formatted fields
The following fields need to be formatted to ensure that the data is imported correctly.
| Field | Description |
|---|---|
business_type | Can be one of individual or company. |
type | Can be one of landlord, leaseholder, or supplier. |
address.country | This should be a two letter country code. For example, “GB” for United Kingdom. |
tax_residency | This should be a two letter country code. For example, “GB” for United Kingdom. |
Owners import
Download the owners import template.
Buildings and units
Yorlet supports two different structures for your properties: single property and multi-unit.
Use the single property type when you’re adding a property you wish to lease as one. For example, a property with three residents all each paying rent.
We are going to create a building record at the same time as a unit record. Single property buildings can only have one unit.
Formatted fields
The following fields need to be formatted to ensure that the data is imported correctly.
| Field | Description |
|---|---|
currency | This should be a three letter currency code. For example, “gbp” for British Pound. |
reference | If you have a unique reference for the unit either from your own system or a previous system, you can add it here. |
building_data.address.country | This should be a two letter country code. For example, “GB” for United Kingdom. |
furnished | This should be either true or false. |
fees.management_fee | This should be an integer. For example, 10% should be 10. |
fees.tax | This should be an integer. For example, 20% VAT should be 20. |
owners[0].owner | This should be the ID of the owner record you created in the owners import that you want to attach to this unit. This can also be the email address of the owner if you have not yet imported the owner data. |
owners[0].percent_ownership | This should be an integer. For example, 100% ownership should be 100. |
owners array. For example, the first owner is owners[0], the second owner is owners[1], and so on. The sum of all the owners[].percent_ownership fields should be 100.Units import (single property)
Download the unit import (single property) template.
Active tenancies
The active tenancy record is used to store the details of the tenancies that are currently active including current tenants and rent details.
Formatted fields
The following fields need to be formatted to ensure that the data is imported correctly.
| Field | Description |
|---|---|
type | Must be active_tenancy. |
currency | This should be a three letter currency code. For example, “gbp” for British Pound. |
unit | This should be the ID of the unit record you created in the units import. |
start_date | This should be a date in the format YYYY-MM-DD. |
end_date | This should be a date in the format YYYY-MM-DD. If the tenancy is rolling, you can leave this blank. |
subscription_data.start_date | This should be the next rent payment date. This should be a date in the format YYYY-MM-DD. |
subscription_data.interval | This should be the interval of the rent payment. This should be one of month or week. |
subscription_data.interval_count | This should be the number of intervals between rent payments. For example, if the rent is paid monthly, this should be 1. If the rent is paid every 3 months, this should be 3. |
subscription_data.amount | This should be the amount of the rent in the unit’s currency. |
subscription_data.description | This should be a description of the rent. This is visible to the tenant on their invoice. |
applicants[0].share_of_rent | This should be an integer. For example, 100% share of rent should be 100. |
applicants array. For example, the first applicant is applicants[0], the second applicant is applicants[1], and so on. The sum of all the applicants[].share_of_rent fields should be 100.Active tenancies import
Download the active tenancies import template.