Releases a unit to the market so it can be marketed and applied for. A unit that is still occupied can be released once its outgoing tenancy has an end date, which puts it in the to_let availability state ahead of the move-out.
The date the unit is available to let from. Defaults to the date already on the unit, which the tenancy lifecycle keeps in step with the outgoing tenancy.
The public URL an applicant can use to apply for this unit. Only present while the unit is released to the market and self-serve applications are enabled.
The letting state of the unit, derived from its status, offer, and release fields. Use this rather than status to decide whether the unit can be marketed or applied for.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
{"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.3990","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":{},"basePath":"","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":"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":"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":"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":"vite-origin","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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","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":"api/core/units/release","slug":"/api/core/units/release","pageMetadata":{"title":"Release a unit to the market","openapi":"openapi-core.json POST /v1/units/{id}/release","description":"Releases a unit to the market so it can be marketed and applied for. A unit that is still occupied can be released once its outgoing tenancy has an end date, which puts it in the `to_let` availability state ahead of the move-out.","href":"/api/core/units/release"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Releases a unit to the market so it can be marketed and applied for. A unit that is still occupied can be released once its outgoing tenancy has an end date, which puts it in the \", _jsx(_components.code, {\n children: \"to_let\"\n }), \" availability state ahead of the move-out.\"]\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{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":"Release a unit to the market","openapi":"openapi-core.json POST /v1/units/{id}/release","description":"Releases a unit to the market so it can be marketed and applied for. A unit that is still occupied can be released once its outgoing tenancy has an end date, which puts it in the `to_let` availability state ahead of the move-out.","href":"/api/core/units/release"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"units_release","summary":"Release a unit to the market","description":"Releases a unit to the market so it can be marketed and applied for. A unit that is still occupied can be released once its outgoing tenancy has an end date, which puts it in the `to_let` availability state ahead of the move-out.","tags":["Units"],"security":["126a8fd7-3efd-4d21-8755-1a8efdb9ac4d"],"parameters":["6b6dcf53-d308-4513-bacf-aff5b204d2fa"],"requestBody":"681d2a25-81cc-48fa-95da-ca5e746f24ac","responses":{"200":"130a5c14-49bc-4f74-b828-acb4c14d975b"},"method":"post","type":"path","servers":["108e2b56-95a2-4fd1-b324-c0c5c7fca619","7694ca65-c560-4e37-abef-2fbe8d0a8f34"],"path":"/v1/units/{id}/release","baseUrlOptions":["https://api.yorlet.com","https://api.yorlet.io"],"title":"Release a unit to the market","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6b6dcf53-d308-4513-bacf-aff5b204d2fa":{"schema":{"type":"string","description":"The id identifier.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"The id identifier.","name":"id","in":"path"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"available_from":{"oneOf":[{"type":"number","description":"The date the unit is available to let from. Defaults to the date already on the unit, which the tenancy lifecycle keeps in step with the outgoing tenancy.","uniqueKey":"available_from.oneOf.0","typeLabel":"number"},{"type":"null","description":"The date the unit is available to let from. Defaults to the date already on the unit, which the tenancy lifecycle keeps in step with the outgoing tenancy.","uniqueKey":"available_from.oneOf.1","typeLabel":"null"}],"uniqueKey":"available_from","typeLabel":"number | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"available_from":123}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"130a5c14-49bc-4f74-b828-acb4c14d975b":{"description":"Returns the unit object if the release succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the object.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"created":{"type":"number","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","isRequired":true,"uniqueKey":"created","typeLabel":"number"},"object":{"type":"string","enum":["unit"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"active":{"type":"boolean","description":"Whether the unit is currently active.","isRequired":true,"uniqueKey":"active","typeLabel":"boolean"},"address":{"type":"object","properties":{"line1":{"oneOf":[{"type":"string","uniqueKey":"address.line1.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","uniqueKey":"address.line2.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"address.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","uniqueKey":"address.country.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.country","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","uniqueKey":"address.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.postal_code","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"address.state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.state","typeLabel":"string | null"}},"description":"The physical address of the unit.","isRequired":true,"uniqueKey":"address","typeLabel":"object"},"apply_url":{"oneOf":[{"type":"string","description":"The public URL an applicant can use to apply for this unit. Only present while the unit is released to the market and self-serve applications are enabled.","isRequired":true,"uniqueKey":"apply_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The public URL an applicant can use to apply for this unit. Only present while the unit is released to the market and self-serve applications are enabled.","isRequired":true,"uniqueKey":"apply_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"apply_url","typeLabel":"string | null"},"availability":{"type":"object","properties":{"available_from":{"oneOf":[{"type":"number","description":"The date the unit is next expected to be available to let.","isRequired":true,"uniqueKey":"availability.available_from.oneOf.0","typeLabel":"number"},{"type":"null","description":"The date the unit is next expected to be available to let.","isRequired":true,"uniqueKey":"availability.available_from.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"availability.available_from","typeLabel":"number | null"},"held":{"type":"boolean","description":"Whether the unit has been deliberately held back from the market.","isRequired":true,"uniqueKey":"availability.held","typeLabel":"boolean"},"hold_reason":{"oneOf":[{"type":"string","enum":["works","owner_instruction","eviction","other",null],"description":"Why the unit is being held back from the market.","isRequired":true,"uniqueKey":"availability.hold_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["works","owner_instruction","eviction","other",null],"description":"Why the unit is being held back from the market.","isRequired":true,"uniqueKey":"availability.hold_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"availability.hold_reason","typeLabel":"enum\u003cstring> | null"},"released":{"type":"boolean","description":"Whether the unit has been released to the market and can be let.","isRequired":true,"uniqueKey":"availability.released","typeLabel":"boolean"},"released_at":{"oneOf":[{"type":"number","description":"The time at which the unit was released to the market.","isRequired":true,"uniqueKey":"availability.released_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"The time at which the unit was released to the market.","isRequired":true,"uniqueKey":"availability.released_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"availability.released_at","typeLabel":"number | null"},"state":{"type":"string","enum":["available","coming_available","held","maintenance","occupied","offline","to_let","under_offer","unmanaged"],"description":"The letting state of the unit.","isRequired":true,"uniqueKey":"availability.state","typeLabel":"enum\u003cstring>"},"tenancy":{"oneOf":[{"type":"string","description":"The ID of the tenancy currently occupying the unit.","isRequired":true,"uniqueKey":"availability.tenancy.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the tenancy currently occupying the unit.","isRequired":true,"uniqueKey":"availability.tenancy.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"availability.tenancy","typeLabel":"string | null"},"tenancy_end":{"oneOf":[{"type":"number","description":"The end date of the tenancy currently occupying the unit.","isRequired":true,"uniqueKey":"availability.tenancy_end.oneOf.0","typeLabel":"number"},{"type":"null","description":"The end date of the tenancy currently occupying the unit.","isRequired":true,"uniqueKey":"availability.tenancy_end.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"availability.tenancy_end","typeLabel":"number | null"}},"description":"The letting state of the unit, derived from its status, offer, and release fields. Use this rather than `status` to decide whether the unit can be marketed or applied for.","required":["available_from","held","hold_reason","released","released_at","state","tenancy","tenancy_end"],"isRequired":true,"uniqueKey":"availability","typeLabel":"object"},"available_from":{"oneOf":[{"type":"number","description":"The date the unit is available from.","isRequired":true,"uniqueKey":"available_from.oneOf.0","typeLabel":"number"},{"type":"null","description":"The date the unit is available from.","isRequired":true,"uniqueKey":"available_from.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"available_from","typeLabel":"number | null"},"bathrooms":{"oneOf":[{"type":"number","description":"The number of bathrooms in the unit.","isRequired":true,"uniqueKey":"bathrooms.oneOf.0","typeLabel":"number"},{"type":"null","description":"The number of bathrooms in the unit.","isRequired":true,"uniqueKey":"bathrooms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bathrooms","typeLabel":"number | null"},"bedrooms":{"oneOf":[{"type":"number","description":"The number of bedrooms in the unit.","isRequired":true,"uniqueKey":"bedrooms.oneOf.0","typeLabel":"number"},{"type":"null","description":"The number of bedrooms in the unit.","isRequired":true,"uniqueKey":"bedrooms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bedrooms","typeLabel":"number | null"},"building":{"oneOf":[{"type":"object","description":"The building the unit belongs to.","required":["id","created","object","active","address","currency","description","marketing","name","removable","single_unit","type","unit_fees","viewing_booking_url","viewings_availability","viewings_require_confirmation"],"properties":{"id":{"type":"string","description":"Unique identifier for the object.","isRequired":true,"uniqueKey":"building.oneOf.0.id","typeLabel":"string"},"created":{"type":"number","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","isRequired":true,"uniqueKey":"building.oneOf.0.created","typeLabel":"number"},"object":{"type":"string","enum":["building"],"isRequired":true,"uniqueKey":"building.oneOf.0.object","typeLabel":"enum\u003cstring>"},"active":{"type":"boolean","description":"Whether the building is currently active.","isRequired":true,"uniqueKey":"building.oneOf.0.active","typeLabel":"boolean"},"address":{"type":"object","properties":{"line1":{"oneOf":[{"type":"string","uniqueKey":"building.oneOf.0.address.line1.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"building.oneOf.0.address.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"building.oneOf.0.address.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","uniqueKey":"building.oneOf.0.address.line2.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"building.oneOf.0.address.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"building.oneOf.0.address.line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"building.oneOf.0.address.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"building.oneOf.0.address.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"building.oneOf.0.address.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","uniqueKey":"building.oneOf.0.address.country.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"building.oneOf.0.address.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"building.oneOf.0.address.country","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","uniqueKey":"building.oneOf.0.address.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"building.oneOf.0.address.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"building.oneOf.0.address.postal_code","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"building.oneOf.0.address.state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"building.oneOf.0.address.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"building.oneOf.0.address.state","typeLabel":"string | null"}},"description":"The physical address of the building.","isRequired":true,"uniqueKey":"building.oneOf.0.address","typeLabel":"object"},"currency":{"type":"string","description":"The default currency used for the building.","isRequired":true,"uniqueKey":"building.oneOf.0.currency","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"An arbitrary description attached to the building.","isRequired":true,"uniqueKey":"building.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"An arbitrary description attached to the building.","isRequired":true,"uniqueKey":"building.oneOf.0.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.description","typeLabel":"string | null"},"marketing":{"type":"object","properties":{"featured_photo":{"oneOf":[{"type":"string","description":"The ID of the file used as the featured photo for the building.","uniqueKey":"building.oneOf.0.marketing.featured_photo.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the file used as the featured photo for the building.","uniqueKey":"building.oneOf.0.marketing.featured_photo.oneOf.1","typeLabel":"null"}],"uniqueKey":"building.oneOf.0.marketing.featured_photo","typeLabel":"string | null"},"photos":{"type":"array","items":{"type":"string","uniqueKey":"building.oneOf.0.marketing.photos.items.[INDEX]","typeLabel":"string"},"description":"IDs of additional photos used to market the building.","uniqueKey":"building.oneOf.0.marketing.photos","typeLabel":"string[]"}},"description":"Marketing details displayed for the building.","isRequired":true,"uniqueKey":"building.oneOf.0.marketing","typeLabel":"object"},"name":{"type":"string","description":"The name of the building.","isRequired":true,"uniqueKey":"building.oneOf.0.name","typeLabel":"string"},"removable":{"type":"boolean","description":"Whether the building can be deleted.","isRequired":true,"uniqueKey":"building.oneOf.0.removable","typeLabel":"boolean"},"single_unit":{"type":"boolean","description":"Whether the building is treated as a single unit.","isRequired":true,"uniqueKey":"building.oneOf.0.single_unit","typeLabel":"boolean"},"type":{"oneOf":[{"type":"string","enum":["block_management","commercial","residential","student",null],"description":"The type of the building.","isRequired":true,"uniqueKey":"building.oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["block_management","commercial","residential","student",null],"description":"The type of the building.","isRequired":true,"uniqueKey":"building.oneOf.0.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.type","typeLabel":"enum\u003cstring> | null"},"unit_fees":{"type":"object","properties":{"management_fee":{"oneOf":[{"type":"number","description":"The default management fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default management fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee","typeLabel":"number | null"},"management_fee_amount":{"oneOf":[{"type":"number","description":"The fixed management fee amount, in the smallest currency unit, when using a `fixed` fee type.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"The fixed management fee amount, in the smallest currency unit, when using a `fixed` fee type.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee_amount","typeLabel":"number | null"},"management_fee_discount":{"oneOf":[{"type":"object","properties":{"percent_off":{"oneOf":[{"type":"number","description":"The percentage discount applied to the management fee.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee_discount.oneOf.0.percent_off.oneOf.0","typeLabel":"number"},{"type":"null","description":"The percentage discount applied to the management fee.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee_discount.oneOf.0.percent_off.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee_discount.oneOf.0.percent_off","typeLabel":"number | null"},"end":{"oneOf":[{"type":"number","description":"The timestamp at which the management fee discount ends.","uniqueKey":"building.oneOf.0.unit_fees.management_fee_discount.oneOf.0.end.oneOf.0","typeLabel":"number"},{"type":"null","description":"The timestamp at which the management fee discount ends.","uniqueKey":"building.oneOf.0.unit_fees.management_fee_discount.oneOf.0.end.oneOf.1","typeLabel":"null"}],"uniqueKey":"building.oneOf.0.unit_fees.management_fee_discount.oneOf.0.end","typeLabel":"number | null"}},"description":"An optional discount applied to the management fee.","required":["percent_off"],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee_discount.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"end":{"oneOf":[{"type":"number","description":"The timestamp at which the management fee discount ends."},{"type":"null","description":"The timestamp at which the management fee discount ends."}]},"percent_off":{"oneOf":[{"type":"number","description":"The percentage discount applied to the management fee."},{"type":"null","description":"The percentage discount applied to the management fee."}]}},"description":"An optional discount applied to the management fee.","required":["percent_off"],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee_discount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee_discount","typeLabel":"object | null"},"management_fee_type":{"oneOf":[{"type":"string","enum":["percentage","fixed",null],"description":"How the management fee is calculated.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["percentage","fixed",null],"description":"How the management fee is calculated.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.management_fee_type","typeLabel":"enum\u003cstring> | null"},"renewal_fee":{"oneOf":[{"type":"number","description":"The default renewal fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.renewal_fee.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default renewal fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.renewal_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.renewal_fee","typeLabel":"number | null"},"rent_review_fee":{"oneOf":[{"type":"number","description":"The default rent review fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.rent_review_fee.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default rent review fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.rent_review_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.rent_review_fee","typeLabel":"number | null"},"tax":{"oneOf":[{"type":"number","description":"The default tax rate applied to fees charged to landlords for units in the building.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.tax.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default tax rate applied to fees charged to landlords for units in the building.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.tax.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.tax","typeLabel":"number | null"},"tax_behavior":{"oneOf":[{"type":"string","enum":["exclusive","inclusive",null],"description":"Whether the default tax rate is inclusive or exclusive of the fee amount.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.tax_behavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["exclusive","inclusive",null],"description":"Whether the default tax rate is inclusive or exclusive of the fee amount.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.tax_behavior.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.tax_behavior","typeLabel":"enum\u003cstring> | null"},"tenant_find_fee":{"oneOf":[{"type":"number","description":"The default tenant find fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.tenant_find_fee.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default tenant find fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.tenant_find_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.tenant_find_fee","typeLabel":"number | null"},"updated_at":{"oneOf":[{"type":"integer","description":"The time at which the unit fees were last updated.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which the unit fees were last updated.","isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees.updated_at","typeLabel":"integer | null"}},"description":"Default fees applied to units in this building.","required":["management_fee","management_fee_amount","management_fee_discount","management_fee_type","renewal_fee","rent_review_fee","tax","tax_behavior","tenant_find_fee","updated_at"],"isRequired":true,"uniqueKey":"building.oneOf.0.unit_fees","typeLabel":"object"},"viewing_booking_url":{"oneOf":[{"type":"string","format":"uri","description":"The public URL a lead can use to book a viewing at this building. Present once a booking link has been minted.","isRequired":true,"uniqueKey":"building.oneOf.0.viewing_booking_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The public URL a lead can use to book a viewing at this building. Present once a booking link has been minted.","isRequired":true,"uniqueKey":"building.oneOf.0.viewing_booking_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.viewing_booking_url","typeLabel":"string\u003curi> | null"},"viewings_availability":{"oneOf":[{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"end_time":{"type":"string","description":"The end time of the slot.","isRequired":true,"uniqueKey":"building.oneOf.0.viewings_availability.oneOf.0.additionalProperties.items.[INDEX].end_time","typeLabel":"string"},"start_time":{"type":"string","description":"The start time of the slot.","isRequired":true,"uniqueKey":"building.oneOf.0.viewings_availability.oneOf.0.additionalProperties.items.[INDEX].start_time","typeLabel":"string"}},"required":["end_time","start_time"],"uniqueKey":"building.oneOf.0.viewings_availability.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"building.oneOf.0.viewings_availability.oneOf.0.additionalProperties","typeLabel":"object[]"},"description":"Weekly viewing hours for this building. `null` inherits the account viewing calendar. An empty object means the building offers no self-serve slots.","isRequired":true,"uniqueKey":"building.oneOf.0.viewings_availability.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"array","items":{"type":"object","properties":{"end_time":{"type":"string","description":"The end time of the slot.","uniqueKey":"building.oneOf.0.viewings_availability.oneOf.1.additionalProperties.items.[INDEX].end_time","typeLabel":"string"},"start_time":{"type":"string","description":"The start time of the slot.","uniqueKey":"building.oneOf.0.viewings_availability.oneOf.1.additionalProperties.items.[INDEX].start_time","typeLabel":"string"}},"required":["end_time","start_time"],"uniqueKey":"building.oneOf.0.viewings_availability.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"building.oneOf.0.viewings_availability.oneOf.1.additionalProperties","typeLabel":"object[]"},"description":"Weekly viewing hours for this building. `null` inherits the account viewing calendar. An empty object means the building offers no self-serve slots.","isRequired":true,"uniqueKey":"building.oneOf.0.viewings_availability.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.viewings_availability","typeLabel":"object | null"},"viewings_require_confirmation":{"oneOf":[{"type":"boolean","description":"Whether bookings from this building's public viewing link need a team member to confirm them. `null` inherits the account setting.","isRequired":true,"uniqueKey":"building.oneOf.0.viewings_require_confirmation.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether bookings from this building's public viewing link need a team member to confirm them. `null` inherits the account setting.","isRequired":true,"uniqueKey":"building.oneOf.0.viewings_require_confirmation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"building.oneOf.0.viewings_require_confirmation","typeLabel":"boolean | null"},"account":{"type":"string","description":"The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.","uniqueKey":"building.oneOf.0.account","typeLabel":"string"},"deleted":{"type":"boolean","default":false,"description":"Only returned if the object has been deleted.","uniqueKey":"building.oneOf.0.deleted","typeLabel":"boolean"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"building.oneOf.0.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"building.oneOf.0.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"building.oneOf.0.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"building.oneOf.0.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"building.oneOf.0.metadata","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"building.oneOf.0","typeLabel":"object"},{"type":"string","description":"The building the unit belongs to.","isRequired":true,"uniqueKey":"building.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"building","typeLabel":"object | string"},"completion_date":{"oneOf":[{"type":"number","description":"The expected completion date of the unit.","isRequired":true,"uniqueKey":"completion_date.oneOf.0","typeLabel":"number"},{"type":"null","description":"The expected completion date of the unit.","isRequired":true,"uniqueKey":"completion_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"completion_date","typeLabel":"number | null"},"contract_address":{"oneOf":[{"type":"string","description":"The address used on contracts for the unit.","isRequired":true,"uniqueKey":"contract_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address used on contracts for the unit.","isRequired":true,"uniqueKey":"contract_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"contract_address","typeLabel":"string | null"},"currency":{"type":"string","description":"The default currency for the unit.","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"currency_options":{"oneOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"deposit_amount":{"oneOf":[{"type":"number","description":"The deposit amount, in the smallest currency unit.","isRequired":true,"uniqueKey":"currency_options.oneOf.0.additionalProperties.deposit_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"The deposit amount, in the smallest currency unit.","isRequired":true,"uniqueKey":"currency_options.oneOf.0.additionalProperties.deposit_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"currency_options.oneOf.0.additionalProperties.deposit_amount","typeLabel":"number | null"},"rent_amount":{"oneOf":[{"type":"number","description":"The rent amount, in the smallest currency unit.","isRequired":true,"uniqueKey":"currency_options.oneOf.0.additionalProperties.rent_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"The rent amount, in the smallest currency unit.","isRequired":true,"uniqueKey":"currency_options.oneOf.0.additionalProperties.rent_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"currency_options.oneOf.0.additionalProperties.rent_amount","typeLabel":"number | null"},"rent_tax_percent":{"oneOf":[{"type":"number","description":"The tax percentage applied to the rent.","uniqueKey":"currency_options.oneOf.0.additionalProperties.rent_tax_percent.oneOf.0","typeLabel":"number"},{"type":"null","description":"The tax percentage applied to the rent.","uniqueKey":"currency_options.oneOf.0.additionalProperties.rent_tax_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency_options.oneOf.0.additionalProperties.rent_tax_percent","typeLabel":"number | null"}},"required":["deposit_amount","rent_amount"],"uniqueKey":"currency_options.oneOf.0.additionalProperties","typeLabel":"object"},"description":"Per-currency options for the unit, keyed by ISO currency code.","isRequired":true,"uniqueKey":"currency_options.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"object","properties":{"deposit_amount":{"oneOf":[{"type":"number","description":"The deposit amount, in the smallest currency unit.","uniqueKey":"currency_options.oneOf.1.additionalProperties.deposit_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"The deposit amount, in the smallest currency unit.","uniqueKey":"currency_options.oneOf.1.additionalProperties.deposit_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency_options.oneOf.1.additionalProperties.deposit_amount","typeLabel":"number | null"},"rent_amount":{"oneOf":[{"type":"number","description":"The rent amount, in the smallest currency unit.","uniqueKey":"currency_options.oneOf.1.additionalProperties.rent_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"The rent amount, in the smallest currency unit.","uniqueKey":"currency_options.oneOf.1.additionalProperties.rent_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency_options.oneOf.1.additionalProperties.rent_amount","typeLabel":"number | null"},"rent_tax_percent":{"oneOf":[{"type":"number","description":"The tax percentage applied to the rent.","uniqueKey":"currency_options.oneOf.1.additionalProperties.rent_tax_percent.oneOf.0","typeLabel":"number"},{"type":"null","description":"The tax percentage applied to the rent.","uniqueKey":"currency_options.oneOf.1.additionalProperties.rent_tax_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency_options.oneOf.1.additionalProperties.rent_tax_percent","typeLabel":"number | null"}},"required":["deposit_amount","rent_amount"],"uniqueKey":"currency_options.oneOf.1.additionalProperties","typeLabel":"object"},"description":"Per-currency options for the unit, keyed by ISO currency code.","isRequired":true,"uniqueKey":"currency_options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"currency_options","typeLabel":"object | null"},"default_deposit":{"oneOf":[{"type":"number","description":"The default deposit, in the smallest currency unit, charged for the unit.","isRequired":true,"uniqueKey":"default_deposit.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default deposit, in the smallest currency unit, charged for the unit.","isRequired":true,"uniqueKey":"default_deposit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"default_deposit","typeLabel":"number | null"},"default_price":{"oneOf":[{"type":"number","description":"The default monthly rent, in the smallest currency unit, for the unit.","isRequired":true,"uniqueKey":"default_price.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default monthly rent, in the smallest currency unit, for the unit.","isRequired":true,"uniqueKey":"default_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"default_price","typeLabel":"number | null"},"default_rent_tax_rate":{"oneOf":[{"type":"object","description":"The default tax rate applied to the rent for the unit.","required":["id","created","object","active","country","description","inclusive","jurisdiction","name","percentage","state","tax_type"],"properties":{"id":{"type":"string","description":"Unique identifier for the object.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.id","typeLabel":"string"},"created":{"type":"number","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.created","typeLabel":"number"},"object":{"type":"string","enum":["tax_rate"],"isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.object","typeLabel":"enum\u003cstring>"},"active":{"type":"boolean","description":"Whether the tax rate is active.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.active","typeLabel":"boolean"},"country":{"oneOf":[{"type":"string","description":"The country for the tax rate.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"The country for the tax rate.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.country","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"The description of the tax rate.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the tax rate.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.description","typeLabel":"string | null"},"inclusive":{"type":"boolean","description":"Whether the tax rate is inclusive or exclusive.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.inclusive","typeLabel":"boolean"},"jurisdiction":{"oneOf":[{"type":"string","description":"The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.jurisdiction.oneOf.0","typeLabel":"string"},{"type":"null","description":"The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.jurisdiction.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.jurisdiction","typeLabel":"string | null"},"name":{"type":"string","description":"The name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.name","typeLabel":"string"},"percentage":{"type":"number","description":"The percentage of the tax rate out of 100.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.percentage","typeLabel":"number"},"state":{"oneOf":[{"type":"string","description":"The state for the tax rate.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The state for the tax rate.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.state","typeLabel":"string | null"},"tax_type":{"oneOf":[{"type":"string","enum":["gst","sales_tax","vat","custom",null],"description":"The high-level tax type.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.tax_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["gst","sales_tax","vat","custom",null],"description":"The high-level tax type.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.tax_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0.tax_type","typeLabel":"enum\u003cstring> | null"},"account":{"type":"string","description":"The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.","uniqueKey":"default_rent_tax_rate.oneOf.0.account","typeLabel":"string"},"deleted":{"type":"boolean","default":false,"description":"Only returned if the object has been deleted.","uniqueKey":"default_rent_tax_rate.oneOf.0.deleted","typeLabel":"boolean"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"default_rent_tax_rate.oneOf.0.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"default_rent_tax_rate.oneOf.0.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"default_rent_tax_rate.oneOf.0.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"default_rent_tax_rate.oneOf.0.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"default_rent_tax_rate.oneOf.0.metadata","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.0","typeLabel":"object"},{"type":"string","description":"The default tax rate applied to the rent for the unit.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.1","typeLabel":"string"},{"type":"null","description":"The default tax rate applied to the rent for the unit.","isRequired":true,"uniqueKey":"default_rent_tax_rate.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"default_rent_tax_rate","typeLabel":"object | string | null"},"fees":{"oneOf":[{"type":"object","properties":{"management_fee":{"oneOf":[{"type":"number","description":"The default management fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default management fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee","typeLabel":"number | null"},"management_fee_amount":{"oneOf":[{"type":"number","description":"The fixed management fee amount, in the smallest currency unit, when using a `fixed` fee type.","isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"The fixed management fee amount, in the smallest currency unit, when using a `fixed` fee type.","isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee_amount","typeLabel":"number | null"},"management_fee_discount":{"oneOf":[{"type":"object","properties":{"percent_off":{"oneOf":[{"type":"number","description":"The percentage discount applied to the management fee.","isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee_discount.oneOf.0.percent_off.oneOf.0","typeLabel":"number"},{"type":"null","description":"The percentage discount applied to the management fee.","isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee_discount.oneOf.0.percent_off.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee_discount.oneOf.0.percent_off","typeLabel":"number | null"},"end":{"oneOf":[{"type":"number","description":"The timestamp at which the management fee discount ends.","uniqueKey":"fees.oneOf.0.management_fee_discount.oneOf.0.end.oneOf.0","typeLabel":"number"},{"type":"null","description":"The timestamp at which the management fee discount ends.","uniqueKey":"fees.oneOf.0.management_fee_discount.oneOf.0.end.oneOf.1","typeLabel":"null"}],"uniqueKey":"fees.oneOf.0.management_fee_discount.oneOf.0.end","typeLabel":"number | null"}},"description":"An optional discount applied to the management fee.","required":["percent_off"],"isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee_discount.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"end":{"oneOf":[{"type":"number","description":"The timestamp at which the management fee discount ends."},{"type":"null","description":"The timestamp at which the management fee discount ends."}]},"percent_off":{"oneOf":[{"type":"number","description":"The percentage discount applied to the management fee."},{"type":"null","description":"The percentage discount applied to the management fee."}]}},"description":"An optional discount applied to the management fee.","required":["percent_off"],"isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee_discount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee_discount","typeLabel":"object | null"},"management_fee_type":{"oneOf":[{"type":"string","enum":["percentage","fixed",null],"description":"How the management fee is calculated.","isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["percentage","fixed",null],"description":"How the management fee is calculated.","isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fees.oneOf.0.management_fee_type","typeLabel":"enum\u003cstring> | null"},"renewal_fee":{"oneOf":[{"type":"number","description":"The default renewal fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"fees.oneOf.0.renewal_fee.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default renewal fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"fees.oneOf.0.renewal_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fees.oneOf.0.renewal_fee","typeLabel":"number | null"},"rent_review_fee":{"oneOf":[{"type":"number","description":"The default rent review fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"fees.oneOf.0.rent_review_fee.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default rent review fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"fees.oneOf.0.rent_review_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fees.oneOf.0.rent_review_fee","typeLabel":"number | null"},"tax":{"oneOf":[{"type":"number","description":"The default tax rate applied to fees charged to landlords for units in the building.","isRequired":true,"uniqueKey":"fees.oneOf.0.tax.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default tax rate applied to fees charged to landlords for units in the building.","isRequired":true,"uniqueKey":"fees.oneOf.0.tax.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fees.oneOf.0.tax","typeLabel":"number | null"},"tax_behavior":{"oneOf":[{"type":"string","enum":["exclusive","inclusive",null],"description":"Whether the default tax rate is inclusive or exclusive of the fee amount.","isRequired":true,"uniqueKey":"fees.oneOf.0.tax_behavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["exclusive","inclusive",null],"description":"Whether the default tax rate is inclusive or exclusive of the fee amount.","isRequired":true,"uniqueKey":"fees.oneOf.0.tax_behavior.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fees.oneOf.0.tax_behavior","typeLabel":"enum\u003cstring> | null"},"tenant_find_fee":{"oneOf":[{"type":"number","description":"The default tenant find fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"fees.oneOf.0.tenant_find_fee.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default tenant find fee charged to landlords for units in the building.","isRequired":true,"uniqueKey":"fees.oneOf.0.tenant_find_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fees.oneOf.0.tenant_find_fee","typeLabel":"number | null"},"updated_at":{"oneOf":[{"type":"integer","description":"The time at which the unit fees were last updated.","isRequired":true,"uniqueKey":"fees.oneOf.0.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which the unit fees were last updated.","isRequired":true,"uniqueKey":"fees.oneOf.0.updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fees.oneOf.0.updated_at","typeLabel":"integer | null"}},"description":"Fee overrides for the unit. Defaults to the fees on the building when not set.","required":["management_fee","management_fee_amount","management_fee_discount","management_fee_type","renewal_fee","rent_review_fee","tax","tax_behavior","tenant_find_fee","updated_at"],"isRequired":true,"uniqueKey":"fees.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"management_fee":{"oneOf":[{"type":"number","description":"The default management fee charged to landlords for units in the building."},{"type":"null","description":"The default management fee charged to landlords for units in the building."}]},"management_fee_amount":{"oneOf":[{"type":"number","description":"The fixed management fee amount, in the smallest currency unit, when using a `fixed` fee type."},{"type":"null","description":"The fixed management fee amount, in the smallest currency unit, when using a `fixed` fee type."}]},"management_fee_discount":{"oneOf":[{"type":"object","properties":{"end":{"oneOf":[{"type":"number","description":"The timestamp at which the management fee discount ends."},{"type":"null","description":"The timestamp at which the management fee discount ends."}]},"percent_off":{"oneOf":[{"type":"number","description":"The percentage discount applied to the management fee."},{"type":"null","description":"The percentage discount applied to the management fee."}]}},"description":"An optional discount applied to the management fee.","required":["percent_off"]},{"type":"null","properties":{"end":{"oneOf":[{"type":"number","description":"The timestamp at which the management fee discount ends."},{"type":"null","description":"The timestamp at which the management fee discount ends."}]},"percent_off":{"oneOf":[{"type":"number","description":"The percentage discount applied to the management fee."},{"type":"null","description":"The percentage discount applied to the management fee."}]}},"description":"An optional discount applied to the management fee.","required":["percent_off"]}]},"management_fee_type":{"oneOf":[{"type":"string","enum":["percentage","fixed",null],"description":"How the management fee is calculated."},{"type":"null","enum":["percentage","fixed",null],"description":"How the management fee is calculated."}]},"renewal_fee":{"oneOf":[{"type":"number","description":"The default renewal fee charged to landlords for units in the building."},{"type":"null","description":"The default renewal fee charged to landlords for units in the building."}]},"rent_review_fee":{"oneOf":[{"type":"number","description":"The default rent review fee charged to landlords for units in the building."},{"type":"null","description":"The default rent review fee charged to landlords for units in the building."}]},"tax":{"oneOf":[{"type":"number","description":"The default tax rate applied to fees charged to landlords for units in the building."},{"type":"null","description":"The default tax rate applied to fees charged to landlords for units in the building."}]},"tax_behavior":{"oneOf":[{"type":"string","enum":["exclusive","inclusive",null],"description":"Whether the default tax rate is inclusive or exclusive of the fee amount."},{"type":"null","enum":["exclusive","inclusive",null],"description":"Whether the default tax rate is inclusive or exclusive of the fee amount."}]},"tenant_find_fee":{"oneOf":[{"type":"number","description":"The default tenant find fee charged to landlords for units in the building."},{"type":"null","description":"The default tenant find fee charged to landlords for units in the building."}]},"updated_at":{"oneOf":[{"type":"integer","description":"The time at which the unit fees were last updated."},{"type":"null","description":"The time at which the unit fees were last updated."}]}},"description":"Fee overrides for the unit. Defaults to the fees on the building when not set.","required":["management_fee","management_fee_amount","management_fee_discount","management_fee_type","renewal_fee","rent_review_fee","tax","tax_behavior","tenant_find_fee","updated_at"],"isRequired":true,"uniqueKey":"fees.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fees","typeLabel":"object | null"},"furnished":{"oneOf":[{"type":"boolean","description":"Whether the unit is furnished.","isRequired":true,"uniqueKey":"furnished.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the unit is furnished.","isRequired":true,"uniqueKey":"furnished.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"furnished","typeLabel":"boolean | null"},"floor":{"oneOf":[{"type":"number","description":"The floor the unit is on.","isRequired":true,"uniqueKey":"floor.oneOf.0","typeLabel":"number"},{"type":"null","description":"The floor the unit is on.","isRequired":true,"uniqueKey":"floor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"floor","typeLabel":"number | null"},"has_owner":{"oneOf":[{"type":"boolean","description":"Whether the unit currently has at least one owner attached.","isRequired":true,"uniqueKey":"has_owner.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the unit currently has at least one owner attached.","isRequired":true,"uniqueKey":"has_owner.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"has_owner","typeLabel":"boolean | null"},"maintenance_threshold":{"oneOf":[{"type":"number","description":"The spend threshold, in the smallest currency unit, above which maintenance requires owner approval.","isRequired":true,"uniqueKey":"maintenance_threshold.oneOf.0","typeLabel":"number"},{"type":"null","description":"The spend threshold, in the smallest currency unit, above which maintenance requires owner approval.","isRequired":true,"uniqueKey":"maintenance_threshold.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maintenance_threshold","typeLabel":"number | null"},"management_type":{"type":"string","enum":["fully_managed","let_only","rent_collection"],"description":"The management type for the unit.","isRequired":true,"uniqueKey":"management_type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the unit.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"plot_number":{"oneOf":[{"type":"string","description":"The plot number of the unit.","isRequired":true,"uniqueKey":"plot_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The plot number of the unit.","isRequired":true,"uniqueKey":"plot_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"plot_number","typeLabel":"string | null"},"square_foot":{"oneOf":[{"type":"number","description":"The size of the unit in square feet.","isRequired":true,"uniqueKey":"square_foot.oneOf.0","typeLabel":"number"},{"type":"null","description":"The size of the unit in square feet.","isRequired":true,"uniqueKey":"square_foot.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"square_foot","typeLabel":"number | null"},"account":{"type":"string","description":"The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.","uniqueKey":"account","typeLabel":"string"},"deleted":{"type":"boolean","default":false,"description":"Only returned if the object has been deleted.","uniqueKey":"deleted","typeLabel":"boolean"},"active_tenancy_end":{"oneOf":[{"type":"number","description":"The end date of the tenancy currently occupying the unit.","uniqueKey":"active_tenancy_end.oneOf.0","typeLabel":"number"},{"type":"null","description":"The end date of the tenancy currently occupying the unit.","uniqueKey":"active_tenancy_end.oneOf.1","typeLabel":"null"}],"uniqueKey":"active_tenancy_end","typeLabel":"number | null"},"archived":{"type":"boolean","description":"Whether the unit has been archived.","uniqueKey":"archived","typeLabel":"boolean"},"archived_at":{"oneOf":[{"type":"number","description":"The time at which the unit was archived.","uniqueKey":"archived_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"The time at which the unit was archived.","uniqueKey":"archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"archived_at","typeLabel":"number | null"},"assignee":{"oneOf":[{"type":"string","description":"The ID of the user the unit is assigned to.","uniqueKey":"assignee.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the user the unit is assigned to.","uniqueKey":"assignee.oneOf.1","typeLabel":"null"}],"uniqueKey":"assignee","typeLabel":"string | null"},"features":{"oneOf":[{"type":"object","properties":{"aspect":{"oneOf":[{"type":"string","enum":["n","s","e","w","ne","nw","se","sw","corner",null],"description":"The orientation of the unit.","uniqueKey":"features.oneOf.0.aspect.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["n","s","e","w","ne","nw","se","sw","corner",null],"description":"The orientation of the unit.","uniqueKey":"features.oneOf.0.aspect.oneOf.1","typeLabel":"null"}],"uniqueKey":"features.oneOf.0.aspect","typeLabel":"enum\u003cstring> | null"},"balcony":{"oneOf":[{"type":"boolean","description":"Whether the unit has a balcony.","uniqueKey":"features.oneOf.0.balcony.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the unit has a balcony.","uniqueKey":"features.oneOf.0.balcony.oneOf.1","typeLabel":"null"}],"uniqueKey":"features.oneOf.0.balcony","typeLabel":"boolean | null"},"pet_friendly":{"oneOf":[{"type":"boolean","description":"Whether the unit is pet-friendly.","uniqueKey":"features.oneOf.0.pet_friendly.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the unit is pet-friendly.","uniqueKey":"features.oneOf.0.pet_friendly.oneOf.1","typeLabel":"null"}],"uniqueKey":"features.oneOf.0.pet_friendly","typeLabel":"boolean | null"},"view":{"oneOf":[{"type":"string","description":"A description of the view from the unit.","uniqueKey":"features.oneOf.0.view.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of the view from the unit.","uniqueKey":"features.oneOf.0.view.oneOf.1","typeLabel":"null"}],"uniqueKey":"features.oneOf.0.view","typeLabel":"string | null"},"min_term":{"oneOf":[{"type":"string","description":"The minimum term, expressed as an ISO 8601 duration, for the unit.","uniqueKey":"features.oneOf.0.min_term.oneOf.0","typeLabel":"string"},{"type":"null","description":"The minimum term, expressed as an ISO 8601 duration, for the unit.","uniqueKey":"features.oneOf.0.min_term.oneOf.1","typeLabel":"null"}],"uniqueKey":"features.oneOf.0.min_term","typeLabel":"string | null"}},"uniqueKey":"features.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"aspect":{"oneOf":[{"type":"string","enum":["n","s","e","w","ne","nw","se","sw","corner",null],"description":"The orientation of the unit."},{"type":"null","enum":["n","s","e","w","ne","nw","se","sw","corner",null],"description":"The orientation of the unit."}]},"balcony":{"oneOf":[{"type":"boolean","description":"Whether the unit has a balcony."},{"type":"null","description":"Whether the unit has a balcony."}]},"pet_friendly":{"oneOf":[{"type":"boolean","description":"Whether the unit is pet-friendly."},{"type":"null","description":"Whether the unit is pet-friendly."}]},"view":{"oneOf":[{"type":"string","description":"A description of the view from the unit."},{"type":"null","description":"A description of the view from the unit."}]},"min_term":{"oneOf":[{"type":"string","description":"The minimum term, expressed as an ISO 8601 duration, for the unit."},{"type":"null","description":"The minimum term, expressed as an ISO 8601 duration, for the unit."}]}},"uniqueKey":"features.oneOf.1","typeLabel":"null"}],"uniqueKey":"features","typeLabel":"object | null"},"compliance":{"oneOf":[{"type":"object","properties":{"epc":{"oneOf":[{"type":"string","description":"The ID of the file containing the EPC certificate.","uniqueKey":"compliance.oneOf.0.epc.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the file containing the EPC certificate.","uniqueKey":"compliance.oneOf.0.epc.oneOf.1","typeLabel":"null"}],"uniqueKey":"compliance.oneOf.0.epc","typeLabel":"string | null"},"epc_expires_at":{"oneOf":[{"type":"number","description":"The date at which the EPC certificate expires.","uniqueKey":"compliance.oneOf.0.epc_expires_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"The date at which the EPC certificate expires.","uniqueKey":"compliance.oneOf.0.epc_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"compliance.oneOf.0.epc_expires_at","typeLabel":"number | null"},"electric_safety":{"oneOf":[{"type":"string","description":"The ID of the file containing the electric safety certificate.","uniqueKey":"compliance.oneOf.0.electric_safety.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the file containing the electric safety certificate.","uniqueKey":"compliance.oneOf.0.electric_safety.oneOf.1","typeLabel":"null"}],"uniqueKey":"compliance.oneOf.0.electric_safety","typeLabel":"string | null"},"electric_safety_expires_at":{"oneOf":[{"type":"number","description":"The date at which the electric safety certificate expires.","uniqueKey":"compliance.oneOf.0.electric_safety_expires_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"The date at which the electric safety certificate expires.","uniqueKey":"compliance.oneOf.0.electric_safety_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"compliance.oneOf.0.electric_safety_expires_at","typeLabel":"number | null"},"gas_safety":{"oneOf":[{"type":"string","description":"The ID of the file containing the gas safety certificate.","uniqueKey":"compliance.oneOf.0.gas_safety.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the file containing the gas safety certificate.","uniqueKey":"compliance.oneOf.0.gas_safety.oneOf.1","typeLabel":"null"}],"uniqueKey":"compliance.oneOf.0.gas_safety","typeLabel":"string | null"},"gas_safety_expires_at":{"oneOf":[{"type":"number","description":"The date at which the gas safety certificate expires.","uniqueKey":"compliance.oneOf.0.gas_safety_expires_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"The date at which the gas safety certificate expires.","uniqueKey":"compliance.oneOf.0.gas_safety_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"compliance.oneOf.0.gas_safety_expires_at","typeLabel":"number | null"},"gas_safety_required":{"oneOf":[{"type":"boolean","description":"Whether a gas safety certificate is required for the unit.","uniqueKey":"compliance.oneOf.0.gas_safety_required.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether a gas safety certificate is required for the unit.","uniqueKey":"compliance.oneOf.0.gas_safety_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"compliance.oneOf.0.gas_safety_required","typeLabel":"boolean | null"}},"uniqueKey":"compliance.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"epc":{"oneOf":[{"type":"string","description":"The ID of the file containing the EPC certificate."},{"type":"null","description":"The ID of the file containing the EPC certificate."}]},"epc_expires_at":{"oneOf":[{"type":"number","description":"The date at which the EPC certificate expires."},{"type":"null","description":"The date at which the EPC certificate expires."}]},"electric_safety":{"oneOf":[{"type":"string","description":"The ID of the file containing the electric safety certificate."},{"type":"null","description":"The ID of the file containing the electric safety certificate."}]},"electric_safety_expires_at":{"oneOf":[{"type":"number","description":"The date at which the electric safety certificate expires."},{"type":"null","description":"The date at which the electric safety certificate expires."}]},"gas_safety":{"oneOf":[{"type":"string","description":"The ID of the file containing the gas safety certificate."},{"type":"null","description":"The ID of the file containing the gas safety certificate."}]},"gas_safety_expires_at":{"oneOf":[{"type":"number","description":"The date at which the gas safety certificate expires."},{"type":"null","description":"The date at which the gas safety certificate expires."}]},"gas_safety_required":{"oneOf":[{"type":"boolean","description":"Whether a gas safety certificate is required for the unit."},{"type":"null","description":"Whether a gas safety certificate is required for the unit."}]}},"uniqueKey":"compliance.oneOf.1","typeLabel":"null"}],"uniqueKey":"compliance","typeLabel":"object | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"offline_reason":{"oneOf":[{"type":"string","description":"The reason the unit is offline.","uniqueKey":"offline_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reason the unit is offline.","uniqueKey":"offline_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"offline_reason","typeLabel":"string | null"},"reference":{"oneOf":[{"type":"string","description":"An arbitrary reference attached to the unit.","uniqueKey":"reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"An arbitrary reference attached to the unit.","uniqueKey":"reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"reference","typeLabel":"string | null"},"rent":{"oneOf":[{"type":"object","properties":{"default":{"oneOf":[{"type":"number","description":"The default monthly rent, in the smallest currency unit.","uniqueKey":"rent.oneOf.0.default.oneOf.0","typeLabel":"number"},{"type":"null","description":"The default monthly rent, in the smallest currency unit.","uniqueKey":"rent.oneOf.0.default.oneOf.1","typeLabel":"null"}],"uniqueKey":"rent.oneOf.0.default","typeLabel":"number | null"},"maximum":{"oneOf":[{"type":"number","description":"The maximum monthly rent the unit will be advertised at.","uniqueKey":"rent.oneOf.0.maximum.oneOf.0","typeLabel":"number"},{"type":"null","description":"The maximum monthly rent the unit will be advertised at.","uniqueKey":"rent.oneOf.0.maximum.oneOf.1","typeLabel":"null"}],"uniqueKey":"rent.oneOf.0.maximum","typeLabel":"number | null"},"minimum":{"oneOf":[{"type":"number","description":"The minimum monthly rent the unit will be advertised at.","uniqueKey":"rent.oneOf.0.minimum.oneOf.0","typeLabel":"number"},{"type":"null","description":"The minimum monthly rent the unit will be advertised at.","uniqueKey":"rent.oneOf.0.minimum.oneOf.1","typeLabel":"null"}],"uniqueKey":"rent.oneOf.0.minimum","typeLabel":"number | null"},"tax_percent":{"oneOf":[{"type":"number","description":"The tax percentage applied to the rent.","uniqueKey":"rent.oneOf.0.tax_percent.oneOf.0","typeLabel":"number"},{"type":"null","description":"The tax percentage applied to the rent.","uniqueKey":"rent.oneOf.0.tax_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"rent.oneOf.0.tax_percent","typeLabel":"number | null"}},"uniqueKey":"rent.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"default":{"oneOf":[{"type":"number","description":"The default monthly rent, in the smallest currency unit."},{"type":"null","description":"The default monthly rent, in the smallest currency unit."}]},"maximum":{"oneOf":[{"type":"number","description":"The maximum monthly rent the unit will be advertised at."},{"type":"null","description":"The maximum monthly rent the unit will be advertised at."}]},"minimum":{"oneOf":[{"type":"number","description":"The minimum monthly rent the unit will be advertised at."},{"type":"null","description":"The minimum monthly rent the unit will be advertised at."}]},"tax_percent":{"oneOf":[{"type":"number","description":"The tax percentage applied to the rent."},{"type":"null","description":"The tax percentage applied to the rent."}]}},"uniqueKey":"rent.oneOf.1","typeLabel":"null"}],"uniqueKey":"rent","typeLabel":"object | null"},"sales":{"oneOf":[{"type":"object","properties":{"last_purchase_price":{"oneOf":[{"type":"number","description":"The last purchase price of the unit, in the smallest currency unit.","uniqueKey":"sales.oneOf.0.last_purchase_price.oneOf.0","typeLabel":"number"},{"type":"null","description":"The last purchase price of the unit, in the smallest currency unit.","uniqueKey":"sales.oneOf.0.last_purchase_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"sales.oneOf.0.last_purchase_price","typeLabel":"number | null"}},"uniqueKey":"sales.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"last_purchase_price":{"oneOf":[{"type":"number","description":"The last purchase price of the unit, in the smallest currency unit."},{"type":"null","description":"The last purchase price of the unit, in the smallest currency unit."}]}},"uniqueKey":"sales.oneOf.1","typeLabel":"null"}],"uniqueKey":"sales","typeLabel":"object | null"},"square_metre":{"oneOf":[{"type":"number","description":"The size of the unit in square metres.","uniqueKey":"square_metre.oneOf.0","typeLabel":"number"},{"type":"null","description":"The size of the unit in square metres.","uniqueKey":"square_metre.oneOf.1","typeLabel":"null"}],"uniqueKey":"square_metre","typeLabel":"number | null"},"status":{"type":"string","enum":["available","maintenance","occupied","offline","unmanaged"],"description":"The status of the unit.","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"under_offer":{"type":"boolean","description":"Whether the unit is currently under offer.","uniqueKey":"under_offer","typeLabel":"boolean"},"unit_group":{"oneOf":[{"type":"string","description":"The ID of the unit group the unit belongs to.","uniqueKey":"unit_group.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the unit group the unit belongs to.","uniqueKey":"unit_group.oneOf.1","typeLabel":"null"}],"uniqueKey":"unit_group","typeLabel":"string | null"}},"required":["id","created","object","active","address","apply_url","availability","available_from","bathrooms","bedrooms","building","completion_date","contract_address","currency","currency_options","default_deposit","default_price","default_rent_tax_rate","fees","furnished","floor","has_owner","maintenance_threshold","management_type","name","plot_number","square_foot"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","created":123,"object":"unit","active":true,"address":{"line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","country":"\u003cstring>","postal_code":"\u003cstring>","state":"\u003cstring>"},"apply_url":"\u003cstring>","availability":{"available_from":123,"held":true,"hold_reason":"works","released":true,"released_at":123,"state":"available","tenancy":"\u003cstring>","tenancy_end":123},"available_from":123,"bathrooms":123,"bedrooms":123,"building":{"id":"\u003cstring>","created":123,"object":"building","active":true,"address":{"line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","country":"\u003cstring>","postal_code":"\u003cstring>","state":"\u003cstring>"},"currency":"\u003cstring>","description":"\u003cstring>","marketing":{"featured_photo":"\u003cstring>","photos":["\u003cstring>"]},"name":"\u003cstring>","removable":true,"single_unit":true,"type":"block_management","unit_fees":{"management_fee":123,"management_fee_amount":123,"management_fee_discount":{"percent_off":123,"end":123},"management_fee_type":"percentage","renewal_fee":123,"rent_review_fee":123,"tax":123,"tax_behavior":"exclusive","tenant_find_fee":123,"updated_at":123},"viewing_booking_url":"\u003cstring>","viewings_availability":{},"viewings_require_confirmation":true,"account":"\u003cstring>","deleted":false,"metadata":{}},"completion_date":123,"contract_address":"\u003cstring>","currency":"\u003cstring>","currency_options":{},"default_deposit":123,"default_price":123,"default_rent_tax_rate":{"id":"\u003cstring>","created":123,"object":"tax_rate","active":true,"country":"\u003cstring>","description":"\u003cstring>","inclusive":true,"jurisdiction":"\u003cstring>","name":"\u003cstring>","percentage":123,"state":"\u003cstring>","tax_type":"gst","account":"\u003cstring>","deleted":false,"metadata":{}},"fees":{"management_fee":123,"management_fee_amount":123,"management_fee_discount":{"percent_off":123,"end":123},"management_fee_type":"percentage","renewal_fee":123,"rent_review_fee":123,"tax":123,"tax_behavior":"exclusive","tenant_find_fee":123,"updated_at":123},"furnished":true,"floor":123,"has_owner":true,"maintenance_threshold":123,"management_type":"fully_managed","name":"\u003cstring>","plot_number":"\u003cstring>","square_foot":123,"account":"\u003cstring>","deleted":false,"active_tenancy_end":123,"archived":true,"archived_at":123,"assignee":"\u003cstring>","features":{"aspect":"n","balcony":true,"pet_friendly":true,"view":"\u003cstring>","min_term":"\u003cstring>"},"compliance":{"epc":"\u003cstring>","epc_expires_at":123,"electric_safety":"\u003cstring>","electric_safety_expires_at":123,"gas_safety":"\u003cstring>","gas_safety_expires_at":123,"gas_safety_required":true},"metadata":{},"offline_reason":"\u003cstring>","reference":"\u003cstring>","rent":{"default":123,"maximum":123,"minimum":123,"tax_percent":123},"sales":{"last_purchase_price":123},"square_metre":123,"status":"available","under_offer":true,"unit_group":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"126a8fd7-3efd-4d21-8755-1a8efdb9ac4d":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API Key authentication. Use \"Bearer YOUR_API_KEY\".","scopes":[]}}},"servers":{"108e2b56-95a2-4fd1-b324-c0c5c7fca619":{"url":"https://api.yorlet.com","description":"Production"},"7694ca65-c560-4e37-abef-2fbe8d0a8f34":{"url":"https://api.yorlet.io","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"API Key authentication. Use \"Bearer YOUR_API_KEY\".","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"API Key authentication. Use \"Bearer YOUR_API_KEY\".","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi-core.json"},"subdomain":"yorlet","siteName":"Yorlet Documentation","title":"Release a unit to the market - Yorlet Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-28T14:23:49.598Z","originalFileLocation":"api/core/units/release.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=\"Releases a unit to the market so it can be marketed and applied for. A unit that is still occupied can be released once its outgoing tenancy has an end date, which puts it in the to_let availability state ahead of the move-out.\">\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=\"Release a unit to the market - Yorlet Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Releases a unit to the market so it can be marketed and applied for. A unit that is still occupied can be released once its outgoing tenancy has an end date, which puts it in the to_let availability state ahead of the move-out.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Yorlet Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.yorlet.com/api/core/units/release\">\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=Units\u0026amp;title=Release+a+unit+to+the+market\u0026amp;description=Releases+a+unit+to+the+market+so+it+can+be+marketed+and+applied+for.+A+unit+that+is+still+occupied+can+be+released+once+its+outgoing+tenancy+has+an+end+date%2C+wh\u0026amp;theme=0e2748c82afbe05d13ce3e71\u0026amp;signature=33506482a531ccf22d6efd529ffef02ef4f99225512f8cf6c67a829fca876868\">\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=\"Release a unit to the market - Yorlet Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Releases a unit to the market so it can be marketed and applied for. A unit that is still occupied can be released once its outgoing tenancy has an end date, which puts it in the to_let availability state ahead of the move-out.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://yorlet.mintlify.app/_mintlify/api/og/v2?division=Units\u0026amp;title=Release+a+unit+to+the+market\u0026amp;description=Releases+a+unit+to+the+market+so+it+can+be+marketed+and+applied+for.+A+unit+that+is+still+occupied+can+be+released+once+its+outgoing+tenancy+has+an+end+date%2C+wh\u0026amp;theme=0e2748c82afbe05d13ce3e71\u0026amp;signature=33506482a531ccf22d6efd529ffef02ef4f99225512f8cf6c67a829fca876868\">\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/api/core/units/release\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/core/units/release.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.yorlet.com/#organization\",\"name\":\"Yorlet Documentation\",\"url\":\"https://docs.yorlet.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/yorlet/Lx2oI1SOO-fmkDb9/logo/light.svg?fit=max\u0026auto=format\u0026n=Lx2oI1SOO-fmkDb9\u0026q=85\u0026s=73fa1e512b4726e6880aad5ea8936c51\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.yorlet.com#website\",\"name\":\"Yorlet Documentation\",\"url\":\"https://docs.yorlet.com\",\"publisher\":{\"@id\":\"https://docs.yorlet.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.yorlet.com/api/core/units/release#webpage\",\"url\":\"https://docs.yorlet.com/api/core/units/release\",\"name\":\"Release a unit to the market\",\"description\":\"Releases a unit to the market so it can be marketed and applied for. A unit that is still occupied can be released once its outgoing tenancy has an end date, which puts it in the to_let availability state ahead of the move-out.\",\"dateModified\":\"2026-08-28T14:23:49.598Z\",\"isPartOf\":{\"@id\":\"https://docs.yorlet.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.yorlet.com/api/core/units/release#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.yorlet.com/api/core/units/release#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core\",\"item\":\"https://docs.yorlet.com/api/core/buildings/object\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Units\",\"item\":\"https://docs.yorlet.com/api/core/units/object\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Release a unit to the market\",\"item\":\"https://docs.yorlet.com/api/core/units/release\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.yorlet.com/api/core/units/release#apireference\",\"headline\":\"Release a unit to the market\",\"name\":\"Release a unit to the market\",\"description\":\"Releases a unit to the market so it can be marketed and applied for. A unit that is still occupied can be released once its outgoing tenancy has an end date, which puts it in the to_let availability state ahead of the move-out.\",\"url\":\"https://docs.yorlet.com/api/core/units/release\",\"mainEntityOfPage\":{\"@id\":\"https://docs.yorlet.com/api/core/units/release#webpage\"},\"dateModified\":\"2026-08-28T14:23:49.598Z\",\"publisher\":{\"@id\":\"https://docs.yorlet.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.yorlet.com#website\"}}]}\u003c/script>\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","pages":[{"title":"Get started","href":"/introduction"}]},{"tab":"Business automation","pages":[{"title":"Business automation","href":"/business-automation/ai/overview"}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/development/overview"}]},{"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","description":"Holds a unit back from the market, so it is not offered to leads or applicants while works, an owner instruction, or an eviction is outstanding.","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","description":null,"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":"Release a unit to the market - Yorlet Documentation","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-R3M_BF4L.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}