# Yorlet Documentation

## Docs

- [Branding](https://docs.yorlet.com/account/branding.md): Learn how to customise your Yorlet account with your brand.
- [Create an application configuration](https://docs.yorlet.com/api/application-configurations/create-an-application-configuration.md): Create an application configuration
- [List all application configurations](https://docs.yorlet.com/api/application-configurations/list-all-application-configurations.md): List all application configurations
- [Retrieve an application configuration](https://docs.yorlet.com/api/application-configurations/retrieve-an-application-configuration.md): Retrieve an application configuration
- [Update an application configuration](https://docs.yorlet.com/api/application-configurations/update-an-application-configuration.md): Update an application configuration
- [Create an application session](https://docs.yorlet.com/api/application-sessions/create-an-application-session.md): Creates a new application session for the specified application.
- [Accept an application](https://docs.yorlet.com/api/applications/accept-an-application.md)
- [Cancel an application](https://docs.yorlet.com/api/applications/cancel-an-application.md)
- [Complete an application](https://docs.yorlet.com/api/applications/complete-an-application.md)
- [Create an application](https://docs.yorlet.com/api/applications/create-an-application.md)
- [List all applicants for an application](https://docs.yorlet.com/api/applications/list-all-applicants-for-an-application.md)
- [List all applications](https://docs.yorlet.com/api/applications/list-all-applications.md)
- [Mark an applicant as paid](https://docs.yorlet.com/api/applications/mark-an-applicant-as-paid.md)
- [Progress an application](https://docs.yorlet.com/api/applications/progress-an-application.md): Advance the application to the next step. Used to progress past waitpoints in configuration mode.
- [Retrieve an applicant](https://docs.yorlet.com/api/applications/retrieve-an-applicant.md)
- [Retrieve an application](https://docs.yorlet.com/api/applications/retrieve-an-application.md)
- [Update an applicant](https://docs.yorlet.com/api/applications/update-an-applicant.md)
- [Update an application](https://docs.yorlet.com/api/applications/update-an-application.md)
- [Authentication](https://docs.yorlet.com/api/authentication.md)
- [Create a building](https://docs.yorlet.com/api/buildings/create-a-building.md)
- [Delete a building](https://docs.yorlet.com/api/buildings/delete-a-building.md)
- [List all buildings](https://docs.yorlet.com/api/buildings/list-all-buildings.md)
- [Retrieve a building](https://docs.yorlet.com/api/buildings/retrieve-a-building.md)
- [Update a building](https://docs.yorlet.com/api/buildings/update-a-building.md)
- [Create a coupon](https://docs.yorlet.com/api/coupons/create-a-coupon.md): Create a coupon
- [Delete a coupon](https://docs.yorlet.com/api/coupons/delete-a-coupon.md): Delete a coupon
- [List all coupons](https://docs.yorlet.com/api/coupons/list-all-coupons.md): List all coupons
- [Retrieve a coupon](https://docs.yorlet.com/api/coupons/retrieve-a-coupon.md): Retrieve a coupon
- [Update a coupon](https://docs.yorlet.com/api/coupons/update-a-coupon.md): Update a coupon
- [Create a credit grant](https://docs.yorlet.com/api/credit-grants/create-a-credit-grant.md): Create a credit grant
- [List all credit grants](https://docs.yorlet.com/api/credit-grants/list-all-credit-grants.md): List all credit grants
- [Retrieve a credit grant](https://docs.yorlet.com/api/credit-grants/retrieve-a-credit-grant.md): Retrieve a credit grant
- [Void a credit grant](https://docs.yorlet.com/api/credit-grants/void-a-credit-grant.md): Void a credit grant
- [Create a customer balance transaction](https://docs.yorlet.com/api/customer-balance-transactions/create-a-customer-balance-transaction.md): Create a customer balance transaction
- [List all customer balance transactions](https://docs.yorlet.com/api/customer-balance-transactions/list-all-customer-balance-transactions.md): List all customer balance transactions
- [Create a customer](https://docs.yorlet.com/api/customers/create-a-customer.md)
- [Delete a customer](https://docs.yorlet.com/api/customers/delete-a-customer.md)
- [List all customers](https://docs.yorlet.com/api/customers/list-all-customers.md)
- [Retrieve a customer](https://docs.yorlet.com/api/customers/retrieve-a-customer.md)
- [Update a customer](https://docs.yorlet.com/api/customers/update-a-customer.md)
- [List all disputes](https://docs.yorlet.com/api/disputes/list-all-disputes.md): List all disputes
- [Mark a dispute as resolved](https://docs.yorlet.com/api/disputes/mark-a-dispute-as-resolved.md): Marks the dispute as resolved.
- [Retrieve a dispute](https://docs.yorlet.com/api/disputes/retrieve-a-dispute.md): Retrieve a dispute
- [Update a dispute](https://docs.yorlet.com/api/disputes/update-a-dispute.md): Update a dispute
- [Environments](https://docs.yorlet.com/api/environments.md)
- [Errors](https://docs.yorlet.com/api/errors.md)
- [Expanding objects](https://docs.yorlet.com/api/expanding.md)
- [Acknowledge the confirmation of payee](https://docs.yorlet.com/api/external-accounts/acknowledge-the-confirmation-of-payee.md): Acknowledge the confirmation of payee for the external account.
- [Create an external account](https://docs.yorlet.com/api/external-accounts/create-an-external-account.md): Create a new external account.
- [Delete an external account](https://docs.yorlet.com/api/external-accounts/delete-an-external-account.md): Deletes the external account.
- [List all external accounts](https://docs.yorlet.com/api/external-accounts/list-all-external-accounts.md): Returns a list of external accounts. The external accounts are returned sorted by creation date, with the most recently created external accounts appearing first.
- [Retrieve an external account](https://docs.yorlet.com/api/external-accounts/retrieve-an-external-account.md): Retrieve the details about a specific external account.
- [Idempotency](https://docs.yorlet.com/api/idempotency.md)
- [Introduction](https://docs.yorlet.com/api/introduction.md)
- [Create a invoice item](https://docs.yorlet.com/api/invoice-items/create-a-invoice-item.md): Create a invoice item
- [Delete a invoice item](https://docs.yorlet.com/api/invoice-items/delete-a-invoice-item.md): Delete a invoice item
- [List all invoice items](https://docs.yorlet.com/api/invoice-items/list-all-invoice-items.md): List all invoice items
- [Retrieve a invoice item](https://docs.yorlet.com/api/invoice-items/retrieve-a-invoice-item.md): Retrieve a invoice item
- [Update a invoice item](https://docs.yorlet.com/api/invoice-items/update-a-invoice-item.md): Update a invoice item
- [Attach a payment to an invoice](https://docs.yorlet.com/api/invoices/attach-a-payment-to-an-invoice.md): Attach a payment to an invoice
- [Create an invoice](https://docs.yorlet.com/api/invoices/create-an-invoice.md): Create an invoice
- [Delete an invoice](https://docs.yorlet.com/api/invoices/delete-an-invoice.md): Delete an invoice
- [Finalize an invoice](https://docs.yorlet.com/api/invoices/finalize-an-invoice.md): Finalize an invoice
- [List invoices](https://docs.yorlet.com/api/invoices/list-invoices.md): List invoices
- [Mark an invoice as paid](https://docs.yorlet.com/api/invoices/mark-an-invoice-as-paid.md): Mark an invoice as paid
- [Mark an invoice as uncollectible](https://docs.yorlet.com/api/invoices/mark-an-invoice-as-uncollectible.md): Mark an invoice as uncollectible
- [Retrieve an invoice](https://docs.yorlet.com/api/invoices/retrieve-an-invoice.md): Retrieve an invoice
- [Retrieve an upcoming invoice](https://docs.yorlet.com/api/invoices/retrieve-an-upcoming-invoice.md): Retrieve an upcoming invoice
- [Send an invoice](https://docs.yorlet.com/api/invoices/send-an-invoice.md): Send an invoice
- [Update an invoice](https://docs.yorlet.com/api/invoices/update-an-invoice.md): Update an invoice
- [Void an invoice](https://docs.yorlet.com/api/invoices/void-an-invoice.md): Void an invoice
- [Create a loyalty program event adjustment](https://docs.yorlet.com/api/loyalty-program-event-adjustments/create-a-loyalty-program-event-adjustment.md): Create a loyalty program event adjustment
- [Create a loyalty program event](https://docs.yorlet.com/api/loyalty-program-events/create-a-loyalty-program-event.md): Create a loyalty program event
- [List all loyalty program events](https://docs.yorlet.com/api/loyalty-program-events/list-all-loyalty-program-events.md): List all loyalty program events
- [Create a loyalty program](https://docs.yorlet.com/api/loyalty-programs/create-a-loyalty-program.md): Create a loyalty program
- [List all loyalty programs](https://docs.yorlet.com/api/loyalty-programs/list-all-loyalty-programs.md): List all loyalty programs
- [Retrieve a loyalty program](https://docs.yorlet.com/api/loyalty-programs/retrieve-a-loyalty-program.md): Retrieve a loyalty program
- [Update a loyalty program](https://docs.yorlet.com/api/loyalty-programs/update-a-loyalty-program.md): Update a loyalty program
- [Approve an owner payout](https://docs.yorlet.com/api/owner-payouts/approve-an-owner-payout.md)
- [Cancel an owner payout](https://docs.yorlet.com/api/owner-payouts/cancel-an-owner-payout.md)
- [Create an owner payout](https://docs.yorlet.com/api/owner-payouts/create-an-owner-payout.md)
- [List all owner payouts](https://docs.yorlet.com/api/owner-payouts/list-all-owner-payouts.md)
- [Mark an owner payout as failed](https://docs.yorlet.com/api/owner-payouts/mark-an-owner-payout-as-failed.md)
- [Mark an owner payout as paid](https://docs.yorlet.com/api/owner-payouts/mark-an-owner-payout-as-paid.md)
- [Pay an owner payout](https://docs.yorlet.com/api/owner-payouts/pay-an-owner-payout.md)
- [Preview an owner payout](https://docs.yorlet.com/api/owner-payouts/preview-an-owner-payout.md)
- [Preview an owner payout approval](https://docs.yorlet.com/api/owner-payouts/preview-an-owner-payout-approval.md)
- [Retrieve an owner payout](https://docs.yorlet.com/api/owner-payouts/retrieve-an-owner-payout.md)
- [Send an owner payout receipt](https://docs.yorlet.com/api/owner-payouts/send-an-owner-payout-receipt.md)
- [Create a payment initiation](https://docs.yorlet.com/api/payment-initiations/create-a-payment-initiation.md): Create a payment initiation request. Yorlet supports two types of payment initiation: <code>type=inbound_payment</code> initiates a payment from an external bank account to a bank account in Yorlet, and <code>type=outbound_payment</code> initiates a payment from your bank account to an external bank…
- [Create a payment initiation token](https://docs.yorlet.com/api/payment-initiations/create-a-payment-initiation-token.md): Creates a single-use token that can be used to initiate a payment. Yorlet supports Payment Initiation using [Plaid](https://plaid.com/docs/payment-initiation/), you will need to launch the Payment Initiation flow in Plaid Link with the token returned by this endpoint.
- [List all payment initiations](https://docs.yorlet.com/api/payment-initiations/list-all-payment-initiations.md): Returns a list of your payment initiations. The payment initiations are returned sorted by creation date, with the most recently created payment initiations appearing first.
- [Retrieves a payment initiation](https://docs.yorlet.com/api/payment-initiations/retrieves-a-payment-initiation.md): Retrieves a Payment Initiation.
- [Create a payment method session](https://docs.yorlet.com/api/payment-method-sessions/create-a-payment-method-session.md): Create a new payment method session.
- [Retrieve a payment method session](https://docs.yorlet.com/api/payment-method-sessions/retrieve-a-payment-method-session.md): Retrieve the details about a specific payment method session.
- [Create a payment method](https://docs.yorlet.com/api/payment-methods/create-a-payment-method.md): Creates a new payment method.
- [List all payment methods](https://docs.yorlet.com/api/payment-methods/list-all-payment-methods.md): Returns a list of payment methods.
- [Retrieve a payment method](https://docs.yorlet.com/api/payment-methods/retrieve-a-payment-method.md): Retrieves a payment method with the given ID.
- [Set up a payment method](https://docs.yorlet.com/api/payment-methods/set-up-a-payment-method.md): Creates a setup intent for collecting payment method details.
- [Simulate a bank transfer](https://docs.yorlet.com/api/payment-methods/simulate-a-bank-transfer.md): Simulates an external bank transfer and adds funds to the payment method's balance. This method can only be called in test mode.
- [Approve a payment run](https://docs.yorlet.com/api/payment-runs/approve-a-payment-run.md)
- [Cancel a payment run](https://docs.yorlet.com/api/payment-runs/cancel-a-payment-run.md)
- [Create a payment run](https://docs.yorlet.com/api/payment-runs/create-a-payment-run.md)
- [List all payment runs](https://docs.yorlet.com/api/payment-runs/list-all-payment-runs.md)
- [Retrieve a payment run](https://docs.yorlet.com/api/payment-runs/retrieve-a-payment-run.md)
- [Cancel a payment session](https://docs.yorlet.com/api/payment-sessions/cancel-a-payment-session.md): Cancels the payment session with the given ID.
- [Create a payment session](https://docs.yorlet.com/api/payment-sessions/create-a-payment-session.md): Creates a new payment session.
- [List all payment sessions](https://docs.yorlet.com/api/payment-sessions/list-all-payment-sessions.md): Returns a list of payment sessions. The payment sessions are returned sorted by creation date, with the most recent payment sessions appearing first.
- [Retrieve a payment session](https://docs.yorlet.com/api/payment-sessions/retrieve-a-payment-session.md): Retrieves the payment session with the given ID.
- [Create a price](https://docs.yorlet.com/api/prices/create-a-price.md): Create a price
- [List all prices](https://docs.yorlet.com/api/prices/list-all-prices.md): List all prices
- [Retrieve a price](https://docs.yorlet.com/api/prices/retrieve-a-price.md): Retrieve a price
- [Update a price](https://docs.yorlet.com/api/prices/update-a-price.md): Update a price
- [Create a product](https://docs.yorlet.com/api/products/create-a-product.md): Create a product
- [List all products](https://docs.yorlet.com/api/products/list-all-products.md): List all products
- [Retrieve a product](https://docs.yorlet.com/api/products/retrieve-a-product.md): Retrieve a product
- [Update a product](https://docs.yorlet.com/api/products/update-a-product.md): Update a product
- [Cancel a reference](https://docs.yorlet.com/api/references/cancel-a-reference.md)
- [Create a reference](https://docs.yorlet.com/api/references/create-a-reference.md)
- [List all references](https://docs.yorlet.com/api/references/list-all-references.md)
- [Retrieve a reference](https://docs.yorlet.com/api/references/retrieve-a-reference.md)
- [Update a reference](https://docs.yorlet.com/api/references/update-a-reference.md)
- [Create a refund](https://docs.yorlet.com/api/refunds/create-a-refund.md): Create a refund for a transaction.
- [List all refunds](https://docs.yorlet.com/api/refunds/list-all-refunds.md): List all refunds.
- [Retrieve a refund](https://docs.yorlet.com/api/refunds/retrieve-a-refund.md): Retrieve a refund by ID.
- [Cancel a renewal intent](https://docs.yorlet.com/api/renewal-intents/cancel-a-renewal-intent.md): Permanently cancel a renewal intent. This cannot be undone.
- [Complete a renewal intent](https://docs.yorlet.com/api/renewal-intents/complete-a-renewal-intent.md): Completes a renewal intent. For no_renewal type, marks as complete. For rent_increase type, marks as effective (requires status to be accepted or tribunal_decided). This cannot be undone.
- [Create a renewal intent](https://docs.yorlet.com/api/renewal-intents/create-a-renewal-intent.md): Creates a new renewal intent. Pass type "rent_increase" to create a rent review intent. Rent review intents can be created ahead of time and include a due_at date that determines when notice can be served.
- [List all renewal intents](https://docs.yorlet.com/api/renewal-intents/list-all-renewal-intents.md): Returns a list of renewal intents. Supports filtering by status, type, assignee, and unit. Renewal intents are returned sorted by creation date, with the most recent first.
- [Retrieve a renewal intent](https://docs.yorlet.com/api/renewal-intents/retrieve-a-renewal-intent.md): Retrieves the renewal intent with the given ID.
- [Reverse an effective rent increase](https://docs.yorlet.com/api/renewal-intents/reverse-an-effective-rent-increase.md): Reverses a rent increase that has already taken effect. This is intended for cases where a tenant referred the increase to a tribunal before the effective date but did not communicate this in time. The intent status is reverted to challenged, the subscription schedule change is undone, and the inten…
- [Update a renewal intent](https://docs.yorlet.com/api/renewal-intents/update-a-renewal-intent.md): Updates the specified renewal intent. For rent_increase type, you can transition the status through the rent increase flow (pending -> notice_served -> accepted/challenged -> effective) and set rent increase fields. Notice can only be served on or after due_at, and effective_date must be at least 2…
- [Create a resident](https://docs.yorlet.com/api/residents/create-a-resident.md): Create a resident
- [List all residents](https://docs.yorlet.com/api/residents/list-all-residents.md): List all residents
- [Retrieve a resident](https://docs.yorlet.com/api/residents/retrieve-a-resident.md): Retrieve a resident
- [Update a resident](https://docs.yorlet.com/api/residents/update-a-resident.md): Update a resident
- [Create a subscription item](https://docs.yorlet.com/api/subscription-items/create-a-subscription-item.md): Create a subscription item
- [Delete a subscription item](https://docs.yorlet.com/api/subscription-items/delete-a-subscription-item.md): Delete a subscription item
- [List all subscription items](https://docs.yorlet.com/api/subscription-items/list-all-subscription-items.md): List all subscription items
- [Retrieve a subscription item](https://docs.yorlet.com/api/subscription-items/retrieve-a-subscription-item.md): Retrieve a subscription item
- [Update a subscription item](https://docs.yorlet.com/api/subscription-items/update-a-subscription-item.md): Update a subscription item
- [Cancel a subscription](https://docs.yorlet.com/api/subscriptions/cancel-a-subscription.md): Cancel a subscription
- [Create a subscription](https://docs.yorlet.com/api/subscriptions/create-a-subscription.md): Create a subscription
- [List all subscriptions](https://docs.yorlet.com/api/subscriptions/list-all-subscriptions.md): A list object with a data property that contains an array of subscriptions.
- [Progress a subscription](https://docs.yorlet.com/api/subscriptions/progress-a-subscription.md): Progress a subscription
- [Retrieve a subscription](https://docs.yorlet.com/api/subscriptions/retrieve-a-subscription.md): Retrieve a subscription
- [Update a subscription](https://docs.yorlet.com/api/subscriptions/update-a-subscription.md): Update a subscription
- [Create a task](https://docs.yorlet.com/api/tasks/create-a-task.md)
- [Delete a task](https://docs.yorlet.com/api/tasks/delete-a-task.md)
- [List all tasks](https://docs.yorlet.com/api/tasks/list-all-tasks.md)
- [Retrieve a task](https://docs.yorlet.com/api/tasks/retrieve-a-task.md)
- [Update a task](https://docs.yorlet.com/api/tasks/update-a-task.md)
- [Create a tax rate](https://docs.yorlet.com/api/tax-rates/create-a-tax-rate.md): Create a tax rate
- [List all tax rates](https://docs.yorlet.com/api/tax-rates/list-all-tax-rates.md): List all tax rates
- [Retrieve a tax rate](https://docs.yorlet.com/api/tax-rates/retrieve-a-tax-rate.md): Retrieve a tax rate
- [Update a tax rate](https://docs.yorlet.com/api/tax-rates/update-a-tax-rate.md): Update a tax rate
- [Cancel a transaction](https://docs.yorlet.com/api/transactions/cancel-a-transaction.md): Cancels the transaction.
- [Confirm a transaction](https://docs.yorlet.com/api/transactions/confirm-a-transaction.md): Confirms the transaction.
- [Create a transaction](https://docs.yorlet.com/api/transactions/create-a-transaction.md): Create a transaction
- [List all transactions](https://docs.yorlet.com/api/transactions/list-all-transactions.md): List all transactions
- [Resend a receipt for a transaction](https://docs.yorlet.com/api/transactions/resend-a-receipt-for-a-transaction.md): Resend a receipt for a transaction
- [Retrieve a transaction](https://docs.yorlet.com/api/transactions/retrieve-a-transaction.md): Retrieve a transaction
- [Terminal handoff for a transaction](https://docs.yorlet.com/api/transactions/terminal-handoff-for-a-transaction.md): Terminal handoff for a transaction
- [Update a transaction](https://docs.yorlet.com/api/transactions/update-a-transaction.md): Update a transaction
- [Create a transfer reversal](https://docs.yorlet.com/api/transfer-reversals/create-a-transfer-reversal.md)
- [List all transfer reversals](https://docs.yorlet.com/api/transfer-reversals/list-all-transfer-reversals.md)
- [Retrieve a transfer reversal](https://docs.yorlet.com/api/transfer-reversals/retrieve-a-transfer-reversal.md)
- [Update a transfer reversal](https://docs.yorlet.com/api/transfer-reversals/update-a-transfer-reversal.md)
- [Create a transfer](https://docs.yorlet.com/api/transfers/create-a-transfer.md)
- [List all transfers](https://docs.yorlet.com/api/transfers/list-all-transfers.md)
- [Retrieve a transfer](https://docs.yorlet.com/api/transfers/retrieve-a-transfer.md)
- [Update a transfer](https://docs.yorlet.com/api/transfers/update-a-transfer.md)
- [Create a verification session](https://docs.yorlet.com/api/verification-sessions/create-a-verification-session.md)
- [List all verification sessions](https://docs.yorlet.com/api/verification-sessions/list-all-verification-sessions.md)
- [Retrieve a verification session](https://docs.yorlet.com/api/verification-sessions/retrieve-a-verification-session.md)
- [Yorlet Billing](https://docs.yorlet.com/billing.md): The smartest way to collect rent, manage arrears recovery, and charge for additional services.
- [Arrears management](https://docs.yorlet.com/billing/arrears.md): Learn how to manage arrears on Yorlet.
- [Payment plans](https://docs.yorlet.com/billing/arrears/payment-plans.md): Learn how to create and manage payment plans in Yorlet.
- [Invoices](https://docs.yorlet.com/billing/invoices.md): Learn how to manage invoices on Yorlet.
- [Automatic transfer reconciliation](https://docs.yorlet.com/billing/invoices/automatic-reconciliation.md): Allow customers to pay invoices by transferring funds to a bank account.
- [Create an invoice](https://docs.yorlet.com/billing/invoices/create-an-invoice.md): Learn how to create an invoice on Yorlet.
- [Credit notes](https://docs.yorlet.com/billing/invoices/credit-notes.md): Learn how to manage credit notes on Yorlet.
- [Edit invoices](https://docs.yorlet.com/billing/invoices/edit-invoices.md): Learn how to edit invoices after finalisation.
- [Hosted Invoices](https://docs.yorlet.com/billing/invoices/hosted-invoices.md): Use Hosted Invoices to securely collect payment from your customers.
- [Part payments](https://docs.yorlet.com/billing/invoices/part-payments.md): Learn how to create and manage part payments in Yorlet.
- [Payment methods for invoices](https://docs.yorlet.com/billing/invoices/payment-methods.md): Learn how to manage payment methods for invoices on Yorlet.
- [Subscriptions](https://docs.yorlet.com/billing/subscriptions.md): Learn how to manage subscriptions on Yorlet.
- [Create a subscription](https://docs.yorlet.com/billing/subscriptions/create-a-subscription.md): Learn how to create a subscription on Yorlet.
- [Pausing subscriptions](https://docs.yorlet.com/billing/subscriptions/pausing-subscriptions.md): Learn how to pause payment collection on subscriptions.
- [Prorations](https://docs.yorlet.com/billing/subscriptions/prorations.md): Learn about the prorations for subscriptions.
- [Update a subscription](https://docs.yorlet.com/billing/subscriptions/update-a-subscription.md): Learn how to update a subscription on Yorlet.
- [Bank reconciliation](https://docs.yorlet.com/business-automation/client-accounting/bank-reconciliation.md): Learn how to reconcile your Yorlet and owner payouts with cash in your bank.
- [Customer credit balances](https://docs.yorlet.com/business-automation/client-accounting/customer-credit-balances.md): Learn how to view the credit balances of your customers.
- [Deposit balances](https://docs.yorlet.com/business-automation/client-accounting/deposit-balances.md): Learn how to view the deposit balances of your clients.
- [Client Accounting](https://docs.yorlet.com/business-automation/client-accounting/overview.md): Learn how to manage client accounting with Yorlet.
- [Owner cash balances](https://docs.yorlet.com/business-automation/client-accounting/owner-cash-balances.md): Learn how to view the cash balances of your owners.
- [Product updates](https://docs.yorlet.com/changelog/overview.md): Keep track of the changes to Yorlet
- [Customers](https://docs.yorlet.com/customers.md): Learn how to create and use customers in Yorlet.
- [API keys](https://docs.yorlet.com/development/api-keys.md): Learn how to create and manage API keys for your Yorlet account.
- [Yorlet-Context header](https://docs.yorlet.com/development/context.md): Learn how to use the Yorlet-Context header to view organisation-wide data.
- [Dates](https://docs.yorlet.com/development/essentials/dates.md): Learn how to work with dates in Yorlet.
- [Metadata](https://docs.yorlet.com/development/essentials/metadata.md): Learn how to work with metadata in Yorlet.
- [Create an application](https://docs.yorlet.com/development/integrations/applications/create-an-application.md): Learn how to create an application with the Yorlet API.
- [Create a subscription with Checkout Sessions](https://docs.yorlet.com/development/integrations/billing/create-a-subscription.md): Learn how to create a subscription with Checkout Sessions.
- [Integrations overview](https://docs.yorlet.com/development/integrations/overview.md): Learn how to integrate Yorlet with your application.
- [Payment Method Sessions](https://docs.yorlet.com/development/integrations/payments/payment-method-sessions.md): Learn how to create and manage Payment Method Sessions to collect and save a payment method.
- [Payment Sessions](https://docs.yorlet.com/development/integrations/payments/payment-sessions.md): Learn how to create and manage Payment Sessions to accept a payment.
- [Yorlet.js SDK](https://docs.yorlet.com/development/libraries/yorletjs.md): Set up the Yorlet.js client-side SDK in your web application.
- [Developer tools](https://docs.yorlet.com/development/overview.md): Learn how to use developer tools to integrate Yorlet with your applications.
- [Yorlet for Platforms](https://docs.yorlet.com/development/platforms/introduction.md): Learn how to embed Yorlet's functionality to your software platform.
- [Send Yorlet events to your webhook endpoints](https://docs.yorlet.com/development/webhooks.md): Learn how to use webhooks to receive notifications about events in your Yorlet account.
- [Introduction](https://docs.yorlet.com/introduction.md): Welcome to the Yorlet docs. Explore guides and tutorials to get started with Yorlet.
- [Getting started](https://docs.yorlet.com/leasing.md): Learn how to get started with Yorlet Leasing.
- [Get started](https://docs.yorlet.com/leasing/applications.md): Learn how to onboard new tenants.
- [Application Portal](https://docs.yorlet.com/leasing/applications/application-portal.md): Discover how your customers progress through the application journey.
- [Create a new application](https://docs.yorlet.com/leasing/applications/create-an-application.md): Learn how to create a rental application.
- [Manage an application](https://docs.yorlet.com/leasing/applications/manage-an-application.md): Learn how to manage a rental application.
- [Update an application](https://docs.yorlet.com/leasing/applications/updating-applications.md): Make effective changes to your rental applications without compromising progress.
- [Deposits](https://docs.yorlet.com/leasing/deposits.md): Learn how to create, register, and return deposits.
- [Creating a deposit](https://docs.yorlet.com/leasing/deposits/create-a-deposit.md): Learn how to create deposits.
- [Adding charges to a deposit](https://docs.yorlet.com/leasing/deposits/deposit-charges.md): Learn how to add charges to a deposit.
- [Deposit routing](https://docs.yorlet.com/leasing/deposits/deposit-routing.md): Learn how to route deposits collected through Yorlet to the correct schemes for payment.
- [Registering a deposit](https://docs.yorlet.com/leasing/deposits/register-a-deposit.md): Learn how to register UK-based deposits.
- [Return a deposit](https://docs.yorlet.com/leasing/deposits/return-a-deposit.md): Learn how to return a deposit.
- [Referencing](https://docs.yorlet.com/leasing/referencing.md): Learn how to create and track tenant references.
- [Integrated referencing](https://docs.yorlet.com/leasing/referencing/integrated-referencing.md): Learn how to use integrated referencing to automate your references.
- [Renewals](https://docs.yorlet.com/leasing/renewals.md): Ensure high occupancy by tracking and automating the renewal process.
- [Tenancies](https://docs.yorlet.com/leasing/tenancies.md): Manage move-ins, move-outs, and make changes to ongoing tenancies with ease.
- [Lease changes](https://docs.yorlet.com/leasing/tenancies/lease-changes.md): Learn how to make changes to ongoing tenancies.
- [Importing data](https://docs.yorlet.com/onboarding/importing-data.md): Learn how to import data into Yorlet during onboarding.
- [Yorlet Owners](https://docs.yorlet.com/owners.md): Learn how to route payments between multiple parties.
- [Understanding owner account balances](https://docs.yorlet.com/owners/account-balances.md): Learn how owner account balances work.
- [Onboard accounts](https://docs.yorlet.com/owners/account-onboarding.md): Let Yorlet collect identity verification information for your owner accounts.
- [Choose an account type](https://docs.yorlet.com/owners/accounts.md): Learn more about the different types of owner accounts you can use with Yorlet Owners.
- [Understanding fund flows](https://docs.yorlet.com/owners/fund-flows.md): Learn how to split payments between your platform and owner accounts when you collect payments.
- [Charging owners](https://docs.yorlet.com/owners/fund-flows/collections.md): Learn how to charge owner accounts to debit their balances.
- [Owner payouts](https://docs.yorlet.com/owners/owner-payouts.md): Learn how Yorlet manages payouts for your owner accounts.
- [Payment runs](https://docs.yorlet.com/owners/payment-runs.md): Manage payment runs for your owner payouts.
- [Platform owner accounts](https://docs.yorlet.com/owners/platform-accounts.md): Learn about the owner account for your platform.
- [Unit ownership](https://docs.yorlet.com/owners/unit-ownership.md): Learn how to attach owner accounts to units to structure their ownership.
- [Updating accounts](https://docs.yorlet.com/owners/updating-accounts.md): Learn how to update your owner accounts.
- [Getting started](https://docs.yorlet.com/payments.md): Learn how to get started with Yorlet Payments.
- [Accept a payment](https://docs.yorlet.com/payments/accept-a-payment.md): Learn how to create one-off payments.
- [Fraud prevention](https://docs.yorlet.com/payments/fraud-prevention.md): Learn how to prevent payment fraud using Yorlet.
- [Payment methods](https://docs.yorlet.com/payments/payment-methods.md): Learn about the different supported payment methods.
- [Alipay](https://docs.yorlet.com/payments/payment-methods/alipay.md): Learn about Alipay, one of the most popular wallets in China.
- [Autogiro](https://docs.yorlet.com/payments/payment-methods/autogiro.md): Learn about Autogiro, one of the most common bank-to-bank transfers in Sweden.
- [Bacs Direct Debit](https://docs.yorlet.com/payments/payment-methods/bacs-debit.md): Learn about Bacs Direct Debit, one of the most common bank-to-bank transfers in the UK.
- [Bank Transfers](https://docs.yorlet.com/payments/payment-methods/bank-transfers.md): Learn about Bank Transfer payments, a simple way to receive funds directly from your customers' bank accounts.
- [Cards](https://docs.yorlet.com/payments/payment-methods/cards.md): Learn about Debit and Credit cards.
- [Direct transfers](https://docs.yorlet.com/payments/payment-methods/direct-transfers.md): Learn about Direct Transfer payments.
- [Pay by Bank](https://docs.yorlet.com/payments/payment-methods/pay-by-bank.md): Learn about Pay by Bank payments.
- [SEPA Direct Debit](https://docs.yorlet.com/payments/payment-methods/sepa-debit.md): Learn about SEPA Direct Debit payments.
- [WeChat Pay](https://docs.yorlet.com/payments/payment-methods/wechat-pay.md): Learn about WeChat Pay, one of the most popular mobile payment platforms in China.
- [Payment Sessions](https://docs.yorlet.com/payments/payment-sessions.md): Learn how collect payments from customers with shareable links.
- [Payouts](https://docs.yorlet.com/payments/payouts.md): Set up your bank accounts to recieve payouts.
- [Refund a payment](https://docs.yorlet.com/payments/refunds.md): Learn how to refund payments.
- [Overview](https://docs.yorlet.com/real-estate.md): Learn how to get started with buildings and units in Yorlet.
- [Buildings](https://docs.yorlet.com/real-estate/buildings.md): Learn how to create and use buildings in Yorlet.
- [Units](https://docs.yorlet.com/real-estate/units.md): Learn how to create and use units in Yorlet.
- [Basic reporting](https://docs.yorlet.com/reporting/basic-reporting.md): Learn how to access and use basic reporting features in Yorlet.
- [Account reports](https://docs.yorlet.com/reporting/basic-reporting/account-reports.md): Learn how to generate reports for your Yorlet account.
- [Owner reports](https://docs.yorlet.com/reporting/basic-reporting/owner-reports.md): Learn how to generate reports for your Owner accounts.
- [Dashboard reports](https://docs.yorlet.com/reporting/dashboard-reports.md): Learn how to use Dashboard reports.
- [Exporting data](https://docs.yorlet.com/reporting/exporting-data.md): Learn how to export data from Yorlet.
- [Yorlet Reporting](https://docs.yorlet.com/reporting/introduction.md): Learn how to use Yorlet’s reporting tools to get insights into your business.
- [Metadata](https://docs.yorlet.com/reporting/metadata.md): Learn how to add metadata to your Yorlet data.

## OpenAPI Specs

- [openapi](https://docs.yorlet.com/openapi.json)
- [openapi-payments](https://docs.yorlet.com/openapi-payments.json)
- [openapi-leasing](https://docs.yorlet.com/openapi-leasing.json)
- [openapi-guardrails](https://docs.yorlet.com/openapi-guardrails.json)
- [openapi-core](https://docs.yorlet.com/openapi-core.json)
- [openapi-billing](https://docs.yorlet.com/openapi-billing.json)
- [openapi-owners](https://docs.yorlet.com/openapi-owners.json)
- [openapi-loyalty](https://docs.yorlet.com/openapi-loyalty.json)