> ## Documentation Index > Fetch the complete documentation index at: https://docs.yorlet.com/llms.txt > Use this file to discover all available pages before exploring further. # Reverse an effective rent increase > Reverses a rent increase that has already taken effect. This is intended for cases where a tenant referred the increase to a tribunal before the effective date but did not communicate this in time. The intent status is reverted to challenged, the subscription schedule change is undone, and the intent is re-linked to the tenancy. Only applicable to rent_increase intents in effective status. ## OpenAPI ````yaml openapi-leasing.json POST /v1/renewal_intents/{id}/reverse openapi: 3.1.0 info: title: Yorlet Leasing API description: >- APIs for managing applications, deposits, guarantors, references, and tenancies. version: 1.0.0 servers: - url: https://api.yorlet.com description: Production - url: https://api.yorlet.io description: Sandbox security: [] paths: /v1/renewal_intents/{id}/reverse: post: tags: - Renewal Intents summary: Reverse an effective rent increase description: >- Reverses a rent increase that has already taken effect. This is intended for cases where a tenant referred the increase to a tribunal before the effective date but did not communicate this in time. The intent status is reverted to challenged, the subscription schedule change is undone, and the intent is re-linked to the tenancy. Only applicable to rent_increase intents in effective status. operationId: renewal_intents_reverse parameters: - schema: type: string description: The id identifier. required: true description: The id identifier. name: id in: path responses: '200': description: Returns the reversed renewal intent. content: application/json: schema: type: object properties: id: type: string description: Unique identifier for the object. created: type: number description: >- Time at which the object was created. Measured in seconds since the Unix epoch. account: type: string description: >- The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header. deleted: type: boolean default: false description: Only returned if the object has been deleted. object: type: string enum: - renewal_intent application: anyOf: - type: object properties: id: type: string description: Unique identifier for the object. created: type: number description: >- Time at which the object was created. Measured in seconds since the Unix epoch. account: type: string description: >- The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header. deleted: type: boolean default: false description: Only returned if the object has been deleted. object: type: string enum: - application advance_rent_amount: type: - integer - 'null' description: The advance rent amount for the application. applicants: type: object properties: count: type: number description: Total number of items in the list. example: 1 has_more: type: boolean description: Whether more items are available. example: false object: type: string enum: - list data: type: array items: type: object properties: id: type: string description: Unique identifier for the object. created: type: number description: >- Time at which the object was created. Measured in seconds since the Unix epoch. account: type: string description: >- The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header. deleted: type: boolean default: false description: >- Only returned if the object has been deleted. object: type: string enum: - application.applicant application: type: string pattern: ^[a-zA-Z0-9_]+$ description: >- The identifier of the application the applicant belongs to. advance_rent: type: object properties: amount: type: number description: >- The advance rent amount for the applicant. paid: type: boolean description: Whether the advance rent has been paid. paid_off_platform: type: boolean description: >- Whether the advance rent was paid off platform. transaction: type: - string - 'null' description: >- The identifier of the advance rent transaction. description: >- The advance rent details for the applicant. currency: type: string enum: - gbp - usd - eur - sek description: The currency for the applicant. example: gbp customer: anyOf: - type: string - type: object additionalProperties: {} description: >- The customer associated with the applicant. deposit: type: object properties: amount: type: number description: The deposit amount for the applicant. paid: type: boolean description: Whether the deposit has been paid. paid_off_platform: type: boolean description: >- Whether the deposit was paid off platform. transaction: type: - string - 'null' description: >- The identifier of the deposit transaction. required: - amount - paid - paid_off_platform - transaction description: The deposit details for the applicant. guarantor: type: - string - 'null' description: >- The identifier of the guarantor for the applicant. guarantor_contract: type: - string - 'null' description: >- The identifier of the guarantor contract for the applicant. holding_fee: type: object properties: amount: type: number description: >- The holding fee amount for the applicant. paid: type: boolean description: Whether the holding fee has been paid. paid_off_platform: type: boolean description: >- Whether the holding fee was paid off platform. transaction: type: - string - 'null' description: >- The identifier of the holding fee transaction. description: >- The holding fee details for the applicant. lead_tenant: type: boolean description: >- Whether the applicant is the lead tenant. pets: type: array items: type: object properties: age: type: - number - 'null' description: The age of the pet. name: type: - string - 'null' description: The name of the pet. type: type: string enum: - dog - cat - small_animal - bird - fish - other description: The species of the pet. required: - age - name - type description: The pets of the applicant. permitted_occupier: type: boolean description: >- Whether the applicant is a permitted occupier. pre_qualification: type: object properties: affordability: type: object properties: company_name: type: string description: >- The name of the company the applicant works for. gross_annual_salary: type: number description: >- The gross annual salary of the applicant. role: type: string description: The role of the applicant. description: >- The affordability details for the applicant. nationality: type: string description: The nationality of the applicant. description: >- The pre-qualification details for the applicant. requirements: type: object properties: guarantor: type: boolean description: Whether the applicant needs a guarantor. required: - guarantor share_of_rent: type: number description: The share of rent for the applicant. status: type: string description: The status of the applicant. tos_acceptance: type: - object - 'null' properties: date: type: - number - 'null' description: >- The date the terms of service were accepted. ip: type: - string - 'null' description: >- The IP address from which the terms of service were accepted. required: - date - ip description: >- The terms of service acceptance details for the applicant. verification_session: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: >- The verification session associated with the applicant. verification_session_required: type: boolean description: >- Whether the applicant is required to complete a verification session. required: - id - created - object - application - advance_rent - currency - customer - deposit - guarantor - guarantor_contract - holding_fee - lead_tenant - permitted_occupier - requirements - share_of_rent - status - tos_acceptance - verification_session - verification_session_required required: - count - has_more - object - data description: The applicants for the application. application_configuration: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: The identifier of the application configuration. application_mode: type: string enum: - classic - configuration description: The mode of the application. assignee: type: - string - 'null' pattern: ^[a-zA-Z0-9_]+$ description: >- The identifier of the assignee for the application. building: anyOf: - type: string - type: object additionalProperties: {} description: >- The identifier of the building for the application. building_snapshot: type: object properties: name: type: string description: The name of the building. single_unit: type: boolean description: Whether the building has a single unit. required: - name - single_unit description: >- A snapshot of the building at the time of the application. completed_at: type: - integer - 'null' description: The date and time the application was completed. contract: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: >- The identifier of the contract for the application. contract_address: type: - string - 'null' description: The address of the contract for the application. contract_options: type: object properties: automatic_counter_signature: type: boolean description: >- Whether to automatically counter sign the contract. legal_entity: type: - string - 'null' description: The legal entity for the contract. owner_signature_required: type: boolean description: Whether the owner signature is required. send_applicant_email: type: boolean description: Whether to send an email to the applicant. send_owner_completion_email: type: boolean description: Whether to send the owner a completion email. description: The contract options for the application. contract_template: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: >- The identifier of the contract template for the application. current_step: oneOf: - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - advance_rent description: The type of the step. required: - id - next_step - type title: Advance rent description: The advance rent step. - type: object properties: id: type: string description: The unique identifier of the step. type: type: string enum: - completion description: The type of the step. completion: type: object properties: behavior: type: string enum: - automatic - manual description: The completion behavior for the step. collection_method: type: string enum: - charge_automatically - send_invoice description: >- The rent collection method for the tenancy. tenancy_behaviour: type: string enum: - roll - complete description: The tenancy behaviour at end of term. credit_note: type: string enum: - none - out_of_band - customer_balance description: >- The credit note behaviour for tenancy revisions. required: - behavior description: The completion settings for the step. required: - id - type - completion title: Completion description: The completion step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - contract description: The type of the step. contract: type: object properties: contract_templates: type: array items: type: string description: >- The contract template IDs that can be used at this step. owner_signature_required: type: boolean description: >- Whether the owner signature is required when signing the contract. send_owner_contract: type: boolean description: >- Whether to send an email notification to the owner when the contract has been signed. break_clause: type: object properties: terms: type: - string - 'null' description: The break clause terms. required: - terms description: The break clause data. description: >- The contract settings for the application configuration step. required: - id - next_step - type title: Contract description: The contract step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - deposit description: The type of the step. required: - id - next_step - type title: Deposit description: The deposit step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - holding_fee description: The type of the step. required: - id - next_step - type title: Holding fee description: The holding fee step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - partial_payment description: The type of the step. required: - id - next_step - type title: Partial payment description: The partial payment step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - payment_method description: The type of the step. payment_method: type: object properties: collection_method: type: string enum: - charge_automatically - send_invoice description: >- The rent collection method for the tenancy. description: >- The payment method settings for the application configuration step. required: - id - next_step - type title: Payment method description: The payment method step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - pre_qualification description: The type of the step. required: - id - next_step - type title: Pre-qualification description: The pre-qualification step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - referencing referencing: type: object properties: automatic_reference: type: object properties: enabled: type: boolean description: >- Whether the automatic reference is enabled. provider: type: string enum: - advance_rent - canopy - homelet - let_alliance description: >- The provider to use with automatic referencing. required: - enabled - provider description: The automatic reference settings. description: >- The referencing settings for the application configuration step. required: - id - next_step - type title: Referencing description: The referencing step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - verification_session description: The type of the step. required: - id - next_step - type title: Verification session description: The verification session step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - waitpoint waitpoint: type: object properties: name: type: string description: The name of the waitpoint. required: - name description: >- The waitpoint settings for the application configuration step. required: - id - next_step - type title: Waitpoint description: The waitpoint step. - type: 'null' description: The current step of the application configuration. currency: type: string enum: - gbp - usd - eur - sek description: The currency for the application. example: gbp deal_assignee: type: - string - 'null' pattern: ^[a-zA-Z0-9_]+$ description: >- The identifier of the deal assignee for the application. deposit_amount: type: - integer - 'null' description: The deposit amount for the application. has_owner: type: boolean description: Whether the application has an owner. holding_fee_amount: type: - integer - 'null' description: The holding fee amount for the application. restrict_credits_to_application: type: boolean description: >- Whether move-in credits (holding fee and advance rent) are reserved for this application’s own invoices, rather than the next invoice for the customer. end_behavior: type: - string - 'null' enum: - roll - complete - null description: The end behavior for the application. end_date: type: - integer - 'null' description: The end date of the application. from_application: type: - object - 'null' properties: action: type: string enum: - revision description: The action of the application. application: type: - string - 'null' pattern: ^[a-zA-Z0-9_]+$ description: The identifier of the application. required: - action - application description: The from application for the application. metadata: type: - object - 'null' additionalProperties: type: string description: The metadata for the application. move_in_date: type: - integer - 'null' description: The expected move in date for the application. move_out_date: type: - integer - 'null' description: The expected move out date for the application. open: type: boolean description: Whether the application is open. overrides: type: - object - 'null' properties: rent_increase: type: - object - 'null' properties: tenancy_start_at: type: - integer - 'null' description: >- Carried-forward override for the tenancy start date (Form 4A section 4.2). first_increase_at: type: - integer - 'null' description: >- Carried-forward override for the date of the first rent increase (Form 4A section 4.4). description: >- Overrides applied when generating a rent increase notice (Form 4A). description: >- Manual overrides carried forward at the tenancy level, applied when generating documents such as the Form 4A rent increase notice. owner_options: type: - object - 'null' properties: apply_unit_fees: type: boolean description: Whether to apply unit fees to the owner. description: The owner options for the application. partial_payment: type: - object - 'null' properties: amount: type: number minimum: 0 maximum: 99999900 description: The partial payment amount. description: type: - string - 'null' description: The description of the partial payment. required: - amount - description description: The partial payment details for the application. rent_term: type: - string - 'null' description: The rent term for the application. start_date: type: - integer - 'null' description: The start date of the application. status: type: string description: The status of the application. steps: type: array items: type: object properties: id: type: string description: The identifier of the step. status: type: string description: The status of the step. type: type: string description: The type of the step. required: - id - status - type description: The steps of the application configuration. subscription_data: type: object properties: add_invoice_items: type: - array - 'null' items: type: object properties: amount: type: integer description: >- The amount to be charged, represented as a whole integer if possible. currency: type: string description: >- Three-letter ISO currency code, in lowercase. Must be a supported currency. description: type: string description: >- The description for the invoice item, to be displayed to the customer. metadata: type: - object - 'null' additionalProperties: type: 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. price: type: string description: The ID of the price object. tax_percent: type: number minimum: 0 maximum: 100 description: >- The tax percentage to use when calculating the tax amount. tax_rate: type: string description: The ID of the tax rate object. transfer_behavior: type: string enum: - automatic - owner - none description: >- The invoice item transfer behavior. The default is automatic. transfer_destination: type: string description: >- ID of the owner that will be the transfer destination. Only allowed when the invoice item transfer behavior is owner. type: type: string enum: - charge - rent - product description: The type of the invoice item. unit: type: - string - 'null' description: >- The ID of the unit the invoice item is for. required: - amount - currency - description - tax_percent - transfer_behavior - type maxItems: 10 description: >- A list of invoice items to add to invoices created by the subscription. billing_anchor: type: - integer - 'null' description: >- The reference point that aligns future billing cycle dates. billing_anchor_config: type: - object - 'null' properties: day_of_month: type: integer minimum: 1 maximum: 31 description: The day of the month to anchor billing to. required: - day_of_month description: Configuration for the billing anchor. collection_method: type: string enum: - charge_automatically - send_invoice description: The collection method for the subscription. coupon: type: - string - 'null' description: >- The identifier of the coupon to apply to the subscription. custom_fields: type: array items: type: object properties: name: type: string maxLength: 30 description: The name of the custom field. value: type: string maxLength: 30 description: The value of the custom field. required: - name - value maxItems: 4 description: >- Custom fields attached to the subscription invoices. days_before_collection: type: integer minimum: 0 maximum: 7 description: >- The number of days before the due date to attempt collection. days_until_due: type: - integer - 'null' minimum: 0 description: The number of days until the invoice is due. end_date: type: - integer - 'null' description: The end date of the subscription. end_date_config: type: - object - 'null' properties: day: type: integer minimum: 1 maximum: 31 description: The day of the month for the end date. month: type: integer minimum: 1 maximum: 12 description: The month for the end date. year: type: integer description: The year for the end date. required: - day - month - year description: >- Configuration to compute the end date of the subscription. first_invoice_creation: type: - string - 'null' enum: - immediately - null description: >- Whether to create the first invoice immediately. interval_count: type: integer description: >- The number of intervals between each billing cycle. Required when interval is not custom. items: type: - array - 'null' items: type: object properties: description: type: string description: >- The description of the subscription item. metadata: type: - object - 'null' additionalProperties: type: string description: >- Set of key-value pairs to attach to the subscription item. price: type: string description: >- The identifier of the price to use for the subscription item. price_data: type: object properties: amount: type: integer description: The amount of the price. currency: type: string description: The currency of the price. tax_percent: type: number description: >- The tax percentage to apply to the price. required: - amount - currency description: >- The price data for the subscription item. proration_behavior: type: string enum: - create_prorations - none description: >- Whether to create prorations when creating the subscription item. schedule: type: - array - 'null' items: type: object properties: amount: type: integer description: The amount for the scheduled change. effective_at: type: integer description: >- The date the scheduled change takes effect. effective_at_config: type: object properties: day: type: integer minimum: 1 maximum: 31 description: >- The day of the month the scheduled change takes effect. month: type: integer minimum: 1 maximum: 12 description: >- The month the scheduled change takes effect. year: type: integer description: >- The year the scheduled change takes effect. required: - day - month - year description: >- Configuration to compute the effective date of the scheduled change. required: - amount description: The schedule for the subscription item. tax_rate: type: string description: >- The identifier of the tax rate for the subscription item. transfer_behavior: type: string enum: - automatic - owner - none description: >- The transfer behavior for the subscription item. transfer_destination: type: string description: >- The identifier of the connected account to transfer funds to. type: type: string enum: - charge - rent - product description: The type of the subscription item. unit: type: - string - 'null' description: >- The identifier of the unit associated with the subscription item. required: - price_data - type minItems: 1 maxItems: 10 description: >- The items for the subscription. Required when interval is not custom. phases: type: - array - 'null' items: type: object properties: start_date: type: integer description: The start date of the phase. items: type: array items: type: object properties: description: type: string description: >- The description of the subscription item. metadata: type: - object - 'null' additionalProperties: type: string description: >- Set of key-value pairs to attach to the subscription item. price: type: string description: >- The identifier of the price to use for the subscription item. price_data: type: object properties: amount: type: integer description: The amount of the price. currency: type: string description: The currency of the price. tax_percent: type: number description: >- The tax percentage to apply to the price. required: - amount - currency description: >- The price data for the subscription item. proration_behavior: type: string enum: - create_prorations - none description: >- Whether to create prorations when creating the subscription item. schedule: type: - array - 'null' items: type: object properties: amount: type: integer description: The amount for the scheduled change. effective_at: type: integer description: >- The date the scheduled change takes effect. effective_at_config: type: object properties: day: type: integer minimum: 1 maximum: 31 description: >- The day of the month the scheduled change takes effect. month: type: integer minimum: 1 maximum: 12 description: >- The month the scheduled change takes effect. year: type: integer description: >- The year the scheduled change takes effect. required: - day - month - year description: >- Configuration to compute the effective date of the scheduled change. required: - amount description: The schedule for the subscription item. tax_rate: type: string description: >- The identifier of the tax rate for the subscription item. transfer_behavior: type: string enum: - automatic - owner - none description: >- The transfer behavior for the subscription item. transfer_destination: type: string description: >- The identifier of the connected account to transfer funds to. type: type: string enum: - charge - rent - product description: The type of the subscription item. unit: type: - string - 'null' description: >- The identifier of the unit associated with the subscription item. required: - price_data - type minItems: 1 maxItems: 10 description: The items in the phase. required: - start_date - items minItems: 1 description: >- The phases of the subscription. Required when interval is custom. start_date: type: - integer - 'null' description: The start date of the subscription. start_date_config: type: - object - 'null' properties: day: type: integer minimum: 1 maximum: 31 description: The day of the month for the start date. month: type: integer minimum: 1 maximum: 12 description: The month for the start date. year: type: integer description: The year for the start date. required: - day - month - year description: >- Configuration to compute the start date of the subscription. interval: type: string enum: - month - week - custom - upfront description: The billing interval for the subscription. required: - collection_method - interval description: The subscription data for the application. type: type: string enum: - active_tenancy - let_only - renewal - standard description: The type of the application. unit: anyOf: - type: string - type: object additionalProperties: {} description: The identifier of the unit for the application. unit_snapshot: type: object properties: name: type: string description: The name of the unit. required: - name description: >- A snapshot of the unit at the time of the application. required: - id - created - object - advance_rent_amount - application_configuration - application_mode - assignee - building - building_snapshot - completed_at - contract - contract_address - contract_options - contract_template - current_step - currency - deal_assignee - deposit_amount - has_owner - holding_fee_amount - restrict_credits_to_application - end_behavior - end_date - from_application - move_in_date - move_out_date - open - owner_options - partial_payment - rent_term - start_date - status - subscription_data - type - unit - unit_snapshot - type: string - type: 'null' description: The new application created when this renewal is accepted. assignee: type: - string - 'null' description: The ID of the user the renewal intent is assigned to. canceled_at: type: - number - 'null' description: The time at which the renewal intent was canceled. completed_at: type: - number - 'null' description: The time at which the renewal intent was completed. due_at: type: - number - 'null' description: >- The time at which the renewal intent is due to be actioned. no_renewal: type: - object - 'null' properties: end_date: type: - number - 'null' description: The date the tenancy is expected to end. reason: type: - string - 'null' description: The reason the tenancy is not being renewed. reason_description: type: - string - 'null' description: A free-form description of the reason for non-renewal. sub_reason: type: - string - 'null' description: A more specific reason for non-renewal. description: Details when the renewal intent type is `no_renewal`. renewal: type: - object - 'null' properties: end_date: type: - number - 'null' description: The end date for the renewed tenancy. start_date: type: - number - 'null' description: The start date for the renewed tenancy. description: Details when the renewal intent type is `renewal`. rent_increase: type: - object - 'null' properties: current_rent: type: - number - 'null' description: The current rent, in the smallest currency unit. proposed_rent: type: - number - 'null' description: The proposed rent, in the smallest currency unit. notice_served_at: type: - number - 'null' description: The time at which the rent increase notice was served. notice_file: type: - string - 'null' description: >- The ID of the file containing the rent increase notice. notice_file_url: type: - string - 'null' format: uri description: >- The URL of the file containing the rent increase notice. effective_date: type: - number - 'null' description: The effective date of the rent increase. tribunal_reference: type: - string - 'null' description: >- The tribunal reference number for the rent increase, if applicable. tribunal_outcome_rent: type: - number - 'null' description: >- The rent agreed by the tribunal, in the smallest currency unit. tribunal_decided_at: type: - number - 'null' description: >- The time at which the tribunal decided the rent increase. reversed_at: type: - number - 'null' description: The time at which the rent increase was reversed. description: Details when the renewal intent type is `rent_increase`. overrides: type: - object - 'null' properties: rent_increase: type: object properties: tenancy_start_at: type: - number - 'null' description: >- Override for the tenancy start date (Form 4A section 4.2). last_increase_at: type: - number - 'null' description: >- Override for the most recent rent increase date (Form 4A section 4.3). first_increase_at: type: - number - 'null' description: >- Override for the date of the first rent increase (Form 4A section 4.4). description: >- Overrides applied when generating a rent increase notice (Form 4A). Omit to leave existing overrides unchanged; set an individual field to null to clear it. description: >- Manual overrides for values that are otherwise derived from the system, used when generating documents such as the Form 4A rent increase notice. source_application: anyOf: - type: object properties: id: type: string description: Unique identifier for the object. created: type: number description: >- Time at which the object was created. Measured in seconds since the Unix epoch. account: type: string description: >- The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header. deleted: type: boolean default: false description: Only returned if the object has been deleted. object: type: string enum: - application advance_rent_amount: type: - integer - 'null' description: The advance rent amount for the application. applicants: type: object properties: count: type: number description: Total number of items in the list. example: 1 has_more: type: boolean description: Whether more items are available. example: false object: type: string enum: - list data: type: array items: type: object properties: id: type: string description: Unique identifier for the object. created: type: number description: >- Time at which the object was created. Measured in seconds since the Unix epoch. account: type: string description: >- The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header. deleted: type: boolean default: false description: >- Only returned if the object has been deleted. object: type: string enum: - application.applicant application: type: string pattern: ^[a-zA-Z0-9_]+$ description: >- The identifier of the application the applicant belongs to. advance_rent: type: object properties: amount: type: number description: >- The advance rent amount for the applicant. paid: type: boolean description: Whether the advance rent has been paid. paid_off_platform: type: boolean description: >- Whether the advance rent was paid off platform. transaction: type: - string - 'null' description: >- The identifier of the advance rent transaction. description: >- The advance rent details for the applicant. currency: type: string enum: - gbp - usd - eur - sek description: The currency for the applicant. example: gbp customer: anyOf: - type: string - type: object additionalProperties: {} description: >- The customer associated with the applicant. deposit: type: object properties: amount: type: number description: The deposit amount for the applicant. paid: type: boolean description: Whether the deposit has been paid. paid_off_platform: type: boolean description: >- Whether the deposit was paid off platform. transaction: type: - string - 'null' description: >- The identifier of the deposit transaction. required: - amount - paid - paid_off_platform - transaction description: The deposit details for the applicant. guarantor: type: - string - 'null' description: >- The identifier of the guarantor for the applicant. guarantor_contract: type: - string - 'null' description: >- The identifier of the guarantor contract for the applicant. holding_fee: type: object properties: amount: type: number description: >- The holding fee amount for the applicant. paid: type: boolean description: Whether the holding fee has been paid. paid_off_platform: type: boolean description: >- Whether the holding fee was paid off platform. transaction: type: - string - 'null' description: >- The identifier of the holding fee transaction. description: >- The holding fee details for the applicant. lead_tenant: type: boolean description: >- Whether the applicant is the lead tenant. pets: type: array items: type: object properties: age: type: - number - 'null' description: The age of the pet. name: type: - string - 'null' description: The name of the pet. type: type: string enum: - dog - cat - small_animal - bird - fish - other description: The species of the pet. required: - age - name - type description: The pets of the applicant. permitted_occupier: type: boolean description: >- Whether the applicant is a permitted occupier. pre_qualification: type: object properties: affordability: type: object properties: company_name: type: string description: >- The name of the company the applicant works for. gross_annual_salary: type: number description: >- The gross annual salary of the applicant. role: type: string description: The role of the applicant. description: >- The affordability details for the applicant. nationality: type: string description: The nationality of the applicant. description: >- The pre-qualification details for the applicant. requirements: type: object properties: guarantor: type: boolean description: Whether the applicant needs a guarantor. required: - guarantor share_of_rent: type: number description: The share of rent for the applicant. status: type: string description: The status of the applicant. tos_acceptance: type: - object - 'null' properties: date: type: - number - 'null' description: >- The date the terms of service were accepted. ip: type: - string - 'null' description: >- The IP address from which the terms of service were accepted. required: - date - ip description: >- The terms of service acceptance details for the applicant. verification_session: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: >- The verification session associated with the applicant. verification_session_required: type: boolean description: >- Whether the applicant is required to complete a verification session. required: - id - created - object - application - advance_rent - currency - customer - deposit - guarantor - guarantor_contract - holding_fee - lead_tenant - permitted_occupier - requirements - share_of_rent - status - tos_acceptance - verification_session - verification_session_required required: - count - has_more - object - data description: The applicants for the application. application_configuration: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: The identifier of the application configuration. application_mode: type: string enum: - classic - configuration description: The mode of the application. assignee: type: - string - 'null' pattern: ^[a-zA-Z0-9_]+$ description: >- The identifier of the assignee for the application. building: anyOf: - type: string - type: object additionalProperties: {} description: >- The identifier of the building for the application. building_snapshot: type: object properties: name: type: string description: The name of the building. single_unit: type: boolean description: Whether the building has a single unit. required: - name - single_unit description: >- A snapshot of the building at the time of the application. completed_at: type: - integer - 'null' description: The date and time the application was completed. contract: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: >- The identifier of the contract for the application. contract_address: type: - string - 'null' description: The address of the contract for the application. contract_options: type: object properties: automatic_counter_signature: type: boolean description: >- Whether to automatically counter sign the contract. legal_entity: type: - string - 'null' description: The legal entity for the contract. owner_signature_required: type: boolean description: Whether the owner signature is required. send_applicant_email: type: boolean description: Whether to send an email to the applicant. send_owner_completion_email: type: boolean description: Whether to send the owner a completion email. description: The contract options for the application. contract_template: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: >- The identifier of the contract template for the application. current_step: oneOf: - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - advance_rent description: The type of the step. required: - id - next_step - type title: Advance rent description: The advance rent step. - type: object properties: id: type: string description: The unique identifier of the step. type: type: string enum: - completion description: The type of the step. completion: type: object properties: behavior: type: string enum: - automatic - manual description: The completion behavior for the step. collection_method: type: string enum: - charge_automatically - send_invoice description: >- The rent collection method for the tenancy. tenancy_behaviour: type: string enum: - roll - complete description: The tenancy behaviour at end of term. credit_note: type: string enum: - none - out_of_band - customer_balance description: >- The credit note behaviour for tenancy revisions. required: - behavior description: The completion settings for the step. required: - id - type - completion title: Completion description: The completion step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - contract description: The type of the step. contract: type: object properties: contract_templates: type: array items: type: string description: >- The contract template IDs that can be used at this step. owner_signature_required: type: boolean description: >- Whether the owner signature is required when signing the contract. send_owner_contract: type: boolean description: >- Whether to send an email notification to the owner when the contract has been signed. break_clause: type: object properties: terms: type: - string - 'null' description: The break clause terms. required: - terms description: The break clause data. description: >- The contract settings for the application configuration step. required: - id - next_step - type title: Contract description: The contract step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - deposit description: The type of the step. required: - id - next_step - type title: Deposit description: The deposit step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - holding_fee description: The type of the step. required: - id - next_step - type title: Holding fee description: The holding fee step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - partial_payment description: The type of the step. required: - id - next_step - type title: Partial payment description: The partial payment step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - payment_method description: The type of the step. payment_method: type: object properties: collection_method: type: string enum: - charge_automatically - send_invoice description: >- The rent collection method for the tenancy. description: >- The payment method settings for the application configuration step. required: - id - next_step - type title: Payment method description: The payment method step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - pre_qualification description: The type of the step. required: - id - next_step - type title: Pre-qualification description: The pre-qualification step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - referencing referencing: type: object properties: automatic_reference: type: object properties: enabled: type: boolean description: >- Whether the automatic reference is enabled. provider: type: string enum: - advance_rent - canopy - homelet - let_alliance description: >- The provider to use with automatic referencing. required: - enabled - provider description: The automatic reference settings. description: >- The referencing settings for the application configuration step. required: - id - next_step - type title: Referencing description: The referencing step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - verification_session description: The type of the step. required: - id - next_step - type title: Verification session description: The verification session step. - type: object properties: id: type: string description: The unique identifier of the step. next_step: type: - string - 'null' description: >- The identifier of the next step in the configuration. type: type: string enum: - waitpoint waitpoint: type: object properties: name: type: string description: The name of the waitpoint. required: - name description: >- The waitpoint settings for the application configuration step. required: - id - next_step - type title: Waitpoint description: The waitpoint step. - type: 'null' description: The current step of the application configuration. currency: type: string enum: - gbp - usd - eur - sek description: The currency for the application. example: gbp deal_assignee: type: - string - 'null' pattern: ^[a-zA-Z0-9_]+$ description: >- The identifier of the deal assignee for the application. deposit_amount: type: - integer - 'null' description: The deposit amount for the application. has_owner: type: boolean description: Whether the application has an owner. holding_fee_amount: type: - integer - 'null' description: The holding fee amount for the application. restrict_credits_to_application: type: boolean description: >- Whether move-in credits (holding fee and advance rent) are reserved for this application’s own invoices, rather than the next invoice for the customer. end_behavior: type: - string - 'null' enum: - roll - complete - null description: The end behavior for the application. end_date: type: - integer - 'null' description: The end date of the application. from_application: type: - object - 'null' properties: action: type: string enum: - revision description: The action of the application. application: type: - string - 'null' pattern: ^[a-zA-Z0-9_]+$ description: The identifier of the application. required: - action - application description: The from application for the application. metadata: type: - object - 'null' additionalProperties: type: string description: The metadata for the application. move_in_date: type: - integer - 'null' description: The expected move in date for the application. move_out_date: type: - integer - 'null' description: The expected move out date for the application. open: type: boolean description: Whether the application is open. overrides: type: - object - 'null' properties: rent_increase: type: - object - 'null' properties: tenancy_start_at: type: - integer - 'null' description: >- Carried-forward override for the tenancy start date (Form 4A section 4.2). first_increase_at: type: - integer - 'null' description: >- Carried-forward override for the date of the first rent increase (Form 4A section 4.4). description: >- Overrides applied when generating a rent increase notice (Form 4A). description: >- Manual overrides carried forward at the tenancy level, applied when generating documents such as the Form 4A rent increase notice. owner_options: type: - object - 'null' properties: apply_unit_fees: type: boolean description: Whether to apply unit fees to the owner. description: The owner options for the application. partial_payment: type: - object - 'null' properties: amount: type: number minimum: 0 maximum: 99999900 description: The partial payment amount. description: type: - string - 'null' description: The description of the partial payment. required: - amount - description description: The partial payment details for the application. rent_term: type: - string - 'null' description: The rent term for the application. start_date: type: - integer - 'null' description: The start date of the application. status: type: string description: The status of the application. steps: type: array items: type: object properties: id: type: string description: The identifier of the step. status: type: string description: The status of the step. type: type: string description: The type of the step. required: - id - status - type description: The steps of the application configuration. subscription_data: type: object properties: add_invoice_items: type: - array - 'null' items: type: object properties: amount: type: integer description: >- The amount to be charged, represented as a whole integer if possible. currency: type: string description: >- Three-letter ISO currency code, in lowercase. Must be a supported currency. description: type: string description: >- The description for the invoice item, to be displayed to the customer. metadata: type: - object - 'null' additionalProperties: type: 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. price: type: string description: The ID of the price object. tax_percent: type: number minimum: 0 maximum: 100 description: >- The tax percentage to use when calculating the tax amount. tax_rate: type: string description: The ID of the tax rate object. transfer_behavior: type: string enum: - automatic - owner - none description: >- The invoice item transfer behavior. The default is automatic. transfer_destination: type: string description: >- ID of the owner that will be the transfer destination. Only allowed when the invoice item transfer behavior is owner. type: type: string enum: - charge - rent - product description: The type of the invoice item. unit: type: - string - 'null' description: >- The ID of the unit the invoice item is for. required: - amount - currency - description - tax_percent - transfer_behavior - type maxItems: 10 description: >- A list of invoice items to add to invoices created by the subscription. billing_anchor: type: - integer - 'null' description: >- The reference point that aligns future billing cycle dates. billing_anchor_config: type: - object - 'null' properties: day_of_month: type: integer minimum: 1 maximum: 31 description: The day of the month to anchor billing to. required: - day_of_month description: Configuration for the billing anchor. collection_method: type: string enum: - charge_automatically - send_invoice description: The collection method for the subscription. coupon: type: - string - 'null' description: >- The identifier of the coupon to apply to the subscription. custom_fields: type: array items: type: object properties: name: type: string maxLength: 30 description: The name of the custom field. value: type: string maxLength: 30 description: The value of the custom field. required: - name - value maxItems: 4 description: >- Custom fields attached to the subscription invoices. days_before_collection: type: integer minimum: 0 maximum: 7 description: >- The number of days before the due date to attempt collection. days_until_due: type: - integer - 'null' minimum: 0 description: The number of days until the invoice is due. end_date: type: - integer - 'null' description: The end date of the subscription. end_date_config: type: - object - 'null' properties: day: type: integer minimum: 1 maximum: 31 description: The day of the month for the end date. month: type: integer minimum: 1 maximum: 12 description: The month for the end date. year: type: integer description: The year for the end date. required: - day - month - year description: >- Configuration to compute the end date of the subscription. first_invoice_creation: type: - string - 'null' enum: - immediately - null description: >- Whether to create the first invoice immediately. interval_count: type: integer description: >- The number of intervals between each billing cycle. Required when interval is not custom. items: type: - array - 'null' items: type: object properties: description: type: string description: >- The description of the subscription item. metadata: type: - object - 'null' additionalProperties: type: string description: >- Set of key-value pairs to attach to the subscription item. price: type: string description: >- The identifier of the price to use for the subscription item. price_data: type: object properties: amount: type: integer description: The amount of the price. currency: type: string description: The currency of the price. tax_percent: type: number description: >- The tax percentage to apply to the price. required: - amount - currency description: >- The price data for the subscription item. proration_behavior: type: string enum: - create_prorations - none description: >- Whether to create prorations when creating the subscription item. schedule: type: - array - 'null' items: type: object properties: amount: type: integer description: The amount for the scheduled change. effective_at: type: integer description: >- The date the scheduled change takes effect. effective_at_config: type: object properties: day: type: integer minimum: 1 maximum: 31 description: >- The day of the month the scheduled change takes effect. month: type: integer minimum: 1 maximum: 12 description: >- The month the scheduled change takes effect. year: type: integer description: >- The year the scheduled change takes effect. required: - day - month - year description: >- Configuration to compute the effective date of the scheduled change. required: - amount description: The schedule for the subscription item. tax_rate: type: string description: >- The identifier of the tax rate for the subscription item. transfer_behavior: type: string enum: - automatic - owner - none description: >- The transfer behavior for the subscription item. transfer_destination: type: string description: >- The identifier of the connected account to transfer funds to. type: type: string enum: - charge - rent - product description: The type of the subscription item. unit: type: - string - 'null' description: >- The identifier of the unit associated with the subscription item. required: - price_data - type minItems: 1 maxItems: 10 description: >- The items for the subscription. Required when interval is not custom. phases: type: - array - 'null' items: type: object properties: start_date: type: integer description: The start date of the phase. items: type: array items: type: object properties: description: type: string description: >- The description of the subscription item. metadata: type: - object - 'null' additionalProperties: type: string description: >- Set of key-value pairs to attach to the subscription item. price: type: string description: >- The identifier of the price to use for the subscription item. price_data: type: object properties: amount: type: integer description: The amount of the price. currency: type: string description: The currency of the price. tax_percent: type: number description: >- The tax percentage to apply to the price. required: - amount - currency description: >- The price data for the subscription item. proration_behavior: type: string enum: - create_prorations - none description: >- Whether to create prorations when creating the subscription item. schedule: type: - array - 'null' items: type: object properties: amount: type: integer description: The amount for the scheduled change. effective_at: type: integer description: >- The date the scheduled change takes effect. effective_at_config: type: object properties: day: type: integer minimum: 1 maximum: 31 description: >- The day of the month the scheduled change takes effect. month: type: integer minimum: 1 maximum: 12 description: >- The month the scheduled change takes effect. year: type: integer description: >- The year the scheduled change takes effect. required: - day - month - year description: >- Configuration to compute the effective date of the scheduled change. required: - amount description: The schedule for the subscription item. tax_rate: type: string description: >- The identifier of the tax rate for the subscription item. transfer_behavior: type: string enum: - automatic - owner - none description: >- The transfer behavior for the subscription item. transfer_destination: type: string description: >- The identifier of the connected account to transfer funds to. type: type: string enum: - charge - rent - product description: The type of the subscription item. unit: type: - string - 'null' description: >- The identifier of the unit associated with the subscription item. required: - price_data - type minItems: 1 maxItems: 10 description: The items in the phase. required: - start_date - items minItems: 1 description: >- The phases of the subscription. Required when interval is custom. start_date: type: - integer - 'null' description: The start date of the subscription. start_date_config: type: - object - 'null' properties: day: type: integer minimum: 1 maximum: 31 description: The day of the month for the start date. month: type: integer minimum: 1 maximum: 12 description: The month for the start date. year: type: integer description: The year for the start date. required: - day - month - year description: >- Configuration to compute the start date of the subscription. interval: type: string enum: - month - week - custom - upfront description: The billing interval for the subscription. required: - collection_method - interval description: The subscription data for the application. type: type: string enum: - active_tenancy - let_only - renewal - standard description: The type of the application. unit: anyOf: - type: string - type: object additionalProperties: {} description: The identifier of the unit for the application. unit_snapshot: type: object properties: name: type: string description: The name of the unit. required: - name description: >- A snapshot of the unit at the time of the application. required: - id - created - object - advance_rent_amount - application_configuration - application_mode - assignee - building - building_snapshot - completed_at - contract - contract_address - contract_options - contract_template - current_step - currency - deal_assignee - deposit_amount - has_owner - holding_fee_amount - restrict_credits_to_application - end_behavior - end_date - from_application - move_in_date - move_out_date - open - owner_options - partial_payment - rent_term - start_date - status - subscription_data - type - unit - unit_snapshot - type: string - type: 'null' description: The application the renewal intent is being created from. status: type: string enum: - accepted - canceled - challenged - complete - effective - leaving - notice_served - pending - renewing - tribunal_decided - withdrawn description: The status of the renewal intent. type: type: - string - 'null' enum: - no_renewal - renewal - rent_increase - null description: The type of renewal intent. unit: anyOf: - type: string - type: object properties: id: type: string description: Unique identifier for the object. created: type: number description: >- Time at which the object was created. Measured in seconds since the Unix epoch. account: type: string description: >- The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header. deleted: type: boolean default: false description: Only returned if the object has been deleted. object: type: string enum: - unit active: type: boolean description: Whether the unit is currently active. address: type: object properties: line1: type: - string - 'null' line2: type: - string - 'null' city: type: - string - 'null' country: type: - string - 'null' postal_code: type: - string - 'null' state: type: - string - 'null' description: The physical address of the unit. archived: type: boolean description: Whether the unit has been archived. archived_at: type: - number - 'null' description: The time at which the unit was archived. assignee: type: - string - 'null' description: The ID of the user the unit is assigned to. available_from: type: - number - 'null' description: The date the unit is available from. bathrooms: type: - number - 'null' description: The number of bathrooms in the unit. bedrooms: type: - number - 'null' description: The number of bedrooms in the unit. building: anyOf: - type: object properties: id: type: string description: Unique identifier for the object. created: type: number description: >- Time at which the object was created. Measured in seconds since the Unix epoch. account: type: string description: >- The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header. deleted: type: boolean default: false description: >- Only returned if the object has been deleted. object: type: string enum: - building active: type: boolean description: Whether the building is currently active. address: type: object properties: line1: type: - string - 'null' line2: type: - string - 'null' city: type: - string - 'null' country: type: - string - 'null' postal_code: type: - string - 'null' state: type: - string - 'null' description: The physical address of the building. currency: type: string description: >- The default currency used for the building. description: type: - string - 'null' description: >- An arbitrary description attached to the building. marketing: type: object properties: featured_photo: type: - string - 'null' description: >- The ID of the file used as the featured photo for the building. photos: type: array items: type: string description: >- IDs of additional photos used to market the building. description: >- Marketing details displayed for the building. metadata: type: - object - 'null' additionalProperties: type: 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. name: type: string description: The name of the building. removable: type: boolean description: Whether the building can be deleted. single_unit: type: boolean description: >- Whether the building is treated as a single unit. type: type: - string - 'null' enum: - block_management - commercial - residential - student - null description: The type of the building. unit_fees: type: object properties: management_fee: type: - number - 'null' description: >- The default management fee charged to landlords for units in the building. management_fee_amount: type: - number - 'null' description: >- The fixed management fee amount, in the smallest currency unit, when using a `fixed` fee type. management_fee_discount: type: - object - 'null' properties: end: type: - number - 'null' description: >- The timestamp at which the management fee discount ends. percent_off: type: - number - 'null' description: >- The percentage discount applied to the management fee. required: - percent_off description: >- An optional discount applied to the management fee. management_fee_type: type: - string - 'null' enum: - percentage - fixed - null description: How the management fee is calculated. renewal_fee: type: - number - 'null' description: >- The default renewal fee charged to landlords for units in the building. rent_review_fee: type: - number - 'null' description: >- The default rent review fee charged to landlords for units in the building. tax: type: - number - 'null' description: >- The default tax rate applied to fees charged to landlords for units in the building. tax_behavior: type: - string - 'null' enum: - exclusive - inclusive - null description: >- Whether the default tax rate is inclusive or exclusive of the fee amount. tenant_find_fee: type: - number - 'null' description: >- The default tenant find fee charged to landlords for units in the building. updated_at: type: - integer - 'null' description: >- The time at which the unit fees were last updated. 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 description: >- Default fees applied to units in this building. required: - id - created - object - active - address - currency - description - marketing - name - removable - single_unit - type - unit_fees - type: string description: The building the unit belongs to. completion_date: type: - number - 'null' description: The expected completion date of the unit. contract_address: type: - string - 'null' description: The address used on contracts for the unit. currency: type: string description: The default currency for the unit. currency_options: type: - object - 'null' additionalProperties: type: object properties: deposit_amount: type: - number - 'null' description: >- The deposit amount, in the smallest currency unit. rent_amount: type: - number - 'null' description: >- The rent amount, in the smallest currency unit. rent_tax_percent: type: - number - 'null' description: The tax percentage applied to the rent. required: - deposit_amount - rent_amount description: >- Per-currency options for the unit, keyed by ISO currency code. default_deposit: type: - number - 'null' description: >- The default deposit, in the smallest currency unit, charged for the unit. default_price: type: - number - 'null' description: >- The default monthly rent, in the smallest currency unit, for the unit. default_rent_tax_rate: anyOf: - type: object properties: id: type: string description: Unique identifier for the object. created: type: number description: >- Time at which the object was created. Measured in seconds since the Unix epoch. account: type: string description: >- The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header. deleted: type: boolean default: false description: >- Only returned if the object has been deleted. object: type: string enum: - tax_rate active: type: boolean description: Whether the tax rate is active. country: type: - string - 'null' description: The country for the tax rate. metadata: type: - object - 'null' additionalProperties: type: 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. description: type: - string - 'null' description: The description of the tax rate. inclusive: type: boolean description: >- Whether the tax rate is inclusive or exclusive. jurisdiction: type: - string - '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. 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. percentage: type: number description: The percentage of the tax rate out of 100. state: type: - string - 'null' description: The state for the tax rate. tax_type: type: - string - 'null' enum: - gst - sales_tax - vat - custom - null description: The high-level tax type. required: - id - created - object - active - country - description - inclusive - jurisdiction - name - percentage - state - tax_type - type: string - type: 'null' description: >- The default tax rate applied to the rent for the unit. features: type: - object - 'null' properties: aspect: type: - string - 'null' enum: - 'n' - s - e - w - ne - nw - se - sw - corner - null description: The orientation of the unit. balcony: type: - boolean - 'null' description: Whether the unit has a balcony. pet_friendly: type: - boolean - 'null' description: Whether the unit is pet-friendly. view: type: - string - 'null' description: A description of the view from the unit. min_term: type: - string - 'null' description: >- The minimum term, expressed as an ISO 8601 duration, for the unit. fees: type: - object - 'null' properties: management_fee: type: - number - 'null' description: >- The default management fee charged to landlords for units in the building. management_fee_amount: type: - number - 'null' description: >- The fixed management fee amount, in the smallest currency unit, when using a `fixed` fee type. management_fee_discount: type: - object - 'null' properties: end: type: - number - 'null' description: >- The timestamp at which the management fee discount ends. percent_off: type: - number - 'null' description: >- The percentage discount applied to the management fee. required: - percent_off description: >- An optional discount applied to the management fee. management_fee_type: type: - string - 'null' enum: - percentage - fixed - null description: How the management fee is calculated. renewal_fee: type: - number - 'null' description: >- The default renewal fee charged to landlords for units in the building. rent_review_fee: type: - number - 'null' description: >- The default rent review fee charged to landlords for units in the building. tax: type: - number - 'null' description: >- The default tax rate applied to fees charged to landlords for units in the building. tax_behavior: type: - string - 'null' enum: - exclusive - inclusive - null description: >- Whether the default tax rate is inclusive or exclusive of the fee amount. tenant_find_fee: type: - number - 'null' description: >- The default tenant find fee charged to landlords for units in the building. updated_at: type: - integer - 'null' description: >- The time at which the unit fees were last updated. 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 description: >- Fee overrides for the unit. Defaults to the fees on the building when not set. furnished: type: - boolean - 'null' description: Whether the unit is furnished. floor: type: - number - 'null' description: The floor the unit is on. has_owner: type: - boolean - 'null' description: >- Whether the unit currently has at least one owner attached. compliance: type: - object - 'null' properties: epc: type: - string - 'null' description: >- The ID of the file containing the EPC certificate. epc_expires_at: type: - number - 'null' description: The date at which the EPC certificate expires. electric_safety: type: - string - 'null' description: >- The ID of the file containing the electric safety certificate. electric_safety_expires_at: type: - number - 'null' description: >- The date at which the electric safety certificate expires. gas_safety: type: - string - 'null' description: >- The ID of the file containing the gas safety certificate. gas_safety_expires_at: type: - number - 'null' description: >- The date at which the gas safety certificate expires. gas_safety_required: type: - boolean - 'null' description: >- Whether a gas safety certificate is required for the unit. maintenance_threshold: type: - number - 'null' description: >- The spend threshold, in the smallest currency unit, above which maintenance requires owner approval. management_type: type: string enum: - fully_managed - let_only - rent_collection description: The management type for the unit. metadata: type: - object - 'null' additionalProperties: type: 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. name: type: string description: The name of the unit. offline_reason: type: - string - 'null' description: The reason the unit is offline. reference: type: - string - 'null' description: An arbitrary reference attached to the unit. plot_number: type: - string - 'null' description: The plot number of the unit. rent: type: - object - 'null' properties: default: type: - number - 'null' description: >- The default monthly rent, in the smallest currency unit. maximum: type: - number - 'null' description: >- The maximum monthly rent the unit will be advertised at. minimum: type: - number - 'null' description: >- The minimum monthly rent the unit will be advertised at. tax_percent: type: - number - 'null' description: The tax percentage applied to the rent. sales: type: - object - 'null' properties: last_purchase_price: type: - number - 'null' description: >- The last purchase price of the unit, in the smallest currency unit. square_foot: type: - number - 'null' description: The size of the unit in square feet. square_metre: type: - number - 'null' description: The size of the unit in square metres. status: type: string enum: - available - maintenance - occupied - offline - unmanaged description: The status of the unit. under_offer: type: boolean description: Whether the unit is currently under offer. unit_group: type: - string - 'null' description: The ID of the unit group the unit belongs to. required: - id - created - object - active - address - 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 - type: 'null' description: The unit the renewal intent is associated with. required: - id - created - object - application - canceled_at - completed_at - source_application - status - type - unit security: - ApiKeyAuth: [] components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: API Key authentication. Use "Bearer YOUR_API_KEY". ````