# Yorlet Documentation

## Docs

- [Introduction](https://docs.yorlet.com/introduction.md): Welcome to the Yorlet docs. Explore guides and tutorials to get started with Yorlet.
- [Customers](https://docs.yorlet.com/customers.md): Learn how to create and use customers in Yorlet.
- [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.
- [Branding](https://docs.yorlet.com/account/branding.md): Learn how to customise your Yorlet account with your brand.
- [Importing data](https://docs.yorlet.com/onboarding/importing-data.md): Learn how to import data into Yorlet during onboarding.
- [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 configurations](https://docs.yorlet.com/leasing/applications/application-configurations.md): Build reusable, step-by-step onboarding flows for your applications.
- [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.
- [Application Portal](https://docs.yorlet.com/leasing/applications/application-portal.md): Discover how your customers progress through the application journey.
- [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.
- [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.
- [Registering a deposit](https://docs.yorlet.com/leasing/deposits/register-a-deposit.md): Learn how to register UK-based deposits.
- [Adding charges to a deposit](https://docs.yorlet.com/leasing/deposits/deposit-charges.md): Learn how to add charges to a deposit.
- [Return a deposit](https://docs.yorlet.com/leasing/deposits/return-a-deposit.md): Learn how to return 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.
- [Guarantors](https://docs.yorlet.com/leasing/guarantors.md): Create and manage guarantors to secure a tenancy.
- [Create a guarantor](https://docs.yorlet.com/leasing/guarantors/create-a-guarantor.md): Learn how to add a guarantor to an application.
- [Manage a guarantor](https://docs.yorlet.com/leasing/guarantors/manage-a-guarantor.md): Learn how to accept, contract, and remove a guarantor.
- [Tenancies](https://docs.yorlet.com/leasing/tenancies.md): Manage move-ins, move-outs, and make changes to ongoing tenancies with ease.
- [Tenancy reviews](https://docs.yorlet.com/leasing/tenancies/tenancy-reviews.md): Schedule reminders to review a tenancy and stay ahead of key dates.
- [Compliance documents](https://docs.yorlet.com/leasing/tenancies/compliance-documents.md): Email a tenancy's customers the compliance certificates on file for their unit.
- [Lease changes](https://docs.yorlet.com/leasing/tenancies/lease-changes.md): Learn how to make changes to ongoing tenancies.
- [Renewals](https://docs.yorlet.com/leasing/renewals.md): Ensure high occupancy by tracking and automating the renewal process.
- [Rent reviews](https://docs.yorlet.com/leasing/renewals/rent-reviews.md): Propose, serve, and apply rent increases with a compliant Section 13 workflow.
- [Yorlet Billing](https://docs.yorlet.com/billing.md): The smartest way to collect rent, manage arrears recovery, and charge for additional services.
- [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.
- [Update a subscription](https://docs.yorlet.com/billing/subscriptions/update-a-subscription.md): Learn how to update 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.
- [Invoices](https://docs.yorlet.com/billing/invoices.md): Learn how to manage invoices on Yorlet.
- [Create an invoice](https://docs.yorlet.com/billing/invoices/create-an-invoice.md): Learn how to create an invoice on Yorlet.
- [Edit invoices](https://docs.yorlet.com/billing/invoices/edit-invoices.md): Learn how to edit invoices after finalisation.
- [Payment methods for invoices](https://docs.yorlet.com/billing/invoices/payment-methods.md): Learn how to manage payment methods for 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.
- [Credit notes](https://docs.yorlet.com/billing/invoices/credit-notes.md): Learn how to manage credit notes on Yorlet.
- [Part payments](https://docs.yorlet.com/billing/invoices/part-payments.md): Learn how to collect a partial payment against an invoice in Yorlet.
- [Hosted Invoices](https://docs.yorlet.com/billing/invoices/hosted-invoices.md): Use Hosted Invoices to securely collect payment from your customers.
- [Credit grants](https://docs.yorlet.com/billing/credit-grants.md): Give a customer credit that is automatically applied to their invoices.
- [Products and prices](https://docs.yorlet.com/billing/products.md): Build a catalogue of products and prices to reuse across invoices and subscriptions.
- [Tax rates](https://docs.yorlet.com/billing/tax-rates.md): Create reusable tax rates to apply to invoices, subscriptions and prices.
- [Coupons](https://docs.yorlet.com/billing/coupons.md): Create coupons to apply discounts to your customers' subscriptions.
- [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.
- [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.
- [Payment Sessions](https://docs.yorlet.com/payments/payment-sessions.md): Learn how collect payments from customers with shareable links.
- [Payment methods](https://docs.yorlet.com/payments/payment-methods.md): Learn about the different supported payment methods.
- [Cards](https://docs.yorlet.com/payments/payment-methods/cards.md): Learn about Debit and Credit cards.
- [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.
- [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.
- [Fraud prevention](https://docs.yorlet.com/payments/fraud-prevention.md): Learn how to prevent payment fraud using Yorlet.
- [Refund a payment](https://docs.yorlet.com/payments/refunds.md): Learn how to refund payments.
- [Payouts](https://docs.yorlet.com/payments/payouts.md): Set up your bank accounts to recieve payouts.
- [Yorlet Balance](https://docs.yorlet.com/balance.md): Hold client funds, move money, and pay owners automatically from your balance.
- [Financial accounts](https://docs.yorlet.com/balance/financial-accounts.md): Open financial accounts to hold client funds and move money on Yorlet.
- [Activity](https://docs.yorlet.com/balance/transactions.md): Review recent activity across your payments balance and financial accounts.
- [Payouts](https://docs.yorlet.com/balance/payouts.md): Pay out your available payments balance to your own bank account.
- [Automatic owner payouts](https://docs.yorlet.com/balance/automatic-owner-payouts.md): Pay owners automatically using the funds held in your balance.
- [Yorlet Owners](https://docs.yorlet.com/owners.md): Learn how to route payments between multiple parties.
- [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.
- [Platform owner accounts](https://docs.yorlet.com/owners/platform-accounts.md): Learn about the owner account for your platform.
- [Onboard accounts](https://docs.yorlet.com/owners/account-onboarding.md): Let Yorlet collect identity verification information for your owner accounts.
- [Updating accounts](https://docs.yorlet.com/owners/updating-accounts.md): Learn how to update the details of your owner accounts.
- [Unit ownership](https://docs.yorlet.com/owners/unit-ownership.md): Learn how to attach owner accounts to units to structure their ownership.
- [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.
- [Understanding owner account balances](https://docs.yorlet.com/owners/account-balances.md): Learn how owner account balances work.
- [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.
- [Tax reporting](https://docs.yorlet.com/owners/tax-reporting.md): Collect and report tax on rental income for landlords who live abroad.
- [Product updates](https://docs.yorlet.com/changelog/overview.md): Keep track of the changes to Yorlet
- [Yorlet Reporting](https://docs.yorlet.com/reporting/introduction.md): Learn how to use Yorlet’s reporting tools to get insights into your business.
- [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.
- [Metadata](https://docs.yorlet.com/reporting/metadata.md): Learn how to add metadata to your Yorlet data.
- [Client Accounting](https://docs.yorlet.com/business-automation/client-accounting/overview.md): Learn how to manage client accounting with 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.
- [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.
- [Maintenance](https://docs.yorlet.com/maintenance.md): Track, prioritise, and resolve maintenance issues across your properties.
- [Manage issues](https://docs.yorlet.com/maintenance/manage-issues.md): Create, prioritise, and resolve maintenance issues from the Dashboard.
- [Tenant requests](https://docs.yorlet.com/maintenance/tenant-requests.md): Let tenants report maintenance issues from their portal and set your team's availability.
- [Developer tools](https://docs.yorlet.com/development/overview.md): Learn how to use developer tools to integrate Yorlet with your applications.
- [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.
- [API versioning](https://docs.yorlet.com/development/versioning.md): Learn how Yorlet versions its API and how to upgrade safely.
- [API changelog](https://docs.yorlet.com/development/api-changelog.md): A list of the changes introduced in each Yorlet API version.
- [Yorlet.js SDK](https://docs.yorlet.com/development/libraries/yorletjs.md): Set up the Yorlet.js client-side SDK in your web application.
- [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.
- [Metadata](https://docs.yorlet.com/development/essentials/metadata.md): Learn how to work with metadata in Yorlet.
- [Dates](https://docs.yorlet.com/development/essentials/dates.md): Learn how to work with dates in Yorlet.
- [CSV imports](https://docs.yorlet.com/development/imports.md): Bulk-create Yorlet records by uploading CSV files in the Dashboard.
- [Integrations overview](https://docs.yorlet.com/development/integrations/overview.md): Learn how to integrate Yorlet with your application.
- [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.
- [Update a subscription](https://docs.yorlet.com/development/integrations/billing/update-a-subscription.md): Learn how to update an existing subscription.
- [Payment Sessions](https://docs.yorlet.com/development/integrations/payments/payment-sessions.md): Learn how to create and manage Payment Sessions to accept a payment.
- [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.
- [Yorlet for Platforms](https://docs.yorlet.com/development/platforms/introduction.md): Learn how to embed Yorlet's functionality to your software platform.
- [Introduction](https://docs.yorlet.com/api/introduction.md)
- [Environments](https://docs.yorlet.com/api/environments.md)
- [Authentication](https://docs.yorlet.com/api/authentication.md)
- [Errors](https://docs.yorlet.com/api/errors.md)
- [Expanding objects](https://docs.yorlet.com/api/expanding.md)
- [Idempotency](https://docs.yorlet.com/api/idempotency.md)
- [Types of events](https://docs.yorlet.com/api/events.md): A complete list of the event types Yorlet sends to your webhook endpoints.
- [The coupon object](https://docs.yorlet.com/api/billing/coupons/object.md)
- [Create a coupon](https://docs.yorlet.com/api/billing/coupons/create.md): Create a coupon
- [Retrieve a coupon](https://docs.yorlet.com/api/billing/coupons/retrieve.md): Retrieve a coupon
- [Update a coupon](https://docs.yorlet.com/api/billing/coupons/update.md): Update a coupon
- [List all coupons](https://docs.yorlet.com/api/billing/coupons/list.md): List all coupons
- [Delete a coupon](https://docs.yorlet.com/api/billing/coupons/delete.md): Delete a coupon
- [The credit grant object](https://docs.yorlet.com/api/billing/credit-grants/object.md)
- [Create a credit grant](https://docs.yorlet.com/api/billing/credit-grants/create.md): Create a credit grant
- [Retrieve a credit grant](https://docs.yorlet.com/api/billing/credit-grants/retrieve.md): Retrieve a credit grant
- [Update a credit grant](https://docs.yorlet.com/api/billing/credit-grants/update.md): Update a credit grant
- [List all credit grants](https://docs.yorlet.com/api/billing/credit-grants/list.md): List all credit grants
- [Void a credit grant](https://docs.yorlet.com/api/billing/credit-grants/void.md): Void a credit grant
- [The credit note object](https://docs.yorlet.com/api/billing/credit-notes/object.md)
- [Create a credit note](https://docs.yorlet.com/api/billing/credit-notes/create.md)
- [Retrieve a credit note](https://docs.yorlet.com/api/billing/credit-notes/retrieve.md)
- [Update a credit note](https://docs.yorlet.com/api/billing/credit-notes/update.md)
- [List all credit notes](https://docs.yorlet.com/api/billing/credit-notes/list.md)
- [Retrieve a credit note's line items](https://docs.yorlet.com/api/billing/credit-notes/lines.md)
- [Preview a credit note](https://docs.yorlet.com/api/billing/credit-notes/preview.md)
- [Void a credit note](https://docs.yorlet.com/api/billing/credit-notes/void.md)
- [Create a customer balance transaction](https://docs.yorlet.com/api/billing/customer-balance-transactions/create.md): Create a customer balance transaction
- [Update a customer balance transaction](https://docs.yorlet.com/api/billing/customer-balance-transactions/update.md): Re-scope a customer balance transaction to an application, or remove the scope.
- [List all customer balance transactions](https://docs.yorlet.com/api/billing/customer-balance-transactions/list.md): List all customer balance transactions
- [The invoice item object](https://docs.yorlet.com/api/billing/invoice-items/object.md)
- [Create a invoice item](https://docs.yorlet.com/api/billing/invoice-items/create.md): Create a invoice item
- [Retrieve a invoice item](https://docs.yorlet.com/api/billing/invoice-items/retrieve.md): Retrieve a invoice item
- [Update a invoice item](https://docs.yorlet.com/api/billing/invoice-items/update.md): Update a invoice item
- [List all invoice items](https://docs.yorlet.com/api/billing/invoice-items/list.md): List all invoice items
- [Delete a invoice item](https://docs.yorlet.com/api/billing/invoice-items/delete.md): Delete a invoice item
- [The invoice object](https://docs.yorlet.com/api/billing/invoices/object.md)
- [Create an invoice](https://docs.yorlet.com/api/billing/invoices/create.md): Create an invoice
- [Retrieve an invoice](https://docs.yorlet.com/api/billing/invoices/retrieve.md): Retrieve an invoice
- [Update an invoice](https://docs.yorlet.com/api/billing/invoices/update.md): Update an invoice
- [List invoices](https://docs.yorlet.com/api/billing/invoices/list.md): List invoices
- [Delete an invoice](https://docs.yorlet.com/api/billing/invoices/delete.md): Delete an invoice
- [Attach a payment to an invoice](https://docs.yorlet.com/api/billing/invoices/attach-payment.md): Attach a payment to an invoice
- [Finalize an invoice](https://docs.yorlet.com/api/billing/invoices/finalize.md): Finalize an invoice
- [Mark an invoice as paid](https://docs.yorlet.com/api/billing/invoices/mark-paid.md): Mark an invoice as paid
- [Mark an invoice as uncollectible](https://docs.yorlet.com/api/billing/invoices/mark-uncollectible.md): Mark an invoice as uncollectible
- [Void an invoice](https://docs.yorlet.com/api/billing/invoices/mark-void.md): Void an invoice
- [Retrieve an upcoming invoice](https://docs.yorlet.com/api/billing/invoices/retrieve-upcoming.md): Retrieve an upcoming invoice
- [Retry failed invoice transfers](https://docs.yorlet.com/api/billing/invoices/retry-transfers.md): Retry failed or stuck (processing) owner transfers for a paid invoice. Successfully completed slices are left untouched.
- [Send an invoice](https://docs.yorlet.com/api/billing/invoices/send.md): Send an invoice
- [The price object](https://docs.yorlet.com/api/billing/prices/object.md)
- [Create a price](https://docs.yorlet.com/api/billing/prices/create.md): Create a price
- [Retrieve a price](https://docs.yorlet.com/api/billing/prices/retrieve.md): Retrieve a price
- [Update a price](https://docs.yorlet.com/api/billing/prices/update.md): Update a price
- [List all prices](https://docs.yorlet.com/api/billing/prices/list.md): List all prices
- [The product object](https://docs.yorlet.com/api/billing/products/object.md)
- [Create a product](https://docs.yorlet.com/api/billing/products/create.md): Create a product
- [Retrieve a product](https://docs.yorlet.com/api/billing/products/retrieve.md): Retrieve a product
- [Update a product](https://docs.yorlet.com/api/billing/products/update.md): Update a product
- [List all products](https://docs.yorlet.com/api/billing/products/list.md): List all products
- [The subscription item object](https://docs.yorlet.com/api/billing/subscription-items/object.md)
- [Create a subscription item](https://docs.yorlet.com/api/billing/subscription-items/create.md): Create a subscription item
- [Retrieve a subscription item](https://docs.yorlet.com/api/billing/subscription-items/retrieve.md): Retrieve a subscription item
- [Update a subscription item](https://docs.yorlet.com/api/billing/subscription-items/update.md): Update a subscription item
- [List all subscription items](https://docs.yorlet.com/api/billing/subscription-items/list.md): List all subscription items
- [Delete a subscription item](https://docs.yorlet.com/api/billing/subscription-items/delete.md): Delete a subscription item
- [The subscription object](https://docs.yorlet.com/api/billing/subscriptions/object.md)
- [Create a subscription](https://docs.yorlet.com/api/billing/subscriptions/create.md): Create a subscription
- [Retrieve a subscription](https://docs.yorlet.com/api/billing/subscriptions/retrieve.md): Retrieve a subscription
- [Update a subscription](https://docs.yorlet.com/api/billing/subscriptions/update.md): Update a subscription
- [List all subscriptions](https://docs.yorlet.com/api/billing/subscriptions/list.md): A list object with a data property that contains an array of subscriptions.
- [Cancel a subscription](https://docs.yorlet.com/api/billing/subscriptions/cancel.md): Cancel a subscription
- [Progress a subscription](https://docs.yorlet.com/api/billing/subscriptions/progress.md): Progress a subscription
- [The tax rate object](https://docs.yorlet.com/api/billing/tax-rates/object.md)
- [Create a tax rate](https://docs.yorlet.com/api/billing/tax-rates/create.md): Create a tax rate
- [Retrieve a tax rate](https://docs.yorlet.com/api/billing/tax-rates/retrieve.md): Retrieve a tax rate
- [Update a tax rate](https://docs.yorlet.com/api/billing/tax-rates/update.md): Update a tax rate
- [List all tax rates](https://docs.yorlet.com/api/billing/tax-rates/list.md): List all tax rates
- [The checkout session object](https://docs.yorlet.com/api/checkout/checkout-sessions/object.md)
- [Create a checkout session](https://docs.yorlet.com/api/checkout/checkout-sessions/create.md): Creates a new checkout session.
- [Retrieve a checkout session](https://docs.yorlet.com/api/checkout/checkout-sessions/retrieve.md): Retrieves the checkout session with the given ID.
- [Update a checkout session](https://docs.yorlet.com/api/checkout/checkout-sessions/update.md): Updates a checkout session.
- [List all checkout sessions](https://docs.yorlet.com/api/checkout/checkout-sessions/list.md): Returns a list of checkout sessions. The checkout sessions are returned sorted by creation date, with the most recent checkout sessions appearing first.
- [Cancel a checkout session](https://docs.yorlet.com/api/checkout/checkout-sessions/cancel.md): Cancels a checkout session.
- [The building object](https://docs.yorlet.com/api/core/buildings/object.md)
- [Create a building](https://docs.yorlet.com/api/core/buildings/create.md)
- [Retrieve a building](https://docs.yorlet.com/api/core/buildings/retrieve.md)
- [Update a building](https://docs.yorlet.com/api/core/buildings/update.md)
- [List all buildings](https://docs.yorlet.com/api/core/buildings/list.md)
- [Delete a building](https://docs.yorlet.com/api/core/buildings/delete.md)
- [The customer object](https://docs.yorlet.com/api/core/customers/object.md)
- [Create a customer](https://docs.yorlet.com/api/core/customers/create.md)
- [Retrieve a customer](https://docs.yorlet.com/api/core/customers/retrieve.md)
- [Update a customer](https://docs.yorlet.com/api/core/customers/update.md)
- [List all customers](https://docs.yorlet.com/api/core/customers/list.md)
- [Delete a customer](https://docs.yorlet.com/api/core/customers/delete.md)
- [The document object](https://docs.yorlet.com/api/core/documents/object.md)
- [Create a document](https://docs.yorlet.com/api/core/documents/create.md)
- [Retrieve a document](https://docs.yorlet.com/api/core/documents/retrieve.md)
- [Update a document](https://docs.yorlet.com/api/core/documents/update.md)
- [List all documents](https://docs.yorlet.com/api/core/documents/list.md)
- [Delete a document](https://docs.yorlet.com/api/core/documents/delete.md)
- [The task object](https://docs.yorlet.com/api/core/tasks/object.md)
- [Create a task](https://docs.yorlet.com/api/core/tasks/create.md)
- [Retrieve a task](https://docs.yorlet.com/api/core/tasks/retrieve.md)
- [Update a task](https://docs.yorlet.com/api/core/tasks/update.md)
- [List all tasks](https://docs.yorlet.com/api/core/tasks/list.md)
- [Delete a task](https://docs.yorlet.com/api/core/tasks/delete.md)
- [The unit group object](https://docs.yorlet.com/api/core/unit-groups/object.md)
- [Create a unit group](https://docs.yorlet.com/api/core/unit-groups/create.md)
- [Retrieve a unit group](https://docs.yorlet.com/api/core/unit-groups/retrieve.md)
- [Update a unit group](https://docs.yorlet.com/api/core/unit-groups/update.md)
- [List all unit groups](https://docs.yorlet.com/api/core/unit-groups/list.md)
- [Delete a unit group](https://docs.yorlet.com/api/core/unit-groups/delete.md)
- [Update a unit owner](https://docs.yorlet.com/api/core/unit-owners/update.md)
- [List all unit owners](https://docs.yorlet.com/api/core/unit-owners/list.md)
- [The unit object](https://docs.yorlet.com/api/core/units/object.md)
- [Create a unit](https://docs.yorlet.com/api/core/units/create.md): Creates a unit.
- [Retrieve a unit](https://docs.yorlet.com/api/core/units/retrieve.md): Retrieves the unit with the given ID.
- [Update a unit](https://docs.yorlet.com/api/core/units/update.md): Updates the specified unit by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
- [List all units](https://docs.yorlet.com/api/core/units/list.md): Returns a list of units. The units are returned sorted by creation date, with the most recent units appearing first.
- [Delete a unit](https://docs.yorlet.com/api/core/units/delete.md): Permanently deletes a unit. This cannot be undone.
- [The webhook endpoint object](https://docs.yorlet.com/api/core/webhook-endpoints/object.md)
- [Create a webhook endpoint](https://docs.yorlet.com/api/core/webhook-endpoints/create.md): Creates a webhook endpoint.
- [Retrieve a webhook endpoint](https://docs.yorlet.com/api/core/webhook-endpoints/retrieve.md): Retrieves the webhook endpoint with the given ID.
- [Update a webhook endpoint](https://docs.yorlet.com/api/core/webhook-endpoints/update.md): Updates the specified webhook endpoint by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
- [List all webhook endpoints](https://docs.yorlet.com/api/core/webhook-endpoints/list.md): Returns a list of webhook endpoints. The webhook endpoints are returned sorted by creation date, with the most recent webhook endpoints appearing first.
- [Delete a webhook endpoint](https://docs.yorlet.com/api/core/webhook-endpoints/delete.md): Permanently deletes a webhook endpoint. This cannot be undone.
- [Roll a webhook endpoint signing secret](https://docs.yorlet.com/api/core/webhook-endpoints/roll-secret.md): Generates a new signing secret for the webhook endpoint, invalidating the previous one. Use this if the existing secret has been compromised.
- [The verification session object](https://docs.yorlet.com/api/guardrails/verification-sessions/object.md)
- [Create a verification session](https://docs.yorlet.com/api/guardrails/verification-sessions/create.md)
- [Retrieve a verification session](https://docs.yorlet.com/api/guardrails/verification-sessions/retrieve.md)
- [List all verification sessions](https://docs.yorlet.com/api/guardrails/verification-sessions/list.md)
- [The leads.enquiry object](https://docs.yorlet.com/api/leads/leads-enquiries/object.md)
- [Create an enquiry](https://docs.yorlet.com/api/leads/leads-enquiries/create.md): Create a new enquiry. Can be created independently or via a qualification form.
- [Retrieve an enquiry](https://docs.yorlet.com/api/leads/leads-enquiries/retrieve.md): Retrieves the details of an existing enquiry.
- [Update an enquiry](https://docs.yorlet.com/api/leads/leads-enquiries/update.md): Updates the specified enquiry. Can be used to apply a qualification configuration and add answers.
- [List all enquiries](https://docs.yorlet.com/api/leads/leads-enquiries/list.md): Returns a list of enquiries. The enquiries are returned sorted by creation date.
- [Attach a qualification configuration to an enquiry](https://docs.yorlet.com/api/leads/leads-enquiries/attach.md): Attach a qualification configuration to a leads enquiry.
- [Create a viewing booking link for an enquiry](https://docs.yorlet.com/api/leads/leads-enquiries/booking-link.md): Returns the self-serve viewing booking link for the enquiry, creating it if one does not exist yet. Optionally emails the link to the lead.
- [Transition an enquiry status](https://docs.yorlet.com/api/leads/leads-enquiries/status.md): Moves an enquiry through the lead pipeline. Records review metadata for qualified/disqualified.
- [The leads.qualification configuration object](https://docs.yorlet.com/api/leads/leads-qualification-configurations/object.md)
- [Create a leads qualification configuration](https://docs.yorlet.com/api/leads/leads-qualification-configurations/create.md)
- [Retrieve a leads qualification configuration](https://docs.yorlet.com/api/leads/leads-qualification-configurations/retrieve.md)
- [Update a leads qualification configuration](https://docs.yorlet.com/api/leads/leads-qualification-configurations/update.md)
- [List all leads qualification configurations](https://docs.yorlet.com/api/leads/leads-qualification-configurations/list.md)
- [The leads.viewing object](https://docs.yorlet.com/api/leads/leads-viewings/object.md)
- [Book a viewing](https://docs.yorlet.com/api/leads/leads-viewings/create.md): Books a viewing against an enquiry. Bookings made with a viewing booking link must fall on an available slot.
- [Retrieve a viewing](https://docs.yorlet.com/api/leads/leads-viewings/retrieve.md): Retrieves the details of an existing viewing.
- [Update a viewing](https://docs.yorlet.com/api/leads/leads-viewings/update.md): Updates the specified viewing. Used to reschedule, reassign or annotate a viewing.
- [List all viewings](https://docs.yorlet.com/api/leads/leads-viewings/list.md): Returns a list of viewings. The viewings are returned sorted by start time.
- [List bookable viewing slots](https://docs.yorlet.com/api/leads/leads-viewings/slots.md): Returns the slots a lead can book, derived from the account's weekly viewing availability minus anything already booked.
- [Transition a viewing status](https://docs.yorlet.com/api/leads/leads-viewings/status.md): Records the outcome of a viewing. A viewing booking link may only be used to cancel the viewing it belongs to.
- [The application object](https://docs.yorlet.com/api/leasing/applications/object.md)
- [Create an application](https://docs.yorlet.com/api/leasing/applications/create.md)
- [Retrieve an application](https://docs.yorlet.com/api/leasing/applications/retrieve.md)
- [Update an application](https://docs.yorlet.com/api/leasing/applications/update.md)
- [List all applications](https://docs.yorlet.com/api/leasing/applications/list.md)
- [Accept an application](https://docs.yorlet.com/api/leasing/applications/accept.md)
- [Cancel an application](https://docs.yorlet.com/api/leasing/applications/cancel.md)
- [Complete an application](https://docs.yorlet.com/api/leasing/applications/complete.md)
- [List all applicants for an application](https://docs.yorlet.com/api/leasing/applications/list-applicants.md)
- [Mark an applicant as paid](https://docs.yorlet.com/api/leasing/applications/mark-applicant-paid.md)
- [Progress an application](https://docs.yorlet.com/api/leasing/applications/progress.md): Advance the application to the next step. Used to progress past waitpoints in configuration mode.
- [Retrieve an applicant](https://docs.yorlet.com/api/leasing/applications/retrieve-applicant.md)
- [Revert a step](https://docs.yorlet.com/api/leasing/applications/revert-step.md): Roll back a skipped step, or a complete money step whose requirements are no longer met, so the application re-enters it. Configuration mode only.
- [Update an applicant](https://docs.yorlet.com/api/leasing/applications/update-applicant.md)
- [The application configuration object](https://docs.yorlet.com/api/leasing/application-configurations/object.md)
- [Create an application configuration](https://docs.yorlet.com/api/leasing/application-configurations/create.md): Create an application configuration
- [Retrieve an application configuration](https://docs.yorlet.com/api/leasing/application-configurations/retrieve.md): Retrieve an application configuration
- [Update an application configuration](https://docs.yorlet.com/api/leasing/application-configurations/update.md): Update an application configuration
- [List all application configurations](https://docs.yorlet.com/api/leasing/application-configurations/list.md): List all application configurations
- [Create an application session](https://docs.yorlet.com/api/leasing/application-sessions/create.md): Creates a new application session for the specified application.
- [Create an application event](https://docs.yorlet.com/api/leasing/applications-events/create.md)
- [List all application events](https://docs.yorlet.com/api/leasing/applications-events/list.md)
- [The deposit charge object](https://docs.yorlet.com/api/leasing/deposits-charges/object.md)
- [Create a deposit charge](https://docs.yorlet.com/api/leasing/deposits-charges/create.md): Creates a new deposit charge.
- [Retrieve a deposit charge](https://docs.yorlet.com/api/leasing/deposits-charges/retrieve.md): Retrieves the deposit charge with the given ID.
- [Update a deposit charge](https://docs.yorlet.com/api/leasing/deposits-charges/update.md): Updates the deposit charge with the given ID.
- [List all deposit charges](https://docs.yorlet.com/api/leasing/deposits-charges/list.md): A list of deposit charges. The deposit charges are returned sorted by creation date, with the most recent deposit charges appearing first.
- [Delete a deposit charge](https://docs.yorlet.com/api/leasing/deposits-charges/delete.md): Deletes the deposit charge with the given ID.
- [Accept a deposit charge](https://docs.yorlet.com/api/leasing/deposits-charges/accept.md): Accept the deposit charge with the given ID.
- [Cancel a deposit charge](https://docs.yorlet.com/api/leasing/deposits-charges/cancel.md): Cancel the deposit charge with the given ID.
- [Dispute a deposit charge](https://docs.yorlet.com/api/leasing/deposits-charges/dispute.md): Dispute the deposit charge with the given ID.
- [The deposit object](https://docs.yorlet.com/api/leasing/deposits/object.md)
- [Create a deposit](https://docs.yorlet.com/api/leasing/deposits/create.md): Creates a new deposit.
- [Retrieve a deposit](https://docs.yorlet.com/api/leasing/deposits/retrieve.md): Retrieves the deposit with the given ID.
- [Update a deposit](https://docs.yorlet.com/api/leasing/deposits/update.md): Updates the deposit with the given ID.
- [List all deposits](https://docs.yorlet.com/api/leasing/deposits/list.md): A list of deposits. The deposits are returned sorted by creation date, with the most recent deposits appearing first.
- [Delete a deposit](https://docs.yorlet.com/api/leasing/deposits/delete.md): Deletes the deposit with the given ID.
- [Activate a deposit](https://docs.yorlet.com/api/leasing/deposits/activate.md): Activate a deposit.
- [List TDS branches](https://docs.yorlet.com/api/leasing/deposits/list-tds-branches.md): Lists the branches available for the configured TDS member.
- [Mark a deposit as returned](https://docs.yorlet.com/api/leasing/deposits/mark-returned.md): Marking a deposit as returned is the final step in returning a deposit.
- [Return a deposit](https://docs.yorlet.com/api/leasing/deposits/return.md): Return a deposit.
- [Mark a deposit as transferred](https://docs.yorlet.com/api/leasing/deposits/transfer.md): Marking a deposit as transferred is the final step in activating certain deposits.
- [The guarantor object](https://docs.yorlet.com/api/leasing/guarantors/object.md)
- [Create a guarantor](https://docs.yorlet.com/api/leasing/guarantors/create.md)
- [Retrieve a guarantor](https://docs.yorlet.com/api/leasing/guarantors/retrieve.md)
- [Detach a guarantor](https://docs.yorlet.com/api/leasing/guarantors/detach.md)
- [The reference object](https://docs.yorlet.com/api/leasing/references/object.md)
- [Create a reference](https://docs.yorlet.com/api/leasing/references/create.md)
- [Retrieve a reference](https://docs.yorlet.com/api/leasing/references/retrieve.md)
- [Update a reference](https://docs.yorlet.com/api/leasing/references/update.md)
- [List all references](https://docs.yorlet.com/api/leasing/references/list.md)
- [Cancel a reference](https://docs.yorlet.com/api/leasing/references/cancel.md)
- [The renewal intent object](https://docs.yorlet.com/api/leasing/renewal-intents/object.md)
- [Create a renewal intent](https://docs.yorlet.com/api/leasing/renewal-intents/create.md): Creates a new renewal intent. Pass type "rent_increase" to create a rent review intent. Rent review intents include a due_at date indicating the suggested notice serving date.
- [Retrieve a renewal intent](https://docs.yorlet.com/api/leasing/renewal-intents/retrieve.md): Retrieves the renewal intent with the given ID.
- [Update a renewal intent](https://docs.yorlet.com/api/leasing/renewal-intents/update.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. The notice_served_at date cannot be in the past. By default, notice can only be serv…
- [List all renewal intents](https://docs.yorlet.com/api/leasing/renewal-intents/list.md): Returns a list of renewal intents. Supports filtering by status (single via `status` or multiple via `statuses`), excluding statuses via `exclude_statuses`, type, assignee, unit, and building. Renewal intents are returned sorted by creation date, with the most recent first.
- [Cancel a renewal intent](https://docs.yorlet.com/api/leasing/renewal-intents/cancel.md): Permanently cancel a renewal intent. This cannot be undone.
- [Complete a renewal intent](https://docs.yorlet.com/api/leasing/renewal-intents/complete.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.
- [Reverse an effective rent increase](https://docs.yorlet.com/api/leasing/renewal-intents/reverse.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…
- [Send the rent increase notice email](https://docs.yorlet.com/api/leasing/renewal-intents/send-notice-email.md): Sends (or re-sends) the rent increase notice email with the Form 4 attached to the tenants on the source tenancy. Only valid for rent_increase intents that have already had notice served and have a Form 4 attached.
- [The tenancy object](https://docs.yorlet.com/api/leasing/tenancies/object.md)
- [Retrieve a tenancy](https://docs.yorlet.com/api/leasing/tenancies/retrieve.md): Retrieves the tenancy with the given ID.
- [Update a tenancy](https://docs.yorlet.com/api/leasing/tenancies/update.md): Updates the assignee or review configuration on a tenancy. Most other fields are managed via the lease changes sub-resource or the application that created the tenancy.
- [List all tenancies](https://docs.yorlet.com/api/leasing/tenancies/list.md): Returns a list of tenancies. Supports filtering by status, assignee, building, customer, unit, and date range. Tenancies are returned sorted by creation date, with the most recent first.
- [Cancel a tenancy](https://docs.yorlet.com/api/leasing/tenancies/cancel.md): Cancels a tenancy, optionally scheduling the cancellation for a future date. By default, associated subscriptions are also canceled and a credit note is generated for any prepaid period.
- [Send compliance documents](https://docs.yorlet.com/api/leasing/tenancies/send-compliance.md): Emails the unit's current compliance documents (EPC, electric safety, gas safety) to the tenancy's customers.
- [Stop a scheduled tenancy cancellation](https://docs.yorlet.com/api/leasing/tenancies/stop-cancellation.md): Stops a pending (future-dated) tenancy cancellation, clearing the scheduled cancellation date and reversing the scheduled cancellation of any still-active associated subscriptions.
- [The loyalty.message object](https://docs.yorlet.com/api/loyalty/loyalty-messages/object.md)
- [Create a message](https://docs.yorlet.com/api/loyalty/loyalty-messages/create.md): Create and send a message to a building or a customer with an active tenancy
- [Retrieve a message](https://docs.yorlet.com/api/loyalty/loyalty-messages/retrieve.md): Retrieve a message
- [List all messages](https://docs.yorlet.com/api/loyalty/loyalty-messages/list.md): List all messages
- [Create a loyalty program event adjustment](https://docs.yorlet.com/api/loyalty/loyalty-program-event-adjustments/create.md): Create a loyalty program event adjustment
- [Create a loyalty program event](https://docs.yorlet.com/api/loyalty/loyalty-program-events/create.md): Create a loyalty program event
- [List all loyalty program events](https://docs.yorlet.com/api/loyalty/loyalty-program-events/list.md): List all loyalty program events
- [The loyalty.program object](https://docs.yorlet.com/api/loyalty/loyalty-programs/object.md)
- [Create a loyalty program](https://docs.yorlet.com/api/loyalty/loyalty-programs/create.md): Create a loyalty program
- [Retrieve a loyalty program](https://docs.yorlet.com/api/loyalty/loyalty-programs/retrieve.md): Retrieve a loyalty program
- [Update a loyalty program](https://docs.yorlet.com/api/loyalty/loyalty-programs/update.md): Update a loyalty program
- [List all loyalty programs](https://docs.yorlet.com/api/loyalty/loyalty-programs/list.md): List all loyalty programs
- [The resident object](https://docs.yorlet.com/api/loyalty/loyalty-residents/object.md)
- [Create a resident](https://docs.yorlet.com/api/loyalty/loyalty-residents/create.md): Create a resident
- [Retrieve a resident](https://docs.yorlet.com/api/loyalty/loyalty-residents/retrieve.md): Retrieve a resident
- [Update a resident](https://docs.yorlet.com/api/loyalty/loyalty-residents/update.md): Update a resident
- [List all residents](https://docs.yorlet.com/api/loyalty/loyalty-residents/list.md): List all residents
- [The loyalty.tier object](https://docs.yorlet.com/api/loyalty/loyalty-tiers/object.md)
- [Create a tier](https://docs.yorlet.com/api/loyalty/loyalty-tiers/create.md): Create a tier
- [Retrieve a tier](https://docs.yorlet.com/api/loyalty/loyalty-tiers/retrieve.md): Retrieve a tier
- [Update a tier](https://docs.yorlet.com/api/loyalty/loyalty-tiers/update.md): Update a tier
- [List all tiers](https://docs.yorlet.com/api/loyalty/loyalty-tiers/list.md): List all tiers
- [The maintenance.issue object](https://docs.yorlet.com/api/maintenance/maintenance-issues/object.md)
- [Create a maintenance issue](https://docs.yorlet.com/api/maintenance/maintenance-issues/create.md)
- [Retrieve a maintenance issue](https://docs.yorlet.com/api/maintenance/maintenance-issues/retrieve.md)
- [Update a maintenance issue](https://docs.yorlet.com/api/maintenance/maintenance-issues/update.md)
- [List all maintenance issues](https://docs.yorlet.com/api/maintenance/maintenance-issues/list.md)
- [Delete a maintenance issue](https://docs.yorlet.com/api/maintenance/maintenance-issues/delete.md)
- [The account collection subscription object](https://docs.yorlet.com/api/owners/account-collection-subscriptions/object.md)
- [Create an account collection subscription](https://docs.yorlet.com/api/owners/account-collection-subscriptions/create.md): Creates a new account collection subscription.
- [Retrieve an account collection subscription](https://docs.yorlet.com/api/owners/account-collection-subscriptions/retrieve.md): Retrieves the account collection subscription with the given ID.
- [List all account collection subscriptions](https://docs.yorlet.com/api/owners/account-collection-subscriptions/list.md): Returns a list of account collection subscriptions. The account collection subscriptions are returned sorted by creation date, with the most recent appearing first.
- [Cancel an account collection subscription](https://docs.yorlet.com/api/owners/account-collection-subscriptions/cancel.md): Cancels an account collection subscription.
- [The account collection object](https://docs.yorlet.com/api/owners/account-collections/object.md)
- [Create an account collection](https://docs.yorlet.com/api/owners/account-collections/create.md): Creates a new account collection.
- [Retrieve an account collection](https://docs.yorlet.com/api/owners/account-collections/retrieve.md): Retrieves the account collection with the given ID.
- [List all account collections](https://docs.yorlet.com/api/owners/account-collections/list.md): Returns a list of account collections. The account collections are returned sorted by creation date, with the most recent account collections appearing first.
- [Approve an account collection](https://docs.yorlet.com/api/owners/account-collections/approve.md): Approves a pending account collection.
- [Cancel an account collection](https://docs.yorlet.com/api/owners/account-collections/cancel.md): Cancels a pending account collection.
- [Create an onboarding session](https://docs.yorlet.com/api/owners/owners-onboarding/create.md)
- [The owner balance transaction object](https://docs.yorlet.com/api/owners/owner-balance-transactions/object.md)
- [Create an owner balance transaction](https://docs.yorlet.com/api/owners/owner-balance-transactions/create.md): Creates a new owner balance transaction (adjustment).
- [Retrieve an owner balance transaction](https://docs.yorlet.com/api/owners/owner-balance-transactions/retrieve.md): Retrieves the owner balance transaction with the given ID.
- [Update an owner balance transaction](https://docs.yorlet.com/api/owners/owner-balance-transactions/update.md): Change whether the owner balance transaction can be seen on statements and payout receipts by owners.
- [List all owner balance transactions](https://docs.yorlet.com/api/owners/owner-balance-transactions/list.md): Returns a list of owner balance transactions. They are returned sorted by creation date, with the most recent transactions appearing first.
- [The owner payment object](https://docs.yorlet.com/api/owners/owner-payments/object.md)
- [Retrieve an owner payment](https://docs.yorlet.com/api/owners/owner-payments/retrieve.md): Retrieves the owner payment with the given ID.
- [Update an owner payment](https://docs.yorlet.com/api/owners/owner-payments/update.md): Updates an owner payment.
- [List all owner payments](https://docs.yorlet.com/api/owners/owner-payments/list.md): Returns a list of owner payments. The owner payments are returned sorted by creation date, with the most recent owner payments appearing first.
- [The owner payout object](https://docs.yorlet.com/api/owners/owner-payouts/object.md)
- [Create an owner payout](https://docs.yorlet.com/api/owners/owner-payouts/create.md)
- [Retrieve an owner payout](https://docs.yorlet.com/api/owners/owner-payouts/retrieve.md)
- [List all owner payouts](https://docs.yorlet.com/api/owners/owner-payouts/list.md)
- [Approve an owner payout](https://docs.yorlet.com/api/owners/owner-payouts/approve.md)
- [Cancel an owner payout](https://docs.yorlet.com/api/owners/owner-payouts/cancel.md)
- [Mark an owner payout as failed](https://docs.yorlet.com/api/owners/owner-payouts/mark-failed.md)
- [Mark an owner payout as paid](https://docs.yorlet.com/api/owners/owner-payouts/mark-paid.md)
- [Pay an owner payout](https://docs.yorlet.com/api/owners/owner-payouts/pay.md)
- [Preview an owner payout](https://docs.yorlet.com/api/owners/owner-payouts/preview.md)
- [Preview an owner payout approval](https://docs.yorlet.com/api/owners/owner-payouts/preview-approve.md)
- [Send an owner payout receipt](https://docs.yorlet.com/api/owners/owner-payouts/send-receipt.md)
- [The owner object](https://docs.yorlet.com/api/owners/owners/object.md)
- [Create an owner](https://docs.yorlet.com/api/owners/owners/create.md)
- [Retrieve an owner](https://docs.yorlet.com/api/owners/owners/retrieve.md)
- [Update an owner](https://docs.yorlet.com/api/owners/owners/update.md)
- [List all owners](https://docs.yorlet.com/api/owners/owners/list.md)
- [Delete an owner](https://docs.yorlet.com/api/owners/owners/delete.md)
- [The owner.person object](https://docs.yorlet.com/api/owners/owners-persons/object.md)
- [Create a person](https://docs.yorlet.com/api/owners/owners-persons/create.md)
- [Retrieve a person](https://docs.yorlet.com/api/owners/owners-persons/retrieve.md)
- [Update a person](https://docs.yorlet.com/api/owners/owners-persons/update.md)
- [List all persons](https://docs.yorlet.com/api/owners/owners-persons/list.md)
- [Delete a person](https://docs.yorlet.com/api/owners/owners-persons/delete.md): Deletes an existing person’s relationship to the account’s legal entity.
- [The payment run object](https://docs.yorlet.com/api/owners/payment-runs/object.md)
- [Create a payment run](https://docs.yorlet.com/api/owners/payment-runs/create.md)
- [Retrieve a payment run](https://docs.yorlet.com/api/owners/payment-runs/retrieve.md)
- [List all payment runs](https://docs.yorlet.com/api/owners/payment-runs/list.md)
- [Approve a payment run](https://docs.yorlet.com/api/owners/payment-runs/approve.md)
- [Cancel a payment run](https://docs.yorlet.com/api/owners/payment-runs/cancel.md)
- [The tax filing object](https://docs.yorlet.com/api/owners/tax-filings/object.md)
- [Create a tax filing](https://docs.yorlet.com/api/owners/tax-filings/create.md)
- [Retrieve a tax filing](https://docs.yorlet.com/api/owners/tax-filings/retrieve.md)
- [List all tax filings](https://docs.yorlet.com/api/owners/tax-filings/list.md)
- [The tax form object](https://docs.yorlet.com/api/owners/tax-forms/object.md)
- [Create a tax form](https://docs.yorlet.com/api/owners/tax-forms/create.md)
- [Retrieve a tax form](https://docs.yorlet.com/api/owners/tax-forms/retrieve.md)
- [List all tax forms](https://docs.yorlet.com/api/owners/tax-forms/list.md)
- [Delete a tax form](https://docs.yorlet.com/api/owners/tax-forms/delete.md)
- [The transfer reversal object](https://docs.yorlet.com/api/owners/transfers-reversals/object.md)
- [Create a transfer reversal](https://docs.yorlet.com/api/owners/transfers-reversals/create.md)
- [Retrieve a transfer reversal](https://docs.yorlet.com/api/owners/transfers-reversals/retrieve.md)
- [Update a transfer reversal](https://docs.yorlet.com/api/owners/transfers-reversals/update.md)
- [List all transfer reversals](https://docs.yorlet.com/api/owners/transfers-reversals/list.md)
- [The transfer object](https://docs.yorlet.com/api/owners/transfers/object.md)
- [Create a transfer](https://docs.yorlet.com/api/owners/transfers/create.md)
- [Retrieve a transfer](https://docs.yorlet.com/api/owners/transfers/retrieve.md)
- [Update a transfer](https://docs.yorlet.com/api/owners/transfers/update.md)
- [List all transfers](https://docs.yorlet.com/api/owners/transfers/list.md)
- [The balance object](https://docs.yorlet.com/api/payments/balance/object.md)
- [Retrieve owner balance](https://docs.yorlet.com/api/payments/balance/retrieve.md): Retrieves the current owner balance for an owner on the account.
- [List all balance transactions](https://docs.yorlet.com/api/payments/balance-transactions/list.md): Returns a list of balance transactions. They are returned sorted by creation date, with the most recent transactions appearing first.
- [The dispute object](https://docs.yorlet.com/api/payments/disputes/object.md)
- [Retrieve a dispute](https://docs.yorlet.com/api/payments/disputes/retrieve.md): Retrieve a dispute
- [Update a dispute](https://docs.yorlet.com/api/payments/disputes/update.md): Update a dispute
- [List all disputes](https://docs.yorlet.com/api/payments/disputes/list.md): List all disputes
- [Mark a dispute as resolved](https://docs.yorlet.com/api/payments/disputes/mark-resolved.md): Marks the dispute as resolved.
- [Submit dispute evidence](https://docs.yorlet.com/api/payments/disputes/submit-evidence.md): Uploads the collected evidence and submits it to the bank for review. Set `submit` to `false` to stage evidence without final submission.
- [The external account object](https://docs.yorlet.com/api/payments/external-accounts/object.md)
- [Create an external account](https://docs.yorlet.com/api/payments/external-accounts/create.md): Create a new external account.
- [Retrieve an external account](https://docs.yorlet.com/api/payments/external-accounts/retrieve.md): Retrieve the details about a specific external account.
- [List all external accounts](https://docs.yorlet.com/api/payments/external-accounts/list.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.
- [Delete an external account](https://docs.yorlet.com/api/payments/external-accounts/delete.md): Deletes the external account.
- [Acknowledge the confirmation of payee](https://docs.yorlet.com/api/payments/external-accounts/acknowledge-confirmation-of-payee.md): Acknowledge the confirmation of payee for the external account.
- [The payment initiation object](https://docs.yorlet.com/api/payments/payment-initiations/object.md)
- [Create a payment initiation](https://docs.yorlet.com/api/payments/payment-initiations/create.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…
- [Retrieves a payment initiation](https://docs.yorlet.com/api/payments/payment-initiations/retrieve.md): Retrieves a Payment Initiation.
- [List all payment initiations](https://docs.yorlet.com/api/payments/payment-initiations/list.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.
- [Create a payment initiation token](https://docs.yorlet.com/api/payments/payment-initiations/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.
- [The payment method session object](https://docs.yorlet.com/api/payments/payment-method-sessions/object.md)
- [Create a payment method session](https://docs.yorlet.com/api/payments/payment-method-sessions/create.md): Create a new payment method session.
- [Retrieve a payment method session](https://docs.yorlet.com/api/payments/payment-method-sessions/retrieve.md): Retrieve the details about a specific payment method session.
- [The payment method object](https://docs.yorlet.com/api/payments/payment-methods/object.md)
- [Create a payment method](https://docs.yorlet.com/api/payments/payment-methods/create.md): Creates a new payment method.
- [Retrieve a payment method](https://docs.yorlet.com/api/payments/payment-methods/retrieve.md): Retrieves a payment method with the given ID.
- [List all payment methods](https://docs.yorlet.com/api/payments/payment-methods/list.md): Returns a list of payment methods.
- [Simulate a bank transfer](https://docs.yorlet.com/api/payments/payment-methods/fund-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.
- [Set up a payment method](https://docs.yorlet.com/api/payments/payment-methods/setup.md): Creates a setup intent for collecting payment method details.
- [The payment session object](https://docs.yorlet.com/api/payments/payment-sessions/object.md)
- [Create a payment session](https://docs.yorlet.com/api/payments/payment-sessions/create.md): Creates a new payment session.
- [Retrieve a payment session](https://docs.yorlet.com/api/payments/payment-sessions/retrieve.md): Retrieves the payment session with the given ID.
- [List all payment sessions](https://docs.yorlet.com/api/payments/payment-sessions/list.md): Returns a list of payment sessions. The payment sessions are returned sorted by creation date, with the most recent payment sessions appearing first.
- [Cancel a payment session](https://docs.yorlet.com/api/payments/payment-sessions/cancel.md): Cancels the payment session with the given ID.
- [The refund object](https://docs.yorlet.com/api/payments/refunds/object.md)
- [Create a refund](https://docs.yorlet.com/api/payments/refunds/create.md): Create a refund for a transaction.
- [Retrieve a refund](https://docs.yorlet.com/api/payments/refunds/retrieve.md): Retrieve a refund by ID.
- [List all refunds](https://docs.yorlet.com/api/payments/refunds/list.md): List all refunds.
- [The transaction object](https://docs.yorlet.com/api/payments/transactions/object.md)
- [Create a transaction](https://docs.yorlet.com/api/payments/transactions/create.md): Create a transaction
- [Retrieve a transaction](https://docs.yorlet.com/api/payments/transactions/retrieve.md): Retrieve a transaction
- [Update a transaction](https://docs.yorlet.com/api/payments/transactions/update.md): Update a transaction
- [List all transactions](https://docs.yorlet.com/api/payments/transactions/list.md): List all transactions
- [Cancel a transaction](https://docs.yorlet.com/api/payments/transactions/cancel.md): Cancels the transaction.
- [Confirm a transaction](https://docs.yorlet.com/api/payments/transactions/confirm.md): Confirms the transaction.
- [Resend a receipt for a transaction](https://docs.yorlet.com/api/payments/transactions/resend-receipt.md): Resend a receipt for a transaction
- [Terminal handoff for a transaction](https://docs.yorlet.com/api/payments/transactions/terminal-handoff.md): Terminal handoff for a transaction
- [The terminal.location object](https://docs.yorlet.com/api/terminal/terminal-locations/object.md)
- [Create a terminal location](https://docs.yorlet.com/api/terminal/terminal-locations/create.md): Create a terminal location.
- [Retrieve a terminal location](https://docs.yorlet.com/api/terminal/terminal-locations/retrieve.md): Retrieve a terminal location.
- [Update a terminal location](https://docs.yorlet.com/api/terminal/terminal-locations/update.md): Update a terminal location.
- [List all terminal locations](https://docs.yorlet.com/api/terminal/terminal-locations/list.md): List all terminal locations.
- [The terminal.offer object](https://docs.yorlet.com/api/terminal/terminal-offers/object.md)
- [Create a terminal offer](https://docs.yorlet.com/api/terminal/terminal-offers/create.md): Create a terminal offer.
- [Retrieve a terminal offer](https://docs.yorlet.com/api/terminal/terminal-offers/retrieve.md): Retrieve a terminal offer.
- [List all terminal offers](https://docs.yorlet.com/api/terminal/terminal-offers/list.md): List all terminal offers.
- [Create a terminal reader](https://docs.yorlet.com/api/terminal/terminal-readers/create.md): Create a terminal reader.
- [List all terminal readers](https://docs.yorlet.com/api/terminal/terminal-readers/list.md): List all terminal readers.
- [Cancel the action of a terminal reader](https://docs.yorlet.com/api/terminal/terminal-readers/cancel-action.md): Cancel the action of a terminal reader.
- [Simulate the outcome of a reference](https://docs.yorlet.com/api/test-helpers/test-helpers/reference-simulate-outcome.md)
- [Simulate the progression of a subscription](https://docs.yorlet.com/api/test-helpers/test-helpers/subscription-simulate-progress.md): Advances a subscription to its next billing period, even if the due date is in the future. Only available in sandbox.

## OpenAPI Specs

- [openapi-loyalty](https://docs.yorlet.com/openapi-loyalty.json)
- [openapi-test_helpers](https://docs.yorlet.com/openapi-test_helpers.json)
- [openapi-terminal](https://docs.yorlet.com/openapi-terminal.json)
- [openapi-payments](https://docs.yorlet.com/openapi-payments.json)
- [openapi-owners](https://docs.yorlet.com/openapi-owners.json)
- [openapi-maintenance](https://docs.yorlet.com/openapi-maintenance.json)
- [openapi-leasing](https://docs.yorlet.com/openapi-leasing.json)
- [openapi-leads](https://docs.yorlet.com/openapi-leads.json)
- [openapi-guardrails](https://docs.yorlet.com/openapi-guardrails.json)
- [openapi-core](https://docs.yorlet.com/openapi-core.json)
- [openapi-checkout](https://docs.yorlet.com/openapi-checkout.json)
- [openapi-billing](https://docs.yorlet.com/openapi-billing.json)
- [openapi-balance](https://docs.yorlet.com/openapi-balance.json)
- [openapi-automation](https://docs.yorlet.com/openapi-automation.json)
- [openapi](https://docs.yorlet.com/api-reference/openapi.json)