Payment traces are a way to track the status of a payment. This guide will show you how to trace payments in the Dashboard.
Was this page helpful?
{"docsConfig":{"theme":"sequoia","$schema":"https://mintlify.com/docs.json","name":"Yorlet Documentation","colors":{"primary":"#6366f1","light":"#818cf8","dark":"#6366f1"},"logo":{"light":"https://mintcdn.com/yorlet/Lx2oI1SOO-fmkDb9/logo/light.svg?fit=max\u0026auto=format\u0026n=Lx2oI1SOO-fmkDb9\u0026q=85\u0026s=73fa1e512b4726e6880aad5ea8936c51","dark":"https://mintcdn.com/yorlet/Lx2oI1SOO-fmkDb9/logo/dark.svg?fit=max\u0026auto=format\u0026n=Lx2oI1SOO-fmkDb9\u0026q=85\u0026s=5d229ed92853e5305de11997003fc762"},"favicon":"https://mintcdn.com/yorlet/Lx2oI1SOO-fmkDb9/favicon.svg?fit=max\u0026auto=format\u0026n=Lx2oI1SOO-fmkDb9\u0026q=85\u0026s=2f41a06e5deb64db8b508d78777f12e8","navbar":{"links":[{"href":"https://www.yorlet.com/contact","label":"Contact sales"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.yorlet.com"}},"footer":{"socials":{"x":"https://x.com/yorlethq","linkedin":"https://www.linkedin.com/company/yorlet"}},"fonts":{"family":"Inter"},"styling":{"codeblocks":{"theme":"dracula"},"latex":false},"errors":{"404":{"redirect":true}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"yorlet","hasAudioNarration":false,"actualSubdomain":"yorlet","customDomains":["docs.yorlet.com"],"gitSource":{"type":"github","owner":"yorlet-engineering","repo":"yorlet-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad86f9cace1a45c00d9294a","collectionId":"2641fb2b-f9c9-473b-80dc-dfcd486734af","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad86f9cace1a45c00d9294a"},"feedback":{"thumbs":true,"edits":false},"entitlements":{},"buildId":"6ad86f9cace1a45c00d9294a","clientVersion":"0.0.3918","searchFilterCounts":[{"language":"default","tag":"API reference","count":471},{"language":"default","tag":"Get started","count":123},{"language":"default","tag":"Billing","count":107},{"language":"default","tag":"Leasing","count":92},{"language":"default","tag":"Owners","count":91},{"language":"default","tag":"Core","count":85},{"language":"default","tag":"Payments","count":66},{"language":"default","tag":"Business automation","count":56},{"language":"default","tag":"Maintenance","count":44},{"language":"default","tag":"Leads","count":36}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"teamspace","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":not(pre)>code{overflow-wrap:break-word;border-radius:var(--rounded-md, 0.375rem);background-color:rgb(var(--gray-100)/.5);-webkit-box-decoration-break:clone;box-decoration-break:clone;padding:.125rem .5rem;line-height:1.5;color:rgb(var(--gray-600));font-size:13px!important;word-break:keep-all;white-space:nowrap;border:1px solid rgb(var(--gray-200))}.dark :not(pre)>code{background-color:rgb(255 255 255/.05);color:rgb(var(--gray-300));border-color:rgb(255 255 255/.1)}#pagination{display:none}"}],"page":{"pagePath":"payments/trace-a-payments","slug":"/payments/trace-a-payments","pageMetadata":{"title":"Trace a payment","description":"Learn how to trace payments.","href":"/payments/trace-a-payments"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Learn how to trace payments.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`Payment traces are a way to track the status of a payment. This guide will show you how to trace payments in the Dashboard.`})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":"dracula"},"config":{},"pageMetadata":{"title":"Trace a payment","description":"Learn how to trace payments.","href":"/payments/trace-a-payments"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"yorlet","siteName":"Yorlet Documentation","title":"Trace a payment - Yorlet Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-27T17:31:59.937Z","originalFileLocation":"payments/trace-a-payments.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Learn how to trace payments.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Yorlet Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/yorlet/SbB2ioktVmLTeJ4E/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/yorlet/SbB2ioktVmLTeJ4E/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/yorlet/SbB2ioktVmLTeJ4E/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/yorlet/SbB2ioktVmLTeJ4E/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/yorlet/SbB2ioktVmLTeJ4E/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/yorlet/SbB2ioktVmLTeJ4E/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/yorlet/SbB2ioktVmLTeJ4E/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/yorlet/SbB2ioktVmLTeJ4E/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/yorlet/SbB2ioktVmLTeJ4E/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Trace a payment - Yorlet Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn how to trace payments.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Yorlet Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.yorlet.com/payments/trace-a-payments\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://yorlet.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Trace+a+payment\u0026amp;description=Learn+how+to+trace+payments.\u0026amp;theme=f91ac42a388867e531d4845e\u0026amp;signature=f7ef05b7d9209f00afd49ba4c919d378547cec8cdd312c6931912b5532b5f781\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Trace a payment - Yorlet Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn how to trace payments.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://yorlet.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Trace+a+payment\u0026amp;description=Learn+how+to+trace+payments.\u0026amp;theme=f91ac42a388867e531d4845e\u0026amp;signature=f7ef05b7d9209f00afd49ba4c919d378547cec8cdd312c6931912b5532b5f781\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/yorlet/SbB2ioktVmLTeJ4E/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Yorlet Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366f1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.yorlet.com/payments/trace-a-payments\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/payments/trace-a-payments.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Yorlet Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Yorlet Documentation","nav":{"global":null,"tabs":[{"tab":"Get started","groups":[{"group":"Get started","pages":[{"title":"Introduction","mode":"wide","href":"/introduction"},{"group":"Dashboard","pages":[{"title":"Dashboard","mode":"wide","href":"/dashboard"},{"title":"Search","href":"/dashboard/search"},{"title":"Working with tables","sidebarTitle":"Tables","href":"/dashboard/tables"},{"title":"Notifications","href":"/dashboard/notifications"},{"title":"Settings","href":"/dashboard/settings"},{"title":"Team and security","sidebarTitle":"Team","href":"/dashboard/team"},{"title":"Help","href":"/dashboard/help"}]},{"group":"Customers","pages":[{"title":"Customers","sidebarTitle":"Overview","href":"/customers"},{"title":"Remaining balances","href":"/customers/remaining-balances"},{"title":"Redact a customer","href":"/customers/redact"}]},{"group":"Real estate","pages":[{"title":"Real estate","sidebarTitle":"Overview","mode":"wide","href":"/real-estate"},{"title":"Buildings","href":"/real-estate/buildings"},{"title":"Units","href":"/real-estate/units"}]},{"group":"Account","pages":[{"title":"Branding","href":"/account/branding"},{"title":"Activity log","sidebarTitle":"Activity","href":"/account/audit-logs"}]},{"group":"Onboarding","pages":[{"title":"Importing data","sidebarTitle":"Imports","href":"/onboarding/importing-data"}]},{"title":"OneMove","href":"/onemove"}]},{"group":"Leads","pages":[{"title":"Leads","sidebarTitle":"Overview","href":"/leads"},{"title":"Enquiries","href":"/leads/enquiries"},{"title":"Qualification configurations","href":"/leads/qualification-configurations"},{"title":"Qualification routing","href":"/leads/qualification-routes"},{"title":"Viewings","href":"/leads/viewings"}]},{"group":"Leasing","pages":[{"title":"Leasing","sidebarTitle":"Overview","mode":"wide","href":"/leasing"},{"group":"Applications","pages":[{"title":"Get started","href":"/leasing/applications"},{"title":"Application configurations","href":"/leasing/applications/application-configurations"},{"title":"Create a new application","sidebarTitle":"Create an application","href":"/leasing/applications/create-an-application"},{"title":"Manage an application","href":"/leasing/applications/manage-an-application"},{"title":"Update an application","href":"/leasing/applications/updating-applications"},{"title":"Update an applicant","href":"/leasing/applications/update-an-applicant"},{"title":"Application Portal","href":"/leasing/applications/application-portal"}]},{"group":"Referencing","pages":[{"title":"Referencing","sidebarTitle":"Overview","href":"/leasing/referencing"},{"title":"Integrated referencing","href":"/leasing/referencing/integrated-referencing"}]},{"group":"Deposits","pages":[{"title":"Deposits","sidebarTitle":"Overview","mode":"wide","href":"/leasing/deposits"},{"title":"Create a deposit","href":"/leasing/deposits/create-a-deposit"},{"title":"Registering a deposit","sidebarTitle":"Register a deposit","href":"/leasing/deposits/register-a-deposit"},{"title":"Adding charges to a deposit","sidebarTitle":"Deposit charges","href":"/leasing/deposits/deposit-charges"},{"title":"Return a deposit","href":"/leasing/deposits/return-a-deposit"},{"title":"Deposit routing","href":"/leasing/deposits/deposit-routing"}]},{"group":"Guarantors","pages":[{"title":"Guarantors","sidebarTitle":"Overview","mode":"wide","href":"/leasing/guarantors"},{"title":"Create a guarantor","href":"/leasing/guarantors/create-a-guarantor"},{"title":"Manage a guarantor","href":"/leasing/guarantors/manage-a-guarantor"}]},{"group":"Tenancies","pages":[{"title":"Tenancies","sidebarTitle":"Overview","href":"/leasing/tenancies"},{"title":"Tenancy reviews","href":"/leasing/tenancies/tenancy-reviews"},{"title":"Compliance documents","href":"/leasing/tenancies/compliance-documents"},{"title":"Lease changes","href":"/leasing/tenancies/lease-changes"}]},{"group":"Renewals","pages":[{"title":"Renewals","sidebarTitle":"Overview","href":"/leasing/renewals"},{"title":"Rent reviews","href":"/leasing/renewals/rent-reviews"}]}]},{"group":"Billing","pages":[{"title":"Yorlet Billing","sidebarTitle":"Overview","mode":"wide","href":"/billing"},{"group":"Subscriptions","pages":[{"title":"Subscriptions","sidebarTitle":"Overview","href":"/billing/subscriptions"},{"title":"Create a subscription","href":"/billing/subscriptions/create-a-subscription"},{"title":"Update a subscription","href":"/billing/subscriptions/update-a-subscription"},{"title":"Pausing subscriptions","href":"/billing/subscriptions/pausing-subscriptions"},{"title":"Prorations","href":"/billing/subscriptions/prorations"}]},{"group":"Invoices","pages":[{"title":"Invoices","sidebarTitle":"Overview","href":"/billing/invoices"},{"title":"Create an invoice","href":"/billing/invoices/create-an-invoice"},{"title":"Edit invoices","href":"/billing/invoices/edit-invoices"},{"group":"Payment methods for invoices","pages":[{"title":"Payment methods for invoices","sidebarTitle":"Overview","href":"/billing/invoices/payment-methods"},{"title":"Automatic transfer reconciliation","sidebarTitle":"Automatic reconciliation","href":"/billing/invoices/automatic-reconciliation"}]},{"title":"Credit notes","href":"/billing/invoices/credit-notes"},{"title":"Part payments","href":"/billing/invoices/part-payments"},{"title":"Hosted Invoices","href":"/billing/invoices/hosted-invoices"}]},{"title":"Credit grants","href":"/billing/credit-grants"},{"group":"Products and pricing","pages":[{"title":"Products and prices","href":"/billing/products"},{"title":"Tax rates","href":"/billing/tax-rates"},{"title":"Coupons","href":"/billing/coupons"}]},{"title":"Arrears management","sidebarTitle":"Overview","href":"/billing/arrears"},{"group":"Recover","pages":[{"title":"Recover","sidebarTitle":"Overview","href":"/billing/recovery"},{"title":"Instalment plans","href":"/billing/recovery/payment-plans"}]}]},{"group":"Payments","pages":[{"title":"Payments","sidebarTitle":"Overview","mode":"wide","href":"/payments"},{"title":"Accept a payment","href":"/payments/accept-a-payment"},{"title":"Payment Sessions","href":"/payments/payment-sessions"},{"group":"Payment methods","pages":[{"title":"Payment methods","sidebarTitle":"Overview","href":"/payments/payment-methods"},{"title":"Cards","href":"/payments/payment-methods/cards"},{"title":"Alipay","href":"/payments/payment-methods/alipay"},{"title":"Autogiro","href":"/payments/payment-methods/autogiro"},{"title":"Bacs Direct Debit","href":"/payments/payment-methods/bacs-debit"},{"title":"Bank Transfers","href":"/payments/payment-methods/bank-transfers"},{"title":"Direct transfers","href":"/payments/payment-methods/direct-transfers"},{"title":"Pay by Bank","href":"/payments/payment-methods/pay-by-bank"},{"title":"SEPA Direct Debit","href":"/payments/payment-methods/sepa-debit"},{"title":"WeChat Pay","href":"/payments/payment-methods/wechat-pay"}]},{"title":"Fraud prevention","href":"/payments/fraud-prevention"},{"title":"Disputes","href":"/payments/disputes"},{"title":"Refund a payment","href":"/payments/refunds"},{"title":"Payouts","href":"/payments/payouts"}]},{"group":"Balance","pages":[{"title":"Yorlet Balance","sidebarTitle":"Overview","mode":"wide","href":"/balance"},{"title":"Financial accounts","href":"/balance/financial-accounts"},{"title":"Activity","href":"/balance/transactions"},{"title":"Payouts","href":"/balance/payouts"},{"title":"Automatic owner payouts","href":"/balance/automatic-owner-payouts"}]},{"group":"Owners","pages":[{"title":"Yorlet Owners","sidebarTitle":"Overview","mode":"wide","href":"/owners"},{"group":"Accounts","pages":[{"title":"Choose an account type","href":"/owners/accounts"},{"title":"Platform owner accounts","href":"/owners/platform-accounts"},{"title":"Onboard accounts","href":"/owners/account-onboarding"},{"title":"Updating accounts","href":"/owners/updating-accounts"}]},{"title":"Unit ownership","href":"/owners/unit-ownership"},{"group":"Fund flows","pages":[{"title":"Understanding fund flows","href":"/owners/fund-flows"},{"title":"Transfers","href":"/owners/fund-flows/transfers"},{"title":"Charging owners","href":"/owners/fund-flows/collections"}]},{"group":"Pay out owners","pages":[{"title":"Understanding owner account balances","sidebarTitle":"Account balances","href":"/owners/account-balances"},{"title":"Owner payouts","href":"/owners/owner-payouts"},{"title":"Payment runs","href":"/owners/payment-runs"}]},{"title":"Tax reporting","href":"/owners/tax-reporting"}]},{"group":"Changelog","pages":[{"title":"Product updates","mode":"wide","href":"/changelog/overview"}]}]},{"tab":"Business automation","groups":[{"group":"Yorlet AI","pages":[{"title":"Yorlet AI","sidebarTitle":"Overview","mode":"wide","href":"/business-automation/ai/overview"},{"title":"Assistant","href":"/business-automation/ai/assistant"},{"title":"Plans","href":"/business-automation/ai/plans"},{"title":"Approvals","href":"/business-automation/ai/approvals"},{"title":"Agent policy","href":"/business-automation/ai/policy"},{"title":"External agents","sidebarTitle":"External agents","href":"/business-automation/ai/agent-keys"},{"title":"MCP","href":"/business-automation/ai/mcp"}]},{"group":"Inbox","pages":[{"title":"Inbox","sidebarTitle":"Overview","mode":"wide","href":"/business-automation/inbox/overview"},{"title":"Email","href":"/business-automation/inbox/email"},{"title":"Agents and Inbox","sidebarTitle":"Agents","href":"/business-automation/inbox/agents"}]},{"group":"Workflows","pages":[{"title":"Workflows","sidebarTitle":"Overview","mode":"wide","href":"/business-automation/workflows/overview"},{"title":"Create a workflow","href":"/business-automation/workflows/create-a-workflow"},{"title":"Triggers","href":"/business-automation/workflows/triggers"},{"title":"Actions","href":"/business-automation/workflows/actions"},{"title":"Conditions and loops","href":"/business-automation/workflows/conditions-and-loops"},{"title":"Variables","href":"/business-automation/workflows/variables"},{"title":"Runs","href":"/business-automation/workflows/runs"},{"title":"Usage and billing","href":"/business-automation/workflows/usage-and-billing"}]},{"group":"Maintenance","pages":[{"title":"Maintenance","sidebarTitle":"Overview","mode":"wide","href":"/maintenance"},{"title":"Manage issues","href":"/maintenance/manage-issues"},{"title":"Tenant requests","href":"/maintenance/tenant-requests"},{"title":"Manage jobs and visits","href":"/maintenance/jobs-and-visits"},{"title":"Quotes and suppliers","href":"/maintenance/quotes-and-suppliers"},{"title":"Landlord approvals","href":"/maintenance/landlord-approvals"},{"title":"Maintenance overview and reporting","href":"/maintenance/overview-and-reporting"},{"title":"Response targets","href":"/maintenance/response-targets"},{"title":"Maintenance settings","sidebarTitle":"Settings","href":"/maintenance/settings"}]},{"group":"Loyalty","pages":[{"title":"Loyalty","sidebarTitle":"Overview","mode":"wide","href":"/loyalty"},{"title":"Loyalty programmes","sidebarTitle":"Programmes","href":"/loyalty/programs"},{"title":"Grant points with a workflow","href":"/loyalty/grant-with-a-workflow"},{"title":"Loyalty tiers","sidebarTitle":"Tiers","href":"/loyalty/tiers"},{"title":"Loyalty residents","sidebarTitle":"Residents","href":"/loyalty/residents"},{"title":"Loyalty messages","sidebarTitle":"Messages","href":"/loyalty/messages"}]},{"group":"Letters","pages":[{"title":"Letters","sidebarTitle":"Overview","mode":"wide","href":"/letters"},{"title":"Send a letter","href":"/letters/send-a-letter"},{"title":"Letter templates","sidebarTitle":"Templates","href":"/letters/templates"}]},{"group":"Reporting","pages":[{"title":"Yorlet Reporting","sidebarTitle":"Overview","href":"/reporting/introduction"},{"group":"Basic reporting","pages":[{"title":"Basic reporting","sidebarTitle":"Overview","href":"/reporting/basic-reporting"},{"title":"Account reports","href":"/reporting/basic-reporting/account-reports"},{"title":"Owner reports","href":"/reporting/basic-reporting/owner-reports"}]},{"title":"Dashboard overview","sidebarTitle":"Dashboard overview","href":"/reporting/dashboard-reports"},{"title":"Vacancy reports","href":"/reporting/vacancy-reports"},{"title":"Exporting data","href":"/reporting/exporting-data"},{"title":"Metadata","href":"/reporting/metadata"},{"group":"Client Accounting","pages":[{"title":"Client Accounting","sidebarTitle":"Overview","href":"/business-automation/client-accounting/overview"},{"title":"Bank reconciliation","href":"/business-automation/client-accounting/bank-reconciliation"},{"title":"Customer credit balances","href":"/business-automation/client-accounting/customer-credit-balances"},{"title":"Deposit balances","href":"/business-automation/client-accounting/deposit-balances"},{"title":"Owner cash balances","href":"/business-automation/client-accounting/owner-cash-balances"}]}]},{"group":"Prism","pages":[{"title":"Yorlet Prism","sidebarTitle":"Overview","mode":"wide","href":"/prism"},{"title":"Plans","href":"/prism/plans"},{"title":"SQL and AI for beginners","href":"/prism/sql-and-ai"},{"title":"Write a query","href":"/prism/write-a-query"},{"title":"Templates","href":"/prism/templates"},{"title":"Save and schedule","href":"/prism/save-and-schedule"},{"title":"Schema","href":"/prism/schema"}]}]},{"tab":"Developers","groups":[{"group":"Developer tools","pages":[{"title":"Developer tools","sidebarTitle":"Overview","mode":"wide","href":"/development/overview"},{"group":"API","pages":[{"title":"API keys","href":"/development/api-keys"},{"title":"Yorlet-Context header","sidebarTitle":"View organisation-wide data","href":"/development/context"},{"title":"API versioning","sidebarTitle":"Versioning","href":"/development/versioning"},{"title":"API changelog","mode":"wide","href":"/development/api-changelog"}]},{"group":"SDKs","pages":[{"title":"Yorlet.js","sidebarTitle":"Yorlet.js","href":"/development/libraries/yorletjs"},{"title":"Yorlet React","sidebarTitle":"React","href":"/development/libraries/react"}]},{"group":"Events","pages":[{"title":"Events and logs","href":"/development/events"},{"title":"Send Yorlet events to your webhook endpoints","sidebarTitle":"Webhooks","href":"/development/webhooks"}]}]},{"group":"Essentials","pages":[{"title":"Metadata","sidebarTitle":"Metadata","href":"/development/essentials/metadata"},{"title":"Dates","sidebarTitle":"Dates","href":"/development/essentials/dates"},{"title":"CSV imports","sidebarTitle":"Imports","href":"/development/imports"}]},{"group":"Integrations","pages":[{"title":"Integrations overview","sidebarTitle":"Overview","href":"/development/integrations/overview"},{"group":"Leads","pages":[{"title":"Create an enquiry","sidebarTitle":"Create an enquiry","href":"/development/integrations/leads/create-an-enquiry"},{"title":"Embed a qualification form","sidebarTitle":"Embed a qualification form","href":"/development/integrations/leads/embed-a-qualification-form"},{"title":"Book a viewing","sidebarTitle":"Book a viewing","href":"/development/integrations/leads/book-a-viewing"}]},{"group":"Applications","pages":[{"title":"Create an application","sidebarTitle":"Create an application","href":"/development/integrations/applications/create-an-application"}]},{"group":"Billing","pages":[{"title":"Create a subscription with Checkout Sessions","sidebarTitle":"Create a subscription","href":"/development/integrations/billing/create-a-subscription"},{"title":"Update a subscription","sidebarTitle":"Update a subscription","href":"/development/integrations/billing/update-a-subscription"}]},{"group":"Payments","pages":[{"title":"Payment Sessions","sidebarTitle":"Accept a payment","href":"/development/integrations/payments/payment-sessions"},{"title":"Payment Method Sessions","sidebarTitle":"Collect a payment method","href":"/development/integrations/payments/payment-method-sessions"}]},{"group":"Loyalty","pages":[{"title":"Grant loyalty rewards from your systems","sidebarTitle":"Grant rewards","href":"/development/integrations/loyalty/grant-rewards"},{"title":"Send loyalty messages from your systems","sidebarTitle":"Send messages","href":"/development/integrations/loyalty/send-messages"}]},{"group":"OneMove","pages":[{"title":"Issue OneMove points from your product","sidebarTitle":"Issue points","href":"/development/integrations/onemove"}]}]},{"group":"Platforms","pages":[{"title":"Yorlet for Platforms","sidebarTitle":"Overview","href":"/development/platforms/introduction"}]}]},{"tab":"API reference","groups":[{"group":"Yorlet API","pages":[{"title":"Introduction","href":"/api/introduction"},{"title":"Environments","href":"/api/environments"},{"title":"Authentication","href":"/api/authentication"},{"title":"Errors","href":"/api/errors"},{"title":"Expanding objects","href":"/api/expanding"},{"title":"Idempotency","href":"/api/idempotency"},{"title":"Types of events","href":"/api/events"}]},{"group":"Billing","pages":[{"group":"Coupons","pages":[{"title":"The coupon object","href":"/api/billing/coupons/object"},{"title":"Create a coupon","openapi":"openapi-billing.json POST /v1/coupons","href":"/api/billing/coupons/create"},{"title":"Retrieve a coupon","openapi":"openapi-billing.json GET /v1/coupons/{id}","href":"/api/billing/coupons/retrieve"},{"title":"Update a coupon","openapi":"openapi-billing.json POST /v1/coupons/{id}","href":"/api/billing/coupons/update"},{"title":"List all coupons","openapi":"openapi-billing.json GET /v1/coupons","href":"/api/billing/coupons/list"},{"title":"Delete a coupon","openapi":"openapi-billing.json DELETE /v1/coupons/{id}","href":"/api/billing/coupons/delete"}]},{"group":"Credit Grants","pages":[{"title":"The credit grant object","href":"/api/billing/credit-grants/object"},{"title":"Create a credit grant","openapi":"openapi-billing.json POST /v1/credit_grants","href":"/api/billing/credit-grants/create"},{"title":"Retrieve a credit grant","openapi":"openapi-billing.json GET /v1/credit_grants/{id}","href":"/api/billing/credit-grants/retrieve"},{"title":"Update a credit grant","openapi":"openapi-billing.json POST /v1/credit_grants/{id}","href":"/api/billing/credit-grants/update"},{"title":"List all credit grants","openapi":"openapi-billing.json GET /v1/credit_grants","href":"/api/billing/credit-grants/list"},{"title":"Void a credit grant","openapi":"openapi-billing.json POST /v1/credit_grants/{id}/void","href":"/api/billing/credit-grants/void"}]},{"group":"Credit Notes","pages":[{"title":"The credit note object","href":"/api/billing/credit-notes/object"},{"title":"Create a credit note","openapi":"openapi-billing.json POST /v1/credit_notes","href":"/api/billing/credit-notes/create"},{"title":"Retrieve a credit note","openapi":"openapi-billing.json GET /v1/credit_notes/{id}","href":"/api/billing/credit-notes/retrieve"},{"title":"Update a credit note","openapi":"openapi-billing.json POST /v1/credit_notes/{id}","href":"/api/billing/credit-notes/update"},{"title":"List all credit notes","openapi":"openapi-billing.json GET /v1/credit_notes","href":"/api/billing/credit-notes/list"},{"title":"Retrieve a credit note's line items","openapi":"openapi-billing.json GET /v1/credit_notes/{id}/lines","href":"/api/billing/credit-notes/lines"},{"title":"Preview a credit note","openapi":"openapi-billing.json POST /v1/credit_notes/preview","href":"/api/billing/credit-notes/preview"},{"title":"Void a credit note","openapi":"openapi-billing.json POST /v1/credit_notes/{id}/void","href":"/api/billing/credit-notes/void"}]},{"group":"Customer Balance Transactions","pages":[{"title":"Create a customer balance transaction","openapi":"openapi-billing.json POST /v1/customer_balance_transactions","href":"/api/billing/customer-balance-transactions/create"},{"title":"Update a customer balance transaction","openapi":"openapi-billing.json POST /v1/customer_balance_transactions/{id}","href":"/api/billing/customer-balance-transactions/update"},{"title":"List all customer balance transactions","openapi":"openapi-billing.json GET /v1/customer_balance_transactions","href":"/api/billing/customer-balance-transactions/list"}]},{"group":"Invoice Items","pages":[{"title":"The invoice item object","href":"/api/billing/invoice-items/object"},{"title":"Create a invoice item","openapi":"openapi-billing.json POST /v1/invoice_items","href":"/api/billing/invoice-items/create"},{"title":"Retrieve a invoice item","openapi":"openapi-billing.json GET /v1/invoice_items/{id}","href":"/api/billing/invoice-items/retrieve"},{"title":"Update a invoice item","openapi":"openapi-billing.json POST /v1/invoice_items/{id}","href":"/api/billing/invoice-items/update"},{"title":"List all invoice items","openapi":"openapi-billing.json GET /v1/invoice_items","href":"/api/billing/invoice-items/list"},{"title":"Delete a invoice item","openapi":"openapi-billing.json DELETE /v1/invoice_items/{id}","href":"/api/billing/invoice-items/delete"}]},{"group":"Invoices","pages":[{"title":"The invoice object","href":"/api/billing/invoices/object"},{"title":"Create an invoice","openapi":"openapi-billing.json POST /v1/invoices","href":"/api/billing/invoices/create"},{"title":"Retrieve an invoice","openapi":"openapi-billing.json GET /v1/invoices/{id}","href":"/api/billing/invoices/retrieve"},{"title":"Update an invoice","openapi":"openapi-billing.json POST /v1/invoices/{id}","href":"/api/billing/invoices/update"},{"title":"List invoices","openapi":"openapi-billing.json GET /v1/invoices","href":"/api/billing/invoices/list"},{"title":"Delete an invoice","openapi":"openapi-billing.json DELETE /v1/invoices/{id}","href":"/api/billing/invoices/delete"},{"title":"Attach a payment to an invoice","openapi":"openapi-billing.json POST /v1/invoices/{id}/attach_payment","href":"/api/billing/invoices/attach-payment"},{"title":"Finalize an invoice","openapi":"openapi-billing.json POST /v1/invoices/{id}/finalize","href":"/api/billing/invoices/finalize"},{"title":"Mark an invoice as paid","openapi":"openapi-billing.json POST /v1/invoices/{id}/mark_paid","href":"/api/billing/invoices/mark-paid"},{"title":"Mark an invoice as uncollectible","openapi":"openapi-billing.json POST /v1/invoices/{id}/mark_uncollectible","href":"/api/billing/invoices/mark-uncollectible"},{"title":"Void an invoice","openapi":"openapi-billing.json POST /v1/invoices/{id}/void","href":"/api/billing/invoices/mark-void"},{"title":"Retrieve an upcoming invoice","openapi":"openapi-billing.json GET /v1/invoices/upcoming","href":"/api/billing/invoices/retrieve-upcoming"},{"title":"Retry failed invoice transfers","openapi":"openapi-billing.json POST /v1/invoices/{id}/retry_transfers","href":"/api/billing/invoices/retry-transfers"},{"title":"Send an invoice","openapi":"openapi-billing.json POST /v1/invoices/{id}/send","href":"/api/billing/invoices/send"}]},{"group":"Payment Plans","pages":[{"title":"The payment plan object","href":"/api/billing/payment-plans/object"},{"title":"Create a payment plan","openapi":"openapi-billing.json POST /v1/payment_plans","href":"/api/billing/payment-plans/create"},{"title":"Retrieve a payment plan","openapi":"openapi-billing.json GET /v1/payment_plans/{id}","href":"/api/billing/payment-plans/retrieve"},{"title":"List all payment plans","openapi":"openapi-billing.json GET /v1/payment_plans","href":"/api/billing/payment-plans/list"},{"title":"Accept a payment plan","openapi":"openapi-billing.json POST /v1/payment_plans/{id}/accept","href":"/api/billing/payment-plans/accept"},{"title":"Cancel a payment plan","openapi":"openapi-billing.json POST /v1/payment_plans/{id}/cancel","href":"/api/billing/payment-plans/cancel"}]},{"group":"Prices","pages":[{"title":"The price object","href":"/api/billing/prices/object"},{"title":"Create a price","openapi":"openapi-billing.json POST /v1/prices","href":"/api/billing/prices/create"},{"title":"Retrieve a price","openapi":"openapi-billing.json GET /v1/prices/{id}","href":"/api/billing/prices/retrieve"},{"title":"Update a price","openapi":"openapi-billing.json POST /v1/prices/{id}","href":"/api/billing/prices/update"},{"title":"List all prices","openapi":"openapi-billing.json GET /v1/prices","href":"/api/billing/prices/list"}]},{"group":"Products","pages":[{"title":"The product object","href":"/api/billing/products/object"},{"title":"Create a product","openapi":"openapi-billing.json POST /v1/products","href":"/api/billing/products/create"},{"title":"Retrieve a product","openapi":"openapi-billing.json GET /v1/products/{id}","href":"/api/billing/products/retrieve"},{"title":"Update a product","openapi":"openapi-billing.json POST /v1/products/{id}","href":"/api/billing/products/update"},{"title":"List all products","openapi":"openapi-billing.json GET /v1/products","href":"/api/billing/products/list"}]},{"group":"Recovery Cases","pages":[{"title":"The recovery case object","href":"/api/billing/recovery-cases/object"},{"title":"Create a recovery case","openapi":"openapi-billing.json POST /v1/recovery_cases","href":"/api/billing/recovery-cases/create"},{"title":"Retrieve a recovery case","openapi":"openapi-billing.json GET /v1/recovery_cases/{id}","href":"/api/billing/recovery-cases/retrieve"},{"title":"Update a recovery case","openapi":"openapi-billing.json POST /v1/recovery_cases/{id}","href":"/api/billing/recovery-cases/update"},{"title":"List all recovery cases","openapi":"openapi-billing.json GET /v1/recovery_cases","href":"/api/billing/recovery-cases/list"},{"title":"Cancel a recovery case","openapi":"openapi-billing.json POST /v1/recovery_cases/{id}/cancel","href":"/api/billing/recovery-cases/cancel"},{"title":"Pay a recovery case","openapi":"openapi-billing.json POST /v1/recovery_cases/{id}/pay","href":"/api/billing/recovery-cases/pay"}]},{"group":"Subscription Items","pages":[{"title":"The subscription item object","href":"/api/billing/subscription-items/object"},{"title":"Create a subscription item","openapi":"openapi-billing.json POST /v1/subscription_items","href":"/api/billing/subscription-items/create"},{"title":"Retrieve a subscription item","openapi":"openapi-billing.json GET /v1/subscription_items/{id}","href":"/api/billing/subscription-items/retrieve"},{"title":"Update a subscription item","openapi":"openapi-billing.json POST /v1/subscription_items/{id}","href":"/api/billing/subscription-items/update"},{"title":"List all subscription items","openapi":"openapi-billing.json GET /v1/subscription_items","href":"/api/billing/subscription-items/list"},{"title":"Delete a subscription item","openapi":"openapi-billing.json DELETE /v1/subscription_items/{id}","href":"/api/billing/subscription-items/delete"}]},{"group":"Subscriptions","pages":[{"title":"The subscription object","href":"/api/billing/subscriptions/object"},{"title":"Create a subscription","openapi":"openapi-billing.json POST /v1/subscriptions","href":"/api/billing/subscriptions/create"},{"title":"Retrieve a subscription","openapi":"openapi-billing.json GET /v1/subscriptions/{id}","href":"/api/billing/subscriptions/retrieve"},{"title":"Update a subscription","openapi":"openapi-billing.json POST /v1/subscriptions/{id}","href":"/api/billing/subscriptions/update"},{"title":"List all subscriptions","openapi":"openapi-billing.json GET /v1/subscriptions","href":"/api/billing/subscriptions/list"},{"title":"Cancel a subscription","openapi":"openapi-billing.json POST /v1/subscriptions/{id}/cancel","href":"/api/billing/subscriptions/cancel"},{"title":"Progress a subscription","openapi":"openapi-billing.json POST /v1/subscriptions/{id}/progress","href":"/api/billing/subscriptions/progress"}]},{"group":"Tax Rates","pages":[{"title":"The tax rate object","href":"/api/billing/tax-rates/object"},{"title":"Create a tax rate","openapi":"openapi-billing.json POST /v1/tax_rates","href":"/api/billing/tax-rates/create"},{"title":"Retrieve a tax rate","openapi":"openapi-billing.json GET /v1/tax_rates/{id}","href":"/api/billing/tax-rates/retrieve"},{"title":"Update a tax rate","openapi":"openapi-billing.json POST /v1/tax_rates/{id}","href":"/api/billing/tax-rates/update"},{"title":"List all tax rates","openapi":"openapi-billing.json GET /v1/tax_rates","href":"/api/billing/tax-rates/list"}]}]},{"group":"Checkout","pages":[{"group":"Checkout Sessions","pages":[{"title":"The checkout session object","href":"/api/checkout/checkout-sessions/object"},{"title":"Create a checkout session","openapi":"openapi-checkout.json POST /v1/checkout_sessions","href":"/api/checkout/checkout-sessions/create"},{"title":"Retrieve a checkout session","openapi":"openapi-checkout.json GET /v1/checkout_sessions/{id}","href":"/api/checkout/checkout-sessions/retrieve"},{"title":"Update a checkout session","openapi":"openapi-checkout.json POST /v1/checkout_sessions/{id}","href":"/api/checkout/checkout-sessions/update"},{"title":"List all checkout sessions","openapi":"openapi-checkout.json GET /v1/checkout_sessions","href":"/api/checkout/checkout-sessions/list"},{"title":"Cancel a checkout session","openapi":"openapi-checkout.json POST /v1/checkout_sessions/{id}/cancel","href":"/api/checkout/checkout-sessions/cancel"}]}]},{"group":"Core","pages":[{"group":"Buildings","pages":[{"title":"The building object","href":"/api/core/buildings/object"},{"title":"Create a building","openapi":"openapi-core.json POST /v1/buildings","href":"/api/core/buildings/create"},{"title":"Retrieve a building","openapi":"openapi-core.json GET /v1/buildings/{id}","href":"/api/core/buildings/retrieve"},{"title":"Update a building","openapi":"openapi-core.json POST /v1/buildings/{id}","href":"/api/core/buildings/update"},{"title":"List all buildings","openapi":"openapi-core.json GET /v1/buildings","href":"/api/core/buildings/list"},{"title":"Delete a building","openapi":"openapi-core.json DELETE /v1/buildings/{id}","href":"/api/core/buildings/delete"},{"title":"Create a building viewing booking link","openapi":"openapi-core.json POST /v1/buildings/{id}/booking_link","href":"/api/core/buildings/booking-link"}]},{"group":"Customers","pages":[{"title":"The customer object","href":"/api/core/customers/object"},{"title":"Create a customer","openapi":"openapi-core.json POST /v1/customers","href":"/api/core/customers/create"},{"title":"Retrieve a customer","openapi":"openapi-core.json GET /v1/customers/{id}","href":"/api/core/customers/retrieve"},{"title":"Update a customer","openapi":"openapi-core.json POST /v1/customers/{id}","href":"/api/core/customers/update"},{"title":"List all customers","openapi":"openapi-core.json GET /v1/customers","href":"/api/core/customers/list"},{"title":"Delete a customer","openapi":"openapi-core.json DELETE /v1/customers/{id}","href":"/api/core/customers/delete"}]},{"group":"Documents","pages":[{"title":"The document object","href":"/api/core/documents/object"},{"title":"Create a document","openapi":"openapi-core.json POST /v1/documents","href":"/api/core/documents/create"},{"title":"Retrieve a document","openapi":"openapi-core.json GET /v1/documents/{id}","href":"/api/core/documents/retrieve"},{"title":"Update a document","openapi":"openapi-core.json POST /v1/documents/{id}","href":"/api/core/documents/update"},{"title":"List all documents","openapi":"openapi-core.json GET /v1/documents","href":"/api/core/documents/list"},{"title":"Delete a document","openapi":"openapi-core.json DELETE /v1/documents/{id}","href":"/api/core/documents/delete"}]},{"group":"Email addresses","pages":[{"title":"Create an email address","openapi":"openapi-core.json POST /v1/email_addresses","href":"/api/core/email-addresses/create"},{"title":"Update an email address","openapi":"openapi-core.json POST /v1/email_addresses/{id}","href":"/api/core/email-addresses/update"},{"title":"List email addresses","openapi":"openapi-core.json GET /v1/email_addresses","href":"/api/core/email-addresses/list"},{"title":"Delete an email address","openapi":"openapi-core.json DELETE /v1/email_addresses/{id}","href":"/api/core/email-addresses/delete"},{"title":"Check address availability","openapi":"openapi-core.json GET /v1/email_addresses/availability","href":"/api/core/email-addresses/availability"}]},{"group":"Email domains","pages":[{"title":"Add a custom domain","openapi":"openapi-core.json POST /v1/email_domains","href":"/api/core/email-domains/create"},{"title":"List custom domains","openapi":"openapi-core.json GET /v1/email_domains","href":"/api/core/email-domains/list"},{"title":"Delete a custom domain","openapi":"openapi-core.json DELETE /v1/email_domains/{id}","href":"/api/core/email-domains/delete"},{"title":"Verify a custom domain","openapi":"openapi-core.json POST /v1/email_domains/{id}/verify","href":"/api/core/email-domains/verify"}]},{"group":"Emails","pages":[{"title":"The message object","href":"/api/core/emails/object"},{"title":"Send an email","openapi":"openapi-core.json POST /v1/emails","href":"/api/core/emails/create"},{"title":"Retrieve an email","openapi":"openapi-core.json GET /v1/emails/{id}","href":"/api/core/emails/retrieve"},{"title":"List emails","openapi":"openapi-core.json GET /v1/emails","href":"/api/core/emails/list"}]},{"group":"Letter templates","pages":[{"title":"The letter template object","href":"/api/core/letter-templates/object"},{"title":"Create a letter template","openapi":"openapi-core.json POST /v1/letter_templates","href":"/api/core/letter-templates/create"},{"title":"Retrieve a letter template","openapi":"openapi-core.json GET /v1/letter_templates/{id}","href":"/api/core/letter-templates/retrieve"},{"title":"Update a letter template","openapi":"openapi-core.json POST /v1/letter_templates/{id}","href":"/api/core/letter-templates/update"},{"title":"List all letter templates","openapi":"openapi-core.json GET /v1/letter_templates","href":"/api/core/letter-templates/list"},{"title":"Delete a letter template","openapi":"openapi-core.json DELETE /v1/letter_templates/{id}","href":"/api/core/letter-templates/delete"}]},{"group":"Letters","pages":[{"title":"The letter object","href":"/api/core/letters/object"},{"title":"Create a letter","openapi":"openapi-core.json POST /v1/letters","href":"/api/core/letters/create"},{"title":"Retrieve a letter","openapi":"openapi-core.json GET /v1/letters/{id}","href":"/api/core/letters/retrieve"},{"title":"Update a letter","openapi":"openapi-core.json POST /v1/letters/{id}","href":"/api/core/letters/update"},{"title":"List all letters","openapi":"openapi-core.json GET /v1/letters","href":"/api/core/letters/list"},{"title":"Delete a letter","openapi":"openapi-core.json DELETE /v1/letters/{id}","href":"/api/core/letters/delete"},{"title":"Cancel a letter","openapi":"openapi-core.json POST /v1/letters/{id}/cancel","href":"/api/core/letters/cancel"},{"title":"Send a letter","openapi":"openapi-core.json POST /v1/letters/{id}/send","href":"/api/core/letters/send"}]},{"group":"Redactions","pages":[{"title":"The redaction object","href":"/api/core/redactions/object"},{"title":"Create a redaction","openapi":"openapi-core.json POST /v1/redactions","href":"/api/core/redactions/create"},{"title":"Retrieve a redaction","openapi":"openapi-core.json GET /v1/redactions/{id}","href":"/api/core/redactions/retrieve"},{"title":"List redactions","openapi":"openapi-core.json GET /v1/redactions","href":"/api/core/redactions/list"}]},{"group":"Tasks","pages":[{"title":"The task object","href":"/api/core/tasks/object"},{"title":"Create a task","openapi":"openapi-core.json POST /v1/tasks","href":"/api/core/tasks/create"},{"title":"Retrieve a task","openapi":"openapi-core.json GET /v1/tasks/{id}","href":"/api/core/tasks/retrieve"},{"title":"Update a task","openapi":"openapi-core.json POST /v1/tasks/{id}","href":"/api/core/tasks/update"},{"title":"List all tasks","openapi":"openapi-core.json GET /v1/tasks","href":"/api/core/tasks/list"},{"title":"Delete a task","openapi":"openapi-core.json DELETE /v1/tasks/{id}","href":"/api/core/tasks/delete"}]},{"group":"Threads","pages":[{"title":"The thread object","href":"/api/core/threads/object"},{"title":"Retrieve a thread","openapi":"openapi-core.json GET /v1/threads/{id}","href":"/api/core/threads/retrieve"},{"title":"Update a thread","openapi":"openapi-core.json POST /v1/threads/{id}","href":"/api/core/threads/update"},{"title":"List threads","openapi":"openapi-core.json GET /v1/threads","href":"/api/core/threads/list"},{"title":"List timeline entries","openapi":"openapi-core.json GET /v1/threads/{id}/timeline_entries","href":"/api/core/threads/list-timeline-entries"}]},{"group":"Unit Groups","pages":[{"title":"The unit group object","href":"/api/core/unit-groups/object"},{"title":"Create a unit group","openapi":"openapi-core.json POST /v1/unit_groups","href":"/api/core/unit-groups/create"},{"title":"Retrieve a unit group","openapi":"openapi-core.json GET /v1/unit_groups/{id}","href":"/api/core/unit-groups/retrieve"},{"title":"Update a unit group","openapi":"openapi-core.json POST /v1/unit_groups/{id}","href":"/api/core/unit-groups/update"},{"title":"List all unit groups","openapi":"openapi-core.json GET /v1/unit_groups","href":"/api/core/unit-groups/list"},{"title":"Delete a unit group","openapi":"openapi-core.json DELETE /v1/unit_groups/{id}","href":"/api/core/unit-groups/delete"}]},{"group":"Unit Owners","pages":[{"title":"Update a unit owner","openapi":"openapi-core.json POST /v1/unit_owners/{id}","href":"/api/core/unit-owners/update"},{"title":"List all unit owners","openapi":"openapi-core.json GET /v1/unit_owners","href":"/api/core/unit-owners/list"}]},{"group":"Units","pages":[{"title":"The unit object","href":"/api/core/units/object"},{"title":"Create a unit","openapi":"openapi-core.json POST /v1/units","href":"/api/core/units/create"},{"title":"Retrieve a unit","openapi":"openapi-core.json GET /v1/units/{id}","href":"/api/core/units/retrieve"},{"title":"Update a unit","openapi":"openapi-core.json POST /v1/units/{id}","href":"/api/core/units/update"},{"title":"List all units","openapi":"openapi-core.json GET /v1/units","href":"/api/core/units/list"},{"title":"Delete a unit","openapi":"openapi-core.json DELETE /v1/units/{id}","href":"/api/core/units/delete"},{"title":"Apply for a unit","openapi":"openapi-core.json POST /v1/units/{id}/apply","href":"/api/core/units/apply"},{"title":"Hold a unit back from the market","openapi":"openapi-core.json POST /v1/units/{id}/hold","href":"/api/core/units/hold"},{"title":"Release a unit to the market","openapi":"openapi-core.json POST /v1/units/{id}/release","href":"/api/core/units/release"}]},{"group":"Webhook Endpoints","pages":[{"title":"The webhook endpoint object","href":"/api/core/webhook-endpoints/object"},{"title":"Create a webhook endpoint","openapi":"openapi-core.json POST /v1/webhook_endpoints","href":"/api/core/webhook-endpoints/create"},{"title":"Retrieve a webhook endpoint","openapi":"openapi-core.json GET /v1/webhook_endpoints/{id}","href":"/api/core/webhook-endpoints/retrieve"},{"title":"Update a webhook endpoint","openapi":"openapi-core.json POST /v1/webhook_endpoints/{id}","href":"/api/core/webhook-endpoints/update"},{"title":"List all webhook endpoints","openapi":"openapi-core.json GET /v1/webhook_endpoints","href":"/api/core/webhook-endpoints/list"},{"title":"Delete a webhook endpoint","openapi":"openapi-core.json DELETE /v1/webhook_endpoints/{id}","href":"/api/core/webhook-endpoints/delete"},{"title":"Roll a webhook endpoint signing secret","openapi":"openapi-core.json POST /v1/webhook_endpoints/{id}/roll_secret","href":"/api/core/webhook-endpoints/roll-secret"}]}]},{"group":"Guardrails","pages":[{"group":"Verification Sessions","pages":[{"title":"The verification session object","href":"/api/guardrails/verification-sessions/object"},{"title":"Create a verification session","openapi":"openapi-guardrails.json POST /v1/verification_sessions","href":"/api/guardrails/verification-sessions/create"},{"title":"Retrieve a verification session","openapi":"openapi-guardrails.json GET /v1/verification_sessions/{id}","href":"/api/guardrails/verification-sessions/retrieve"},{"title":"List all verification sessions","openapi":"openapi-guardrails.json GET /v1/verification_sessions","href":"/api/guardrails/verification-sessions/list"}]}]},{"group":"Leads","pages":[{"group":"Leads Enquiries","pages":[{"title":"The leads.enquiry object","href":"/api/leads/leads-enquiries/object"},{"title":"Create an enquiry","openapi":"openapi-leads.json POST /v1/leads/enquiries","href":"/api/leads/leads-enquiries/create"},{"title":"Retrieve an enquiry","openapi":"openapi-leads.json GET /v1/leads/enquiries/{id}","href":"/api/leads/leads-enquiries/retrieve"},{"title":"Update an enquiry","openapi":"openapi-leads.json POST /v1/leads/enquiries/{id}","href":"/api/leads/leads-enquiries/update"},{"title":"List all enquiries","openapi":"openapi-leads.json GET /v1/leads/enquiries","href":"/api/leads/leads-enquiries/list"},{"title":"Attach a qualification configuration to an enquiry","openapi":"openapi-leads.json POST /v1/leads/enquiries/{id}/attach","href":"/api/leads/leads-enquiries/attach"},{"title":"Create a viewing booking link for an enquiry","openapi":"openapi-leads.json POST /v1/leads/enquiries/{id}/booking_link","href":"/api/leads/leads-enquiries/booking-link"},{"title":"Create a qualification form link for an enquiry","openapi":"openapi-leads.json POST /v1/leads/enquiries/{id}/qualification_link","href":"/api/leads/leads-enquiries/qualification-link"},{"title":"Submit qualification answers for an enquiry","openapi":"openapi-leads.json POST /v1/leads/enquiries/{id}/qualify","href":"/api/leads/leads-enquiries/qualify"},{"title":"Transition an enquiry status","openapi":"openapi-leads.json POST /v1/leads/enquiries/{id}/status","href":"/api/leads/leads-enquiries/status"}]},{"group":"Leads Qualification Configurations","pages":[{"title":"The leads.qualification configuration object","href":"/api/leads/leads-qualification-configurations/object"},{"title":"Create a leads qualification configuration","openapi":"openapi-leads.json POST /v1/leads/qualification_configurations","href":"/api/leads/leads-qualification-configurations/create"},{"title":"Retrieve a leads qualification configuration","openapi":"openapi-leads.json GET /v1/leads/qualification_configurations/{id}","href":"/api/leads/leads-qualification-configurations/retrieve"},{"title":"Update a leads qualification configuration","openapi":"openapi-leads.json POST /v1/leads/qualification_configurations/{id}","href":"/api/leads/leads-qualification-configurations/update"},{"title":"List all leads qualification configurations","openapi":"openapi-leads.json GET /v1/leads/qualification_configurations","href":"/api/leads/leads-qualification-configurations/list"},{"title":"Roll a leads qualification configuration form token","openapi":"openapi-leads.json POST /v1/leads/qualification_configurations/{id}/token","href":"/api/leads/leads-qualification-configurations/roll-token"}]},{"group":"Leads Qualification Routes","pages":[{"title":"The leads.qualification route object","href":"/api/leads/leads-qualification-routes/object"},{"title":"Create a qualification route","openapi":"openapi-leads.json POST /v1/leads/qualification_routes","href":"/api/leads/leads-qualification-routes/create"},{"title":"Retrieve a qualification route","openapi":"openapi-leads.json GET /v1/leads/qualification_routes/{id}","href":"/api/leads/leads-qualification-routes/retrieve"},{"title":"Update a qualification route","openapi":"openapi-leads.json POST /v1/leads/qualification_routes/{id}","href":"/api/leads/leads-qualification-routes/update"},{"title":"List all qualification routes","openapi":"openapi-leads.json GET /v1/leads/qualification_routes","href":"/api/leads/leads-qualification-routes/list"}]},{"group":"Leads Viewings","pages":[{"title":"The leads.viewing object","href":"/api/leads/leads-viewings/object"},{"title":"Book a viewing","openapi":"openapi-leads.json POST /v1/leads/viewings","href":"/api/leads/leads-viewings/create"},{"title":"Retrieve a viewing","openapi":"openapi-leads.json GET /v1/leads/viewings/{id}","href":"/api/leads/leads-viewings/retrieve"},{"title":"Update a viewing","openapi":"openapi-leads.json POST /v1/leads/viewings/{id}","href":"/api/leads/leads-viewings/update"},{"title":"List all viewings","openapi":"openapi-leads.json GET /v1/leads/viewings","href":"/api/leads/leads-viewings/list"},{"title":"List bookable viewing slots","openapi":"openapi-leads.json GET /v1/leads/viewings/slots","href":"/api/leads/leads-viewings/slots"},{"title":"Transition a viewing status","openapi":"openapi-leads.json POST /v1/leads/viewings/{id}/status","href":"/api/leads/leads-viewings/status"}]}]},{"group":"Leasing","pages":[{"group":"Applications","pages":[{"title":"The application object","href":"/api/leasing/applications/object"},{"title":"Create an application","openapi":"openapi-leasing.json POST /v1/applications","href":"/api/leasing/applications/create"},{"title":"Retrieve an application","openapi":"openapi-leasing.json GET /v1/applications/{id}","href":"/api/leasing/applications/retrieve"},{"title":"Update an application","openapi":"openapi-leasing.json POST /v1/applications/{id}","href":"/api/leasing/applications/update"},{"title":"List all applications","openapi":"openapi-leasing.json GET /v1/applications","href":"/api/leasing/applications/list"},{"title":"Accept an application","openapi":"openapi-leasing.json POST /v1/applications/{id}/accept","href":"/api/leasing/applications/accept"},{"title":"Cancel an application","openapi":"openapi-leasing.json POST /v1/applications/{id}/cancel","href":"/api/leasing/applications/cancel"},{"title":"Complete an application","openapi":"openapi-leasing.json POST /v1/applications/{id}/complete","href":"/api/leasing/applications/complete"},{"title":"List all applicants for an application","openapi":"openapi-leasing.json GET /v1/applications/{id}/applicants","href":"/api/leasing/applications/list-applicants"},{"title":"Mark an applicant as paid","openapi":"openapi-leasing.json POST /v1/applications/{id}/applicants/{applicantId}/mark_paid","href":"/api/leasing/applications/mark-applicant-paid"},{"title":"Progress an application","openapi":"openapi-leasing.json POST /v1/applications/{id}/progress","href":"/api/leasing/applications/progress"},{"title":"Retrieve an applicant","openapi":"openapi-leasing.json GET /v1/applications/{id}/applicants/{applicantId}","href":"/api/leasing/applications/retrieve-applicant"},{"title":"Revert a step","openapi":"openapi-leasing.json POST /v1/applications/{id}/steps/{stepId}/revert","href":"/api/leasing/applications/revert-step"},{"title":"Update an applicant","openapi":"openapi-leasing.json POST /v1/applications/{id}/applicants/{applicantId}","href":"/api/leasing/applications/update-applicant"}]},{"group":"Application Configurations","pages":[{"title":"The application configuration object","href":"/api/leasing/application-configurations/object"},{"title":"Create an application configuration","openapi":"openapi-leasing.json POST /v1/application_configurations","href":"/api/leasing/application-configurations/create"},{"title":"Retrieve an application configuration","openapi":"openapi-leasing.json GET /v1/application_configurations/{id}","href":"/api/leasing/application-configurations/retrieve"},{"title":"Update an application configuration","openapi":"openapi-leasing.json POST /v1/application_configurations/{id}","href":"/api/leasing/application-configurations/update"},{"title":"List all application configurations","openapi":"openapi-leasing.json GET /v1/application_configurations","href":"/api/leasing/application-configurations/list"}]},{"group":"Application Sessions","pages":[{"title":"Create an application session","openapi":"openapi-leasing.json POST /v1/application_sessions","href":"/api/leasing/application-sessions/create"}]},{"group":"Application Events","pages":[{"title":"Create an application event","openapi":"openapi-leasing.json POST /v1/applications/{id}/events","href":"/api/leasing/applications-events/create"},{"title":"List all application events","openapi":"openapi-leasing.json GET /v1/applications/{id}/events","href":"/api/leasing/applications-events/list"}]},{"group":"Deposit Charges","pages":[{"title":"The deposit charge object","href":"/api/leasing/deposits-charges/object"},{"title":"Create a deposit charge","openapi":"openapi-leasing.json POST /v1/deposits/{id}/charges","href":"/api/leasing/deposits-charges/create"},{"title":"Retrieve a deposit charge","openapi":"openapi-leasing.json GET /v1/deposits/{id}/charges/{chargeId}","href":"/api/leasing/deposits-charges/retrieve"},{"title":"Update a deposit charge","openapi":"openapi-leasing.json POST /v1/deposits/{id}/charges/{chargeId}","href":"/api/leasing/deposits-charges/update"},{"title":"List all deposit charges","openapi":"openapi-leasing.json GET /v1/deposits/{id}/charges","href":"/api/leasing/deposits-charges/list"},{"title":"Delete a deposit charge","openapi":"openapi-leasing.json DELETE /v1/deposits/{id}/charges/{chargeId}","href":"/api/leasing/deposits-charges/delete"},{"title":"Accept a deposit charge","openapi":"openapi-leasing.json POST /v1/deposits/{id}/charges/{chargeId}/accept","href":"/api/leasing/deposits-charges/accept"},{"title":"Cancel a deposit charge","openapi":"openapi-leasing.json POST /v1/deposits/{id}/charges/{chargeId}/cancel","href":"/api/leasing/deposits-charges/cancel"},{"title":"Dispute a deposit charge","openapi":"openapi-leasing.json POST /v1/deposits/{id}/charges/{chargeId}/dispute","href":"/api/leasing/deposits-charges/dispute"}]},{"group":"Deposits","pages":[{"title":"The deposit object","href":"/api/leasing/deposits/object"},{"title":"Create a deposit","openapi":"openapi-leasing.json POST /v1/deposits","href":"/api/leasing/deposits/create"},{"title":"Retrieve a deposit","openapi":"openapi-leasing.json GET /v1/deposits/{id}","href":"/api/leasing/deposits/retrieve"},{"title":"Update a deposit","openapi":"openapi-leasing.json POST /v1/deposits/{id}","href":"/api/leasing/deposits/update"},{"title":"List all deposits","openapi":"openapi-leasing.json GET /v1/deposits","href":"/api/leasing/deposits/list"},{"title":"Delete a deposit","openapi":"openapi-leasing.json DELETE /v1/deposits/{id}","href":"/api/leasing/deposits/delete"},{"title":"Activate a deposit","openapi":"openapi-leasing.json POST /v1/deposits/{id}/activate","href":"/api/leasing/deposits/activate"},{"title":"Mark a deposit as returned","openapi":"openapi-leasing.json POST /v1/deposits/{id}/mark_returned","href":"/api/leasing/deposits/mark-returned"},{"title":"Return a deposit","openapi":"openapi-leasing.json POST /v1/deposits/{id}/return","href":"/api/leasing/deposits/return"},{"title":"Mark a deposit as transferred","openapi":"openapi-leasing.json POST /v1/deposits/{id}/transfer","href":"/api/leasing/deposits/transfer"}]},{"group":"Guarantors","pages":[{"title":"The guarantor object","href":"/api/leasing/guarantors/object"},{"title":"Create a guarantor","openapi":"openapi-leasing.json POST /v1/guarantors","href":"/api/leasing/guarantors/create"},{"title":"Retrieve a guarantor","openapi":"openapi-leasing.json GET /v1/guarantors/{id}","href":"/api/leasing/guarantors/retrieve"},{"title":"Detach a guarantor","openapi":"openapi-leasing.json POST /v1/guarantors/{id}/detach","href":"/api/leasing/guarantors/detach"}]},{"group":"References","pages":[{"title":"The reference object","href":"/api/leasing/references/object"},{"title":"Create a reference","openapi":"openapi-leasing.json POST /v1/references","href":"/api/leasing/references/create"},{"title":"Retrieve a reference","openapi":"openapi-leasing.json GET /v1/references/{id}","href":"/api/leasing/references/retrieve"},{"title":"Update a reference","openapi":"openapi-leasing.json POST /v1/references/{id}","href":"/api/leasing/references/update"},{"title":"List all references","openapi":"openapi-leasing.json GET /v1/references","href":"/api/leasing/references/list"},{"title":"Cancel a reference","openapi":"openapi-leasing.json POST /v1/references/{id}/cancel","href":"/api/leasing/references/cancel"}]},{"group":"Renewal Intents","pages":[{"title":"The renewal intent object","href":"/api/leasing/renewal-intents/object"},{"title":"Create a renewal intent","openapi":"openapi-leasing.json POST /v1/renewal_intents","href":"/api/leasing/renewal-intents/create"},{"title":"Retrieve a renewal intent","openapi":"openapi-leasing.json GET /v1/renewal_intents/{id}","href":"/api/leasing/renewal-intents/retrieve"},{"title":"Update a renewal intent","openapi":"openapi-leasing.json POST /v1/renewal_intents/{id}","href":"/api/leasing/renewal-intents/update"},{"title":"List all renewal intents","openapi":"openapi-leasing.json GET /v1/renewal_intents","href":"/api/leasing/renewal-intents/list"},{"title":"Cancel a renewal intent","openapi":"openapi-leasing.json POST /v1/renewal_intents/{id}/cancel","href":"/api/leasing/renewal-intents/cancel"},{"title":"Complete a renewal intent","openapi":"openapi-leasing.json POST /v1/renewal_intents/{id}/complete","href":"/api/leasing/renewal-intents/complete"},{"title":"Reverse an effective rent increase","openapi":"openapi-leasing.json POST /v1/renewal_intents/{id}/reverse","href":"/api/leasing/renewal-intents/reverse"},{"title":"Send the rent increase notice email","openapi":"openapi-leasing.json POST /v1/renewal_intents/{id}/send_notice_email","href":"/api/leasing/renewal-intents/send-notice-email"}]},{"group":"Tenancies","pages":[{"title":"The tenancy object","href":"/api/leasing/tenancies/object"},{"title":"Retrieve a tenancy","openapi":"openapi-leasing.json GET /v1/tenancies/{id}","href":"/api/leasing/tenancies/retrieve"},{"title":"Update a tenancy","openapi":"openapi-leasing.json POST /v1/tenancies/{id}","href":"/api/leasing/tenancies/update"},{"title":"List all tenancies","openapi":"openapi-leasing.json GET /v1/tenancies","href":"/api/leasing/tenancies/list"},{"title":"Cancel a tenancy","openapi":"openapi-leasing.json POST /v1/tenancies/{id}/cancel","href":"/api/leasing/tenancies/cancel"},{"title":"Send compliance documents","openapi":"openapi-leasing.json POST /v1/tenancies/{id}/send_compliance","href":"/api/leasing/tenancies/send-compliance"},{"title":"Stop a scheduled tenancy cancellation","openapi":"openapi-leasing.json POST /v1/tenancies/{id}/stop_cancellation","href":"/api/leasing/tenancies/stop-cancellation"}]}]},{"group":"Loyalty","pages":[{"group":"Loyalty Messages","pages":[{"title":"The loyalty.message object","href":"/api/loyalty/loyalty-messages/object"},{"title":"Create a message","openapi":"openapi-loyalty.json POST /v1/loyalty/messages","href":"/api/loyalty/loyalty-messages/create"},{"title":"Retrieve a message","openapi":"openapi-loyalty.json GET /v1/loyalty/messages/{id}","href":"/api/loyalty/loyalty-messages/retrieve"},{"title":"List all messages","openapi":"openapi-loyalty.json GET /v1/loyalty/messages","href":"/api/loyalty/loyalty-messages/list"}]},{"group":"Loyalty Program Event Adjustments","pages":[{"title":"Create a loyalty program event adjustment","openapi":"openapi-loyalty.json POST /v1/loyalty/program_event_adjustments","href":"/api/loyalty/loyalty-program-event-adjustments/create"}]},{"group":"Loyalty Program Events","pages":[{"title":"Create a loyalty program event","openapi":"openapi-loyalty.json POST /v1/loyalty/program_events","href":"/api/loyalty/loyalty-program-events/create"},{"title":"List all loyalty program events","openapi":"openapi-loyalty.json GET /v1/loyalty/program_events","href":"/api/loyalty/loyalty-program-events/list"}]},{"group":"Loyalty Programs","pages":[{"title":"The loyalty.program object","href":"/api/loyalty/loyalty-programs/object"},{"title":"Create a loyalty program","openapi":"openapi-loyalty.json POST /v1/loyalty/programs","href":"/api/loyalty/loyalty-programs/create"},{"title":"Retrieve a loyalty program","openapi":"openapi-loyalty.json GET /v1/loyalty/programs/{id}","href":"/api/loyalty/loyalty-programs/retrieve"},{"title":"Update a loyalty program","openapi":"openapi-loyalty.json POST /v1/loyalty/programs/{id}","href":"/api/loyalty/loyalty-programs/update"},{"title":"List all loyalty programs","openapi":"openapi-loyalty.json GET /v1/loyalty/programs","href":"/api/loyalty/loyalty-programs/list"}]},{"group":"Residents","pages":[{"title":"The resident object","href":"/api/loyalty/loyalty-residents/object"},{"title":"Create a resident","openapi":"openapi-loyalty.json POST /v1/loyalty/residents","href":"/api/loyalty/loyalty-residents/create"},{"title":"Retrieve a resident","openapi":"openapi-loyalty.json GET /v1/loyalty/residents/{id}","href":"/api/loyalty/loyalty-residents/retrieve"},{"title":"Update a resident","openapi":"openapi-loyalty.json POST /v1/loyalty/residents/{id}","href":"/api/loyalty/loyalty-residents/update"},{"title":"List all residents","openapi":"openapi-loyalty.json GET /v1/loyalty/residents","href":"/api/loyalty/loyalty-residents/list"}]},{"group":"Tiers","pages":[{"title":"The loyalty.tier object","href":"/api/loyalty/loyalty-tiers/object"},{"title":"Create a tier","openapi":"openapi-loyalty.json POST /v1/loyalty/tiers","href":"/api/loyalty/loyalty-tiers/create"},{"title":"Retrieve a tier","openapi":"openapi-loyalty.json GET /v1/loyalty/tiers/{id}","href":"/api/loyalty/loyalty-tiers/retrieve"},{"title":"Update a tier","openapi":"openapi-loyalty.json POST /v1/loyalty/tiers/{id}","href":"/api/loyalty/loyalty-tiers/update"},{"title":"List all tiers","openapi":"openapi-loyalty.json GET /v1/loyalty/tiers","href":"/api/loyalty/loyalty-tiers/list"}]}]},{"group":"Maintenance","pages":[{"group":"Maintenance Issues","pages":[{"title":"The maintenance.issue object","href":"/api/maintenance/maintenance-issues/object"},{"title":"Create a maintenance issue","openapi":"openapi-maintenance.json POST /v1/maintenance/issues","href":"/api/maintenance/maintenance-issues/create"},{"title":"Retrieve a maintenance issue","openapi":"openapi-maintenance.json GET /v1/maintenance/issues/{id}","href":"/api/maintenance/maintenance-issues/retrieve"},{"title":"Update a maintenance issue","openapi":"openapi-maintenance.json POST /v1/maintenance/issues/{id}","href":"/api/maintenance/maintenance-issues/update"},{"title":"List all maintenance issues","openapi":"openapi-maintenance.json GET /v1/maintenance/issues","href":"/api/maintenance/maintenance-issues/list"},{"title":"Delete a maintenance issue","openapi":"openapi-maintenance.json DELETE /v1/maintenance/issues/{id}","href":"/api/maintenance/maintenance-issues/delete"},{"title":"List maintenance issue attachments","openapi":"openapi-maintenance.json GET /v1/maintenance/issues/{id}/attachments","href":"/api/maintenance/maintenance-issues/attachments"},{"title":"Mark maintenance issue chat as read","openapi":"openapi-maintenance.json POST /v1/maintenance/issues/{id}/read","href":"/api/maintenance/maintenance-issues/read"}]},{"group":"Maintenance Jobs","pages":[{"title":"The maintenance.job object","href":"/api/maintenance/maintenance-jobs/object"},{"title":"Create a maintenance job","openapi":"openapi-maintenance.json POST /v1/maintenance/jobs","href":"/api/maintenance/maintenance-jobs/create"},{"title":"Retrieve a maintenance job","openapi":"openapi-maintenance.json GET /v1/maintenance/jobs/{id}","href":"/api/maintenance/maintenance-jobs/retrieve"},{"title":"Update a maintenance job","openapi":"openapi-maintenance.json POST /v1/maintenance/jobs/{id}","href":"/api/maintenance/maintenance-jobs/update"},{"title":"List all maintenance jobs","openapi":"openapi-maintenance.json GET /v1/maintenance/jobs","href":"/api/maintenance/maintenance-jobs/list"},{"title":"Delete a maintenance job","openapi":"openapi-maintenance.json DELETE /v1/maintenance/jobs/{id}","href":"/api/maintenance/maintenance-jobs/delete"},{"title":"Assign a maintenance job","openapi":"openapi-maintenance.json POST /v1/maintenance/jobs/{id}/assign","href":"/api/maintenance/maintenance-jobs/assign"},{"title":"List attachments for a maintenance job","openapi":"openapi-maintenance.json GET /v1/maintenance/jobs/{id}/attachments","href":"/api/maintenance/maintenance-jobs/attachments"},{"title":"Cancel a maintenance job","openapi":"openapi-maintenance.json POST /v1/maintenance/jobs/{id}/cancel","href":"/api/maintenance/maintenance-jobs/cancel"},{"title":"Complete a maintenance job","openapi":"openapi-maintenance.json POST /v1/maintenance/jobs/{id}/complete","href":"/api/maintenance/maintenance-jobs/complete"},{"title":"Record a landlord’s decision on a maintenance job","openapi":"openapi-maintenance.json POST /v1/maintenance/jobs/{id}/record_landlord_approval","href":"/api/maintenance/maintenance-jobs/record-landlord-approval"},{"title":"Request landlord approval for a maintenance job","openapi":"openapi-maintenance.json POST /v1/maintenance/jobs/{id}/request_landlord_approval","href":"/api/maintenance/maintenance-jobs/request-landlord-approval"},{"title":"Schedule a maintenance job","openapi":"openapi-maintenance.json POST /v1/maintenance/jobs/{id}/schedule","href":"/api/maintenance/maintenance-jobs/schedule"}]},{"group":"Maintenance Messages","pages":[{"title":"The maintenance.message object","href":"/api/maintenance/maintenance-messages/object"},{"title":"Send a maintenance message","openapi":"openapi-maintenance.json POST /v1/maintenance/messages","href":"/api/maintenance/maintenance-messages/create"},{"title":"Retrieve a maintenance message","openapi":"openapi-maintenance.json GET /v1/maintenance/messages/{id}","href":"/api/maintenance/maintenance-messages/retrieve"},{"title":"List maintenance messages","openapi":"openapi-maintenance.json GET /v1/maintenance/messages","href":"/api/maintenance/maintenance-messages/list"}]},{"group":"Maintenance Quotes","pages":[{"title":"The maintenance.quote object","href":"/api/maintenance/maintenance-quotes/object"},{"title":"Create a maintenance quote","openapi":"openapi-maintenance.json POST /v1/maintenance/quotes","href":"/api/maintenance/maintenance-quotes/create"},{"title":"Retrieve a maintenance quote","openapi":"openapi-maintenance.json GET /v1/maintenance/quotes/{id}","href":"/api/maintenance/maintenance-quotes/retrieve"},{"title":"Update a maintenance quote","openapi":"openapi-maintenance.json POST /v1/maintenance/quotes/{id}","href":"/api/maintenance/maintenance-quotes/update"},{"title":"List all maintenance quotes","openapi":"openapi-maintenance.json GET /v1/maintenance/quotes","href":"/api/maintenance/maintenance-quotes/list"},{"title":"Delete a maintenance quote","openapi":"openapi-maintenance.json DELETE /v1/maintenance/quotes/{id}","href":"/api/maintenance/maintenance-quotes/delete"},{"title":"Approve a maintenance quote","openapi":"openapi-maintenance.json POST /v1/maintenance/quotes/{id}/approve","href":"/api/maintenance/maintenance-quotes/approve"},{"title":"Reject a maintenance quote","openapi":"openapi-maintenance.json POST /v1/maintenance/quotes/{id}/reject","href":"/api/maintenance/maintenance-quotes/reject"},{"title":"Request a maintenance quote","openapi":"openapi-maintenance.json POST /v1/maintenance/quotes/{id}/request","href":"/api/maintenance/maintenance-quotes/request"}]},{"group":"Maintenance Triage","pages":[{"title":"Triage a maintenance issue","openapi":"openapi-maintenance.json POST /v1/maintenance/triage","href":"/api/maintenance/maintenance-triage/create"}]}]},{"group":"Owners","pages":[{"group":"Account Collection Subscriptions","pages":[{"title":"The account collection subscription object","href":"/api/owners/account-collection-subscriptions/object"},{"title":"Create an account collection subscription","openapi":"openapi-owners.json POST /v1/account_collection_subscriptions","href":"/api/owners/account-collection-subscriptions/create"},{"title":"Retrieve an account collection subscription","openapi":"openapi-owners.json GET /v1/account_collection_subscriptions/{id}","href":"/api/owners/account-collection-subscriptions/retrieve"},{"title":"List all account collection subscriptions","openapi":"openapi-owners.json GET /v1/account_collection_subscriptions","href":"/api/owners/account-collection-subscriptions/list"},{"title":"Cancel an account collection subscription","openapi":"openapi-owners.json POST /v1/account_collection_subscriptions/{id}/cancel","href":"/api/owners/account-collection-subscriptions/cancel"}]},{"group":"Account Collections","pages":[{"title":"The account collection object","href":"/api/owners/account-collections/object"},{"title":"Create an account collection","openapi":"openapi-owners.json POST /v1/account_collections","href":"/api/owners/account-collections/create"},{"title":"Retrieve an account collection","openapi":"openapi-owners.json GET /v1/account_collections/{id}","href":"/api/owners/account-collections/retrieve"},{"title":"List all account collections","openapi":"openapi-owners.json GET /v1/account_collections","href":"/api/owners/account-collections/list"},{"title":"Approve an account collection","openapi":"openapi-owners.json POST /v1/account_collections/{id}/approve","href":"/api/owners/account-collections/approve"},{"title":"Cancel an account collection","openapi":"openapi-owners.json POST /v1/account_collections/{id}/cancel","href":"/api/owners/account-collections/cancel"}]},{"group":"Onboarding Sessions","pages":[{"title":"Create an onboarding session","openapi":"openapi-owners.json POST /v1/owners/{id}/onboarding","href":"/api/owners/owners-onboarding/create"}]},{"group":"Owner Balance Transactions","pages":[{"title":"The owner balance transaction object","href":"/api/owners/owner-balance-transactions/object"},{"title":"Create an owner balance transaction","openapi":"openapi-owners.json POST /v1/owner_balance_transactions","href":"/api/owners/owner-balance-transactions/create"},{"title":"Retrieve an owner balance transaction","openapi":"openapi-owners.json GET /v1/owner_balance_transactions/{id}","href":"/api/owners/owner-balance-transactions/retrieve"},{"title":"Update an owner balance transaction","openapi":"openapi-owners.json POST /v1/owner_balance_transactions/{id}","href":"/api/owners/owner-balance-transactions/update"},{"title":"List all owner balance transactions","openapi":"openapi-owners.json GET /v1/owner_balance_transactions","href":"/api/owners/owner-balance-transactions/list"}]},{"group":"Owner Payments","pages":[{"title":"The owner payment object","href":"/api/owners/owner-payments/object"},{"title":"Retrieve an owner payment","openapi":"openapi-owners.json GET /v1/owner_payments/{id}","href":"/api/owners/owner-payments/retrieve"},{"title":"Update an owner payment","openapi":"openapi-owners.json POST /v1/owner_payments/{id}","href":"/api/owners/owner-payments/update"},{"title":"List all owner payments","openapi":"openapi-owners.json GET /v1/owner_payments","href":"/api/owners/owner-payments/list"}]},{"group":"Owner Payouts","pages":[{"title":"The owner payout object","href":"/api/owners/owner-payouts/object"},{"title":"Create an owner payout","openapi":"openapi-owners.json POST /v1/owner_payouts","href":"/api/owners/owner-payouts/create"},{"title":"Retrieve an owner payout","openapi":"openapi-owners.json GET /v1/owner_payouts/{id}","href":"/api/owners/owner-payouts/retrieve"},{"title":"List all owner payouts","openapi":"openapi-owners.json GET /v1/owner_payouts","href":"/api/owners/owner-payouts/list"},{"title":"Approve an owner payout","openapi":"openapi-owners.json POST /v1/owner_payouts/{id}/approve","href":"/api/owners/owner-payouts/approve"},{"title":"Cancel an owner payout","openapi":"openapi-owners.json POST /v1/owner_payouts/{id}/cancel","href":"/api/owners/owner-payouts/cancel"},{"title":"Mark an owner payout as failed","openapi":"openapi-owners.json POST /v1/owner_payouts/{id}/mark_failed","href":"/api/owners/owner-payouts/mark-failed"},{"title":"Mark an owner payout as paid","openapi":"openapi-owners.json POST /v1/owner_payouts/{id}/mark_paid","href":"/api/owners/owner-payouts/mark-paid"},{"title":"Pay an owner payout","openapi":"openapi-owners.json POST /v1/owner_payouts/{id}/pay","href":"/api/owners/owner-payouts/pay"},{"title":"Preview an owner payout","openapi":"openapi-owners.json POST /v1/owner_payouts/preview","href":"/api/owners/owner-payouts/preview"},{"title":"Preview an owner payout approval","openapi":"openapi-owners.json POST /v1/owner_payouts/{id}/approve/preview","href":"/api/owners/owner-payouts/preview-approve"},{"title":"Send an owner payout receipt","openapi":"openapi-owners.json POST /v1/owner_payouts/{id}/send_receipt","href":"/api/owners/owner-payouts/send-receipt"}]},{"group":"Owners","pages":[{"title":"The owner object","href":"/api/owners/owners/object"},{"title":"Create an owner","openapi":"openapi-owners.json POST /v1/owners","href":"/api/owners/owners/create"},{"title":"Retrieve an owner","openapi":"openapi-owners.json GET /v1/owners/{id}","href":"/api/owners/owners/retrieve"},{"title":"Update an owner","openapi":"openapi-owners.json POST /v1/owners/{id}","href":"/api/owners/owners/update"},{"title":"List all owners","openapi":"openapi-owners.json GET /v1/owners","href":"/api/owners/owners/list"},{"title":"Delete an owner","openapi":"openapi-owners.json DELETE /v1/owners/{id}","href":"/api/owners/owners/delete"},{"title":"Invite a supplier to the portal","openapi":"openapi-owners.json POST /v1/owners/{id}/invite","href":"/api/owners/owners/invite"}]},{"group":"Owner Persons","pages":[{"title":"The owner.person object","href":"/api/owners/owners-persons/object"},{"title":"Create a person","openapi":"openapi-owners.json POST /v1/owners/{id}/persons","href":"/api/owners/owners-persons/create"},{"title":"Retrieve a person","openapi":"openapi-owners.json GET /v1/owners/{id}/persons/{personId}","href":"/api/owners/owners-persons/retrieve"},{"title":"Update a person","openapi":"openapi-owners.json POST /v1/owners/{id}/persons/{personId}","href":"/api/owners/owners-persons/update"},{"title":"List all persons","openapi":"openapi-owners.json GET /v1/owners/{id}/persons","href":"/api/owners/owners-persons/list"},{"title":"Delete a person","openapi":"openapi-owners.json DELETE /v1/owners/{id}/persons/{personId}","href":"/api/owners/owners-persons/delete"}]},{"group":"Payment Runs","pages":[{"title":"The payment run object","href":"/api/owners/payment-runs/object"},{"title":"Create a payment run","openapi":"openapi-owners.json POST /v1/payment_runs","href":"/api/owners/payment-runs/create"},{"title":"Retrieve a payment run","openapi":"openapi-owners.json GET /v1/payment_runs/{id}","href":"/api/owners/payment-runs/retrieve"},{"title":"List all payment runs","openapi":"openapi-owners.json GET /v1/payment_runs","href":"/api/owners/payment-runs/list"},{"title":"Approve a payment run","openapi":"openapi-owners.json POST /v1/payment_runs/{id}/approve","href":"/api/owners/payment-runs/approve"},{"title":"Cancel a payment run","openapi":"openapi-owners.json POST /v1/payment_runs/{id}/cancel","href":"/api/owners/payment-runs/cancel"}]},{"group":"Tax Filings","pages":[{"title":"The tax filing object","href":"/api/owners/tax-filings/object"},{"title":"Create a tax filing","openapi":"openapi-owners.json POST /v1/tax_filings","href":"/api/owners/tax-filings/create"},{"title":"Retrieve a tax filing","openapi":"openapi-owners.json GET /v1/tax_filings/{id}","href":"/api/owners/tax-filings/retrieve"},{"title":"List all tax filings","openapi":"openapi-owners.json GET /v1/tax_filings","href":"/api/owners/tax-filings/list"}]},{"group":"Tax Forms","pages":[{"title":"The tax form object","href":"/api/owners/tax-forms/object"},{"title":"Create a tax form","openapi":"openapi-owners.json POST /v1/tax_forms","href":"/api/owners/tax-forms/create"},{"title":"Retrieve a tax form","openapi":"openapi-owners.json GET /v1/tax_forms/{id}","href":"/api/owners/tax-forms/retrieve"},{"title":"List all tax forms","openapi":"openapi-owners.json GET /v1/tax_forms","href":"/api/owners/tax-forms/list"},{"title":"Delete a tax form","openapi":"openapi-owners.json DELETE /v1/tax_forms/{id}","href":"/api/owners/tax-forms/delete"}]},{"group":"Transfer Reversals","pages":[{"title":"The transfer reversal object","href":"/api/owners/transfers-reversals/object"},{"title":"Create a transfer reversal","openapi":"openapi-owners.json POST /v1/transfers/{id}/reversals","href":"/api/owners/transfers-reversals/create"},{"title":"Retrieve a transfer reversal","openapi":"openapi-owners.json GET /v1/transfers/{id}/reversals/{id}","href":"/api/owners/transfers-reversals/retrieve"},{"title":"Update a transfer reversal","openapi":"openapi-owners.json POST /v1/transfers/{id}/reversals/{id}","href":"/api/owners/transfers-reversals/update"},{"title":"List all transfer reversals","openapi":"openapi-owners.json GET /v1/transfers/{id}/reversals","href":"/api/owners/transfers-reversals/list"}]},{"group":"Transfers","pages":[{"title":"The transfer object","href":"/api/owners/transfers/object"},{"title":"Create a transfer","openapi":"openapi-owners.json POST /v1/transfers","href":"/api/owners/transfers/create"},{"title":"Retrieve a transfer","openapi":"openapi-owners.json GET /v1/transfers/{id}","href":"/api/owners/transfers/retrieve"},{"title":"Update a transfer","openapi":"openapi-owners.json POST /v1/transfers/{id}","href":"/api/owners/transfers/update"},{"title":"List all transfers","openapi":"openapi-owners.json GET /v1/transfers","href":"/api/owners/transfers/list"}]}]},{"group":"Payments","pages":[{"group":"Balance","pages":[{"title":"The balance object","href":"/api/payments/balance/object"},{"title":"Retrieve owner balance","openapi":"openapi-payments.json GET /v1/balance/owners","href":"/api/payments/balance/retrieve"},{"title":"Retrieve owner balance","openapi":"openapi-payments.json GET /v1/balance/owners","href":"/api/payments/balance/retrieve"}]},{"group":"Balance Transactions","pages":[{"title":"List all balance transactions","openapi":"openapi-payments.json GET /v1/balance_transactions","href":"/api/payments/balance-transactions/list"}]},{"group":"Disputes","pages":[{"title":"The dispute object","href":"/api/payments/disputes/object"},{"title":"Retrieve a dispute","openapi":"openapi-payments.json GET /v1/disputes/{id}","href":"/api/payments/disputes/retrieve"},{"title":"Update a dispute","openapi":"openapi-payments.json POST /v1/disputes/{id}","href":"/api/payments/disputes/update"},{"title":"List all disputes","openapi":"openapi-payments.json GET /v1/disputes","href":"/api/payments/disputes/list"},{"title":"Mark a dispute as resolved","openapi":"openapi-payments.json POST /v1/disputes/{id}/mark_resolved","href":"/api/payments/disputes/mark-resolved"},{"title":"Submit dispute evidence","openapi":"openapi-payments.json POST /v1/disputes/{id}/submit_evidence","href":"/api/payments/disputes/submit-evidence"}]},{"group":"External Accounts","pages":[{"title":"The external account object","href":"/api/payments/external-accounts/object"},{"title":"Create an external account","openapi":"openapi-payments.json POST /v1/external_accounts","href":"/api/payments/external-accounts/create"},{"title":"Retrieve an external account","openapi":"openapi-payments.json GET /v1/external_accounts/{id}","href":"/api/payments/external-accounts/retrieve"},{"title":"List all external accounts","openapi":"openapi-payments.json GET /v1/external_accounts","href":"/api/payments/external-accounts/list"},{"title":"Delete an external account","openapi":"openapi-payments.json DELETE /v1/external_accounts/{id}","href":"/api/payments/external-accounts/delete"},{"title":"Acknowledge the confirmation of payee","openapi":"openapi-payments.json POST /v1/external_accounts/{id}/acknowledge_confirmation_of_payee","href":"/api/payments/external-accounts/acknowledge-confirmation-of-payee"}]},{"group":"Payment Initiations","pages":[{"title":"The payment initiation object","href":"/api/payments/payment-initiations/object"},{"title":"Create a payment initiation","openapi":"openapi-payments.json POST /v1/payment_initiations","href":"/api/payments/payment-initiations/create"},{"title":"Retrieves a payment initiation","openapi":"openapi-payments.json GET /v1/payment_initiations/{id}","href":"/api/payments/payment-initiations/retrieve"},{"title":"List all payment initiations","openapi":"openapi-payments.json GET /v1/payment_initiations","href":"/api/payments/payment-initiations/list"},{"title":"Create a payment initiation token","openapi":"openapi-payments.json POST /v1/payment_initiations/{id}/tokens","href":"/api/payments/payment-initiations/token"}]},{"group":"Payment Method Sessions","pages":[{"title":"The payment method session object","href":"/api/payments/payment-method-sessions/object"},{"title":"Create a payment method session","openapi":"openapi-payments.json POST /v1/payment_method_sessions","href":"/api/payments/payment-method-sessions/create"},{"title":"Retrieve a payment method session","openapi":"openapi-payments.json GET /v1/payment_method_sessions/{id}","href":"/api/payments/payment-method-sessions/retrieve"}]},{"group":"Payment Methods","pages":[{"title":"The payment method object","href":"/api/payments/payment-methods/object"},{"title":"Create a payment method","openapi":"openapi-payments.json POST /v1/payment_methods","href":"/api/payments/payment-methods/create"},{"title":"Retrieve a payment method","openapi":"openapi-payments.json GET /v1/payment_methods/{id}","href":"/api/payments/payment-methods/retrieve"},{"title":"List all payment methods","openapi":"openapi-payments.json GET /v1/payment_methods","href":"/api/payments/payment-methods/list"},{"title":"Simulate a bank transfer","openapi":"openapi-payments.json POST /v1/payment_methods/{id}/fund_bank_transfer","href":"/api/payments/payment-methods/fund-bank-transfer"},{"title":"Set up a payment method","openapi":"openapi-payments.json POST /v1/payment_methods/setup","href":"/api/payments/payment-methods/setup"}]},{"group":"Payment Sessions","pages":[{"title":"The payment session object","href":"/api/payments/payment-sessions/object"},{"title":"Create a payment session","openapi":"openapi-payments.json POST /v1/payment_sessions","href":"/api/payments/payment-sessions/create"},{"title":"Retrieve a payment session","openapi":"openapi-payments.json GET /v1/payment_sessions/{id}","href":"/api/payments/payment-sessions/retrieve"},{"title":"List all payment sessions","openapi":"openapi-payments.json GET /v1/payment_sessions","href":"/api/payments/payment-sessions/list"},{"title":"Cancel a payment session","openapi":"openapi-payments.json POST /v1/payment_sessions/{id}/cancel","href":"/api/payments/payment-sessions/cancel"}]},{"group":"Refunds","pages":[{"title":"The refund object","href":"/api/payments/refunds/object"},{"title":"Create a refund","openapi":"openapi-payments.json POST /v1/refunds","href":"/api/payments/refunds/create"},{"title":"Retrieve a refund","openapi":"openapi-payments.json GET /v1/refunds/{id}","href":"/api/payments/refunds/retrieve"},{"title":"List all refunds","openapi":"openapi-payments.json GET /v1/refunds","href":"/api/payments/refunds/list"}]},{"group":"Transactions","pages":[{"title":"The transaction object","href":"/api/payments/transactions/object"},{"title":"Create a transaction","openapi":"openapi-payments.json POST /v1/transactions","href":"/api/payments/transactions/create"},{"title":"Retrieve a transaction","openapi":"openapi-payments.json GET /v1/transactions/{id}","href":"/api/payments/transactions/retrieve"},{"title":"Update a transaction","openapi":"openapi-payments.json POST /v1/transactions/{id}","href":"/api/payments/transactions/update"},{"title":"List all transactions","openapi":"openapi-payments.json GET /v1/transactions","href":"/api/payments/transactions/list"},{"title":"Cancel a transaction","openapi":"openapi-payments.json POST /v1/transactions/{id}/cancel","href":"/api/payments/transactions/cancel"},{"title":"Confirm a transaction","openapi":"openapi-payments.json POST /v1/transactions/{id}/confirm","href":"/api/payments/transactions/confirm"},{"title":"Resend a receipt for a transaction","openapi":"openapi-payments.json POST /v1/transactions/{id}/resend_receipt","href":"/api/payments/transactions/resend-receipt"},{"title":"Terminal handoff for a transaction","openapi":"openapi-payments.json POST /v1/transactions/{id}/terminal_handoff","href":"/api/payments/transactions/terminal-handoff"}]}]},{"group":"Terminal","pages":[{"group":"Terminal Locations","pages":[{"title":"The terminal.location object","href":"/api/terminal/terminal-locations/object"},{"title":"Create a terminal location","openapi":"openapi-terminal.json POST /v1/terminal/locations","href":"/api/terminal/terminal-locations/create"},{"title":"Retrieve a terminal location","openapi":"openapi-terminal.json GET /v1/terminal/locations/{id}","href":"/api/terminal/terminal-locations/retrieve"},{"title":"Update a terminal location","openapi":"openapi-terminal.json POST /v1/terminal/locations/{id}","href":"/api/terminal/terminal-locations/update"},{"title":"List all terminal locations","openapi":"openapi-terminal.json GET /v1/terminal/locations","href":"/api/terminal/terminal-locations/list"}]},{"group":"Terminal Offers","pages":[{"title":"The terminal.offer object","href":"/api/terminal/terminal-offers/object"},{"title":"Create a terminal offer","openapi":"openapi-terminal.json POST /v1/terminal/offers","href":"/api/terminal/terminal-offers/create"},{"title":"Retrieve a terminal offer","openapi":"openapi-terminal.json GET /v1/terminal/offers/{id}","href":"/api/terminal/terminal-offers/retrieve"},{"title":"List all terminal offers","openapi":"openapi-terminal.json GET /v1/terminal/offers","href":"/api/terminal/terminal-offers/list"}]},{"group":"Terminal Readers","pages":[{"title":"Create a terminal reader","openapi":"openapi-terminal.json POST /v1/terminal/readers","href":"/api/terminal/terminal-readers/create"},{"title":"List all terminal readers","openapi":"openapi-terminal.json GET /v1/terminal/readers","href":"/api/terminal/terminal-readers/list"},{"title":"Cancel the action of a terminal reader","openapi":"openapi-terminal.json POST /v1/terminal/readers/{id}/cancel_action","href":"/api/terminal/terminal-readers/cancel-action"}]}]},{"group":"Test Helpers","pages":[{"group":"Test Helpers","pages":[{"title":"Simulate an inbound email","openapi":"openapi-test_helpers.json POST /v1/test_helpers/emails/inbound","href":"/api/test-helpers/test-helpers/email-simulate-inbound"},{"title":"Simulate the outcome of a reference","openapi":"openapi-test_helpers.json POST /v1/test_helpers/references/{id}/simulate_outcome","href":"/api/test-helpers/test-helpers/reference-simulate-outcome"},{"title":"Simulate the progression of a subscription","openapi":"openapi-test_helpers.json POST /v1/test_helpers/subscriptions/{id}/simulate_progress","href":"/api/test-helpers/test-helpers/subscription-simulate-progress"}]}]}]}]},"title":"Trace a payment - Yorlet Documentation","buildId":"dpl_22zLaHtK6fmmSqApXTTP5tC7UBZn","deploymentId":"dpl_22zLaHtK6fmmSqApXTTP5tC7UBZn","dynamics":[],"chunks":[]}
