Yorlet Documentation

Get started

Payments

Business automation

Reporting

Developer tools

Dashboard

Blog

Contact sales

Learn how to embed Yorlet's functionality to your software platform.

Overview

Yorlet for Platforms

Welcome to the Yorlet docs. Explore guides and tutorials to get started with Yorlet.

Introduction

Learn how to create and use customers in Yorlet.

Customers

Learn how to get started with buildings and units in Yorlet.

Learn how to create and use buildings in Yorlet.

Buildings

Learn how to create and use units in Yorlet.

Units

Learn how to customise your Yorlet account with your brand.

Branding

Learn how to get started with Yorlet Leasing.

Getting started

Learn how to create a rental application.

Create an application

Create a new application

Learn how to manage a rental application.

Manage an application

Make effective changes to your rental applications without compromising progress.

Update an application

Discover how your customers progress through the application journey.

Application Portal

Learn how to create and track tenant references.

Referencing

Learn how to use Canopy for tenant references.

Canopy

Canopy referencing

Learn how to create, register, and return deposits.

Deposits

Creating a deposit

Registering a deposit

Deposit charges

Adding charges to a deposit

Return a deposit

Learn how to route deposits collected through Yorlet to the correct schemes for payment.

Deposit routing

Manage move-ins, move-outs, and make changes to ongoing tenancies with ease.

Tenancies

Learn how to make changes to ongoing tenancies.

Lease changes

Ensure high occupancy by tracking and automating the renewal process.

Renewals

The smartest way to collect rent, manage arrears recovery, and charge for additional services.

Yorlet Billing

Learn how to manage subscriptions on Yorlet.

Subscriptions

Learn how to create a subscription on Yorlet.

Create a subscription

Learn how to update a subscription on Yorlet.

Update a subscription

Learn how to pause payment collection on subscriptions.

Pausing subscriptions

Invoices

Learn how to create an invoice on Yorlet.

Create an invoice

Learn how to edit invoices after finalisation.

Edit invoices

Learn how to manage credit notes on Yorlet.

Credit notes

Learn how to create and manage part payments in Yorlet.

Part payments

Use Hosted Invoices to securely collect payment from your customers.

Hosted Invoices

Arrears management

Learn how to create and manage payment plans in Yorlet.

Payment plans

Learn how to route payments between multiple parties.

Yorlet Owners

Learn more about the different types of owner accounts you can use with Yorlet Owners.

Choose an account type

Learn about the owner account for your platform.

Platform owner accounts

Let Yorlet collect identity verification information for your owner accounts.

Onboard accounts

Updating accounts

Learn how to attach owner accounts to units to structure their ownership.

Unit ownership

Learn how to split payments between your platform and owner accounts when you collect payments.

Understanding fund flows

Learn how to charge owner accounts to debit their balances.

Charging owners

Account balances

Understanding owner account balances

Learn how Yorlet manages payouts for your owner accounts.

Owner payouts

Manage payment runs for your owner payouts.

Payment runs

Learn how to get started with Yorlet Payments.

Accept a payment

Learn how collect payments from customers with shareable links.

Payment Sessions

Learn about the different supported payment methods.

Payment methods

Cards

Learn about Alipay, one of the most popular wallets in China.

Alipay

Learn about Autogiro, one of the most common bank-to-bank transfers in Sweden.

Autogiro

Learn about Bacs Direct Debit, one of the most common bank-to-bank transfers in the UK.

Bacs Direct Debit

Bank Transfers

Direct transfers

Pay by Bank

SEPA Direct Debit

Learn how to prevent payment fraud using Yorlet.

Fraud prevention

Refund a payment

Set up your bank accounts to recieve payouts.

Payouts

Learn how to manage client accounting with Yorlet.

Client Accounting

Learn how to reconcile your Yorlet and owner payouts with cash in your bank.

Bank reconciliation

Learn how to view the credit balances of your customers.

Customer credit balances

Learn how to view the deposit balances of your clients.

Deposit balances

Learn how to view the cash balances of your owners.

Owner cash balances

Learn how to use developer tools to integrate Yorlet with your applications.

Learn how to use webhooks to receive notifications about events in your Yorlet account.

Send Yorlet events to your webhook endpoints

Set up the Yorlet.js client-side SDK in your web application.

Yorlet.js SDK

Learn how to create and manage API keys for your Yorlet account.

API keys

API Reference

Learn how to integrate Yorlet with your application.

Integrations overview

Learn how to create and manage Payment Sessions to accept a payment.

Learn how to make requests on behalf of accounts using the Yorlet API.

Making requests on-behalf of accounts

Learn how to use Yorlet’s reporting tools to get insights into your business.

Yorlet Reporting

Learn how to access and use basic reporting features in Yorlet.

Basic reporting

Learn how to generate reports for your Yorlet account.

Account reports

Learn how to generate reports for your Owner accounts.

Owner reports

Dashboard reports

Exporting data

Learn how to add metadata to your Yorlet data.