Onboarding
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
1
Owners
This is your landlord, leaseholder, and supplier data.
2
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.
3
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. |
You can add multiple owners to a unit if the property is owned by multiple people. For each owner increment the index of the
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.collection_method | The collection method for the subscription. charge_automatically requires the customer to provide a payment method; charges are made automatically each billing cycle. send_invoice sends an invoice to the customer each billing cycle, including a link to pay manually. |
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. |
You can add multiple applicants to a tenancy if there are multiple people sharing the rent. For each applicant increment the index of the
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.
Invoices
The invoice record is used to bill customers.Formatted fields
The following fields need to be formatted to ensure that the data is imported correctly.| Field | Description |
|---|---|
customer | Must be the ID of the customer record you created in the customers import. |
currency | This should be a three letter currency code. For example, “gbp” for British Pound. |
collection_method | The collection method for the subscription. charge_automatically requires the customer to provide a payment method; charges are made automatically each billing cycle. send_invoice sends an invoice to the customer each billing cycle, including a link to pay manually. |
unit | This should be the ID of the unit record you created in the units import. |
period_start | This should be a date in the format YYYY-MM-DD. |
period_end | This should be a date in the format YYYY-MM-DD. |
line_item[0].amount | This should be a the amount to charge. |
line_item[0].description | This should be a description of the line item. |
line_item[0].tax_percentage | This should be the tax percentage for the line item. Should be a number between 0 and 100. |
line_item[0].type | This should be the type of the line item. Can be rent, charge, or product. |
You can add multiple line items to an invoice. For each line item, increment the index of the
line_item array. For example, the first line item is line_item[0], the second line item is line_item[1], and so on.Invoices import
Download the invoices import template.
Subscriptions
The subscription record is used to bill customers recurringly.Formatted fields
The following fields need to be formatted to ensure that the data is imported correctly.| Field | Description |
|---|---|
customer | Must be the ID of the customer record you created in the customers import. |
currency | This should be a three letter currency code. For example, “gbp” for British Pound. |
collection_method | The collection method for the subscription. charge_automatically requires the customer to provide a payment method; charges are made automatically each billing cycle. send_invoice sends an invoice to the customer each billing cycle, including a link to pay manually. |
start | This should be the next payment date. This should be a date in the format YYYY-MM-DD. |
end | This should be a date in the format YYYY-MM-DD. If the subscription is rolling, you can leave this blank. |
interval | This should be a string of the interval. Can be month or week. |
interval_count | The interval count of the subscription. For example, if the interval is month and the interval_count is 1, the subscription will be billed every month. If the interval is week and the interval_count is 2, the subscription will be billed every 2 weeks. |
items[0].amount | This should be a the amount to charge. |
items[0].description | This should be a description of the line item. |
items[0].tax_percentage | This should be the tax percentage for the line item. Should be a number between 0 and 100. |
items[0].type | This should be the type of the line item. Can be rent, charge, or product. |
You can add multiple line items to a subscription. For each line item, increment the index of the
items array. For example, the first line item is items[0], the second line item is items[1], and so on.Subscriptions import
Download the subscriptions import template.