> ## 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. # Preview an owner payout ## OpenAPI ````yaml openapi-owners.json POST /v1/owner_payouts/preview openapi: 3.1.0 info: title: Yorlet Owners API description: APIs for managing owner payouts, payment runs, transfers, and tax forms. version: 1.0.0 servers: - url: https://api.yorlet.com description: Production - url: https://api.yorlet.io description: Sandbox security: [] paths: /v1/owner_payouts/preview: post: tags: - Owner Payouts summary: Preview an owner payout operationId: owner_payouts_preview requestBody: content: application/json: schema: type: object properties: description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. 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. method: type: string enum: - automatic - manual description: The method used to issue this payout. period: type: object properties: end: type: integer description: The end of the period the payout covers. start: type: integer description: The start of the period the payout covers. required: - end - start description: The period this payout covers. statement_descriptor: type: string description: >- The statement descriptor that will appear on the recipient bank statement. send_email: type: boolean description: >- Whether to send an email notification to the owner when the payout is approved. options: type: object properties: apply_unit_restriction: type: boolean description: >- Whether to limit the payout to transactions belonging to the specified unit. description: Additional options that control how the payout is computed. owner: type: string description: The ID of the owner the payout is for. unit: type: string description: The ID of the unit the payout is associated with. required: - owner responses: '200': description: Returns the previewed owner payout. 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: - owner_payout amount: type: number description: The payout amount, in the smallest currency unit. approved_at: type: - integer - 'null' description: The time at which the payout was approved. canceled_at: type: - integer - 'null' description: The time at which the payout was canceled. client_secret: type: - string - 'null' description: >- The client secret used to authorize the payout from the client side. currency: type: string enum: - gbp - usd - eur - sek description: >- Three-letter ISO currency code, in lowercase. Must be a supported currency. example: gbp description: type: - string - 'null' description: >- An arbitrary string attached to the object. Often useful for displaying to users. destination: 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: - external_account available_payout_methods: type: array items: type: string description: >- The payout methods supported by this external account. bank_account: type: object properties: account_holder_name: type: - string - 'null' description: >- The name of the person or business that owns the bank account. account_holder_type: type: - string - 'null' enum: - individual - company - null description: The type of entity that holds the account. bank_name: type: - string - 'null' description: Name of the bank associated with the account. country: type: string description: >- Two-letter ISO code representing the country the bank account is located in. currency: type: string enum: - aud - eur - gbp - bwp - bnd - cny - hkd - kwd - ils - inr - myr - mur - mxn - mad - nzd - ngn - omr - qar - sar - sgd - sek - thb - try - usd - aed - uyu description: >- Three-letter ISO code for the currency of the bank account. last4: type: - string - 'null' description: >- The last four digits of the bank account number. routing_number: type: - string - 'null' description: >- The routing number, sort code or other country-appropriate institution number for the bank account. swift_bic: type: - string - 'null' description: The SWIFT/BIC code identifying the bank. required: - account_holder_name - account_holder_type - bank_name - country - currency - last4 - routing_number description: >- Bank account details when the external account type is `bank_account`. confirmation_of_payee: type: - object - 'null' properties: status: type: - string - 'null' enum: - awaiting_acknowledgement - confirmed - uninitiated - null description: The status of the confirmation of payee check. required: - status description: >- Confirmation of payee status for the external account. 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. status: type: string enum: - new - errored description: The status of the external account. type: type: string enum: - bank_account description: The type of the external account. required: - id - created - object - available_payout_methods - confirmation_of_payee - status - type - type: 'null' description: The external account the payout was sent to. failed_at: type: - integer - 'null' description: The time at which the payout failed. failure_code: type: - string - 'null' description: >- Error code explaining the reason for payout failure if available. failure_message: type: - string - 'null' description: >- Message to user further explaining the reason for payout failure if available. failure_owner_balance_transaction: type: - string - 'null' description: >- The owner balance transaction that records the payout failure. hosted_payment_url: type: - string - 'null' description: The URL of the hosted page for paying out this payout. last_approval_error: type: - object - 'null' properties: message: type: string description: The message of the approval error. type: type: string description: The type of the approval error. required: - message - type description: The most recent approval error for the payout, if any. last_outbound_payment_error: type: - object - 'null' properties: message: type: string description: The message of the outbound payment error. type: type: string description: The type of the outbound payment error. required: - message - type description: >- The most recent outbound payment error for the payout, if any. 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. method: type: - string - 'null' enum: - automatic - manual - null description: The method used to issue this payout. net: type: number description: >- The net amount, in the smallest currency unit, after any fees or deductions. number: type: - string - 'null' description: >- A unique, identifying string that appears on emails sent for the payout. owner: 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: - owner address: type: - object - 'null' 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 owner's address. balance: type: number default: 0 description: >- The owner's current balance, in the smallest currency unit. business_type: type: string enum: - individual - company description: The legal type of the owner. client_secret: type: string description: >- A secret token used to authenticate owner-scoped requests, such as generating PDF statements. company: type: - object - 'null' properties: address: type: - object - 'null' 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 company's registered address. email: type: - string - 'null' description: The contact email for the company. name: type: - string - 'null' description: Legal name of the company. phone: type: - string - 'null' description: Contact phone number for the company. tax_id: type: - string - 'null' description: The company's tax identification number. vat_id: type: - string - 'null' description: The company's VAT identification number. required: - address - email - name - phone - tax_id - vat_id description: >- Information about the company. Only present when `business_type` is `company`. country: type: - string - 'null' description: >- Two-letter ISO code representing the country of the owner. email: type: - string - 'null' description: The owner's contact email address. external_account: 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: - external_account available_payout_methods: type: array items: type: string description: >- The payout methods supported by this external account. bank_account: type: object properties: account_holder_name: type: - string - 'null' description: >- The name of the person or business that owns the bank account. account_holder_type: type: - string - 'null' enum: - individual - company - null description: >- The type of entity that holds the account. bank_name: type: - string - 'null' description: >- Name of the bank associated with the account. country: type: string description: >- Two-letter ISO code representing the country the bank account is located in. currency: type: string enum: - aud - eur - gbp - bwp - bnd - cny - hkd - kwd - ils - inr - myr - mur - mxn - mad - nzd - ngn - omr - qar - sar - sgd - sek - thb - try - usd - aed - uyu description: >- Three-letter ISO code for the currency of the bank account. last4: type: - string - 'null' description: >- The last four digits of the bank account number. routing_number: type: - string - 'null' description: >- The routing number, sort code or other country-appropriate institution number for the bank account. swift_bic: type: - string - 'null' description: The SWIFT/BIC code identifying the bank. required: - account_holder_name - account_holder_type - bank_name - country - currency - last4 - routing_number description: >- Bank account details when the external account type is `bank_account`. confirmation_of_payee: type: - object - 'null' properties: status: type: - string - 'null' enum: - awaiting_acknowledgement - confirmed - uninitiated - null description: >- The status of the confirmation of payee check. required: - status description: >- Confirmation of payee status for the external account. 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. status: type: string enum: - new - errored description: The status of the external account. type: type: string enum: - bank_account description: The type of the external account. required: - id - created - object - available_payout_methods - confirmation_of_payee - status - type - type: 'null' - type: string description: The external account to which payouts are sent. individual: type: - object - 'null' 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: - owner.person address: type: - object - 'null' 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 individual's home address. dob: type: - object - 'null' properties: day: type: - integer - 'null' minimum: 1 maximum: 31 month: type: - integer - 'null' minimum: 1 maximum: 12 year: type: - integer - 'null' minimum: 1900 maximum: 9999 required: - day - month - year description: The individual's date of birth. email: type: - string - 'null' format: email description: The individual’s email address. first_name: type: - string - 'null' description: The individual's first name. last_name: type: - string - 'null' description: The individual's last name. 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. phone: type: - string - 'null' description: The individual's phone number. relationship: type: object properties: director: type: - boolean - 'null' description: >- Whether the person is a director of the company. executive: type: - boolean - 'null' description: >- Whether the person is an executive of the company. owner: type: - boolean - 'null' description: >- Whether the person is an owner of the company. percent_ownership: type: - number - 'null' minimum: 0 maximum: 100 description: >- The percentage of the company that the person owns. representative: type: - boolean - 'null' description: >- Whether the person is the legal representative of the company. title: type: - string - 'null' description: >- The person's title within the company (e.g., CEO, Director). required: - director - executive - owner - percent_ownership - representative - title description: >- Describes the person's relationship to the company. title: type: - string - 'null' description: The person's title within the company. verification_session: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: >- The verification session associated with the person. verification: type: object properties: status: type: - string - 'null' description: The verification status of the person. required: - status description: Verification status information. required: - id - created - object - address - dob - email - first_name - last_name - phone - relationship - title - verification_session - verification description: >- Information about the individual. Only present when `business_type` is `individual`. name: type: - string - 'null' description: Display name of the owner. 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. payouts_enabled: type: boolean default: false description: >- Whether the owner is currently able to receive payouts. requirements: type: object properties: currently_due: type: array items: type: string description: >- Fields that must be provided to keep the owner enabled. disabled_reason: type: - string - 'null' description: Reason the owner is disabled, if any. eventually_due: type: array items: type: string description: Fields that must eventually be provided. required: - currently_due - disabled_reason - eventually_due description: Outstanding requirements for the owner. settings: type: object properties: account_collections: type: object properties: platform_fee: type: number default: 0 description: >- The platform fee applied to account collections, in the smallest currency unit. description: Settings related to account collections. maintenance: type: object properties: issue_categories: type: array items: type: string description: >- Maintenance issue categories supported for this owner. issue_preferred_categories: type: array items: type: string description: >- Preferred maintenance issue categories for this owner. required: - issue_categories - issue_preferred_categories description: Maintenance-related settings. payout_receipts: type: object properties: email_cc: type: array items: type: string default: [] description: >- Additional email addresses to CC on payout receipt emails. email_to: type: - string - 'null' description: >- The email address that payout receipts are sent to. send_email: type: boolean default: true description: Whether to send payout receipt emails. statement_descriptor: type: - string - 'null' description: >- The descriptor to display on payout receipt emails. required: - email_to - statement_descriptor description: Settings controlling payout receipt emails. payout_schedule: type: object properties: interval: type: string enum: - daily - weekly - manual - monthly - quarterly - yearly description: How often payouts are sent to the owner. monthly_anchor: type: number default: 31 description: >- The day of the month payouts are sent when `interval` is `monthly`. weekly_anchor: type: number default: 5 description: >- The day of the week payouts are sent when `interval` is `weekly`. required: - interval description: The payout schedule for the owner. payouts: type: object properties: automatic_approval: type: boolean default: false description: >- Whether payouts are automatically approved. instant_payouts: type: boolean default: false description: Whether instant payouts are enabled. negative_payouts: type: boolean default: false description: Whether negative payouts are permitted. transaction_grouping: type: string enum: - all - per_unit description: How transactions are grouped on a payout. required: - transaction_grouping description: Payout-specific settings. required: - account_collections - maintenance - payout_receipts - payout_schedule - payouts description: Configurable settings for the owner. status: type: string enum: - complete - incomplete - disabled - archived description: The current status of the owner. tax_residency: type: - string - 'null' description: >- Two-letter ISO code representing the owner's tax residency country. type: type: string enum: - landlord - leaseholder - platform - supplier description: The type of the owner. required: - id - created - object - address - business_type - client_secret - company - country - email - external_account - individual - name - requirements - settings - status - tax_residency - type description: The owner the payout is for. owner_balance_transaction: anyOf: - type: 'null' - 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: - owner_balance_transaction amount: type: integer description: >- The amount of the owner balance transaction, in the smallest currency unit. available_on: type: - integer - 'null' description: >- The date the transaction becomes available in the owner balance. balance_type: type: - string - 'null' description: The type of balance this transaction affects. building: type: - string - 'null' description: >- The ID of the building the transaction is associated with. created_from_owner_payout: type: boolean default: false description: >- Whether this transaction was created automatically from an owner payout. currency: type: string enum: - gbp - usd - eur - sek description: >- Three-letter ISO currency code, in lowercase. Must be a supported currency. example: gbp description: type: - string - 'null' description: >- An arbitrary string attached to the object. Often useful for displaying to users. 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. net: type: - integer - 'null' description: The net amount of the transaction after taxes. owner: 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: - owner address: type: - object - 'null' 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 owner's address. balance: type: number default: 0 description: >- The owner's current balance, in the smallest currency unit. business_type: type: string enum: - individual - company description: The legal type of the owner. client_secret: type: string description: >- A secret token used to authenticate owner-scoped requests, such as generating PDF statements. company: type: - object - 'null' properties: address: type: - object - 'null' 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 company's registered address. email: type: - string - 'null' description: The contact email for the company. name: type: - string - 'null' description: Legal name of the company. phone: type: - string - 'null' description: Contact phone number for the company. tax_id: type: - string - 'null' description: The company's tax identification number. vat_id: type: - string - 'null' description: The company's VAT identification number. required: - address - email - name - phone - tax_id - vat_id description: >- Information about the company. Only present when `business_type` is `company`. country: type: - string - 'null' description: >- Two-letter ISO code representing the country of the owner. email: type: - string - 'null' description: The owner's contact email address. external_account: 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: - external_account available_payout_methods: type: array items: type: string description: >- The payout methods supported by this external account. bank_account: type: object properties: account_holder_name: type: - string - 'null' description: >- The name of the person or business that owns the bank account. account_holder_type: type: - string - 'null' enum: - individual - company - null description: >- The type of entity that holds the account. bank_name: type: - string - 'null' description: >- Name of the bank associated with the account. country: type: string description: >- Two-letter ISO code representing the country the bank account is located in. currency: type: string enum: - aud - eur - gbp - bwp - bnd - cny - hkd - kwd - ils - inr - myr - mur - mxn - mad - nzd - ngn - omr - qar - sar - sgd - sek - thb - try - usd - aed - uyu description: >- Three-letter ISO code for the currency of the bank account. last4: type: - string - 'null' description: >- The last four digits of the bank account number. routing_number: type: - string - 'null' description: >- The routing number, sort code or other country-appropriate institution number for the bank account. swift_bic: type: - string - 'null' description: The SWIFT/BIC code identifying the bank. required: - account_holder_name - account_holder_type - bank_name - country - currency - last4 - routing_number description: >- Bank account details when the external account type is `bank_account`. confirmation_of_payee: type: - object - 'null' properties: status: type: - string - 'null' enum: - awaiting_acknowledgement - confirmed - uninitiated - null description: >- The status of the confirmation of payee check. required: - status description: >- Confirmation of payee status for the external account. 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. status: type: string enum: - new - errored description: The status of the external account. type: type: string enum: - bank_account description: The type of the external account. required: - id - created - object - available_payout_methods - confirmation_of_payee - status - type - type: 'null' - type: string description: >- The external account to which payouts are sent. individual: type: - object - 'null' 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: - owner.person address: type: - object - 'null' 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 individual's home address. dob: type: - object - 'null' properties: day: type: - integer - 'null' minimum: 1 maximum: 31 month: type: - integer - 'null' minimum: 1 maximum: 12 year: type: - integer - 'null' minimum: 1900 maximum: 9999 required: - day - month - year description: The individual's date of birth. email: type: - string - 'null' format: email description: The individual’s email address. first_name: type: - string - 'null' description: The individual's first name. last_name: type: - string - 'null' description: The individual's last name. 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. phone: type: - string - 'null' description: The individual's phone number. relationship: type: object properties: director: type: - boolean - 'null' description: >- Whether the person is a director of the company. executive: type: - boolean - 'null' description: >- Whether the person is an executive of the company. owner: type: - boolean - 'null' description: >- Whether the person is an owner of the company. percent_ownership: type: - number - 'null' minimum: 0 maximum: 100 description: >- The percentage of the company that the person owns. representative: type: - boolean - 'null' description: >- Whether the person is the legal representative of the company. title: type: - string - 'null' description: >- The person's title within the company (e.g., CEO, Director). required: - director - executive - owner - percent_ownership - representative - title description: >- Describes the person's relationship to the company. title: type: - string - 'null' description: The person's title within the company. verification_session: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: >- The verification session associated with the person. verification: type: object properties: status: type: - string - 'null' description: The verification status of the person. required: - status description: Verification status information. required: - id - created - object - address - dob - email - first_name - last_name - phone - relationship - title - verification_session - verification description: >- Information about the individual. Only present when `business_type` is `individual`. name: type: - string - 'null' description: Display name of the owner. 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. payouts_enabled: type: boolean default: false description: >- Whether the owner is currently able to receive payouts. requirements: type: object properties: currently_due: type: array items: type: string description: >- Fields that must be provided to keep the owner enabled. disabled_reason: type: - string - 'null' description: Reason the owner is disabled, if any. eventually_due: type: array items: type: string description: Fields that must eventually be provided. required: - currently_due - disabled_reason - eventually_due description: Outstanding requirements for the owner. settings: type: object properties: account_collections: type: object properties: platform_fee: type: number default: 0 description: >- The platform fee applied to account collections, in the smallest currency unit. description: Settings related to account collections. maintenance: type: object properties: issue_categories: type: array items: type: string description: >- Maintenance issue categories supported for this owner. issue_preferred_categories: type: array items: type: string description: >- Preferred maintenance issue categories for this owner. required: - issue_categories - issue_preferred_categories description: Maintenance-related settings. payout_receipts: type: object properties: email_cc: type: array items: type: string default: [] description: >- Additional email addresses to CC on payout receipt emails. email_to: type: - string - 'null' description: >- The email address that payout receipts are sent to. send_email: type: boolean default: true description: Whether to send payout receipt emails. statement_descriptor: type: - string - 'null' description: >- The descriptor to display on payout receipt emails. required: - email_to - statement_descriptor description: >- Settings controlling payout receipt emails. payout_schedule: type: object properties: interval: type: string enum: - daily - weekly - manual - monthly - quarterly - yearly description: How often payouts are sent to the owner. monthly_anchor: type: number default: 31 description: >- The day of the month payouts are sent when `interval` is `monthly`. weekly_anchor: type: number default: 5 description: >- The day of the week payouts are sent when `interval` is `weekly`. required: - interval description: The payout schedule for the owner. payouts: type: object properties: automatic_approval: type: boolean default: false description: >- Whether payouts are automatically approved. instant_payouts: type: boolean default: false description: Whether instant payouts are enabled. negative_payouts: type: boolean default: false description: Whether negative payouts are permitted. transaction_grouping: type: string enum: - all - per_unit description: >- How transactions are grouped on a payout. required: - transaction_grouping description: Payout-specific settings. required: - account_collections - maintenance - payout_receipts - payout_schedule - payouts description: Configurable settings for the owner. status: type: string enum: - complete - incomplete - disabled - archived description: The current status of the owner. tax_residency: type: - string - 'null' description: >- Two-letter ISO code representing the owner's tax residency country. type: type: string enum: - landlord - leaseholder - platform - supplier description: The type of the owner. required: - id - created - object - address - business_type - client_secret - company - country - email - external_account - individual - name - requirements - settings - status - tax_residency - type - type: 'null' description: The owner the transaction is for. owner_payout: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: >- The owner payout this transaction belongs to, if any. reconciled_owner_payout: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: >- The owner payout this transaction was reconciled against, if any. reconciled_owner_payout_paid_at: type: - integer - 'null' description: The time at which the reconciled payout was paid. reporting_subtype: type: - string - 'null' description: >- The reporting subtype used to categorize this transaction. reporting_type: type: - string - 'null' description: >- The reporting type used to categorize this transaction. source: anyOf: - type: string - type: object additionalProperties: {} - type: 'null' description: >- The source object the transaction is associated with. source_object: type: - string - 'null' description: >- The type of source object the transaction is associated with. tax: type: integer default: 0 description: The amount of tax on the transaction. tax_percent: type: number default: 0 description: The tax percentage applied to the transaction. type: type: string description: The type of the owner balance transaction. unit: type: - string - 'null' description: >- The ID of the unit the transaction is associated with. visible_to_owner: type: boolean default: true description: >- Whether this transaction is visible in the owner portal. workspace: type: - string - 'null' description: The workspace the transaction belongs to. required: - id - created - object - amount - available_on - balance_type - building - currency - description - net - owner - owner_payout - reconciled_owner_payout - reconciled_owner_payout_paid_at - reporting_subtype - reporting_type - source - source_object - type - unit - workspace description: >- The owner balance transaction that describes the impact of this payout on the owner balance. owner_non_resident_tax: type: - object - 'null' properties: deduction: type: number description: >- The amount of non-resident tax deducted, in the smallest currency unit. details: type: - object - 'null' properties: certificate: type: - string - 'null' description: The non-resident tax certificate identifier. certificate_date: type: - integer - 'null' description: >- The date the non-resident tax certificate was issued. country: type: - string - 'null' description: >- Two-letter ISO code representing the country of tax residency. status: type: - string - 'null' enum: - exempt - resident - taxable - null description: The non-resident tax status applied to the payout. required: - country - status description: >- Details about the non-resident tax applied to this payout. taxable_amount: type: - number - 'null' description: The taxable amount, in the smallest currency unit. required: - deduction - details - taxable_amount description: >- Non-resident tax information applied to the owner's payout. owner_tax_residency: type: - string - 'null' description: >- Two-letter ISO code representing the owner's tax residency country. paid_at: type: - integer - 'null' description: The time at which the payout was paid. payment_run: type: - string - 'null' description: The ID of the payment run the payout was included in. period: type: - object - 'null' properties: adjustment_amount: type: - integer - 'null' description: The total adjustment amount applied to the period. adjustment_explanations: type: - array - 'null' items: type: object properties: id: type: string description: The identifier of the adjustment. adjustment_amount: type: number description: >- The amount of the adjustment, in the smallest currency unit. amount: type: number description: The amount before the adjustment. daily_rate: type: number description: The daily rate used to compute the adjustment. days: type: number description: The number of days the adjustment covers. description: type: string description: A description of the adjustment. original_amount: type: number description: >- The original amount before the adjustment was applied. period_breakdown: type: array items: type: object properties: days: type: number description: >- The number of days covered by this breakdown segment. period_start: type: integer description: The start date of the breakdown segment. period_end: type: integer description: The end date of the breakdown segment. prorated_amount: type: number description: The prorated amount for this segment. required: - days - period_start - period_end - prorated_amount description: >- A breakdown of the adjustment across sub-periods. period_end: type: integer description: The end of the period the adjustment covers. period_start: type: integer description: The start of the period the adjustment covers. total_days: type: number description: The total number of days across the full period. required: - id - adjustment_amount - amount - daily_rate - days - description - original_amount - period_breakdown - period_end - period_start - total_days description: >- A list of adjustments explaining how the period amount was computed. end: type: - integer - 'null' description: The end of the period covered by the payout. start: type: - integer - 'null' description: The start of the period covered by the payout. required: - adjustment_amount - adjustment_explanations - end - start description: The period this payout covers. radar: type: - object - 'null' properties: no_fees: type: boolean description: >- Whether radar fees should be excluded from this payout. required: - no_fees description: Radar-related information for this payout. statement_descriptor: type: - string - 'null' description: >- The statement descriptor that will appear on the recipient bank statement. status: type: string enum: - draft - pending - in_transit - requires_payment - paid - failed - canceled description: The current status of the payout. transaction: type: - string - 'null' description: The transaction used to settle the payout. type: type: - string - 'null' enum: - landlord - leaseholder - supplier - owner - null description: The type of owner the payout is for. unit: type: - string - 'null' description: The unit this payout is associated with, if any. required: - id - created - object - amount - approved_at - canceled_at - client_secret - currency - description - destination - failed_at - failure_code - failure_message - failure_owner_balance_transaction - hosted_payment_url - last_approval_error - last_outbound_payment_error - method - net - number - owner - owner_balance_transaction - owner_non_resident_tax - owner_tax_residency - paid_at - payment_run - period - radar - statement_descriptor - status - transaction - type - unit security: - ApiKeyAuth: [] components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: API Key authentication. Use "Bearer YOUR_API_KEY". ````