openapi: 3.0.2 info: title: VTS Lease API version: v1 description: VTS Lease REST API — the commercial real estate leasing, asset management, and portfolio data surface of the VTS platform. Resources include assets, spaces, leases, deals, deal terms, lease terms, financials, budgets, tenants, buildings, listings, and the Leasing Availability API. Harvested verbatim from the VTS developer portal (readme.vts.com) per-operation OpenAPI fragments. contact: name: VTS API Support url: https://readme.vts.com/ termsOfService: https://www.vts.com/services-terms servers: - url: https://api.vts.com - url: https://sandbox.vts.com description: Sandbox security: - basic_auth: [] tags: - name: Account Admin - name: Appraisals - name: Approvals - name: Assets - name: Auth2.0 Access Token - name: Blended Budgets - name: Broker - name: Budgets - name: Coordination Projects - name: Deal Comments - name: Deal Iterations - name: Deal Snapshots - name: Deal Tasks - name: Deal Terms - name: Deal Tours - name: Deals - name: Delinquencies - name: Download Links - name: Financials - name: Global Tenants - name: Lease Terms - name: Leases - name: Leasing Availability - name: Options - name: Proposals - name: Retail Sales - name: Spaces - name: Tenant Contacts - name: Tenant Industries - name: Tenant Updates - name: Tenants - name: Users paths: /: get: description: Download AWS CloudFront pre-signed URIs tags: - Download Links summary: Download files URIs parameters: - description: Defines the export. name: export_name in: query required: true schema: type: string enum: - activate_reservations - activate_analytics_events - activate_user_channel_details - sample_export - description: Specifies the generated date of the requested export file (YYYY-MM-DD). name: generated_date in: query schema: type: string - description: Authentication JSON Web Token with correct claims and identifier information. name: authorization in: header required: true schema: type: string default: Bearer - description: JSON content type header. name: Content-Type in: header required: true schema: type: string default: application/json responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/models_api.DownloadLinksResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/models_api.ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/models_api.ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/models_api.ErrorResponse' '500': description: Internal Server Error content: application/json: schema: type: string '503': description: Service Unavailable content: application/json: schema: type: string operationId: get_-1 /api/v1/account_admin/approval_settings: get: summary: Fetches approval settings tags: - Account Admin security: - basic_auth: [] parameters: - name: page[size] in: query required: false description: 'The number of items returned for any one page (default: 10, max: 100)' schema: type: integer - name: page[before] in: query required: false description: Show records before the given page indicator schema: type: string - name: page[after] in: query required: false description: Show records after the given page indicator schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Approval settings content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string attributes: type: object properties: name: type: string example: New Approval Setting deal_types: type: array items: type: object properties: id: type: integer example: 1 name: type: string example: New Deal created_at: type: string format: date-time updated_at: type: string format: date-time space_types: type: array items: type: object properties: id: type: integer example: 1 name: type: string example: Education created_at: type: string format: date-time updated_at: type: string format: date-time relationships: description: The objects linked to a approval settings type: object properties: asset_group: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/account_admin/asset_groups?id=1 data: type: object properties: type: type: string example: asset_groups id: type: string example: '1' watcher: type: object properties: data: type: array items: type: object properties: type: type: string example: users id: type: string example: '1' approver_slots: type: object properties: data: type: array items: type: object properties: type: type: string example: approver_slots id: type: string example: '1' links: type: object properties: related: type: string example: https://api.vts.com/api/v1/account_admin/approver_slots?filter%5Bapproval_setting_id%5D=1 links: type: object properties: self: type: string example: https://api.vts.com/api/v1/account_admin/approval_settings?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/account_admin/approval_settings?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Approval Setting next: type: string example: https://api.vts.com/api/v1/account_admin/approval_settings?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Approval Setting required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-account-admin-approval-settings /api/v1/account_admin/approver_rules: get: summary: Fetches approver rules tags: - Account Admin security: - basic_auth: [] parameters: - name: page[size] in: query required: false description: 'The number of items returned for any one page (default: 10, max: 100)' schema: type: integer - name: page[before] in: query required: false description: Show records before the given page indicator schema: type: string - name: page[after] in: query required: false description: Show records after the given page indicator schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Approver Rules content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string attributes: type: object properties: order_number: type: number example: 1 rule_type: type: string enum: - above_budget - below_budget - capital_variance_above_budget - cost - deal_term_greater_than - deal_term_less_than - lease_infos - ner_to_break_below_budget - options_and_rights - rentable_size - size_greater_than - size_less_than - total_capital - total_capital_less_than - year_one_total_rent example: above_budget description: Represents the type of the approver rule as stored in the database. rule_name: type: string example: NER Variance Above Budget description: Represents a user-friendly label or name for the approver rule type. condition: type: string enum: - and - or example: and threshold: type: object properties: value: type: number example: 1 unit: type: string example: '%' nullable: true right_types: type: array items: type: string example: audit rights enum: - audit rights - cap on rates - co-tenancy - contraction - exclusive use - generator rights - go dark - kick out - landlord & tenant act 1954 - make good - must lease - other - parking - purchase - radius - relocation - rent review - rofn - set off rights - signage - special provisions - storage - sublease - use - break - expansion - renewal - rights to terminate - rofo - rofr description: The type of the right nullable: true lease_info_types: type: array items: type: string example: guarantor enum: - guarantor - tenant notice info - lease drafter - certificate of insurance - development impact - other description: The type of the lease info nullable: true relationships: description: The objects linked to a approver rules type: object properties: approver_slot: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/account_admin/approver_slots/1 data: type: object properties: type: type: string example: approver_slots id: type: string example: '1' links: type: object properties: self: type: string example: https://api.vts.com/api/v1/account_admin/approver_rules?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/account_admin/approver_rules?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Approver Rules next: type: string example: https://api.vts.com/api/v1/account_admin/approver_rules?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Approver Rules required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-account-admin-approver-rules /api/v1/account_admin/approver_slots: get: summary: Fetches approver slots tags: - Account Admin security: - basic_auth: [] parameters: - name: page[size] in: query required: false description: 'The number of items returned for any one page (default: 10, max: 100)' schema: type: integer - name: page[before] in: query required: false description: Show records before the given page indicator schema: type: string - name: page[after] in: query required: false description: Show records after the given page indicator schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Approver Slots content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string attributes: type: object properties: description: type: string example: Approver Slots Description order_number: type: number example: 1 relationships: description: The objects linked to a approver slots type: object properties: approver: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/users/1 data: type: object properties: type: type: string example: users id: type: string example: '1' approver_rules: type: object properties: data: type: array items: type: object properties: type: type: string example: approver_rules id: type: string example: '1' links: type: object properties: related: type: string example: https://api.vts.com/api/v1/account_admin/approver_rules?filter%5Bapprover_slot_id%5D=1 links: type: object properties: self: type: string example: https://api.vts.com/api/v1/account_admin/approver_slots?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/account_admin/approver_slots?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Approver Slots next: type: string example: https://api.vts.com/api/v1/account_admin/approver_slots?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Approver Slots required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-account-admin-approver-slots /api/v1/account_admin/approver_slots/{id}: get: summary: Retrieves specific approver slots tags: - Account Admin security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested approver slot if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: description: type: string example: Approver Slots Description order_number: type: number example: 1 relationships: description: The objects linked to a approver slots type: object properties: approver: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/users/1 data: type: object properties: type: type: string example: users id: type: string example: '1' approver_rules: type: object properties: data: type: array items: type: object properties: type: type: string example: approver_rules id: type: string example: '1' links: type: object properties: related: type: string example: https://api.vts.com/api/v1/account_admin/approver_rules?filter%5Bapprover_slot_id%5D=1 '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested approver slot does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-account-admin-approver-slots-id /api/v1/account_admin/asset_groups: get: summary: Fetches asset groups tags: - Account Admin security: - basic_auth: [] parameters: - name: page[size] in: query required: false description: 'The number of items returned for any one page (default: 10, max: 100)' schema: type: integer - name: page[before] in: query required: false description: Show records before the given page indicator schema: type: string - name: page[after] in: query required: false description: Show records after the given page indicator schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Asset Groups content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string attributes: type: object properties: name: type: string example: New Deal relationships: description: The objects linked to a Asset Group type: object properties: assets: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/assets?filter%5Basset_group_id%5D=1 data: type: array items: type: object properties: id: type: string example: 100 type: type: string example: assets task_settings: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/account_admin/task_settings?filter%5Basset_group_id%5D=1 data: type: array items: type: object properties: id: type: string example: 100 type: type: string example: task_settings links: type: object properties: self: type: string example: https://api.vts.com/api/v1/account_admin/asset_groups?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/account_admin/asset_groups?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Asset Group next: type: string example: https://api.vts.com/api/v1/account_admin/asset_groups?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Asset Group required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-account-admin-asset-groups /api/v1/account_admin/asset_groups/{id}: get: summary: Retrieves specific asset groups tags: - Account Admin security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested asset group if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: name: type: string example: New Deal relationships: description: The objects linked to a Asset Group type: object properties: assets: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/assets?filter%5Basset_group_id%5D=1 data: type: array items: type: object properties: id: type: string example: 100 type: type: string example: assets task_settings: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/account_admin/task_settings?filter%5Basset_group_id%5D=1 data: type: array items: type: object properties: id: type: string example: 100 type: type: string example: task_settings '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested asset group does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-account-admin-asset-groups-id /api/v1/account_admin/task_settings: get: summary: Fetches task settings tags: - Account Admin security: - basic_auth: [] parameters: - name: page[size] in: query required: false description: 'The number of items returned for any one page (default: 10, max: 100)' schema: type: integer - name: page[before] in: query required: false description: Show records before the given page indicator schema: type: string - name: page[after] in: query required: false description: Show records after the given page indicator schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Task settings content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string attributes: type: object properties: name: type: string example: New Task Setting deal_types: type: array items: type: string example: renewal space_types: type: array items: type: string example: amenities relationships: description: The objects linked to a task settings type: object properties: asset_group: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/account_admin/asset_groups?id=1 data: type: object properties: type: type: string example: asset_groups id: type: string example: '1' task_templates: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/account_admin/task_templates?filter%5Btask_setting_id%5D=1 data: type: array items: type: object properties: type: type: string example: task_templates id: type: string example: '1' links: type: object properties: self: type: string example: https://api.vts.com/api/v1/account_admin/task_settings?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/account_admin/task_settings?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Task Setting next: type: string example: https://api.vts.com/api/v1/account_admin/task_settings?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Task Setting required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-account-admin-task-settings /api/v1/account_admin/task_settings/{id}: get: summary: Retrieves specific task settings tags: - Account Admin security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested task setting if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: name: type: string example: New Task Setting deal_types: type: array items: type: string example: renewal space_types: type: array items: type: string example: amenities relationships: description: The objects linked to a task settings type: object properties: asset_group: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/account_admin/asset_groups?id=1 data: type: object properties: type: type: string example: asset_groups id: type: string example: '1' task_templates: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/account_admin/task_templates?filter%5Btask_setting_id%5D=1 data: type: array items: type: object properties: type: type: string example: task_templates id: type: string example: '1' '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested task setting does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-account-admin-task-settings-id /api/v1/account_admin/task_templates: get: summary: Fetches task templates tags: - Account Admin security: - basic_auth: [] parameters: - name: filter[task_setting_id] in: query required: false schema: type: string - name: page[size] in: query required: false description: 'The number of items returned for any one page (default: 10, max: 100)' schema: type: integer - name: page[before] in: query required: false description: Show records before the given page indicator schema: type: string - name: page[after] in: query required: false description: Show records after the given page indicator schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Task templates content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string attributes: type: object properties: description: type: string example: Setting Name deal_stage: type: object properties: status: type: string example: initial_inquiry display_name: type: string example: Inquiry order_number: type: integer example: 1 required: type: boolean relationships: description: The objects linked to a task templates type: object properties: assignee: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/users/1 data: type: object properties: type: type: string example: users id: type: string example: '1' nullable: true task_setting: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/account_admin/task_settings/1 data: type: object properties: type: type: string example: task_settings id: type: string example: '1' links: type: object properties: self: type: string example: https://api.vts.com/api/v1/account_admin/task_templates?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/account_admin/task_templates?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Task Template next: type: string example: https://api.vts.com/api/v1/account_admin/task_templates?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Task Template required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-account-admin-task-templates /api/v1/account_admin/user_asset_permissions: get: summary: Fetches user asset permissions description: Contains the user asset permissions in your portfolio. tags: - Account Admin security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string responses: '200': description: Returns list of User Asset Permissions content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: user_asset_permissions id: type: string example: '1' attributes: type: object properties: permission: type: string example: user_admin user_email: type: string example: johndoe@example.com asset_address: type: string example: 123 Park Avenue relationships: type: object properties: asset: type: object properties: data: type: object nullable: true properties: id: type: string example: 100 type: type: string example: assets links: type: object properties: related: type: string example: https://api.vts.com/api/v1/assets/1 user: type: object properties: data: type: object nullable: true properties: id: type: string example: 100 type: type: string example: user links: type: object properties: related: type: string example: https://api.vts.com/api/v1/users/1 links: type: object properties: self: type: string example: https://api.vts.com/api/v1/account_admin/user_asset_permissions prev: type: string example: https://api.vts.com/api/v1/account_admin/user_asset_permissions?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/account_admin/user_asset_permissions?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-account-admin-user-asset-permissions /api/v1/account_admin/user_space_permissions: get: summary: Fetches user space permissions description: Contains the user space permissions in your portfolio. tags: - Account Admin security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string responses: '200': description: Returns list of User Spaces Permissions content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: user_space_permissions id: type: string example: '1' attributes: type: object properties: permission: type: string example: user_admin team_override: type: boolean user_email: type: string example: johndoe@example.com asset_address: type: string example: 123 Park Avenue suite_name: type: string nullable: true relationships: type: object properties: asset: type: object properties: data: type: object nullable: true properties: id: type: string example: 100 type: type: string example: assets links: type: object properties: related: type: string example: https://api.vts.com/api/v1/assets/1 space: type: object properties: data: type: object nullable: true properties: id: type: string example: 100 type: type: string example: spaces_office links: type: object properties: related: type: string example: https://api.vts.com/api/v1/spaces/1 user: type: object properties: data: type: object nullable: true properties: id: type: string example: 100 type: type: string example: user links: type: object properties: related: type: string example: https://api.vts.com/api/v1/users/1 links: type: object properties: self: type: string example: https://api.vts.com/api/v1/account_admin/user_space_permissions prev: type: string example: https://api.vts.com/api/v1/account_admin/user_space_permissions?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/account_admin/user_space_permissions?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-account-admin-user-space-permissions /api/v1/appraisals: get: summary: Fetches appraisals tags: - Appraisals security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string responses: '200': description: Returns list of Appraisals content: application/json: schema: type: object properties: type: type: string example: appraisals id: type: string example: '1' attributes: type: object properties: analysis_type: type: string example: appraisal description: The proposal type of the appraisal created_at: type: string example: '2021-12-08T16:28:22.179486Z' format: date-time description: The timestamp when this appraisal was created commencement_date: type: string example: '2021-12-08' format: date description: Start of the lease. Usually designates when the tenant is entitled to the space. concessions: type: string example: '0.0' description: Total concessions on the deal description: type: string nullable: true example: Some text description: A description of the appraisal entered_date: type: string example: '1' description: When the deal term was entered npv_discount_rate: type: string nullable: true example: '1.0' description: Net Present Value discount rate payback: type: number example: 1 description: The number of months it takes for the landlord to earn back what they had to pay out as costs of the deal structure: type: string example: full service description: Rent and recovery structure label calculated_metrics: type: object properties: ner_override: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: Net Effective Rent as a percent of NER of appraisal npv_per_area: allOf: - $ref: '#/components/schemas/measure_money_area' - description: The present value of the net cash flow given the time value of money total_net_cash_flow: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash inflows minus outflows per the terms over the lifetime of the lease internal_rate_of_return: type: string nullable: true example: '100.0' description: The return on money spent for the term of the lease percentage_rents: $ref: '#/components/schemas/percentage_rents' other_incomes: $ref: '#/components/schemas/other_incomes' reimbursable_expenses: type: array items: type: object properties: type: type: string example: OperationalExpense enum: - OperationalExpense - RealEstateTax - ReimbursableExpenseCleaning - ReimbursableExpenseInsurance - ReimbursableExpenseMarketing - ReimbursableExpenseOm - ReimbursableExpenseOther - ReimbursableExpenseRepairsAndMaintenance - ReimbursableExpenseSecurity - ReimbursableExpenseUtility - ReimbursableExpenseCam - ReimbursableExpenseElectric - ReimbursableExpenseLandscaping - ReimbursableExpenseManagementFee description: The type of the reimbursable expense deprecated: true expense_type: type: string example: OperationalExpense enum: - OperationalExpense - RealEstateTax - ReimbursableExpenseCleaning - ReimbursableExpenseInsurance - ReimbursableExpenseMarketing - ReimbursableExpenseOm - ReimbursableExpenseOther - ReimbursableExpenseRepairsAndMaintenance - ReimbursableExpenseSecurity - ReimbursableExpenseUtility - ReimbursableExpenseCam - ReimbursableExpenseElectric - ReimbursableExpenseLandscaping - ReimbursableExpenseManagementFee description: The type of the reimbursable expense recovery_method: type: string example: gross enum: - gross - net - amount - modified_gross description: The calculation method of the recovery amount for the reimbursable expense expense_growth_rate: allOf: - $ref: '#/components/schemas/measure_percentage' - description: The expenses will grow by this rate every 12 months after the lease commencement date. expense_amount: type: number format: float example: 10 description: The amount of the reimbursable expense deprecated: true expense_amount_with_units: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The amount of the reimbursable expense recovery_amount: type: number example: 5 description: The amount of reimbursable expense that will be paid to landlord by the tenant deprecated: true recovery_amount_with_units: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The amount of reimbursable expense that will be paid to landlord by the tenant with recovery type modified_gross expense_stop: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The expense stop of the reimbursable expense. Only applies for expenses with recovery type modified_gross description: type: string example: Description description: The description of reimbursable expense base_rents: $ref: '#/components/schemas/base_rents' commissions: $ref: '#/components/schemas/commissions' costs: $ref: '#/components/schemas/costs' free_rents: allOf: - $ref: '#/components/schemas/free_rents' - properties: recovery_type: type: string enum: - net - gross example: gross description: 'net: percent of net base rent; gross: percent of gross base rent and recoveries.' deprecated: true percent_free: type: number format: float example: 1.5 description: Discount as a percentage value of rent deprecated: true duration: type: number example: 1 description: The number of months in which the free rent applies deprecated: true net_effective_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The normalized value a tenant will pay per period to the landlord over the length of a lease considering Net Present Value. Returned in money/area/year units rent_escalations: $ref: '#/components/schemas/rent_escalations' rentable_size: allOf: - $ref: '#/components/schemas/measure_area' - description: The area of the tenants rented Space. security_deposit: allOf: - $ref: '#/components/schemas/measure_money' - properties: security_deposit_type: type: string example: letter_of_credit description: The type of the security deposit description: Value and currency of the appraisal's security deposit total_deal_value: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' total_lease_term: $ref: '#/components/schemas/measure_period' tenant_improvements: type: array items: description: Each Tenant Improvement type: object properties: allowance_unit: type: string example: rsf description: Tenant Improvements allowance unit allowance: type: number format: float example: 0 description: Tenant Improvements allowance occurrence_month: type: number example: 1 description: Tenant Improvements occurrence month. Possible values are between 1 and the number of months in the budget description: type: string nullable: true example: Some text description: Tenant Improvements description building_improvements: type: array items: description: Each Building Improvement type: object properties: allowance_unit: type: string example: rsf description: Building Improvements allowance unit allowance: type: number format: float example: 0 description: Building Improvements allowance occurrence_month: type: number example: 1 description: Building Improvements occurrence month. Possible values are between 1 and the number of months in the budget description: type: string nullable: true example: Some text description: Building Improvements description total_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: Amount of income that will be realized as "rent". Total value of Base Rent + Escalations - Free Rent relationships: type: object properties: space: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office - spaces_retail - spaces_industrial - spaces_miscellaneous example: spaces_office links: type: object properties: related: type: string format: uri description: Only present for space-level appraisals '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-appraisals /api/v1/appraisals/{id}: get: summary: Retrieves specific appraisals tags: - Appraisals security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested appraisal if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: appraisals id: type: string example: '1' attributes: type: object properties: analysis_type: type: string example: appraisal description: The proposal type of the appraisal created_at: type: string example: '2021-12-08T16:28:22.179486Z' format: date-time description: The timestamp when this appraisal was created commencement_date: type: string example: '2021-12-08' format: date description: Start of the lease. Usually designates when the tenant is entitled to the space. concessions: type: string example: '0.0' description: Total concessions on the deal description: type: string nullable: true example: Some text description: A description of the appraisal entered_date: type: string example: '1' description: When the deal term was entered npv_discount_rate: type: string nullable: true example: '1.0' description: Net Present Value discount rate payback: type: number example: 1 description: The number of months it takes for the landlord to earn back what they had to pay out as costs of the deal structure: type: string example: full service description: Rent and recovery structure label calculated_metrics: type: object properties: ner_override: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: Net Effective Rent as a percent of NER of appraisal npv_per_area: allOf: - $ref: '#/components/schemas/measure_money_area' - description: The present value of the net cash flow given the time value of money total_net_cash_flow: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash inflows minus outflows per the terms over the lifetime of the lease internal_rate_of_return: type: string nullable: true example: '100.0' description: The return on money spent for the term of the lease percentage_rents: $ref: '#/components/schemas/percentage_rents' other_incomes: $ref: '#/components/schemas/other_incomes' reimbursable_expenses: type: array items: type: object properties: type: type: string example: OperationalExpense enum: - OperationalExpense - RealEstateTax - ReimbursableExpenseCleaning - ReimbursableExpenseInsurance - ReimbursableExpenseMarketing - ReimbursableExpenseOm - ReimbursableExpenseOther - ReimbursableExpenseRepairsAndMaintenance - ReimbursableExpenseSecurity - ReimbursableExpenseUtility - ReimbursableExpenseCam - ReimbursableExpenseElectric - ReimbursableExpenseLandscaping - ReimbursableExpenseManagementFee description: The type of the reimbursable expense deprecated: true expense_type: type: string example: OperationalExpense enum: - OperationalExpense - RealEstateTax - ReimbursableExpenseCleaning - ReimbursableExpenseInsurance - ReimbursableExpenseMarketing - ReimbursableExpenseOm - ReimbursableExpenseOther - ReimbursableExpenseRepairsAndMaintenance - ReimbursableExpenseSecurity - ReimbursableExpenseUtility - ReimbursableExpenseCam - ReimbursableExpenseElectric - ReimbursableExpenseLandscaping - ReimbursableExpenseManagementFee description: The type of the reimbursable expense recovery_method: type: string example: gross enum: - gross - net - amount - modified_gross description: The calculation method of the recovery amount for the reimbursable expense expense_growth_rate: allOf: - $ref: '#/components/schemas/measure_percentage' - description: The expenses will grow by this rate every 12 months after the lease commencement date. expense_amount: type: number format: float example: 10 description: The amount of the reimbursable expense deprecated: true expense_amount_with_units: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The amount of the reimbursable expense recovery_amount: type: number example: 5 description: The amount of reimbursable expense that will be paid to landlord by the tenant deprecated: true recovery_amount_with_units: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The amount of reimbursable expense that will be paid to landlord by the tenant with recovery type modified_gross expense_stop: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The expense stop of the reimbursable expense. Only applies for expenses with recovery type modified_gross description: type: string example: Description description: The description of reimbursable expense base_rents: $ref: '#/components/schemas/base_rents' commissions: $ref: '#/components/schemas/commissions' costs: $ref: '#/components/schemas/costs' free_rents: allOf: - $ref: '#/components/schemas/free_rents' - properties: recovery_type: type: string enum: - net - gross example: gross description: 'net: percent of net base rent; gross: percent of gross base rent and recoveries.' deprecated: true percent_free: type: number format: float example: 1.5 description: Discount as a percentage value of rent deprecated: true duration: type: number example: 1 description: The number of months in which the free rent applies deprecated: true net_effective_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The normalized value a tenant will pay per period to the landlord over the length of a lease considering Net Present Value. Returned in money/area/year units rent_escalations: $ref: '#/components/schemas/rent_escalations' rentable_size: allOf: - $ref: '#/components/schemas/measure_area' - description: The area of the tenants rented Space. security_deposit: allOf: - $ref: '#/components/schemas/measure_money' - properties: security_deposit_type: type: string example: letter_of_credit description: The type of the security deposit description: Value and currency of the appraisal's security deposit total_deal_value: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' total_lease_term: $ref: '#/components/schemas/measure_period' tenant_improvements: type: array items: description: Each Tenant Improvement type: object properties: allowance_unit: type: string example: rsf description: Tenant Improvements allowance unit allowance: type: number format: float example: 0 description: Tenant Improvements allowance occurrence_month: type: number example: 1 description: Tenant Improvements occurrence month. Possible values are between 1 and the number of months in the budget description: type: string nullable: true example: Some text description: Tenant Improvements description building_improvements: type: array items: description: Each Building Improvement type: object properties: allowance_unit: type: string example: rsf description: Building Improvements allowance unit allowance: type: number format: float example: 0 description: Building Improvements allowance occurrence_month: type: number example: 1 description: Building Improvements occurrence month. Possible values are between 1 and the number of months in the budget description: type: string nullable: true example: Some text description: Building Improvements description total_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: Amount of income that will be realized as "rent". Total value of Base Rent + Escalations - Free Rent relationships: type: object properties: space: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office - spaces_retail - spaces_industrial - spaces_miscellaneous example: spaces_office links: type: object properties: related: type: string format: uri description: Only present for space-level appraisals '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested appraisal does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-appraisals-id /api/v1/assets: get: summary: Fetches assets description: Contains the assets in your portfolio. Assets are the top-level building or property component in VTS. tags: - Assets security: - basic_auth: [] parameters: - name: filter[multi_building_asset_id] in: query required: false schema: type: integer - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Assets content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: assets id: type: string example: '1' attributes: type: object properties: address: type: object properties: street_address: type: string example: 114 W 41st St, Floor 11 locality: type: string example: New York region: type: string example: NY country: type: string example: United States postal_code: type: string example: '10036' formatted: type: string example: 114 W 41st St, Floor 11, New York, NY 10036 building_class: type: string example: A created_at: type: string format: date-time currency: type: string example: USD description: type: string example: Beautiful property with great views and park nearby. external_ids: type: array items: type: object properties: system_id: type: string example: '12345' system_name: type: string example: ExternalSystem has_industrial_space: type: boolean has_office_space: type: boolean has_retail_space: type: boolean lease_roll: type: integer example: 32999 lease_vacant_area: $ref: '#/components/schemas/measure_size' leasing_company: type: string example: Leasing Company managing_company: type: string example: Managing Company name: type: string example: West 41st Tower notes: type: string nullable: true number_of_floors: type: integer minimum: 0 example: 22 photo_url: type: string nullable: true example: http://images.vts.com/image/upload/photo.jpg owner: type: string nullable: true owning_company: type: string nullable: true description: The owning company of the property rentable_building_area: $ref: '#/components/schemas/measure_size' sourceid: type: string nullable: true example: '000004353' space_available: $ref: '#/components/schemas/measure_size' submarket: type: string building_region: type: string example: New York nullable: true description: The region a building is located in. Specifically, this returns the free-form text field "Region" in the Location section of Buildings. updated_at: type: string format: date-time video_thumbnail: type: string nullable: true example: http://images.vts.com/image/upload/thumbnail.jpg year_built: type: integer minimum: 0 example: 1915 years_renovated: type: string example: - '2018' - 1984, 2001, 2012 - '' property_funds: type: array items: type: string description: The name of the fund example: - Multi Tenant - Test Fund description: The property funds belonging to the employer of the account hitting the API market: type: string example: test market account: type: object properties: id: type: number example: 123 name: type: string example: Monacan LLC size: $ref: '#/components/schemas/measure_area' legal_entity: type: string example: Avenue Holdings description: The name of legal entity belonging to the employer of the account hitting the API nullable: true asset_managers: type: array items: type: string description: The name of the asset manager nullable: true example: - John Stephens - Mary Smith description: The asset managers belonging to the employer of the account hitting the API jv_partners: type: array items: type: string description: The name of the jv partners nullable: true example: - XYZ Partners - ABC Global Development description: The JV partners belonging to the employer of the account hitting the API clients: type: array items: type: string description: The name of the clients nullable: true example: - ABC Partners - XYZ Partners description: The clients belonging to the employer of the account hitting the API relationships: type: object properties: multi_building_asset: type: object properties: data: type: object nullable: true properties: id: type: string example: 100 type: type: string example: multi_building_asset links: type: object properties: self: type: string example: https://api.vts.com/api/v1/assets prev: type: string example: https://api.vts.com/api/v1/assets?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/assets?page%5Bafter%5D=MzE2NjQ%253D required: - self included: type: array items: type: object properties: id: type: string example: '1' type: type: string format: multi_building_assets example: multi_building_assets attributes: type: object properties: name: type: string example: VTS Office Park sourceid: type: string example: '000004353' external_ids: type: array items: type: object properties: system_id: type: string example: '12345' system_name: type: string nullable: true example: ExternalSystem required: - system_id - system_name '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-assets /api/v1/assets/{asset_id}/deal_settings: get: summary: Retrieves deal settings for given asset for specific account tags: - Assets security: - basic_auth: [] parameters: - name: asset_id in: path required: true schema: type: string responses: '200': description: returns requested account asset deal settings if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: assets id: type: string example: '1' attributes: type: object properties: terms: type: object properties: lease_type: type: string nullable: true example: triple net discount_rate: type: string nullable: true example: '5.0' periods: type: string nullable: true example: rsf/month nullable: true rent_schedule: type: object properties: rent_schedule_display_in_unit: type: string example: psf/mo nullable: true nullable: true expenses_and_recoveries: type: array items: type: object properties: type: type: string nullable: true example: ReimbursableExpenseLandscaping expense_amount: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The amount of the reimbursable expense nullable: true recovery_amount: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The amount of reimbursable expense that will be paid to landlord by the tenant with recovery type modified_gross nullable: true expense_growth_rate: allOf: - $ref: '#/components/schemas/measure_percentage' - description: The expenses will grow by this rate every 12 months after the lease commencement date. nullable: true recovery_method: type: string example: gross description: The calculation method of the recovery amount for the reimbursable expense nullable: true nullable: true commissions: type: array items: type: object properties: broker: type: string example: VTS description: Broker/Company name nullable: true commission_type: type: string enum: - landlord - tenant_rep example: landlord description: Commissions Value paid to landlord or tenant brokers on the deal nullable: true periods: type: array items: type: object properties: amount: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: Commission Amount for the new added commission nullable: true starts: type: object properties: month: type: number example: 1 description: The start month when commissions will start counting for. free_rent: type: string example: amortize_over_term description: How commission rent should handle free rent nullable: true net_or_gross: type: string example: gross description: The calculation method of the commission amount. nullable: true nullable: true '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested asset does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-assets-asset-id-deal-settings /api/v1/assets/{id}: get: summary: Retrieves specific asset description: Contains the assets in your portfolio. Assets are the top-level building or property component in VTS. tags: - Assets security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested asset if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: assets id: type: string example: '1' attributes: type: object properties: address: type: object properties: street_address: type: string example: 114 W 41st St, Floor 11 locality: type: string example: New York region: type: string example: NY country: type: string example: United States postal_code: type: string example: '10036' formatted: type: string example: 114 W 41st St, Floor 11, New York, NY 10036 building_class: type: string example: A created_at: type: string format: date-time currency: type: string example: USD description: type: string example: Beautiful property with great views and park nearby. external_ids: type: array items: type: object properties: system_id: type: string example: '12345' system_name: type: string example: ExternalSystem has_industrial_space: type: boolean has_office_space: type: boolean has_retail_space: type: boolean lease_roll: type: integer example: 32999 lease_vacant_area: $ref: '#/components/schemas/measure_size' leasing_company: type: string example: Leasing Company managing_company: type: string example: Managing Company name: type: string example: West 41st Tower notes: type: string nullable: true number_of_floors: type: integer minimum: 0 example: 22 photo_url: type: string nullable: true example: http://images.vts.com/image/upload/photo.jpg owner: type: string nullable: true owning_company: type: string nullable: true description: The owning company of the property rentable_building_area: $ref: '#/components/schemas/measure_size' sourceid: type: string nullable: true example: '000004353' space_available: $ref: '#/components/schemas/measure_size' submarket: type: string building_region: type: string example: New York nullable: true description: The region a building is located in. Specifically, this returns the free-form text field "Region" in the Location section of Buildings. updated_at: type: string format: date-time video_thumbnail: type: string nullable: true example: http://images.vts.com/image/upload/thumbnail.jpg year_built: type: integer minimum: 0 example: 1915 years_renovated: type: string example: - '2018' - 1984, 2001, 2012 - '' property_funds: type: array items: type: string description: The name of the fund example: - Multi Tenant - Test Fund description: The property funds belonging to the employer of the account hitting the API market: type: string example: test market account: type: object properties: id: type: number example: 123 name: type: string example: Monacan LLC size: $ref: '#/components/schemas/measure_area' legal_entity: type: string example: Avenue Holdings description: The name of legal entity belonging to the employer of the account hitting the API nullable: true asset_managers: type: array items: type: string description: The name of the asset manager nullable: true example: - John Stephens - Mary Smith description: The asset managers belonging to the employer of the account hitting the API jv_partners: type: array items: type: string description: The name of the jv partners nullable: true example: - XYZ Partners - ABC Global Development description: The JV partners belonging to the employer of the account hitting the API clients: type: array items: type: string description: The name of the clients nullable: true example: - ABC Partners - XYZ Partners description: The clients belonging to the employer of the account hitting the API relationships: type: object properties: multi_building_asset: type: object properties: data: type: object nullable: true properties: id: type: string example: 100 type: type: string example: multi_building_asset included: type: array items: type: object properties: id: type: string example: '1' type: type: string format: multi_building_assets example: multi_building_assets attributes: type: object properties: name: type: string example: VTS Office Park sourceid: type: string example: '000004353' external_ids: type: array items: type: object properties: system_id: type: string example: '12345' system_name: type: string nullable: true example: ExternalSystem required: - system_id - system_name '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested asset does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-assets-id /api/v1/blended_budgets: get: summary: Fetches blended budgets tags: - Blended Budgets security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string responses: '200': description: Returns list of Blended Budgets content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: blended_budgets id: type: string example: '1' description: The ID of the blended budget attributes: type: object properties: created_at: type: string example: '2021-11-29T20:10:15.232949Z' description: The timestamp when this blended budget was created updated_at: type: string example: '2021-11-29T20:10:15.232949Z' description: The timestamp when this blended budget was last updated rentable_size: allOf: - $ref: '#/components/schemas/measure_area' - description: The sum of the rentable areas for each budget comprising the blended budget base_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The weighted average of the base rents for each budget comprising the blended budget recovered_income: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The weighted average of the recovery income for each budget comprising the blended budget total_other_revenue: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The weighted average of other revenue for each budget comprising the blended budget total_percentage_rent: allOf: - $ref: '#/components/schemas/measure_money' - description: Sum of percentage rent for each budget comprising the blended budget total_free_rent: allOf: - $ref: '#/components/schemas/measure_money' - description: Sum of free rent for each budget comprising the blended budget tenant_improvements: allOf: - $ref: '#/components/schemas/measure_money_area' - description: Sum of tenant improvements for each budget comprising the blended budget building_improvements: allOf: - $ref: '#/components/schemas/measure_money_area' - description: Sum of building improvements for each budget comprising the blended budget total_commissions: allOf: - $ref: '#/components/schemas/measure_money' - description: Sum of commissions for each budget comprising the blended budget reimbursable_expenses: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The weighted average of reimbursable expenses for each budget comprising the blended budget net_effective_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The weighted average of net effective rent for each budget comprising the blended budget net_present_value: allOf: - $ref: '#/components/schemas/measure_money_area' - description: The weighted average of net present value for each budget comprising the blended budget relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri budgets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - budgets example: budgets '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-blended-budgets /api/v1/blended_budgets/{id}: get: summary: Retrieves specific blended budgets tags: - Blended Budgets security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested blended budget if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: blended_budgets id: type: string example: '1' description: The ID of the blended budget attributes: type: object properties: created_at: type: string example: '2021-11-29T20:10:15.232949Z' description: The timestamp when this blended budget was created updated_at: type: string example: '2021-11-29T20:10:15.232949Z' description: The timestamp when this blended budget was last updated rentable_size: allOf: - $ref: '#/components/schemas/measure_area' - description: The sum of the rentable areas for each budget comprising the blended budget base_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The weighted average of the base rents for each budget comprising the blended budget recovered_income: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The weighted average of the recovery income for each budget comprising the blended budget total_other_revenue: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The weighted average of other revenue for each budget comprising the blended budget total_percentage_rent: allOf: - $ref: '#/components/schemas/measure_money' - description: Sum of percentage rent for each budget comprising the blended budget total_free_rent: allOf: - $ref: '#/components/schemas/measure_money' - description: Sum of free rent for each budget comprising the blended budget tenant_improvements: allOf: - $ref: '#/components/schemas/measure_money_area' - description: Sum of tenant improvements for each budget comprising the blended budget building_improvements: allOf: - $ref: '#/components/schemas/measure_money_area' - description: Sum of building improvements for each budget comprising the blended budget total_commissions: allOf: - $ref: '#/components/schemas/measure_money' - description: Sum of commissions for each budget comprising the blended budget reimbursable_expenses: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The weighted average of reimbursable expenses for each budget comprising the blended budget net_effective_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The weighted average of net effective rent for each budget comprising the blended budget net_present_value: allOf: - $ref: '#/components/schemas/measure_money_area' - description: The weighted average of net present value for each budget comprising the blended budget relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri budgets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - budgets example: budgets '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested blended budget does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-blended-budgets-id /api/v1/broker/activities: get: summary: Fetches Broker Activities tags: - Broker security: - basic_auth: [] responses: '200': description: Returns list of Broker Activities content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: broker_activities attributes: type: object properties: total_active_deals: type: object description: Number of active deals by deal type (i.e. any deal that doesn't have the status `lease_executed`, `dead_deal`, or `idle`) properties: new: type: number example: 1 description: Number of active deals with deal type `new` original: type: number example: 1 description: Number of active deals with deal type `original` renewal: type: number example: 1 description: Number of active deals with deal type `renewal` renewal_two: type: number example: 1 description: Number of active deals with deal type `renewal_two` renewal_three: type: number example: 1 description: Number of active deals with deal type `renewal_three` extension: type: number example: 1 description: Number of active deals with deal type `extension` expansion: type: number example: 1 description: Number of active deals with deal type `expansion` termination: type: number example: 1 description: Number of active deals with deal type `termination` modification: type: number example: 1 description: Number of active deals with deal type `modification` sublease: type: number example: 1 description: Number of active deals with deal type `sublease` license_agreement: type: number example: 1 description: Number of active deals with deal type `license_agreement` storage: type: number example: 1 description: Number of active deals with deal type `storage` specialty: type: number example: 1 description: Number of active deals with deal type `specialty` short_term_lease: type: number example: 1 description: Number of active deals with deal type `short_term_lease` other: type: number example: 1 description: Number of active deals with deal type `other` relocation: type: number example: 1 description: Number of active deals with deal type `relocation` rent_review: type: number example: 1 description: Number of active deals with deal type `rent_review` break: type: number example: 1 description: Number of active deals with deal type `break` fixed_option: type: number example: 1 description: Number of active deals with deal type `fixed_option` total_executed_deals: type: object description: Number of executed deals by deal type (i.e. any deal with the status `lease_executed`) properties: new: type: number example: 1 description: Number of executed deals with deal type `new` original: type: number example: 1 description: Number of executed deals with deal type `original` renewal: type: number example: 1 description: Number of executed deals with deal type `renewal` renewal_two: type: number example: 1 description: Number of executed deals with deal type `renewal_two` renewal_three: type: number example: 1 description: Number of executed deals with deal type `renewal_three` extension: type: number example: 1 description: Number of executed deals with deal type `extension` expansion: type: number example: 1 description: Number of executed deals with deal type `expansion` termination: type: number example: 1 description: Number of executed deals with deal type `termination` modification: type: number example: 1 description: Number of executed deals with deal type `modification` sublease: type: number example: 1 description: Number of executed deals with deal type `sublease` license_agreement: type: number example: 1 description: Number of executed deals with deal type `license_agreement` storage: type: number example: 1 description: Number of executed deals with deal type `storage` specialty: type: number example: 1 description: Number of executed deals with deal type `specialty` short_term_lease: type: number example: 1 description: Number of executed deals with deal type `short_term_lease` other: type: number example: 1 description: Number of executed deals with deal type `other` relocation: type: number example: 1 description: Number of executed deals with deal type `relocation` rent_review: type: number example: 1 description: Number of executed deals with deal type `rent_review` break: type: number example: 1 description: Number of executed deals with deal type `break` fixed_option: type: number example: 1 description: Number of executed deals with deal type `fixed_option` total_deals: type: object description: Number of deals in each stage properties: tenants_in_the_market: type: number example: 1 description: Number of deals with deal stage `tenants_in_the_market` initial_inquiry: type: number example: 1 description: Number of deals with deal stage `initial_inquiry` preview: type: number example: 1 description: Number of deals with deal stage `preview` tour: type: number example: 1 description: Number of deals with deal stage `tour` proposal: type: number example: 1 description: Number of deals with deal stage `proposal` loi: type: number example: 1 description: Number of deals with deal stage `loi` legal: type: number example: 1 description: Number of deals with deal stage `legal` lease_out: type: number example: 1 description: Number of deals with deal stage `lease_out` idle: type: number example: 1 description: Number of deals with deal stage `idle` dead_deal: type: number example: 1 description: Number of deals with deal stage `dead_deal` lease_executed: type: number example: 1 description: Number of deals with deal stage `lease_executed` '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-broker-activities /api/v1/broker/agents: get: summary: Fetches broker agent users tags: - Broker security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns a list of broker agent users associated with the current account content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string example: '1' type: type: string example: broker_agents attributes: type: object properties: first_name: type: string example: John last_name: type: string example: Doe email: type: string example: johndoe@example.com created_at: type: string format: date-time description: The created at date-time the current broker user current_sign_in_at: type: string nullable: true format: date-time is_account_user: type: boolean is_company_admin: type: boolean phone: type: string example: '1234567890' phone_extension: type: string example: '1234' days_signed_in_for_last_30_days: type: number minimum: 0 maximum: 30 example: 14 description: Within the last 30 days, the number of days where the User had at least 1 login days_with_activity_for_last_30_days: type: number minimum: 0 maximum: 30 example: 10 description: Within the last 30 days, the number of days where the User performed at least 1 creation, update, or deletion within VTS Lease email_engagement_for_last_30_days: type: object description: VTS email activity for this User properties: emails_delivered: type: number minimum: 0 maximum: 30 example: 4 description: Within the last 30 days, the number of emails delivered to this User emails_opened: type: number minimum: 0 maximum: 30 example: 3 description: Within the last 30 days, number of emails opened by this User assets: type: array items: type: object properties: id: type: string type: type: string example: asset name: type: string example: A property name nullable: true owner_name: type: string example: VTS Investments address: type: string example: 70233 Allyson Lake New York, NY 10023 country: type: string example: United States account_id: type: string example: '123' nullable: true links: type: object properties: self: type: string example: https://api.vts.com/api/v1/broker/agents?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/broker/agents?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Broker Agents next: type: string example: https://api.vts.com/api/v1/broker/agents?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Broker Agents required: - self '401': description: Bad API Credentials content: application/json: schema: $ref: '#/components/schemas/errors_object' '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-broker-agents /api/v1/broker/agents/{id}: get: summary: Retrieves specific broker agent user tags: - Broker security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested broker agent user if it exists content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: '1' type: type: string example: broker_agents attributes: type: object properties: first_name: type: string example: John last_name: type: string example: Doe email: type: string example: johndoe@example.com created_at: type: string format: date-time description: The created at date-time the current broker user current_sign_in_at: type: string nullable: true format: date-time is_account_user: type: boolean is_company_admin: type: boolean phone: type: string example: '1234567890' phone_extension: type: string example: '1234' days_signed_in_for_last_30_days: type: number minimum: 0 maximum: 30 example: 14 description: Within the last 30 days, the number of days where the User had at least 1 login days_with_activity_for_last_30_days: type: number minimum: 0 maximum: 30 example: 10 description: Within the last 30 days, the number of days where the User performed at least 1 creation, update, or deletion within VTS Lease email_engagement_for_last_30_days: type: object description: VTS email activity for this User properties: emails_delivered: type: number minimum: 0 maximum: 30 example: 4 description: Within the last 30 days, the number of emails delivered to this User emails_opened: type: number minimum: 0 maximum: 30 example: 3 description: Within the last 30 days, number of emails opened by this User assets: type: array items: type: object properties: id: type: string type: type: string example: asset name: type: string example: A property name nullable: true owner_name: type: string example: VTS Investments address: type: string example: 70233 Allyson Lake New York, NY 10023 country: type: string example: United States account_id: type: string example: '123' nullable: true '401': description: Bad API Credentials content: application/json: schema: $ref: '#/components/schemas/errors_object' '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested broker agent user does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-broker-agents-id /api/v1/broker/assets: get: summary: Fetches Broker Assets tags: - Broker security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Broker Assets content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string attributes: type: object properties: account: type: object properties: name: type: string example: VTS description: The name of the Account that owns this Asset nullable: true id: type: string example: '12345' description: The ID of the Account that owns this Asset nullable: true owner: type: string example: OwnerCorp description: The owning company for this Asset nullable: true name: type: string example: My Cool Property description: The building name for this Asset nullable: true address: type: object description: Geographic address information properties: street_address: type: string example: 114 W 41st St, Floor 11 description: The street address locality: type: string example: New York description: The locality or city region: type: string example: NY description: The province, state, county, or region country: type: string example: United States description: The country postal_code: type: string example: '10036' description: The postal or zip code formatted: type: string example: 114 W 41st St, Floor 11, New York, NY 10036 description: Formatted address string broker: type: object description: Broker contact information properties: name: type: string example: Mary Jane Watson description: Broker Name nullable: true title: type: string example: Actor description: Broker Title nullable: true email: type: string example: mj@actorsequity.org description: Broker Email Address nullable: true deprecated: true building_class: type: string example: A enum: - A - B - C description: 'The Building Class for this Asset. Possible values: A, B, C.' has_office_space: type: boolean description: Whether this Asset has office space has_retail_space: type: boolean description: Whether this Asset has retail space has_industrial_space: type: boolean description: Whether this Asset has industrial space number_of_floors: type: number description: The number of floors this Asset has nullable: true rentable_building_area: $ref: '#/components/schemas/measure_size' size: $ref: '#/components/schemas/measure_size' submarket: type: string nullable: true description: The submarket in which this Asset is located market: type: string nullable: true description: The market in which this Asset is located floors: type: array items: type: object properties: position: type: number description: The floor position name: type: string description: The name or label for this floor building_contacts: type: array items: type: object properties: name: type: string description: The name for the Building Contact email: type: string description: The email address for the Building Contact multi_building_asset: type: object nullable: true properties: name: type: string example: Parker Plaza description: The name of the Multi-Building Asset that this Asset is associated with id: type: string example: '123488776' description: The ID of the Multi-Building Asset that this Asset is associated with created_at: type: string format: date-time updated_at: type: string format: date-time total_active_deals: type: object properties: new: type: number example: 1 description: Number of active deals on this Asset with deal type `new` original: type: number example: 1 description: Number of active deals on this Asset with deal type `original` renewal: type: number example: 1 description: Number of active deals on this Asset with deal type `renewal` renewal_two: type: number example: 1 description: Number of active deals on this Asset with deal type `renewal_two` renewal_three: type: number example: 1 description: Number of active deals on this Asset with deal type `renewal_three` extension: type: number example: 1 description: Number of active deals on this Asset with deal type `extension` expansion: type: number example: 1 description: Number of active deals on this Asset with deal type `expansion` termination: type: number example: 1 description: Number of active deals on this Asset with deal type `termination` modification: type: number example: 1 description: Number of active deals on this Asset with deal type `modification` sublease: type: number example: 1 description: Number of active deals on this Asset with deal type `sublease` license_agreement: type: number example: 1 description: Number of active deals on this Asset with deal type `license_agreement` storage: type: number example: 1 description: Number of active deals on this Asset with deal type `storage` specialty: type: number example: 1 description: Number of active deals on this Asset with deal type `specialty` short_term_lease: type: number example: 1 description: Number of active deals on this Asset with deal type `short_term_lease` other: type: number example: 1 description: Number of active deals on this Asset with deal type `other` relocation: type: number example: 1 description: Number of active deals on this Asset with deal type `relocation` rent_review: type: number example: 1 description: Number of active deals on this Asset with deal type `rent_review` break: type: number example: 1 description: Number of active deals on this Asset with deal type `break` fixed_option: type: number example: 1 description: Number of active deals on this Asset with deal type `fixed_option` total_executed_deals: type: object description: Number of executed deals by deal type (i.e. any deal with the status `lease_executed`) properties: new: type: number example: 1 description: Number of executed deals on this Asset with deal type `new` original: type: number example: 1 description: Number of executed deals on this Asset with deal type `original` renewal: type: number example: 1 description: Number of executed deals on this Asset with deal type `renewal` renewal_two: type: number example: 1 description: Number of executed deals on this Asset with deal type `renewal_two` renewal_three: type: number example: 1 description: Number of executed deals on this Asset with deal type `renewal_three` extension: type: number example: 1 description: Number of executed deals on this Asset with deal type `extension` expansion: type: number example: 1 description: Number of executed deals on this Asset with deal type `expansion` termination: type: number example: 1 description: Number of executed deals on this Asset with deal type `termination` modification: type: number example: 1 description: Number of executed deals on this Asset with deal type `modification` sublease: type: number example: 1 description: Number of executed deals on this Asset with deal type `sublease` license_agreement: type: number example: 1 description: Number of executed deals on this Asset with deal type `license_agreement` storage: type: number example: 1 description: Number of executed deals on this Asset with deal type `storage` specialty: type: number example: 1 description: Number of executed deals on this Asset with deal type `specialty` short_term_lease: type: number example: 1 description: Number of executed deals on this Asset with deal type `short_term_lease` other: type: number example: 1 description: Number of executed deals on this Asset with deal type `other` relocation: type: number example: 1 description: Number of executed deals on this Asset with deal type `relocation` rent_review: type: number example: 1 description: Number of executed deals on this Asset with deal type `rent_review` break: type: number example: 1 description: Number of executed deals on this Asset with deal type `break` fixed_option: type: number example: 1 description: Number of executed deals on this Asset with deal type `fixed_option` total_deals: type: object description: Number of deals in each stage properties: tenants_in_the_market: type: number example: 1 description: Number of deals on this Asset with deal stage `tenants_in_the_market` initial_inquiry: type: number example: 1 description: Number of deals on this Asset with deal stage `initial_inquiry` preview: type: number example: 1 description: Number of deals on this Asset with deal stage `preview` tour: type: number example: 1 description: Number of deals on this Asset with deal stage `tour` proposal: type: number example: 1 description: Number of deals on this Asset with deal stage `proposal` loi: type: number example: 1 description: Number of deals on this Asset with deal stage `loi` legal: type: number example: 1 description: Number of deals on this Asset with deal stage `legal` lease_out: type: number example: 1 description: Number of deals on this Asset with deal stage `lease_out` idle: type: number example: 1 description: Number of deals on this Asset with deal stage `idle` dead_deal: type: number example: 1 description: Number of deals on this Asset with deal stage `dead_deal` lease_executed: type: number example: 1 description: Number of deals on this Asset with deal stage `lease_executed` links: type: object properties: self: type: string example: https://api.vts.com/api/v1/broker/assets?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/broker/assets?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Broker Assets next: type: string example: https://api.vts.com/api/v1/broker/assets?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Broker Assets required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-broker-assets /api/v1/broker/assets/{id}: get: summary: Fetches Specific Broker Asset tags: - Broker security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested asset if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: account: type: object properties: name: type: string example: VTS description: The name of the Account that owns this Asset nullable: true id: type: string example: '12345' description: The ID of the Account that owns this Asset nullable: true owner: type: string example: OwnerCorp description: The owning company for this Asset nullable: true name: type: string example: My Cool Property description: The building name for this Asset nullable: true address: type: object description: Geographic address information properties: street_address: type: string example: 114 W 41st St, Floor 11 description: The street address locality: type: string example: New York description: The locality or city region: type: string example: NY description: The province, state, county, or region country: type: string example: United States description: The country postal_code: type: string example: '10036' description: The postal or zip code formatted: type: string example: 114 W 41st St, Floor 11, New York, NY 10036 description: Formatted address string broker: type: object description: Broker contact information properties: name: type: string example: Mary Jane Watson description: Broker Name nullable: true title: type: string example: Actor description: Broker Title nullable: true email: type: string example: mj@actorsequity.org description: Broker Email Address nullable: true deprecated: true building_class: type: string example: A enum: - A - B - C description: 'The Building Class for this Asset. Possible values: A, B, C.' has_office_space: type: boolean description: Whether this Asset has office space has_retail_space: type: boolean description: Whether this Asset has retail space has_industrial_space: type: boolean description: Whether this Asset has industrial space number_of_floors: type: number description: The number of floors this Asset has nullable: true rentable_building_area: $ref: '#/components/schemas/measure_size' size: $ref: '#/components/schemas/measure_size' submarket: type: string nullable: true description: The submarket in which this Asset is located market: type: string nullable: true description: The market in which this Asset is located floors: type: array items: type: object properties: position: type: number description: The floor position name: type: string description: The name or label for this floor building_contacts: type: array items: type: object properties: name: type: string description: The name for the Building Contact email: type: string description: The email address for the Building Contact multi_building_asset: type: object nullable: true properties: name: type: string example: Parker Plaza description: The name of the Multi-Building Asset that this Asset is associated with id: type: string example: '123488776' description: The ID of the Multi-Building Asset that this Asset is associated with created_at: type: string format: date-time updated_at: type: string format: date-time total_active_deals: type: object properties: new: type: number example: 1 description: Number of active deals on this Asset with deal type `new` original: type: number example: 1 description: Number of active deals on this Asset with deal type `original` renewal: type: number example: 1 description: Number of active deals on this Asset with deal type `renewal` renewal_two: type: number example: 1 description: Number of active deals on this Asset with deal type `renewal_two` renewal_three: type: number example: 1 description: Number of active deals on this Asset with deal type `renewal_three` extension: type: number example: 1 description: Number of active deals on this Asset with deal type `extension` expansion: type: number example: 1 description: Number of active deals on this Asset with deal type `expansion` termination: type: number example: 1 description: Number of active deals on this Asset with deal type `termination` modification: type: number example: 1 description: Number of active deals on this Asset with deal type `modification` sublease: type: number example: 1 description: Number of active deals on this Asset with deal type `sublease` license_agreement: type: number example: 1 description: Number of active deals on this Asset with deal type `license_agreement` storage: type: number example: 1 description: Number of active deals on this Asset with deal type `storage` specialty: type: number example: 1 description: Number of active deals on this Asset with deal type `specialty` short_term_lease: type: number example: 1 description: Number of active deals on this Asset with deal type `short_term_lease` other: type: number example: 1 description: Number of active deals on this Asset with deal type `other` relocation: type: number example: 1 description: Number of active deals on this Asset with deal type `relocation` rent_review: type: number example: 1 description: Number of active deals on this Asset with deal type `rent_review` break: type: number example: 1 description: Number of active deals on this Asset with deal type `break` fixed_option: type: number example: 1 description: Number of active deals on this Asset with deal type `fixed_option` total_executed_deals: type: object description: Number of executed deals by deal type (i.e. any deal with the status `lease_executed`) properties: new: type: number example: 1 description: Number of executed deals on this Asset with deal type `new` original: type: number example: 1 description: Number of executed deals on this Asset with deal type `original` renewal: type: number example: 1 description: Number of executed deals on this Asset with deal type `renewal` renewal_two: type: number example: 1 description: Number of executed deals on this Asset with deal type `renewal_two` renewal_three: type: number example: 1 description: Number of executed deals on this Asset with deal type `renewal_three` extension: type: number example: 1 description: Number of executed deals on this Asset with deal type `extension` expansion: type: number example: 1 description: Number of executed deals on this Asset with deal type `expansion` termination: type: number example: 1 description: Number of executed deals on this Asset with deal type `termination` modification: type: number example: 1 description: Number of executed deals on this Asset with deal type `modification` sublease: type: number example: 1 description: Number of executed deals on this Asset with deal type `sublease` license_agreement: type: number example: 1 description: Number of executed deals on this Asset with deal type `license_agreement` storage: type: number example: 1 description: Number of executed deals on this Asset with deal type `storage` specialty: type: number example: 1 description: Number of executed deals on this Asset with deal type `specialty` short_term_lease: type: number example: 1 description: Number of executed deals on this Asset with deal type `short_term_lease` other: type: number example: 1 description: Number of executed deals on this Asset with deal type `other` relocation: type: number example: 1 description: Number of executed deals on this Asset with deal type `relocation` rent_review: type: number example: 1 description: Number of executed deals on this Asset with deal type `rent_review` break: type: number example: 1 description: Number of executed deals on this Asset with deal type `break` fixed_option: type: number example: 1 description: Number of executed deals on this Asset with deal type `fixed_option` total_deals: type: object description: Number of deals in each stage properties: tenants_in_the_market: type: number example: 1 description: Number of deals on this Asset with deal stage `tenants_in_the_market` initial_inquiry: type: number example: 1 description: Number of deals on this Asset with deal stage `initial_inquiry` preview: type: number example: 1 description: Number of deals on this Asset with deal stage `preview` tour: type: number example: 1 description: Number of deals on this Asset with deal stage `tour` proposal: type: number example: 1 description: Number of deals on this Asset with deal stage `proposal` loi: type: number example: 1 description: Number of deals on this Asset with deal stage `loi` legal: type: number example: 1 description: Number of deals on this Asset with deal stage `legal` lease_out: type: number example: 1 description: Number of deals on this Asset with deal stage `lease_out` idle: type: number example: 1 description: Number of deals on this Asset with deal stage `idle` dead_deal: type: number example: 1 description: Number of deals on this Asset with deal stage `dead_deal` lease_executed: type: number example: 1 description: Number of deals on this Asset with deal stage `lease_executed` '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested asset does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-broker-assets-id /api/v1/broker/availabilities: get: summary: Fetches Broker Availabilities tags: - Broker security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of BrokerAvailabilities content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this availability was created updated_at: type: string format: date-time description: The timestamp when this availability was last updated asset: type: object properties: id: type: string example: '232' description: The Asset ID for this Space name: type: string nullable: true example: The Cool Building description: The Asset Name that this Space included in suite: type: string example: '7' description: The Space suite number floor: type: object properties: name: type: string example: Floor 1 description: Floor Name position: type: number example: 1 description: Floor Position availability_type: type: string example: arranged enum: - arranged - immediate - month to month - not available - specified description: 'The Availability Type for this Space. Possible Values: arranged, immediate, month to month, not available, specified' current_size: $ref: '#/components/schemas/measure_size' space_type: type: string nullable: true enum: - office - retail - industrial_warehouse - telecom - storage - flex - parking - amenities - rooftop - other - lab - manufacturing - residential - medical_office - education - restaurant - leisure - unspecified - null example: office description: 'The type of space. Possible values: office, retail, industrial_warehouse, telecom, storage, flex, parking, amenities, rooftop, other, lab, manufacturing, residential, medical_office, education, restaurant, leisure, unspecified' relationships: type: object properties: asset: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets example: assets brokers: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: self: type: string example: https://api.vts.com/api/v1/broker/availabilities?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/broker/availabilities?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Availabilities next: type: string example: https://api.vts.com/api/v1/broker/availabilities?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Availabilities required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-broker-availabilities /api/v1/budgets: get: summary: Fetches budgets tags: - Budgets security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string responses: '200': description: Returns list of Budgets content: application/json: schema: type: object properties: type: type: string example: budgets id: type: string example: '1' attributes: type: object properties: label: type: string nullable: true example: Budget for Fiscal Year 2022 description: The label assigned for the given Budget budget_year: type: number nullable: true example: 2022 description: The year for the Budget npv_discount_rate: type: string nullable: true example: '1.0' description: Net Present Value discount rate rentable_size: allOf: - $ref: '#/components/schemas/measure_area' - description: Area of the space budgeted for lease structure: type: string example: full service description: Rent and recovery structure label total_lease_term: type: number example: 24 description: Duration of the lease in months commencement_date: type: string example: '2021-12-08' format: date description: Start of the lease. Usually designates when the tenant is entitled to the space. created_at: type: string example: '2021-12-08T16:28:22.179486Z' format: date-time description: The timestamp when this budget was created updated_at: type: string example: '2021-12-08T16:28:22.187979Z' description: The timestamp when this budget was last updated commissions_months: type: number nullable: true example: 1 description: When commission percentage will be applied at a different rate during the term of the lease. The user can specify the start month that the percentage is applicable for. The percentage is applied between the start month and the next commission period start month security_deposit: allOf: - $ref: '#/components/schemas/measure_money' - properties: security_deposit_type: type: string example: letter_of_credit description: The type of the security deposit description: Value and currency of the budget's security deposit net_effective_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The normalized value a tenant will pay per period to the landlord over the lease term,considering Net Present Value. Returned in money/area/year units. tenant_improvements: type: array items: description: Each Tenant Improvement type: object properties: allowance_unit: type: string example: rsf description: Tenant Improvements allowance unit allowance: type: number format: float example: 0 description: Tenant Improvements allowance occurrence_month: type: number example: 1 description: Tenant Improvements occurrence month. Possible values are between 1 and the number of months in the budget description: type: string nullable: true example: Some text description: Tenant Improvements description deprecated: true building_improvements: type: array items: description: Each Building Improvement type: object properties: allowance_unit: type: string example: rsf description: Building Improvements allowance unit allowance: type: number format: float example: 0 description: Building Improvements allowance occurrence_month: type: number example: 1 description: Building Improvements occurrence month. Possible values are between 1 and the number of months in the budget description: type: string nullable: true example: Some text description: Building Improvements description deprecated: true entered_date: type: string example: '1' description: When the deal term was entered execution_date: type: string nullable: true example: '1' description: Date lease was or will be executed by lawyers rent_schedule: type: array description: Individual rent steps of a budget's calculated schedule items: type: object properties: start_month: type: number example: 1 description: Month that rent step goes into effect, relative to lease commencement date end_month: type: number example: 5 description: Final month that rent step is in effect, relative to lease commencement date amount: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 description: Calculated rent amount for period, annualized per area unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: Calculated rent amount for period, annualized per area net_present_value: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The present value of the net cash flow given the time value of money total_deal_value: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: type: string nullable: true example: Some text description: A description of the budget net_cash_flow: allOf: - $ref: '#/components/schemas/measure_money' - description: Total net cash flow of the deal total_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: Amount of income that will be realized as "rent". Total value of Base Rent + Escalations - Free Rent concessions: type: string example: '0.0' description: Total concessions on the deal payback: type: number example: 1 description: Month number for the breakeven point internal_rate_of_return: type: string nullable: true example: '100.0' description: The return on money spent for the term of the lease gross_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: Value of revenue from base rent, escalation, & recovery income net_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: Value of revenue from base rent, escalation, - recovery income. Returned in money/area/month units free_rents: allOf: - $ref: '#/components/schemas/free_rents' - properties: recovery_type: type: string enum: - net - gross example: gross description: 'net: percent of net base rent; gross: percent of gross base rent and recoveries.' deprecated: true percent_free: type: number format: float example: 1.5 description: Discount as a percentage value of rent deprecated: true duration: type: number example: 1 description: The number of months in which the free rent applies deprecated: true base_rents: allOf: - $ref: '#/components/schemas/base_rents' - properties: begin_in: type: number example: 1 description: This attributes is deprecated. Please start using start_month attribute. deprecated: true tenant_risk_description: type: string nullable: true example: Some text description: Description of money paid to landlord outside of lease cash flow to mitigate the risk of leasing to tenant downtime: allOf: - $ref: '#/components/schemas/measure_period' - properties: magnitude: example: 2 unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M description: Months from previous tenant move-out to commencement date of replacement tenant lock_in_end_date: type: string nullable: true example: '2021-12-08' description: The minimum duration of the lease that must be honored/paid by the tenant should they choose to terminate early in the future. minimum_guarantee: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: Value of revenue from base rent, escalation, - recovery income. Returned in money/area/month units other_fees: type: array items: type: object properties: occurrence_month: type: number example: 1 description: Other Fees occurrence month. Possible values are between 1 and the number of months in the budget allowance_unit: type: string enum: - total - USD/sf example: USD/sf description: Other Fees allowance unit allowance: type: number example: 9.99 description: Other Fees allowance description: type: string example: Description description: The description of other fees deprecated: true commissions: $ref: '#/components/schemas/commissions' rent_escalations: $ref: '#/components/schemas/rent_escalations' percentage_rents: $ref: '#/components/schemas/percentage_rents' other_incomes: $ref: '#/components/schemas/other_incomes' reimbursable_expenses: type: array items: type: object properties: type: type: string example: OperationalExpense enum: - OperationalExpense - RealEstateTax - ReimbursableExpenseCleaning - ReimbursableExpenseInsurance - ReimbursableExpenseMarketing - ReimbursableExpenseOm - ReimbursableExpenseOther - ReimbursableExpenseRepairsAndMaintenance - ReimbursableExpenseSecurity - ReimbursableExpenseUtility - ReimbursableExpenseCam - ReimbursableExpenseElectric - ReimbursableExpenseLandscaping - ReimbursableExpenseManagementFee description: The type of the reimbursable expense deprecated: true expense_type: type: string example: OperationalExpense enum: - OperationalExpense - RealEstateTax - ReimbursableExpenseCleaning - ReimbursableExpenseInsurance - ReimbursableExpenseMarketing - ReimbursableExpenseOm - ReimbursableExpenseOther - ReimbursableExpenseRepairsAndMaintenance - ReimbursableExpenseSecurity - ReimbursableExpenseUtility - ReimbursableExpenseCam - ReimbursableExpenseElectric - ReimbursableExpenseLandscaping - ReimbursableExpenseManagementFee description: The type of the reimbursable expense recovery_method: type: string example: gross enum: - gross - net - amount - modified_gross description: The calculation method of the recovery amount for the reimbursable expense expense_growth_rate: allOf: - $ref: '#/components/schemas/measure_percentage' - description: The expenses will grow by this rate every 12 months after the lease commencement date. expense_amount: type: number format: float example: 10 description: The amount of the reimbursable expense deprecated: true expense_amount_with_units: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The amount of the reimbursable expense recovery_amount: type: number example: 5 description: The amount of reimbursable expense that will be paid to landlord by the tenant deprecated: true recovery_amount_with_units: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The amount of reimbursable expense that will be paid to landlord by the tenant with recovery type modified_gross expense_stop: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The expense stop of the reimbursable expense. Only applies for expenses with recovery type modified_gross description: type: string example: Description description: The description of reimbursable expense costs: $ref: '#/components/schemas/costs' proposal_type: type: string example: budget description: The proposal type of the budget calculated_metrics: type: object properties: ner_override: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: Net Effective Rent as a percent of NER of budget npv_per_area: allOf: - $ref: '#/components/schemas/measure_money_area' - description: The present value of the net cash flow given the time value of money relationships: type: object properties: asset: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets example: assets links: type: object properties: related: type: string format: uri description: Only present for asset-level budgets space: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office - spaces_retail - spaces_industrial - spaces_miscellaneous example: spaces_office links: type: object properties: related: type: string format: uri description: Only present for space-level budgets blended_budget: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - blended_budgets example: blended_budgets '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-budgets /api/v1/budgets/{id}: get: summary: Retrieves specific budgets tags: - Budgets security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested budget if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: budgets id: type: string example: '1' attributes: type: object properties: label: type: string nullable: true example: Budget for Fiscal Year 2022 description: The label assigned for the given Budget budget_year: type: number nullable: true example: 2022 description: The year for the Budget npv_discount_rate: type: string nullable: true example: '1.0' description: Net Present Value discount rate rentable_size: allOf: - $ref: '#/components/schemas/measure_area' - description: Area of the space budgeted for lease structure: type: string example: full service description: Rent and recovery structure label total_lease_term: type: number example: 24 description: Duration of the lease in months commencement_date: type: string example: '2021-12-08' format: date description: Start of the lease. Usually designates when the tenant is entitled to the space. created_at: type: string example: '2021-12-08T16:28:22.179486Z' format: date-time description: The timestamp when this budget was created updated_at: type: string example: '2021-12-08T16:28:22.187979Z' description: The timestamp when this budget was last updated commissions_months: type: number nullable: true example: 1 description: When commission percentage will be applied at a different rate during the term of the lease. The user can specify the start month that the percentage is applicable for. The percentage is applied between the start month and the next commission period start month security_deposit: allOf: - $ref: '#/components/schemas/measure_money' - properties: security_deposit_type: type: string example: letter_of_credit description: The type of the security deposit description: Value and currency of the budget's security deposit net_effective_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The normalized value a tenant will pay per period to the landlord over the lease term,considering Net Present Value. Returned in money/area/year units. tenant_improvements: type: array items: description: Each Tenant Improvement type: object properties: allowance_unit: type: string example: rsf description: Tenant Improvements allowance unit allowance: type: number format: float example: 0 description: Tenant Improvements allowance occurrence_month: type: number example: 1 description: Tenant Improvements occurrence month. Possible values are between 1 and the number of months in the budget description: type: string nullable: true example: Some text description: Tenant Improvements description deprecated: true building_improvements: type: array items: description: Each Building Improvement type: object properties: allowance_unit: type: string example: rsf description: Building Improvements allowance unit allowance: type: number format: float example: 0 description: Building Improvements allowance occurrence_month: type: number example: 1 description: Building Improvements occurrence month. Possible values are between 1 and the number of months in the budget description: type: string nullable: true example: Some text description: Building Improvements description deprecated: true entered_date: type: string example: '1' description: When the deal term was entered execution_date: type: string nullable: true example: '1' description: Date lease was or will be executed by lawyers rent_schedule: type: array description: Individual rent steps of a budget's calculated schedule items: type: object properties: start_month: type: number example: 1 description: Month that rent step goes into effect, relative to lease commencement date end_month: type: number example: 5 description: Final month that rent step is in effect, relative to lease commencement date amount: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 description: Calculated rent amount for period, annualized per area unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: Calculated rent amount for period, annualized per area net_present_value: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The present value of the net cash flow given the time value of money total_deal_value: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: type: string nullable: true example: Some text description: A description of the budget net_cash_flow: allOf: - $ref: '#/components/schemas/measure_money' - description: Total net cash flow of the deal total_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: Amount of income that will be realized as "rent". Total value of Base Rent + Escalations - Free Rent concessions: type: string example: '0.0' description: Total concessions on the deal payback: type: number example: 1 description: Month number for the breakeven point internal_rate_of_return: type: string nullable: true example: '100.0' description: The return on money spent for the term of the lease gross_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: Value of revenue from base rent, escalation, & recovery income net_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: Value of revenue from base rent, escalation, - recovery income. Returned in money/area/month units free_rents: allOf: - $ref: '#/components/schemas/free_rents' - properties: recovery_type: type: string enum: - net - gross example: gross description: 'net: percent of net base rent; gross: percent of gross base rent and recoveries.' deprecated: true percent_free: type: number format: float example: 1.5 description: Discount as a percentage value of rent deprecated: true duration: type: number example: 1 description: The number of months in which the free rent applies deprecated: true base_rents: allOf: - $ref: '#/components/schemas/base_rents' - properties: begin_in: type: number example: 1 description: This attributes is deprecated. Please start using start_month attribute. deprecated: true tenant_risk_description: type: string nullable: true example: Some text description: Description of money paid to landlord outside of lease cash flow to mitigate the risk of leasing to tenant downtime: allOf: - $ref: '#/components/schemas/measure_period' - properties: magnitude: example: 2 unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M description: Months from previous tenant move-out to commencement date of replacement tenant lock_in_end_date: type: string nullable: true example: '2021-12-08' description: The minimum duration of the lease that must be honored/paid by the tenant should they choose to terminate early in the future. minimum_guarantee: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: Value of revenue from base rent, escalation, - recovery income. Returned in money/area/month units other_fees: type: array items: type: object properties: occurrence_month: type: number example: 1 description: Other Fees occurrence month. Possible values are between 1 and the number of months in the budget allowance_unit: type: string enum: - total - USD/sf example: USD/sf description: Other Fees allowance unit allowance: type: number example: 9.99 description: Other Fees allowance description: type: string example: Description description: The description of other fees deprecated: true commissions: $ref: '#/components/schemas/commissions' rent_escalations: $ref: '#/components/schemas/rent_escalations' percentage_rents: $ref: '#/components/schemas/percentage_rents' other_incomes: $ref: '#/components/schemas/other_incomes' reimbursable_expenses: type: array items: type: object properties: type: type: string example: OperationalExpense enum: - OperationalExpense - RealEstateTax - ReimbursableExpenseCleaning - ReimbursableExpenseInsurance - ReimbursableExpenseMarketing - ReimbursableExpenseOm - ReimbursableExpenseOther - ReimbursableExpenseRepairsAndMaintenance - ReimbursableExpenseSecurity - ReimbursableExpenseUtility - ReimbursableExpenseCam - ReimbursableExpenseElectric - ReimbursableExpenseLandscaping - ReimbursableExpenseManagementFee description: The type of the reimbursable expense deprecated: true expense_type: type: string example: OperationalExpense enum: - OperationalExpense - RealEstateTax - ReimbursableExpenseCleaning - ReimbursableExpenseInsurance - ReimbursableExpenseMarketing - ReimbursableExpenseOm - ReimbursableExpenseOther - ReimbursableExpenseRepairsAndMaintenance - ReimbursableExpenseSecurity - ReimbursableExpenseUtility - ReimbursableExpenseCam - ReimbursableExpenseElectric - ReimbursableExpenseLandscaping - ReimbursableExpenseManagementFee description: The type of the reimbursable expense recovery_method: type: string example: gross enum: - gross - net - amount - modified_gross description: The calculation method of the recovery amount for the reimbursable expense expense_growth_rate: allOf: - $ref: '#/components/schemas/measure_percentage' - description: The expenses will grow by this rate every 12 months after the lease commencement date. expense_amount: type: number format: float example: 10 description: The amount of the reimbursable expense deprecated: true expense_amount_with_units: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The amount of the reimbursable expense recovery_amount: type: number example: 5 description: The amount of reimbursable expense that will be paid to landlord by the tenant deprecated: true recovery_amount_with_units: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The amount of reimbursable expense that will be paid to landlord by the tenant with recovery type modified_gross expense_stop: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The expense stop of the reimbursable expense. Only applies for expenses with recovery type modified_gross description: type: string example: Description description: The description of reimbursable expense costs: $ref: '#/components/schemas/costs' proposal_type: type: string example: budget description: The proposal type of the budget calculated_metrics: type: object properties: ner_override: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: Net Effective Rent as a percent of NER of budget npv_per_area: allOf: - $ref: '#/components/schemas/measure_money_area' - description: The present value of the net cash flow given the time value of money relationships: type: object properties: asset: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets example: assets links: type: object properties: related: type: string format: uri description: Only present for asset-level budgets space: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office - spaces_retail - spaces_industrial - spaces_miscellaneous example: spaces_office links: type: object properties: related: type: string format: uri description: Only present for space-level budgets blended_budget: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - blended_budgets example: blended_budgets '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested budget does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-budgets-id /api/v1/buildings: get: summary: Fetches a set of buildings description: Part of the Leasing Availability API, this fetches buildings on VTS Market associated with the account that the API key is generated for with information about the building and its available listings. Expected usage would be to make a portfolio page for the given account security: - basic_auth: [] tags: - Leasing Availability parameters: - name: filter[city] in: query description: Filter by city name. Intended use is either a page for buildings of a given city or to populate a dropdown of cities required: false schema: type: string - name: filter[search] in: query description: Filter by a search string. Partial matches will match and the results will be ordered by the amount of match with buildings and which data element it matches on. Weighted highest for building name and address, then for city, then for state and country required: false schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string responses: '200': description: Returns a list of buildings content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: buildings id: type: string example: 20be22bd-7d79-47f6-a267-fc3492c5d90b attributes: type: object description: A Building properties: abbreviated_region: type: string example: NY amenities: type: object properties: bar_available: type: boolean nullable: true example: true barbershop: type: boolean nullable: true example: true bike_storage_available: type: boolean nullable: true example: true cafe_available: type: boolean nullable: true example: true car_wash: type: boolean nullable: true example: true cctv: type: boolean nullable: true example: true common_area_wifi: type: boolean nullable: true example: true communal_lobby_space: type: boolean nullable: true example: true communal_outdoor_space: type: boolean nullable: true example: true communal_roof_access: type: boolean nullable: true example: true conference_center: type: boolean nullable: true example: true controlled_elevator_access: type: boolean nullable: true example: true covered_parking: type: boolean nullable: true example: true destination_dispatch_elevators: type: boolean nullable: true example: true event_space: type: boolean nullable: true example: true flex_space_available: type: boolean nullable: true example: true food_service_available: type: boolean nullable: true example: true general_store_available: type: boolean nullable: true example: true gym_available: type: boolean nullable: true example: true key_card_building_entry: type: boolean nullable: true example: true loading_dock: type: boolean nullable: true example: true lobby_attendant: type: boolean nullable: true example: true lobby_beverage_available: type: boolean nullable: true example: true lobby_food_available: type: boolean nullable: true example: true locker_rooms: type: boolean nullable: true example: true messenger_center: type: boolean nullable: true example: true networking_events: type: boolean nullable: true example: true option_to_add_internet_service_provider: type: boolean nullable: true example: true parking_available: type: boolean nullable: true example: true parking_garage: type: boolean nullable: true example: true pets_allowed: type: boolean nullable: true example: true pharmacy_available: type: boolean nullable: true example: true property_manager_on_site: type: boolean nullable: true example: true restaurant_available: type: boolean nullable: true example: true showers: type: boolean nullable: true example: true shuttle: type: boolean nullable: true example: true spa_available: type: boolean nullable: true example: true storage_available: type: boolean nullable: true example: true tenant_lounge: type: boolean nullable: true example: true tenant_portal_app: type: boolean nullable: true example: true touch_free_elevator_access: type: boolean nullable: true example: true touchless_turnstile_entry: type: boolean nullable: true example: true transportation_accessible: type: boolean nullable: true example: true turnstiles: type: boolean nullable: true example: true twenty_four_seven_access: type: boolean nullable: true example: true twenty_four_seven_security: type: boolean nullable: true example: true urgent_care_doctor_onsite: type: boolean nullable: true example: true valet_parking: type: boolean nullable: true example: true yoga_studio_available: type: boolean nullable: true example: true electric_vehicle_charging_stations_count: type: integer nullable: true example: 1 passenger_elevator_count: type: integer nullable: true example: 1 service_elevator_count: type: integer nullable: true example: 1 leed_certification: type: string nullable: true example: Gold wired_certification: type: string nullable: true example: Platinum asset_types: type: array items: type: string example: industrial banner_image: type: object properties: path: type: string example: https://media.truva.com/path small_path: type: string example: https://media.truva.com/t_small_image/path description: type: string example: Building Photo nullable: true building_brochure: type: object nullable: true example: name: Brochure-name.pdf url: https://download.link/whatever.pdf id: 2 building_name: type: string nullable: true example: Empire State Building contacts: type: array items: type: object properties: id: type: integer example: 1 first_name: type: string example: John last_name: type: string nullable: true example: Doe email: type: string example: whatever@whever.com role: type: string nullable: true example: CEO phone: type: string nullable: true example: 123-456-7890 phone_extension: type: string nullable: true example: '1234' photo_url: type: string nullable: true example: https://media.truva.com/path company_logo_url: type: string nullable: true example: https://media.truva.com/path broker_licence_number: type: string nullable: true example: 'RC #192017' country_code: type: string example: US description: type: string nullable: true example: This is a building images: type: array items: type: object properties: path: type: string example: https://media.truva.com/path small_path: type: string example: https://media.truva.com/t_small_image/path description: type: string example: Building Photo nullable: false latitude: type: number example: 40.7128 listings: type: array items: type: object properties: id: type: string example: 45b13e12-057c-4136-8dde-06a375613465 area: allOf: - $ref: '#/components/schemas/measure_area' - description: Area of the space of the listing asking_rent: type: object nullable: true properties: magnitude: type: number example: 10000 type: type: string example: area units: type: object properties: area: type: string example: SquareFoot currency: type: string example: USD period: type: string example: month available: type: boolean example: true available_date: type: string nullable: true example: '2021-01-01' condition: type: string nullable: true example: white_box floor: type: string nullable: true example: '7' floor_plan: type: object properties: path: type: string example: https://media.truva.com/path small_path: type: string example: https://media.truva.com/t_small_image/path description: type: string example: Building Photo nullable: true hero_image: type: object properties: path: type: string example: https://media.truva.com/path small_path: type: string example: https://media.truva.com/t_small_image/path description: type: string example: Building Photo nullable: false lease_type: type: string example: direct listing_name: type: string example: 7th Floor, Room 204 suite: type: string nullable: true example: '204' suite_type: type: string nullable: true example: room locality: type: string example: New York logo: type: object properties: path: type: string example: https://media.truva.com/path small_path: type: string example: https://media.truva.com/t_small_image/path description: type: string example: Building Photo nullable: true longitude: type: number example: -74.006 marketplace_url: type: string nullable: true example: https://marketplace.vts.com/market_buildings/id notable_tenants: type: array items: type: object properties: company_name: type: string example: Company logo: type: string example: path postal_code: type: string example: '10001' rentable_area: allOf: - $ref: '#/components/schemas/measure_area' - description: Area of the space of the listing status: type: string example: active street_address: type: string example: 123 Main St submarket: type: string nullable: true example: Bryant Park video_url: type: string nullable: true example: https://example.com virtual_tour_url: type: string nullable: true example: https://example.com vts_property_id: type: integer example: 100 year_built: type: integer nullable: true example: 1920 year_renovated: type: integer nullable: true example: 2020 links: type: object properties: self: type: string example: https://api.vts.com/api/v1/buildings?building_id=20be22bd-7d79-47f6-a267-fc3492c5d90b&page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/buildings?building_id=20be22bd-7d79-47f6-a267-fc3492c5d90b&page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Buildings next: type: string example: https://api.vts.com/api/v1/buildings?building_id=20be22bd-7d79-47f6-a267-fc3492c5d90b&page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Buildings required: - self meta: type: object properties: all_cities: type: array items: type: string example: New York total_buildings: type: integer example: 13 '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-buildings /api/v1/buildings/{id}: get: summary: Fetches a specific building description: Part of the Leasing Availability API, this fetches a specific building on VTS Market with information about the building and its available listings. Expected usage would be to make a webpage about the building tags: - Leasing Availability security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested building if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: buildings id: type: string example: 20be22bd-7d79-47f6-a267-fc3492c5d90b attributes: type: object description: A Building properties: abbreviated_region: type: string example: NY amenities: type: object properties: bar_available: type: boolean nullable: true example: true barbershop: type: boolean nullable: true example: true bike_storage_available: type: boolean nullable: true example: true cafe_available: type: boolean nullable: true example: true car_wash: type: boolean nullable: true example: true cctv: type: boolean nullable: true example: true common_area_wifi: type: boolean nullable: true example: true communal_lobby_space: type: boolean nullable: true example: true communal_outdoor_space: type: boolean nullable: true example: true communal_roof_access: type: boolean nullable: true example: true conference_center: type: boolean nullable: true example: true controlled_elevator_access: type: boolean nullable: true example: true covered_parking: type: boolean nullable: true example: true destination_dispatch_elevators: type: boolean nullable: true example: true event_space: type: boolean nullable: true example: true flex_space_available: type: boolean nullable: true example: true food_service_available: type: boolean nullable: true example: true general_store_available: type: boolean nullable: true example: true gym_available: type: boolean nullable: true example: true key_card_building_entry: type: boolean nullable: true example: true loading_dock: type: boolean nullable: true example: true lobby_attendant: type: boolean nullable: true example: true lobby_beverage_available: type: boolean nullable: true example: true lobby_food_available: type: boolean nullable: true example: true locker_rooms: type: boolean nullable: true example: true messenger_center: type: boolean nullable: true example: true networking_events: type: boolean nullable: true example: true option_to_add_internet_service_provider: type: boolean nullable: true example: true parking_available: type: boolean nullable: true example: true parking_garage: type: boolean nullable: true example: true pets_allowed: type: boolean nullable: true example: true pharmacy_available: type: boolean nullable: true example: true property_manager_on_site: type: boolean nullable: true example: true restaurant_available: type: boolean nullable: true example: true showers: type: boolean nullable: true example: true shuttle: type: boolean nullable: true example: true spa_available: type: boolean nullable: true example: true storage_available: type: boolean nullable: true example: true tenant_lounge: type: boolean nullable: true example: true tenant_portal_app: type: boolean nullable: true example: true touch_free_elevator_access: type: boolean nullable: true example: true touchless_turnstile_entry: type: boolean nullable: true example: true transportation_accessible: type: boolean nullable: true example: true turnstiles: type: boolean nullable: true example: true twenty_four_seven_access: type: boolean nullable: true example: true twenty_four_seven_security: type: boolean nullable: true example: true urgent_care_doctor_onsite: type: boolean nullable: true example: true valet_parking: type: boolean nullable: true example: true yoga_studio_available: type: boolean nullable: true example: true electric_vehicle_charging_stations_count: type: integer nullable: true example: 1 passenger_elevator_count: type: integer nullable: true example: 1 service_elevator_count: type: integer nullable: true example: 1 leed_certification: type: string nullable: true example: Gold wired_certification: type: string nullable: true example: Platinum asset_types: type: array items: type: string example: industrial banner_image: type: object properties: path: type: string example: https://media.truva.com/path small_path: type: string example: https://media.truva.com/t_small_image/path description: type: string example: Building Photo nullable: true building_brochure: type: object nullable: true example: name: Brochure-name.pdf url: https://download.link/whatever.pdf id: 2 building_name: type: string nullable: true example: Empire State Building contacts: type: array items: type: object properties: id: type: integer example: 1 first_name: type: string example: John last_name: type: string nullable: true example: Doe email: type: string example: whatever@whever.com role: type: string nullable: true example: CEO phone: type: string nullable: true example: 123-456-7890 phone_extension: type: string nullable: true example: '1234' photo_url: type: string nullable: true example: https://media.truva.com/path company_logo_url: type: string nullable: true example: https://media.truva.com/path broker_licence_number: type: string nullable: true example: 'RC #192017' country_code: type: string example: US description: type: string nullable: true example: This is a building images: type: array items: type: object properties: path: type: string example: https://media.truva.com/path small_path: type: string example: https://media.truva.com/t_small_image/path description: type: string example: Building Photo nullable: false latitude: type: number example: 40.7128 listings: type: array items: type: object properties: id: type: string example: 45b13e12-057c-4136-8dde-06a375613465 area: allOf: - $ref: '#/components/schemas/measure_area' - description: Area of the space of the listing asking_rent: type: object nullable: true properties: magnitude: type: number example: 10000 type: type: string example: area units: type: object properties: area: type: string example: SquareFoot currency: type: string example: USD period: type: string example: month available: type: boolean example: true available_date: type: string nullable: true example: '2021-01-01' condition: type: string nullable: true example: white_box floor: type: string nullable: true example: '7' floor_plan: type: object properties: path: type: string example: https://media.truva.com/path small_path: type: string example: https://media.truva.com/t_small_image/path description: type: string example: Building Photo nullable: true hero_image: type: object properties: path: type: string example: https://media.truva.com/path small_path: type: string example: https://media.truva.com/t_small_image/path description: type: string example: Building Photo nullable: false lease_type: type: string example: direct listing_name: type: string example: 7th Floor, Room 204 suite: type: string nullable: true example: '204' suite_type: type: string nullable: true example: room locality: type: string example: New York logo: type: object properties: path: type: string example: https://media.truva.com/path small_path: type: string example: https://media.truva.com/t_small_image/path description: type: string example: Building Photo nullable: true longitude: type: number example: -74.006 marketplace_url: type: string nullable: true example: https://marketplace.vts.com/market_buildings/id notable_tenants: type: array items: type: object properties: company_name: type: string example: Company logo: type: string example: path postal_code: type: string example: '10001' rentable_area: allOf: - $ref: '#/components/schemas/measure_area' - description: Area of the space of the listing status: type: string example: active street_address: type: string example: 123 Main St submarket: type: string nullable: true example: Bryant Park video_url: type: string nullable: true example: https://example.com virtual_tour_url: type: string nullable: true example: https://example.com vts_property_id: type: integer example: 100 year_built: type: integer nullable: true example: 1920 year_renovated: type: integer nullable: true example: 2020 '403': description: authenticated but does not have access to requested building content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested building does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-buildings-id /api/v1/coordination_project_milestones: get: summary: Gets a list of coordination project milestones description: Contains all milestones of your portfolio tags: - Coordination Projects security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns a list of milestones associated with your portfolio content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string type: type: string attributes: type: object properties: description: type: string nullable: true completed_at: type: string nullable: true target_date: type: string nullable: true notes: type: string nullable: true created_at: type: string updated_at: type: string category_description: type: string nullable: true relationships: type: object properties: completed_by: type: object properties: data: type: object properties: id: type: string type: type: string nullable: true links: type: object properties: related: type: string coordination_project: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/coordination_projects/1 links: type: object properties: self: type: string example: https://api.vts.com/api/v1/coordination_projects/1/milestones prev: type: string example: https://api.vts.com/api/v1/coordination_projects/12345/milestones?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/coordination_projects/12345/milestones?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-coordination-project-milestones /api/v1/coordination_project_milestones/{id}: get: summary: Gets specific coordination project milestones description: Contains specific milestones of your portfolio tags: - Coordination Projects security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string responses: '200': description: Returns a specific milestones associated with your portfolio content: application/json: schema: type: object properties: data: type: object properties: id: type: string type: type: string attributes: type: object properties: description: type: string nullable: true completed_at: type: string nullable: true target_date: type: string nullable: true notes: type: string nullable: true created_at: type: string updated_at: type: string category_description: type: string nullable: true relationships: type: object properties: completed_by: type: object properties: data: type: object properties: id: type: string type: type: string nullable: true links: type: object properties: related: type: string coordination_project: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/coordination_projects/1 '403': description: API not authorized for use operationId: get_api-v1-coordination-project-milestones-id /api/v1/coordination_projects: get: summary: Gets coordination projects description: Contains the coordination projects in your portfolio tags: - Coordination Projects operationId: coordination_projects security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns a list of coordination projects associated with the current account content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string example: '1' type: type: string example: coordination_projects attributes: type: object properties: target_rent_commencement_date: type: string format: date nullable: true current_rent_commencement_date: type: string format: date nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time status: type: string example: on_track nullable: true relationships: type: object properties: tenant: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/tenants/12345 deal: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/deals/1 asset: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/assets/1 next_milestone: anyOf: - type: object properties: data: type: object properties: id: type: string example: '10' type: type: string example: coordination_milestones links: type: object properties: related: type: string example: https://api.vts.com/api/v1/coordination_project_milestones/1 - type: object properties: data: type: object properties: id: type: string example: '10' type: type: string example: coordination_milestones nullable: true links: type: object properties: self: type: string example: https://api.vts.com/api/v1/coordination_projects prev: type: string example: https://api.vts.com/api/v1/coordination_projects?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/coordination_projects?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' /api/v1/coordination_projects/{id}: get: summary: Retrieves specific coordination project description: Contains the coordination projects in your portfolio tags: - Coordination Projects operationId: coordination_project security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested coordination project if it exists content: application/json: schema: type: object properties: data: type: object items: type: object properties: id: type: string example: '1' type: type: string example: coordination_projects attributes: type: object properties: target_rent_commencement_date: type: string format: date nullable: true current_rent_commencement_date: type: string format: date nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time status: type: string example: on_track nullable: true relationships: type: object properties: tenant: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/tenants/12345 deal: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/deals/1 asset: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/assets/1 next_milestone: anyOf: - type: object properties: data: type: object properties: id: type: string example: '10' type: type: string example: coordination_milestones links: type: object properties: related: type: string example: https://api.vts.com/api/v1/coordination_project_milestones/1 - type: object properties: data: type: object properties: id: type: string example: '10' type: type: string example: coordination_milestones nullable: true links: type: object properties: self: type: string example: https://api.vts.com/api/v1/coordination_projects prev: type: string example: https://api.vts.com/api/v1/coordination_projects?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/coordination_projects?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested coordination project does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' /api/v1/coordination_projects/{project_id}/milestones: get: summary: Gets a coordination project's milestones description: Contains the coordination projects in your portfolio tags: - Coordination Projects security: - basic_auth: [] parameters: - name: project_id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns a list of milestones associated with the coordination project content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string type: type: string attributes: type: object properties: description: type: string nullable: true completed_at: type: string nullable: true target_date: type: string nullable: true notes: type: string nullable: true created_at: type: string updated_at: type: string category_description: type: string nullable: true relationships: type: object properties: completed_by: type: object properties: data: type: object properties: id: type: string type: type: string nullable: true links: type: object properties: related: type: string coordination_project: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/coordination_projects/1 links: type: object properties: self: type: string example: https://api.vts.com/api/v1/coordination_projects/1/milestones prev: type: string example: https://api.vts.com/api/v1/coordination_projects/12345/milestones?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/coordination_projects/12345/milestones?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Referenced coordination project not found content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-coordination-projects-project-id-milestones /api/v1/deal_approvals: get: summary: Fetches approvals tags: - Approvals security: - basic_auth: [] parameters: - name: page[size] in: query required: false description: 'The number of items returned for any one page (default: 10, max: 100)' schema: type: integer - name: page[before] in: query required: false description: Show records before the given page indicator schema: type: string - name: page[after] in: query required: false description: Show records after the given page indicator schema: type: string - name: filter[latest] in: query required: false description: Only show Approvals for the latest Proposal schema: type: boolean - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Approvals content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: approvals id: type: string example: '1' description: The ID of the approval attributes: description: Attributes for the approval type: object properties: requester_comment: type: string example: This is a comment description: Any comments made by the approval requester requested_at: type: string format: date-time description: The date-time the approval was requested at active: type: boolean created_at: type: string format: date-time description: The timestamp when this approval was created updated_at: type: string format: date-time description: The timestamp when this approval was last updated recommendation: type: string nullable: true description: Any suggestions for handling the approval request approvers: description: Information about the specific approval step requested type: array items: description: Information for an approval step type: object properties: step_number: type: integer example: 0 description: The number of the approval step description: type: string example: A description for the approval step status: type: string enum: - pending - approved - rejected - revision_requested description: 'The status of the approval step. Possible values: pending, approved, rejected, revision_requested' reviewed_at: type: string format: date-time nullable: true description: The date-time the approval step was reviewed at - null if not reviewed yet comment: type: string example: This is a comment description: Any comments associated with the approval step approver_user_id: type: integer example: 1 description: The user id of the user assigned to approve the approval step relationships: description: The objects linked to an approval step type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals requester: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals approvers: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users included: type: array items: type: object description: User information for the proposal approvers properties: type: type: string example: users id: type: string example: '1' description: The ID of the user attributes: description: User attributes for a specific approver type: object properties: first_name: type: string example: John description: Approver's first name last_name: type: string example: Doe description: Approver's last name links: type: object properties: self: type: string example: https://api.vts.com/api/v1/deals/123/approvals?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/deals/123/approvals?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Approvals next: type: string example: https://api.vts.com/api/v1/deals/123/approvals?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Approvals required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-approvals /api/v1/deal_approvals/{id}: get: summary: Retrieves specific approvals tags: - Approvals security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested approval if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: approvals id: type: string example: '1' description: The ID of the approval attributes: description: Attributes for the approval type: object properties: requester_comment: type: string example: This is a comment description: Any comments made by the approval requester requested_at: type: string format: date-time description: The date-time the approval was requested at active: type: boolean created_at: type: string format: date-time description: The timestamp when this approval was created updated_at: type: string format: date-time description: The timestamp when this approval was last updated recommendation: type: string nullable: true description: Any suggestions for handling the approval request approvers: description: Information about the specific approval step requested type: array items: description: Information for an approval step type: object properties: step_number: type: integer example: 0 description: The number of the approval step description: type: string example: A description for the approval step status: type: string enum: - pending - approved - rejected - revision_requested description: 'The status of the approval step. Possible values: pending, approved, rejected, revision_requested' reviewed_at: type: string format: date-time nullable: true description: The date-time the approval step was reviewed at - null if not reviewed yet comment: type: string example: This is a comment description: Any comments associated with the approval step approver_user_id: type: integer example: 1 description: The user id of the user assigned to approve the approval step relationships: description: The objects linked to an approval step type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals requester: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals approvers: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested approval does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-approvals-id /api/v1/deal_comments: get: summary: Fetches Deal Comments for a Specific Account description: Contains comments associated with a given deal tags: - Deal Comments security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Deal Comments content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string pattern: deal_comments id: type: string example: '1' attributes: type: object properties: latest: type: boolean description: Whether or not this is the latest comment of it's associated deal text: type: string nullable: true example: This is a comment. description: The content of the deal comment occurred_at: type: string format: date-time description: The timestamp when the comment was added to its associated deal created_at: type: string format: date-time description: The timestamp when this deal comment was created updated_at: type: string format: date-time description: The timestamp when this deal comment was last updated relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri iteration: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deal_iterations example: deal_iterations user: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string example: https://api.vts.com/api/v1/deals/123/comments?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/deals/123/comments?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Deal Comments next: type: string example: https://api.vts.com/api/v1/deals/123/comments?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Deal Comments required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-comments /api/v1/deal_comments/{id}: get: summary: Retrieves specific Deal Comment description: Contains the Deal Comment from your account tags: - Deal Comments security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested account deal comment if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string pattern: deal_comments id: type: string example: '1' attributes: type: object properties: latest: type: boolean description: Whether or not this is the latest comment of it's associated deal text: type: string nullable: true example: This is a comment. description: The content of the deal comment occurred_at: type: string format: date-time description: The timestamp when the comment was added to its associated deal created_at: type: string format: date-time description: The timestamp when this deal comment was created updated_at: type: string format: date-time description: The timestamp when this deal comment was last updated relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri iteration: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deal_iterations example: deal_iterations user: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested deal comment does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-comments-id /api/v1/deal_iterations: get: summary: Fetches account deal iterations description: Contains attributes of deal iterations for a given deal, including deal stage and transition reason tags: - Deal Iterations security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Iterations content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string pattern: deal_iterations example: deal_iterations id: type: string example: '1' attributes: type: object properties: latest: type: boolean description: Whether or not this is the latest stage of it's associated deal stage: type: string enum: - tenants_in_the_market - initial_inquiry - preview - tour - proposal - loi - legal - lease_out example: proposal description: 'The current stage of the associated deal.Possible values: tenants_in_the_market, initial_inquiry, preview, tour, proposal, loi, legal, lease_outidle, dead_deal, lease_executed' reason: type: string enum: - adjacent_stores - cannibalization_risk - ceiling_height - foot_traffic - image - lobby - location - location_on_floor - other - parking_ratio - price - renewal - requirement_dead - security - size - space_condition - space_configuration - space_leased - storefront - timing - transportation - views - global_crisis - duplicate_deal - requirement_changed - decided_to_sublease - unknown - amenities - walkability - tenant_covenant - landlord_decision - tenant_non_responsive - null example: space_leased nullable: true description: 'Why the deal was moved to its current stage. Only applies to a deal in the dead deal stage. Possible values: adjacent_stores, cannibalization_risk, ceiling_height, foot_traffic, image, lobby, location, location_on_floor, other, parking_ratio, price, renewal, requirement_dead, security, size, space_condition, space_configuration, space_leased, storefront, timing, transportation, views, global_crisis, duplicate_deal, requirement_changed, decided_to_sublease, unknown, amenities, walkability, tenant_covenant, landlord_decision, tenant_non_responsive, null' occurred_at: type: string format: date-time description: The timestamp when a deal was marked with the current deal iteration stage created_at: type: string format: date-time description: The timestamp when this deal iteration was created updated_at: type: string format: date-time description: The timestamp when this deal iteration was last updated ended_at: type: string format: date description: The timestamp when the deal iteration ended nullable: true duration_in_days: type: integer example: 1 description: Number of days remaining to end the the Deal. relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri user: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string example: https://api.vts.com/api/v1/deals/123/iterations?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/deals/123/iterations?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Iterations next: type: string example: https://api.vts.com/api/v1/deals/123/iterations?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Iterations required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-iterations /api/v1/deal_iterations/{id}: get: summary: Retrieves specific account deal iteration description: Contains attributes of deal iterations for a given deal, including deal stage and transition reason tags: - Deal Iterations security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested account iteration if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string pattern: deal_iterations example: deal_iterations id: type: string example: '1' attributes: type: object properties: latest: type: boolean description: Whether or not this is the latest stage of it's associated deal stage: type: string enum: - tenants_in_the_market - initial_inquiry - preview - tour - proposal - loi - legal - lease_out example: proposal description: 'The current stage of the associated deal.Possible values: tenants_in_the_market, initial_inquiry, preview, tour, proposal, loi, legal, lease_outidle, dead_deal, lease_executed' reason: type: string enum: - adjacent_stores - cannibalization_risk - ceiling_height - foot_traffic - image - lobby - location - location_on_floor - other - parking_ratio - price - renewal - requirement_dead - security - size - space_condition - space_configuration - space_leased - storefront - timing - transportation - views - global_crisis - duplicate_deal - requirement_changed - decided_to_sublease - unknown - amenities - walkability - tenant_covenant - landlord_decision - tenant_non_responsive - null example: space_leased nullable: true description: 'Why the deal was moved to its current stage. Only applies to a deal in the dead deal stage. Possible values: adjacent_stores, cannibalization_risk, ceiling_height, foot_traffic, image, lobby, location, location_on_floor, other, parking_ratio, price, renewal, requirement_dead, security, size, space_condition, space_configuration, space_leased, storefront, timing, transportation, views, global_crisis, duplicate_deal, requirement_changed, decided_to_sublease, unknown, amenities, walkability, tenant_covenant, landlord_decision, tenant_non_responsive, null' occurred_at: type: string format: date-time description: The timestamp when a deal was marked with the current deal iteration stage created_at: type: string format: date-time description: The timestamp when this deal iteration was created updated_at: type: string format: date-time description: The timestamp when this deal iteration was last updated ended_at: type: string format: date description: The timestamp when the deal iteration ended nullable: true duration_in_days: type: integer example: 1 description: Number of days remaining to end the the Deal. relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri user: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested iteration does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-iterations-id /api/v1/deal_snapshots/{id}: get: summary: Retrieves specific deal snapshot tags: - Deal Snapshots description: Refer to https://readme.vts.com/docs/deal-snapshot-documentation for a description of deal snapshots payload security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested deal snapshot if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: deal snapshot id: type: string example: '1' description: The ID of the deal snapshot attributes: type: object properties: account_id: type: integer example: 1 description: The id the account who's user generated the deal snapshot user_id: type: integer example: 1 description: The id of the user who's generated the deal snapshot metadata: type: object example: metadata_key: metadata_value description: Metadata that was attached to the deal snapshot via a PATCH request to the deal_snapshots endpoint. relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals created_by: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users includes: type: array items: type: object description: Refer to https://readme.vts.com/docs/deal-snapshot-documentation for a description of the resources returned here links: type: object properties: self: type: string example: https://api.vts.com/api/v1/deal_snapshots/1 '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested deal snapshot does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-snapshots-id patch: summary: Updates deal snapshot tags: - Deal Snapshots description: Updates a deal snapshot record security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: integer responses: '204': description: Deal Snapshot successfully updated '400': description: Parameters are invalid '403': description: API not authorized for use '404': description: Referenced deal snapshot not found requestBody: content: application/json: schema: type: object properties: data: type: object properties: attributes: type: object properties: metadata: type: object required: true operationId: patch_api-v1-deal-snapshots-id /api/v1/deal_tasks: get: summary: Fetches deal tasks tags: - Deal Tasks security: - basic_auth: [] parameters: - name: page[size] in: query required: false description: 'The number of items returned for any one page (default: 10, max: 100)' schema: type: integer - name: page[before] in: query required: false description: Show records before the given page indicator schema: type: string - name: page[after] in: query required: false description: Show records after the given page indicator schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Deal Tasks content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string attributes: type: object properties: description: type: string example: This is a deal task description: Description of the deal task required: type: boolean example: false description: Whether or not the task is required before the deal can move to the next stage completed: type: boolean example: false description: Whether or not the task is complete completed_at: type: string format: date-time description: Description of the deal task created_at: type: string format: date-time description: The timestamp when this deal task was created updated_at: type: string format: date-time description: The timestamp when this deal task was last updated relationships: description: The objects linked to a deal task type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri assignee: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri completed_by: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string example: https://api.vts.com/api/v1/deals/123/tasks?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/deals/123/tasks?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Deal Tasks next: type: string example: https://api.vts.com/api/v1/deals/123/tasks?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Deal Tasks required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-tasks /api/v1/deal_tasks/{id}: get: summary: Retrieves Tasks for Given Deal for Specific Account tags: - Deal Tasks security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested account deal task if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: description: type: string example: This is a deal task description: Description of the deal task required: type: boolean example: false description: Whether or not the task is required before the deal can move to the next stage completed: type: boolean example: false description: Whether or not the task is complete completed_at: type: string format: date-time description: Description of the deal task created_at: type: string format: date-time description: The timestamp when this deal task was created updated_at: type: string format: date-time description: The timestamp when this deal task was last updated relationships: description: The objects linked to a deal task type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri assignee: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri completed_by: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested deal task does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-tasks-id /api/v1/deal_terms: get: summary: Fetches deal terms description: Contains attributes of a given deal term, including rentable size, term duration, and tenant risks tags: - Deal Terms security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[proposal_id] in: query required: false schema: type: integer - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of DealTerms content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: deal_terms id: type: string example: '1' attributes: type: object properties: calculated_metrics: type: object properties: net_effective_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The normalized value a tenant will pay per period to the landlord over the length of a lease considering Net Present Value. Returned in money/area/year units ner_override: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr description: Manually input value for net effective rent ner_to_termination: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The NER in light of a termination right added to the proposal. Returned in money/area/year units ner_with_downtime: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The NER in light of a downtime included in the proposal. Returned in money/area/year units net_present_value: allOf: - $ref: '#/components/schemas/measure_money' - description: The present value of the net cash flow given the time value of money leasing_spread: type: number format: float example: 1.5 nullable: true description: Only appears if you select a "Previous Lease" for comparison. The percentage change between theexpiring base rent rate of the previous lease to the starting base rent rate of your new proposalafter the first period of free rent total_net_rent: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash received from base rent + escalation - free rent. Returned in money/area/year units net_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: Total cash received from base rent + escalation - free rent. Returned in money/area/month units internal_rate_of_return: type: number format: float example: 1.5 nullable: true description: The return on money spent for the term of the lease payback: type: number example: 2 nullable: true description: The number of months it takes for the landlord to earn back what they had to pay out as costs of the deal. Measured in months total_capital: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash being paid out as part of costs associated with TI + BI + Other Fees + Commissions total_capital_per_size: allOf: - $ref: '#/components/schemas/measure_money_area' - description: Total cash being paid out per area as part of costs associated with lease TI + BI + Other Fees + Commissions gaap_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: Calculation = (base rent + escalations - free rent - lease incentives +/- straight line balance)/area/term. Returned in money/area/year units total_net_cash_flow: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash inflows minus outflows per the terms over the lifetime of the lease total_term_free_rent: allOf: - $ref: '#/components/schemas/measure_money' - description: The total aggregate free rent amount for all free rent objects on this term npv_per_area: allOf: - $ref: '#/components/schemas/measure_money_area' - properties: magnitude: example: 35 unit: example: USD/sf unit_components: properties: area: enum: - sf description: 'Possible values: ''sf''' - description: Total cash being paid out per area as part of costs associated with lease TI + BI + Other Fees + Commissions total_commissions: allOf: - $ref: '#/components/schemas/measure_money' - description: Sum of commissions for a deal term landlord_commissions: allOf: - $ref: '#/components/schemas/measure_money' - description: Total of Landlord Commission for Deal Term tenant_commissions: allOf: - $ref: '#/components/schemas/measure_money' - description: Total of Tenant Commission for Deal Term commencement_date: type: string format: date example: '2021-03-01' rent_commencement_date: type: string format: date example: '2021-03-01' description: The date when rent begins being paid created_at: type: string format: date-time downtime: allOf: - $ref: '#/components/schemas/measure_period' - type: object nullable: true properties: magnitude: example: 2 unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M description: Months from previous tenant move-out to commencement date of replacement tenant entered_date: type: string nullable: true format: date example: '2020-02-02' execution_date: type: string nullable: true format: date example: '2021-03-01' expiration_date: type: string nullable: true format: date example: '2021-12-31' rentable_size: $ref: '#/components/schemas/measure_size' tenant_buildout_period: $ref: '#/components/schemas/measure_period' tenant_possession_date: type: string nullable: true format: date example: '2021-02-01' tenant_risks: type: array items: type: object properties: risk_type: type: string enum: - security_deposit - letter_of_credit - guarantee - other description: type: string nullable: true amount: $ref: '#/components/schemas/measure_money' term_duration: $ref: '#/components/schemas/measure_period' term_type: type: string enum: - new - original - renewal - renewal_two - renewal_three - extension - expansion - termination - modification - sublease - license_agreement - storage - specialty - short_term_lease - other - relocation - rent_review - break - fixed_option example: renewal rent_schedule: type: array description: Individual rent step of a deal term's calculated schedule items: type: object properties: start_month: type: number example: 1 description: Month that rent step goes into effect, relative to lease commencement date end_month: type: number example: 5 description: Final month that rent step is in effect, relative to lease commencement date amount: type: object description: Calculated rent amount for period, annualized per area properties: magnitude: type: number example: 10 description: Calculated rent amount for period, annualized per area unit: type: string example: USD description: Calculated rent currency retail: type: object properties: description: type: string nullable: true example: My retail description. estimated_sales: $ref: '#/components/schemas/measure_money_period' growth_rate: type: number format: float minimum: 0 maximum: 1 example: 0.42 percent_rent: type: number format: float minimum: 0 maximum: 1 example: 0.41 unnatural_breakpoint: $ref: '#/components/schemas/measure_money_period' straight_line_balance: $ref: '#/components/schemas/measure_money' structure: type: string enum: - full service - triple net - modified gross example: full service updated_at: type: string format: date-time total_commissions: allOf: - $ref: '#/components/schemas/measure_money' - properties: units: type: object example: money: type: string example: USD deprecated: true - description: Sum of commissions for a deal term deprecated: true description: type: string nullable: true example: Some text description: The description of deal term commissions: $ref: '#/components/schemas/commissions' rent_escalations: $ref: '#/components/schemas/rent_escalations' base_rents: $ref: '#/components/schemas/base_rents' free_rents: $ref: '#/components/schemas/free_rents' remaining_lease_obligations: type: array items: type: object properties: start_month: type: number example: 1 description: Month number in which to begin remaining lease obligations duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The amount of time in which the remaining lease obligations applies (including amount of time units) amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' percentage_rents: $ref: '#/components/schemas/percentage_rents' other_incomes: $ref: '#/components/schemas/other_incomes' reimbursable_expenses: $ref: '#/components/schemas/reimbursable_expenses' costs: $ref: '#/components/schemas/costs' relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri spaces: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces example: spaces links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string example: https://api.vts.com/api/v1/deal_terms prev: type: string example: https://api.vts.com/api/v1/deal_terms?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/deal_terms?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-terms /api/v1/deal_terms/{deal_term_id}/financials: get: summary: Fetches Financials for a given deal term description: Contains the corresponding financials for a lease or deal term tags: - Financials security: - basic_auth: [] parameters: - name: deal_term_id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Financials content: application/json: schema: type: object properties: data: type: array items: oneOf: - type: object properties: type: type: string pattern: base_rents example: base_rents id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this base rent was created updated_at: type: string format: date-time description: The timestamp when this base rent was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: free_rents example: free_rents id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this free rent was created updated_at: type: string format: date-time description: The timestamp when this free rent was last updated structure: type: string nullable: true enum: - net - gross - null example: net relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: other_revenues example: other_revenues id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this other revenue was created updated_at: type: string format: date-time description: The timestamp when this other revenue was last updated revenue_type: type: string nullable: true example: other relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: reimbursable_expenses example: reimbursable_expenses id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this reimbursable expense was created updated_at: type: string format: date-time description: The timestamp when this reimbursable expense was last updated base_year: type: object properties: start: type: integer nullable: true example: 2009 end: type: integer nullable: true example: 2010 description: type: string nullable: true example: real estate tax recovery_amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' recovery_type: type: string enum: - Opex - Real Estate Taxes - CAM - Cleaning - Electric - Insurance - Landscaping - Repairs and Maintenance - Management Fee - Marketing - Other - Security - Utilities reimbursed: type: boolean nullable: true stop_amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' structure: type: string nullable: true enum: - gross - net - amount - modified_gross - null relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: commissions example: commissions id: type: string example: '1' attributes: type: object properties: structure: type: string nullable: true example: gross broker: type: string nullable: true example: Ensemble commission_date: type: string nullable: true example: '2020-01-01' commission_type: type: string nullable: true example: Tenant created_at: type: string format: date-time description: The timestamp when this commission was created updated_at: type: string format: date-time description: The timestamp when this commission was last updated periods: type: array items: type: object properties: amount: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money' - $ref: '#/components/schemas/measure_period' - $ref: '#/components/schemas/measure_percentage' starts: type: object properties: date: type: string nullable: true format: date example: '2020-01-01' month: type: integer nullable: true example: 1 minimum: 1 relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: pattern: rent_escalations example: rent_escalations id: type: string example: '1' attributes: properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_percentage' frequency: allOf: - $ref: '#/components/schemas/measure_period' - type: object properties: interval: type: string enum: - Annual - One Time example: Annual starts: type: object properties: date: type: string format: date example: '2020-01-01' month: type: integer minimum: 1 example: 1 created_at: type: string format: date-time description: The timestamp when this rent escalation was created updated_at: type: string format: date-time description: The timestamp when this rent escalation was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: pattern: remaining_lease_obligations example: remaining_lease_obligations id: type: string example: '1' attributes: properties: ends: allOf: - type: object properties: date: type: string nullable: true - type: object properties: duration: $ref: '#/components/schemas/measure_period' starts: type: object properties: date: type: string format: date example: '2020-01-01' month: type: integer minimum: 1 example: 13 created_at: type: string format: date-time description: The timestamp when this remaining lease obligation was created updated_at: type: string format: date-time description: The timestamp when this remaining lease obligation was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string enum: - improvements example: improvements pattern: improvements id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_area' - $ref: '#/components/schemas/measure_money' occurrence_month: type: integer minimum: 0 nullable: true description: type: string nullable: true improvement_type: type: string enum: - tenant - building created_at: type: string format: date-time description: The timestamp when this improvement was created updated_at: type: string format: date-time description: The timestamp when this improvement was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string enum: - lease_incentives - other_credits example: lease_incentives id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_area' - $ref: '#/components/schemas/measure_money' occurrence_month: type: integer minimum: 0 nullable: true description: type: string nullable: true improvement_type: type: string enum: - tenant - building created_at: type: string format: date-time description: The timestamp when this lease incentive was created updated_at: type: string format: date-time description: The timestamp when this lease incentive was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: other_credits example: other_credits id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' occurrence_month: type: integer minimum: 0 nullable: true description: type: string nullable: true created_at: type: string format: date-time description: The timestamp when this other credit was created updated_at: type: string format: date-time description: The timestamp when this other credit was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string prev: type: string next: type: string required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-terms-deal-term-id-financials /api/v1/deal_terms/{deal_term_id}/options: get: summary: Fetches options for Deal Term description: Contains all options for a given deal term or lease term. Examples include encumbrances, renewals, and termination options tags: - Options security: - basic_auth: [] parameters: - name: deal_term_id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Options content: application/json: schema: type: object properties: data: type: array items: anyOf: - type: object properties: type: type: string pattern: options_miscellaneous example: options_miscellaneous id: type: string example: '1' attributes: type: object properties: option_type: type: string enum: - audit rights - cap on rates - generator rights - go dark - landlord & tenant act 1954 - make good - must lease - other - parking - radius - relocation - set off rights - signage - special provisions - storage - sublease - use description: 'The type of option. Possible values: audit rights, cap on rates, generator rights, go dark, landlord & tenant act 1954, make good, must lease, other, parking, radius, relocation, set off rights, signage, special provisions, storage, sublease, use.' description: type: string nullable: true example: This is a description. description: A description of the option relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_co_tenancy example: options_co_tenancy id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: co-tenancy example: co-tenancy description: 'The type of option. Possible values: co-tenancy' co_tenancy_type: type: string enum: - named - occupied - null nullable: true description: 'The type of co-tenancy option. Possible values: named, occupied, null' who_can_exercise: type: string enum: - tenant - landlord - mutual - null nullable: true description: 'Who is allowed to exercise the co-tenancy option. Possible values: tenant, landlord, mutual, null' description: type: string nullable: true example: This is a description. description: A description of the option relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_contraction example: options_contraction id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: contraction example: contraction description: 'The type of option. Possible values: contraction.' description: type: string nullable: true example: This is a description. description: A description of the option minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum (smallest) size down to which the right-holder can contract the space effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right type: type: string enum: - tenant - landlord - mutual - null nullable: true description: Identifies who is holding the right - who owns and benefits from the contraction right fee: allOf: - $ref: '#/components/schemas/measure_money' - description: Fee associated with exercising the right — if the right-holder chooses to do so relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_encumberance example: options_encumberance id: type: string example: '1' attributes: type: object properties: option_type: type: string enum: - rofo - rofn - rofr description: 'The type of option. Possible values: rofo, rofn, rofr' description: type: string nullable: true example: This is a description. description: A description of the option minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum size of the space under the purview of the ROFO clause effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right rate_note: type: string nullable: true description: Free text field to further explain the nature of the rate type rate_type: type: string enum: - variable - fixed - null nullable: true description: 'Describes the unit/rate for the cost of the next term. Possible values: variable, fixed' relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_exclusive_use example: options_exclusive_use id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: exclusive use example: exclusive use description: 'The type of option. Possible values: exclusive use' description: type: string nullable: true example: This is a description. description: A description of the option trigger_details: type: string nullable: true description: A custom message detailing the nature of this tenant's exclusive use right that will appear elsewhere in VTS remedy_details: type: string nullable: true description: A custom message detailing how a new tenant might be able to negotiate or remedy potentially breaking an existing tenant's exclusive use right in VTS relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_purchase example: options_purchase id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: purchase example: purchase description: 'The type of option. Possible values: purchase' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_rent_review example: options_rent_review id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: rent review example: rent review description: 'The type of option. Possible values: rent review.' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_renewal example: options_renewal id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: renewal example: renewal description: 'The type of option. Possible values: renewal.' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum size of the space under the purview of the renewal clause term: allOf: - $ref: '#/components/schemas/measure_size' - description: Number of months notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right number_of_options: type: integer nullable: true example: 1 description: Number of renewal options available rate_note: type: string nullable: true description: Free text field to further explain the nature of the rate type rate_type: type: string nullable: true description: 'Describes the unit/rate for the cost of the next term. Possible values: variable, fixed' relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_expansion example: options_expansion id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: expansion example: expansion description: 'The type of option. Possible values: expansion' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right maximum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The maximum size to which the tenant can expand per the clause minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum size to which the tenant can expand per the clause notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right rate_note: type: string nullable: true description: Free text field to further explain the nature of the rate type rate_type: type: string nullable: true description: 'Describes the unit/rate for the cost of the next term. Possible values: variable, fixed' tenant_improvements: allOf: - $ref: '#/components/schemas/measure_money' - description: The amount of tenant improvements alloted by the landlord in the expansion relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_termination example: options_termination id: type: string example: '1' attributes: type: object properties: option_type: type: string enum: - break - kick out - rights to terminate description: 'The type of option. Possible values: break, kick out, rights to terminate' description: type: string nullable: true example: This is a description. description: A description of the option termination_fee: allOf: - $ref: '#/components/schemas/measure_money' - description: The fee associated with exercising the early termination effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right rights_holder: type: string enum: - tenant - landlord - mutual - null nullable: true description: 'Possible values: tenant, landlord, mutual' relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string prev: type: string next: type: string required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-terms-deal-term-id-options /api/v1/deal_terms/{id}: get: summary: Retrieves specific deal term description: Contains attributes of a given deal term, including rentable size, term duration, and tenant risks tags: - Deal Terms security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested deal_term if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: deal_terms id: type: string example: '1' attributes: type: object properties: calculated_metrics: type: object properties: net_effective_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The normalized value a tenant will pay per period to the landlord over the length of a lease considering Net Present Value. Returned in money/area/year units ner_override: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr description: Manually input value for net effective rent ner_to_termination: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The NER in light of a termination right added to the proposal. Returned in money/area/year units ner_with_downtime: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: The NER in light of a downtime included in the proposal. Returned in money/area/year units net_present_value: allOf: - $ref: '#/components/schemas/measure_money' - description: The present value of the net cash flow given the time value of money leasing_spread: type: number format: float example: 1.5 nullable: true description: Only appears if you select a "Previous Lease" for comparison. The percentage change between theexpiring base rent rate of the previous lease to the starting base rent rate of your new proposalafter the first period of free rent total_net_rent: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash received from base rent + escalation - free rent. Returned in money/area/year units net_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: Total cash received from base rent + escalation - free rent. Returned in money/area/month units internal_rate_of_return: type: number format: float example: 1.5 nullable: true description: The return on money spent for the term of the lease payback: type: number example: 2 nullable: true description: The number of months it takes for the landlord to earn back what they had to pay out as costs of the deal. Measured in months total_capital: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash being paid out as part of costs associated with TI + BI + Other Fees + Commissions total_capital_per_size: allOf: - $ref: '#/components/schemas/measure_money_area' - description: Total cash being paid out per area as part of costs associated with lease TI + BI + Other Fees + Commissions gaap_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: Calculation = (base rent + escalations - free rent - lease incentives +/- straight line balance)/area/term. Returned in money/area/year units total_net_cash_flow: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash inflows minus outflows per the terms over the lifetime of the lease total_term_free_rent: allOf: - $ref: '#/components/schemas/measure_money' - description: The total aggregate free rent amount for all free rent objects on this term npv_per_area: allOf: - $ref: '#/components/schemas/measure_money_area' - properties: magnitude: example: 35 unit: example: USD/sf unit_components: properties: area: enum: - sf description: 'Possible values: ''sf''' - description: Total cash being paid out per area as part of costs associated with lease TI + BI + Other Fees + Commissions total_commissions: allOf: - $ref: '#/components/schemas/measure_money' - description: Sum of commissions for a deal term landlord_commissions: allOf: - $ref: '#/components/schemas/measure_money' - description: Total of Landlord Commission for Deal Term tenant_commissions: allOf: - $ref: '#/components/schemas/measure_money' - description: Total of Tenant Commission for Deal Term commencement_date: type: string format: date example: '2021-03-01' rent_commencement_date: type: string format: date example: '2021-03-01' description: The date when rent begins being paid created_at: type: string format: date-time downtime: allOf: - $ref: '#/components/schemas/measure_period' - type: object nullable: true properties: magnitude: example: 2 unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M description: Months from previous tenant move-out to commencement date of replacement tenant entered_date: type: string nullable: true format: date example: '2020-02-02' execution_date: type: string nullable: true format: date example: '2021-03-01' expiration_date: type: string nullable: true format: date example: '2021-12-31' rentable_size: $ref: '#/components/schemas/measure_size' tenant_buildout_period: $ref: '#/components/schemas/measure_period' tenant_possession_date: type: string nullable: true format: date example: '2021-02-01' tenant_risks: type: array items: type: object properties: risk_type: type: string enum: - security_deposit - letter_of_credit - guarantee - other description: type: string nullable: true amount: $ref: '#/components/schemas/measure_money' term_duration: $ref: '#/components/schemas/measure_period' term_type: type: string enum: - new - original - renewal - renewal_two - renewal_three - extension - expansion - termination - modification - sublease - license_agreement - storage - specialty - short_term_lease - other - relocation - rent_review - break - fixed_option example: renewal rent_schedule: type: array description: Individual rent step of a deal term's calculated schedule items: type: object properties: start_month: type: number example: 1 description: Month that rent step goes into effect, relative to lease commencement date end_month: type: number example: 5 description: Final month that rent step is in effect, relative to lease commencement date amount: type: object description: Calculated rent amount for period, annualized per area properties: magnitude: type: number example: 10 description: Calculated rent amount for period, annualized per area unit: type: string example: USD description: Calculated rent currency retail: type: object properties: description: type: string nullable: true example: My retail description. estimated_sales: $ref: '#/components/schemas/measure_money_period' growth_rate: type: number format: float minimum: 0 maximum: 1 example: 0.42 percent_rent: type: number format: float minimum: 0 maximum: 1 example: 0.41 unnatural_breakpoint: $ref: '#/components/schemas/measure_money_period' straight_line_balance: $ref: '#/components/schemas/measure_money' structure: type: string enum: - full service - triple net - modified gross example: full service updated_at: type: string format: date-time total_commissions: allOf: - $ref: '#/components/schemas/measure_money' - properties: units: type: object example: money: type: string example: USD deprecated: true - description: Sum of commissions for a deal term deprecated: true description: type: string nullable: true example: Some text description: The description of deal term commissions: $ref: '#/components/schemas/commissions' rent_escalations: $ref: '#/components/schemas/rent_escalations' base_rents: $ref: '#/components/schemas/base_rents' free_rents: $ref: '#/components/schemas/free_rents' remaining_lease_obligations: type: array items: type: object properties: start_month: type: number example: 1 description: Month number in which to begin remaining lease obligations duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The amount of time in which the remaining lease obligations applies (including amount of time units) amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' percentage_rents: $ref: '#/components/schemas/percentage_rents' other_incomes: $ref: '#/components/schemas/other_incomes' reimbursable_expenses: $ref: '#/components/schemas/reimbursable_expenses' costs: $ref: '#/components/schemas/costs' relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri spaces: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces example: spaces links: type: object properties: related: type: string format: uri '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested deal_term does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deal-terms-id /api/v1/deals: get: summary: Fetches deals description: Contains an overview of a given deal, including requirements, stage, and deal type tags: - Deals security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Deals content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: deals id: type: string example: '1' attributes: type: object properties: comment: type: string nullable: true example: This is a comment. deprecated: true description: This attribute is deprecated, please use the `Deal Comments` API endpoint created_at: type: string format: date-time competitive_set: type: string nullable: true example: 100 Main, $34/SF deal_type: type: string enum: - new - original - renewal - renewal_two - renewal_three - extension - expansion - termination - modification - sublease - license_agreement - storage - specialty - short_term_lease - other - relocation - rent_review - break - fixed_option example: new probability: type: number format: float minimum: 0 maximum: 1 brokers: type: array items: type: object properties: id: type: number example: '1' description: Identifier of the broker agent to deal relationship first_name: type: string example: Dweezil description: The first name of the broker agent last_name: type: string example: Zappa description: The last name of the broker agent name: type: string example: Dweezil Zappa description: The full name of the broker agent email: type: string example: zappa@vts.com description: The email of the broker agent phone_extension: type: string example: '123' description: The phone extension of the broker agent phone: type: string example: 123-456-7890 description: The phone number of the broker agent company: type: string example: Rock Ltd. description: The company the broker agent belongs to description: The broker agent associated with the deal contacts: type: array items: type: object properties: name: type: string example: Moon Unit Zappa description: The full name of the tenant contact email: type: string example: moon.zappa@vts.com description: The email of the tenant contact phone: type: string example: 012-345-6789 description: The phone number of the tenant contact company: type: string example: Stone Ltd. description: The company the tenant contact belongs to description: The tenant contact associated with the deal requirements: type: object properties: commencement_date: type: string nullable: true format: date inquiry_type: type: string nullable: true enum: - costar - crexi - email - event - internal_referral - loop_net - mailer - marketing_website - open_house - other - phone - vts_marketplace - null example: costar requirement_size: type: object properties: minimum: type: number nullable: true example: 5000 maximum: type: number nullable: true example: 10000 type: type: string pattern: area example: area unit: type: string enum: - sf - sm unit_components: type: object properties: area: type: string enum: - sf - sm example: sf retail_deal_type: type: string nullable: true enum: - permanent - specialty - null example: permanent space_type: type: string nullable: true enum: - office - retail - industrial_warehouse - telecom - storage - flex - parking - amenities - rooftop - other - lab - manufacturing - residential - medical_office - education - restaurant - leisure - unspecified - null target_locations: type: array items: type: object properties: locality: type: string example: New York region: type: string example: NEW YORK postal_code: type: string example: '10001' country: type: string example: United States formatted: type: string example: New York, NEW YORK 10001 United States target_rent: type: object properties: minimum: type: number nullable: true example: 5000 description: Minimum amount of the requirement range maximum: type: number nullable: true example: 10000 description: Maximum amount of the requirement range type: type: string pattern: money example: money description: Type of unit being measured unit: type: string pattern: '...' description: ISO 4217 currency code example: USD unit_components: type: object properties: money: type: string pattern: '...' example: USD stage: type: string enum: - tenants_in_the_market - initial_inquiry - preview - tour - proposal - loi - legal - lease_out - lease_executed - dead_deal - idle example: loi tenant_info: type: object properties: name: format: string example: ACME Tenant Inc. undisclosed: format: boolean current_lease: type: object properties: current_address: type: string nullable: true example: 123 Park Avenue current_rent: $ref: '#/components/schemas/measure_money' current_size: $ref: '#/components/schemas/measure_size' expiration_date: type: string nullable: true format: date example: '2025-12-31' total_size: $ref: '#/components/schemas/measure_size' updated_at: type: string format: date-time description: Changes when any financials on the terms of any proposals on the deal, the terms or proposals themselves, spaces on the deal, or any options or their targets (i.e. targeted spaces, floors, assets, etc) associated to proposals belonging to the deal are updated is_private: type: boolean nullable: true description: True when the deal has been configured to only allow specified users to view the deal relationships: type: object properties: deal_tours: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deal_tours example: deal_tours assets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets - multi_building_assets example: assets latest_proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri comparative_lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri created_by: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri deal_leads: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users spaces: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces example: spaces tenant: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - tenants example: tenants links: type: object properties: related: type: string format: uri tenant_industry: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - tenant_industries example: tenant_industries links: type: object properties: related: type: string format: uri coordination_projects: type: object properties: links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string example: https://api.vts.com/api/v1/deals prev: type: string example: https://api.vts.com/api/v1/deals?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/deals?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deals /api/v1/deals/{deal_id}/approvals: get: summary: Fetches deal approvals tags: - Approvals security: - basic_auth: [] parameters: - name: deal_id in: path required: true description: ID of the deal containing the approval schema: type: string - name: page[size] in: query required: false description: 'The number of items returned for any one page (default: 10, max: 100)' schema: type: integer - name: page[before] in: query required: false description: Show records before the given page indicator schema: type: string - name: page[after] in: query required: false description: Show records after the given page indicator schema: type: string - name: filter[latest] in: query required: false description: Only show Approvals for the latest Proposal schema: type: boolean - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Deal Approvals content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: approvals id: type: string example: '1' description: The ID of the approval attributes: description: Attributes for the approval type: object properties: requester_comment: type: string example: This is a comment description: Any comments made by the approval requester requested_at: type: string format: date-time description: The date-time the approval was requested at active: type: boolean created_at: type: string format: date-time description: The timestamp when this approval was created updated_at: type: string format: date-time description: The timestamp when this approval was last updated approvers: description: Information about the specific approval step requested type: array items: description: Information for an approval step type: object properties: step_number: type: integer example: 0 description: The number of the approval step description: type: string example: A description for the approval step status: type: string enum: - pending - approved - rejected - revision_requested description: 'The status of the approval step. Possible values: pending, approved, rejected, revision_requested' reviewed_at: type: string format: date-time nullable: true description: The date-time the approval step was reviewed at - null if not reviewed yet comment: type: string example: This is a comment description: Any comments associated with the approval step approver_user_id: type: integer example: 1 description: The user id of the user assigned to approve the approval step relationships: description: The objects linked to an approval step type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals requester: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals approvers: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users included: type: array items: type: object description: User information for the proposal approvers properties: type: type: string example: users id: type: string example: '1' description: The ID of the user attributes: description: User attributes for a specific approver type: object properties: first_name: type: string example: John description: Approver's first name last_name: type: string example: Doe description: Approver's last name links: type: object properties: self: type: string example: https://api.vts.com/api/v1/deals/123/approvals?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/deals/123/approvals?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Approvals next: type: string example: https://api.vts.com/api/v1/deals/123/approvals?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Approvals required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deals-deal-id-approvals /api/v1/deals/{deal_id}/comments: get: summary: Fetches Deal Comments for a Specific Deal tags: - Deal Comments security: - basic_auth: [] parameters: - name: deal_id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Deal Comments content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string pattern: deal_comments id: type: string example: '1' attributes: type: object properties: latest: type: boolean description: Whether or not this is the latest comment of it's associated deal text: type: string nullable: true example: This is a comment. description: The content of the deal comment occurred_at: type: string format: date-time description: The timestamp when the comment was added to its associated deal created_at: type: string format: date-time description: The timestamp when this deal comment was created updated_at: type: string format: date-time description: The timestamp when this deal comment was last updated relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri iteration: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deal_iterations example: deal_iterations user: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string example: https://api.vts.com/api/v1/deals/123/comments?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/deals/123/comments?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Deal Comments next: type: string example: https://api.vts.com/api/v1/deals/123/comments?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Deal Comments required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deals-deal-id-comments /api/v1/deals/{deal_id}/coordination_projects: get: summary: Gets coordination projects for specific deal description: Contains the coordination projects in your portfolio for specific deal tags: - Coordination Projects operationId: coordination_projects_per_deal security: - basic_auth: [] parameters: - name: deal_id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns a list of coordination projects associated with the current account content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string example: '1' type: type: string example: coordination_projects attributes: type: object properties: target_rent_commencement_date: type: string format: date nullable: true current_rent_commencement_date: type: string format: date nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time status: type: string example: on_track nullable: true relationships: type: object properties: tenant: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/tenants/12345 deal: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/deals/1 asset: type: object properties: links: type: object properties: related: type: string example: https://api.vts.com/api/v1/assets/1 next_milestone: anyOf: - type: object properties: data: type: object properties: id: type: string example: '10' type: type: string example: coordination_milestones links: type: object properties: related: type: string example: https://api.vts.com/api/v1/coordination_project_milestones/1 - type: object properties: data: type: object properties: id: type: string example: '10' type: type: string example: coordination_milestones nullable: true links: type: object properties: self: type: string example: https://api.vts.com/api/v1/coordination_projects prev: type: string example: https://api.vts.com/api/v1/coordination_projects?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/coordination_projects?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' /api/v1/deals/{deal_id}/iterations: get: summary: Fetches Deal Iterations for a Specific Deal description: Contains attributes of deal iterations for a given deal, including deal stage and transition reason tags: - Deal Iterations security: - basic_auth: [] parameters: - name: deal_id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Iterations content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string pattern: deal_iterations example: deal_iterations id: type: string example: '1' attributes: type: object properties: latest: type: boolean description: Whether or not this is the latest stage of it's associated deal stage: type: string enum: - tenants_in_the_market - initial_inquiry - preview - tour - proposal - loi - legal - lease_out example: proposal description: 'The current stage of the associated deal. Possible values: tenants_in_the_market, initial_inquiry, preview, tour, proposal, loi, legal, lease_out, idle, dead_deal, lease_executed' reason: type: string enum: - adjacent_stores - cannibalization_risk - ceiling_height - foot_traffic - image - lobby - location - location_on_floor - other - parking_ratio - price - renewal - requirement_dead - security - size - space_condition - space_configuration - space_leased - storefront - timing - transportation - views - global_crisis - duplicate_deal - requirement_changed - decided_to_sublease - unknown - amenities - walkability - tenant_covenant - landlord_decision - tenant_non_responsive - null example: space_leased nullable: true description: 'Why the deal was moved to its current stage. Only applies to a deal in the dead deal stage. Possible values: adjacent_stores, cannibalization_risk, ceiling_height, foot_traffic, image, lobby, location, location_on_floor, other, parking_ratio, price, renewal, requirement_dead, security, size, space_condition, space_configuration, space_leased, storefront, timing, transportation, views, global_crisis, duplicate_deal, requirement_changed, decided_to_sublease, unknown, amenities, walkability, tenant_covenant, landlord_decision, tenant_non_responsive, null' occurred_at: type: string format: date-time description: The timestamp when a deal was marked with the current deal iteration stage created_at: type: string format: date-time description: The timestamp when this deal iteration was created updated_at: type: string format: date-time description: The timestamp when this deal iteration was last updated ended_at: type: string format: date description: The date when a deal will be marked as ended. nullable: true duration_in_days: type: integer example: 1 description: The duration of the deal iteration in number of days relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri user: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string example: https://api.vts.com/api/v1/deals/123/iterations?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/deals/123/iterations?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Iterations next: type: string example: https://api.vts.com/api/v1/deals/123/iterations?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Iterations required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deals-deal-id-iterations /api/v1/deals/{deal_id}/proposals: get: summary: Fetches proposals description: Contains details of a given proposal, including discount rate, proposal type, and description tags: - Proposals security: - basic_auth: [] parameters: - name: deal_id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[latest] in: query required: false description: Only show the latest Proposal schema: type: boolean - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Proposals content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: proposals id: type: string example: '1' attributes: type: object properties: proposal_label: type: string example: Proposal Name nullable: true description: The name of the proposal calculated_metrics: type: object properties: net_effective_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: "The normalized value a tenant will pay per period to the landlord over the\ \ length of a\n lease considering Net Present Value.\ \ Returned in money/area/month units" ner_to_termination: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: The NER in light of a termination right added to the proposal. Returned in money/area/month units ner_with_downtime: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: The NER in light of a downtime included in the proposal. Returned in money/area/month units ner_vs_budget: type: number nullable: true example: 1 description: Net Effective Rent as a percent of NER of budget ner_to_termination_vs_budget: type: number nullable: true example: 1 description: '"NER to termination" as a percent of NER of the budget' net_present_value: allOf: - $ref: '#/components/schemas/measure_money' - description: The present value of the net cash flow given the time value of money net_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: Total cash received from base rent + escalation - free rent. Returned in money/area/year units total_capital: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash being paid out as part of costs associated with TI + BI + Other Fees + Commissions total_net_cash_flow: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash inflows minus outflows per the terms over the lifetime of the lease total_base_rent: allOf: - $ref: '#/components/schemas/measure_money' - description: Total base rent over the lifetime of the lease deprecated: true total_escalated_rent_before_abatement: allOf: - $ref: '#/components/schemas/measure_money' - description: Total base rent before abatement over the lifetime of the lease which includes the sum of base_rent + rent_escalation created_at: type: string format: date-time updated_at: type: string format: date-time entered_date: type: string format: date latest: type: boolean discount_rate: type: number nullable: true example: 0.08 description: type: string nullable: true example: This is a proposal. proposal_date: type: string format: date proposal_type: type: string example: final relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri deal_terms: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deal_terms example: deal_terms options: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - options_miscellaneous - options_co_tenancy - options_contraction - options_encumberance - options_exclusive_use - options_purchase - options_rent_review - options_renewal - options_expansion - options_termination example: options_miscellaneous links: type: object properties: self: type: string example: https://api.vts.com/api/v1/deals/1/proposals prev: type: string example: https://api.vts.com/api/v1/deals/12345/proposals?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/deals/12345/proposals?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deals-deal-id-proposals /api/v1/deals/{deal_id}/tasks: get: summary: Fetches deal tasks for a Deal tags: - Deal Tasks security: - basic_auth: [] parameters: - name: deal_id in: path required: true description: ID of the deal containing the tasks schema: type: string - name: page[size] in: query required: false description: 'The number of items returned for any one page (default: 10, max: 100)' schema: type: integer - name: page[before] in: query required: false description: Show records before the given page indicator schema: type: string - name: page[after] in: query required: false description: Show records after the given page indicator schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Deal Tasks content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string attributes: type: object properties: description: type: string example: This is a deal task description: Description of the deal task required: type: boolean example: false description: Whether or not the task is required before the deal can move to the next stage completed: type: boolean example: false description: Whether or not the task is complete completed_at: type: string format: date-time description: Description of the deal task created_at: type: string format: date-time description: The timestamp when this deal task was created updated_at: type: string format: date-time description: The timestamp when this deal task was last updated relationships: description: The objects linked to a deal task type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri assignee: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri completed_by: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string example: https://api.vts.com/api/v1/deals/123/tasks?page%5Bafter%5D=MzE2NTE%253D description: The current URL prev: type: string example: https://api.vts.com/api/v1/deals/123/tasks?page%5Bbefore%5D=MzE2NTI%253D description: URL for the previous page of Deal Tasks next: type: string example: https://api.vts.com/api/v1/deals/123/tasks?page%5Bbefore%5D=MzE2NTI%253D description: URL for the next page of Deal Tasks required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deals-deal-id-tasks /api/v1/deals/{deal_id}/tours: get: summary: Fetches deal tours description: Contains attributes of a given deal tours, including rentable size, term duration, and tenant risks tags: - Deal Tours security: - basic_auth: [] parameters: - name: deal_id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of DealTours for a Deal content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: deal_tours id: type: string example: '1' attributes: type: object properties: tour_datetime: type: string example: '2023-03-16T10:08:10.000000Z' comment: type: string example: Tour completed created_at: type: string format: date-time updated_at: type: string format: date-time relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals user: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users spaces: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deals-deal-id-tours /api/v1/deals/{id}: get: summary: Retrieves specific deal description: Contains an overview of a given deal, including requirements, stage, and deal type tags: - Deals security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested deal if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: deals id: type: string example: '1' attributes: type: object properties: comment: type: string nullable: true example: This is a comment. deprecated: true description: This attribute is deprecated, please use the `Deal Comments` API endpoint created_at: type: string format: date-time competitive_set: type: string nullable: true example: 100 Main, $34/SF deal_type: type: string enum: - new - original - renewal - renewal_two - renewal_three - extension - expansion - termination - modification - sublease - license_agreement - storage - specialty - short_term_lease - other - relocation - rent_review - break - fixed_option example: new probability: type: number format: float minimum: 0 maximum: 1 brokers: type: array items: type: object properties: id: type: number example: '1' description: Identifier of the broker agent to deal relationship first_name: type: string example: Dweezil description: The first name of the broker agent last_name: type: string example: Zappa description: The last name of the broker agent name: type: string example: Dweezil Zappa description: The full name of the broker agent email: type: string example: zappa@vts.com description: The email of the broker agent phone_extension: type: string example: '123' description: The phone extension of the broker agent phone: type: string example: 123-456-7890 description: The phone number of the broker agent company: type: string example: Rock Ltd. description: The company the broker agent belongs to description: The broker agent associated with the deal contacts: type: array items: type: object properties: name: type: string example: Moon Unit Zappa description: The full name of the tenant contact email: type: string example: moon.zappa@vts.com description: The email of the tenant contact phone: type: string example: 012-345-6789 description: The phone number of the tenant contact company: type: string example: Stone Ltd. description: The company the tenant contact belongs to description: The tenant contact associated with the deal requirements: type: object properties: commencement_date: type: string nullable: true format: date inquiry_type: type: string nullable: true enum: - costar - crexi - email - event - internal_referral - loop_net - mailer - marketing_website - open_house - other - phone - vts_marketplace - null example: costar requirement_size: type: object properties: minimum: type: number nullable: true example: 5000 maximum: type: number nullable: true example: 10000 type: type: string pattern: area example: area unit: type: string enum: - sf - sm unit_components: type: object properties: area: type: string enum: - sf - sm example: sf retail_deal_type: type: string nullable: true enum: - permanent - specialty - null example: permanent space_type: type: string nullable: true enum: - office - retail - industrial_warehouse - telecom - storage - flex - parking - amenities - rooftop - other - lab - manufacturing - residential - medical_office - education - restaurant - leisure - unspecified - null target_locations: type: array items: type: object properties: locality: type: string example: New York region: type: string example: NEW YORK postal_code: type: string example: '10001' country: type: string example: United States formatted: type: string example: New York, NEW YORK 10001 United States target_rent: type: object properties: minimum: type: number nullable: true example: 5000 description: Minimum amount of the requirement range maximum: type: number nullable: true example: 10000 description: Maximum amount of the requirement range type: type: string pattern: money example: money description: Type of unit being measured unit: type: string pattern: '...' description: ISO 4217 currency code example: USD unit_components: type: object properties: money: type: string pattern: '...' example: USD stage: type: string enum: - tenants_in_the_market - initial_inquiry - preview - tour - proposal - loi - legal - lease_out - lease_executed - dead_deal - idle example: loi tenant_info: type: object properties: name: format: string example: ACME Tenant Inc. undisclosed: format: boolean current_lease: type: object properties: current_address: type: string nullable: true example: 123 Park Avenue current_rent: $ref: '#/components/schemas/measure_money' current_size: $ref: '#/components/schemas/measure_size' expiration_date: type: string nullable: true format: date example: '2025-12-31' total_size: $ref: '#/components/schemas/measure_size' updated_at: type: string format: date-time description: Changes when any financials on the terms of any proposals on the deal, the terms or proposals themselves, spaces on the deal, or any options or their targets (i.e. targeted spaces, floors, assets, etc) associated to proposals belonging to the deal are updated is_private: type: boolean nullable: true description: True when the deal has been configured to only allow specified users to view the deal relationships: type: object properties: deal_tours: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deal_tours example: deal_tours assets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets - multi_building_assets example: assets latest_proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri comparative_lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri created_by: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri deal_leads: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users spaces: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces example: spaces tenant: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - tenants example: tenants links: type: object properties: related: type: string format: uri tenant_industry: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - tenant_industries example: tenant_industries links: type: object properties: related: type: string format: uri coordination_projects: type: object properties: links: type: object properties: related: type: string format: uri '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested deal does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-deals-id /api/v1/delinquencies: get: summary: Fetches delinquencies description: Contains the delinquent leases in your portfolio tags: - Delinquencies security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[status] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Delinquencies for the Lease content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: delinquencies id: type: string example: '1' attributes: type: object properties: lease_id: type: string example: '1' deprecated: true description: This attribute is deprecated, please use lease from the `relationships` object instead current_amount: type: number total_amount: type: number charge_date: type: string format: date charge_type: type: string example: late payment_date: type: string nullable: true format: date created_at: type: string format: date-time updated_at: type: string format: date-time relationships: description: The objects linked to a delinquency type: object properties: lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri operationId: get_api-v1-delinquencies /api/v1/delinquencies/{id}: patch: summary: Updates delinquency tags: - Delinquencies description: Updates a delinquency record on the lease security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: integer responses: '200': description: Delinquency successfully updated content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: delinquencies id: type: string example: '1' attributes: type: object properties: lease_id: type: string example: '1' deprecated: true description: This attribute is deprecated, please use lease from the `relationships` object instead current_amount: type: number total_amount: type: number charge_date: type: string format: date charge_type: type: string example: late payment_date: type: string nullable: true format: date created_at: type: string format: date-time updated_at: type: string format: date-time relationships: description: The objects linked to a delinquency type: object properties: lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri '400': description: Parameters are invalid content: application/json: schema: $ref: '#/components/schemas/errors_object' '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Referenced lease not found content: application/json: schema: $ref: '#/components/schemas/errors_object' requestBody: content: application/json: schema: type: object properties: data: type: object properties: attributes: type: object properties: total_amount: type: number current_amount: type: number charge_date: type: string format: date charge_type: type: string example: late payment_date: type: string nullable: true format: date required: true operationId: patch_api-v1-delinquencies-id /api/v1/financials: get: summary: Fetches Financials for lease terms and/or lease terms description: Contains the corresponding financials for a lease or deal term tags: - Financials security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' - name: filter[term_type] in: query schema: type: string enum: - deal_term - lease_term required: false description: Only display financials belonging to the specific parent object example: deal_term responses: '200': description: Returns list of Financials content: application/json: schema: type: object properties: data: type: array items: oneOf: - type: object properties: type: type: string pattern: base_rents example: base_rents id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this base rent was created updated_at: type: string format: date-time description: The timestamp when this base rent was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: free_rents example: free_rents id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this free rent was created updated_at: type: string format: date-time description: The timestamp when this free rent was last updated structure: type: string nullable: true enum: - net - gross - null example: net relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: percentage_rents example: percentage_rents id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this base rent was created updated_at: type: string format: date-time description: The timestamp when this base rent was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri created_at: type: string format: date-time description: The timestamp when this percentage rent was created updated_at: type: string format: date-time description: The timestamp when this percentage rent was last updated - type: object properties: type: type: string pattern: other_revenues example: other_revenues id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this other revenue was created updated_at: type: string format: date-time description: The timestamp when this other revenue was last updated revenue_type: type: string nullable: true example: other relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string enum: - improvements example: improvements pattern: improvements id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_area' - $ref: '#/components/schemas/measure_money' occurrence_month: type: integer minimum: 0 nullable: true description: type: string nullable: true improvement_type: type: string enum: - tenant - building created_at: type: string format: date-time description: The timestamp when this improvement was created updated_at: type: string format: date-time description: The timestamp when this improvement was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string enum: - lease_incentives - other_credits example: lease_incentives id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_area' - $ref: '#/components/schemas/measure_money' occurrence_month: type: integer minimum: 0 nullable: true description: type: string nullable: true improvement_type: type: string enum: - tenant - building created_at: type: string format: date-time description: The timestamp when this lease incentive was created updated_at: type: string format: date-time description: The timestamp when this lease incentive was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: other_credits example: other_credits id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' occurrence_month: type: integer minimum: 0 nullable: true description: type: string nullable: true created_at: type: string format: date-time description: The timestamp when this other credit was created updated_at: type: string format: date-time description: The timestamp when this other credit was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: reimbursable_expenses example: reimbursable_expenses id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this reimbursable expense was created updated_at: type: string format: date-time description: The timestamp when this reimbursable expense was last updated base_year: type: object properties: start: type: integer nullable: true example: 2009 end: type: integer nullable: true example: 2010 description: type: string nullable: true example: real estate tax recovery_amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' recovery_type: type: string enum: - Opex - Real Estate Taxes - CAM - Cleaning - Electric - Insurance - Landscaping - Repairs and Maintenance - Management Fee - Marketing - Other - Security - Utilities reimbursed: type: boolean nullable: true stop_amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' structure: type: string nullable: true enum: - gross - net - amount - modified_gross - null relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: commissions example: commissions id: type: string example: '1' attributes: type: object properties: structure: type: string nullable: true example: gross broker: type: string nullable: true example: Ensemble commission_date: type: string nullable: true example: '2020-01-01' commission_type: type: string nullable: true example: Tenant created_at: type: string format: date-time description: The timestamp when this commission was created updated_at: type: string format: date-time description: The timestamp when this commission was last updated periods: type: array items: type: object properties: amount: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money' - $ref: '#/components/schemas/measure_period' - $ref: '#/components/schemas/measure_percentage' starts: type: object properties: date: type: string nullable: true format: date example: '2020-01-01' month: type: integer nullable: true example: 1 minimum: 1 relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: pattern: rent_escalations example: rent_escalations id: type: string example: '1' attributes: properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_percentage' frequency: allOf: - $ref: '#/components/schemas/measure_period' - type: object properties: interval: type: string enum: - Annual - One Time example: Annual starts: type: object properties: date: type: string format: date example: '2020-01-01' month: type: integer minimum: 1 example: 1 created_at: type: string format: date-time description: The timestamp when this rent escalation was created updated_at: type: string format: date-time description: The timestamp when this rent escalation was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri - type: object properties: type: pattern: remaining_lease_obligations example: remaining_lease_obligations id: type: string example: '1' attributes: properties: ends: allOf: - type: object properties: date: type: string nullable: true - type: object properties: duration: $ref: '#/components/schemas/measure_period' starts: type: object properties: date: type: string format: date example: '2020-01-01' month: type: integer minimum: 1 example: 13 created_at: type: string format: date-time description: The timestamp when this remaining lease obligation was created updated_at: type: string format: date-time description: The timestamp when this remaining lease obligation was last updated relationships: type: object properties: deal_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: deal_terms links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string prev: type: string next: type: string required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-financials /api/v1/global_tenants: get: summary: Fetches global tenants description: Contains the cleansed tenant names associated with reported or inputted tenant names. Links to the ultimate parent global tenant ID tags: - Global Tenants security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[cap_iq_id][] in: query style: form explode: true description: Find Global Tenants by their S&P Capital IQ ID. If you want to filter by multiple IDs, specify this parameter multiple times required: false schema: type: integer - name: filter[q] in: query description: Find Global Tenants by using keywords required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of global tenants content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string description: Type of object returned example: global_tenants id: type: string description: This tenant's Ultimate Parent Global Tenant ID example: 19dbe413-442a-4fd1-afe4-9b12dc2c02ce attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this global tenant was created updated_at: type: string format: date-time description: The timestamp when this global tenant was last updated name: type: string description: This is the Global Name of the tenant industry: type: string description: This is the Global Tenant’s industry. This may be different than the linked Reported Tenant’s industry address: type: string description: Location of Global Tenant cap_iq_id: type: integer description: ID of associated company from the S&P Capital IQ database nullable: true relationships: type: object properties: ultimate_parent: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - global_tenants example: global_tenants '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-global-tenants /api/v1/global_tenants/{id}: get: summary: Fetches specific global tenant description: Contains the cleansed tenant names associated with reported or inputted tenant names. Links to the ultimate parent global tenant ID tags: - Global Tenants security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested global tenant content: application/json: schema: type: object properties: data: type: object properties: type: type: string description: Type of object returned example: global_tenants id: type: string description: This tenant's Ultimate Parent Global Tenant ID example: 19dbe413-442a-4fd1-afe4-9b12dc2c02ce attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this global tenant was created updated_at: type: string format: date-time description: The timestamp when this global tenant was last updated name: type: string description: This is the Global Name of the tenant industry: type: string description: This is the Global Tenant’s industry. This may be different than the linked Reported Tenant’s industry address: type: string description: Location of Global Tenant cap_iq_id: type: integer description: ID of associated company from the S&P Capital IQ database nullable: true relationships: type: object properties: ultimate_parent: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - global_tenants example: global_tenants '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-global-tenants-id /api/v1/lease_terms: get: summary: Fetches lease terms description: Contains attributes of a given lease term including possession date, lease type, and calculated rents tags: - Lease Terms security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of LeaseTerms content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: lease_terms id: type: string example: '1' attributes: type: object properties: calculated_rents: type: object properties: expiring_base_rent: $ref: '#/components/schemas/measure_money_area_period' expiring_gross_rent: $ref: '#/components/schemas/measure_money_area_period' in_place_base_rent: $ref: '#/components/schemas/measure_money_area_period' in_place_gross_rent: $ref: '#/components/schemas/measure_money_area_period' reimbursable_expenses: type: array items: type: object properties: type: type: string example: OperationalExpense enum: - OperationalExpense - RealEstateTax - ReimbursableExpenseCleaning - ReimbursableExpenseInsurance - ReimbursableExpenseMarketing - ReimbursableExpenseOm - ReimbursableExpenseOther - ReimbursableExpenseRepairsAndMaintenance - ReimbursableExpenseSecurity - ReimbursableExpenseUtility - ReimbursableExpenseCam - ReimbursableExpenseElectric - ReimbursableExpenseLandscaping - ReimbursableExpenseManagementFee description: The type of the reimbursable expense start_date: type: string example: '2022-03-02' end_date: type: string example: '2023-03-02' amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' commencement_date: type: string format: date created_at: type: string format: date-time term_type: type: string example: Renewal nullable: true description: The purpose of the deal (new, renewal, expansion) entered_date: type: string format: date description: Date the Lease was added to VTS execution_date: type: string format: date description: The date the Lease is executed—usually the same as the commencement date. structure: type: string enum: - full service - triple net - modified gross example: full service description: Type of the lease the lease term belongs to deal_type: type: string example: new enum: - new - original - renewal - renewal_two - renewal_three - extension - expansion - termination - modification - sublease - license_agreement - storage - specialty - short_term_lease - other - relocation - rent_review - break - fixed_option description: type: string nullable: true example: This is a lease term. downtime: allOf: - $ref: '#/components/schemas/measure_period' - type: object nullable: true properties: magnitude: example: 2 unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M description: Months from previous tenant move-out to commencement date of replacement tenant expiration_date: type: string format: date gaap_rent: $ref: '#/components/schemas/measure_money' is_month_to_month: type: boolean lease_type: type: string example: full service move_out_date: type: string format: date nullable: true possession_date: type: string format: date nullable: true rent_commencement_date: type: string format: date nullable: true rentable_size: $ref: '#/components/schemas/measure_size' lock_in_end_date: type: string format: date nullable: true retail: type: object properties: description: type: string nullable: true growth_rate: type: number percent_rent: type: number estimated_sales: $ref: '#/components/schemas/measure_money_period' natural_breakpoint: $ref: '#/components/schemas/measure_money_period' unnatural_breakpoint: $ref: '#/components/schemas/measure_money_period' percentage_rents: type: array items: type: object properties: start_date: type: string format: date example: '2022-03-13' description: The start date in which the percentage rent revenue applies end_date: type: string format: date example: '2022-04-13' description: The end date in which the percentage rent revenue applies amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' description: The amount of the percentage rent revenue description: Amount of the tenant's sales that must be paid as rent to the landlord sourceid: type: string nullable: true example: '000004353' tenant_buildout_period: $ref: '#/components/schemas/measure_period' term_duration: $ref: '#/components/schemas/measure_period' updated_at: type: string format: date-time lease_infos: type: array items: type: object properties: type: type: string example: guarantor enum: - guarantor - tenant notice info - lease drafter - certificate of insurance - development impact - other description: The type of the lease info description: type: string example: My description nullable: true description: Lease info description other_incomes: type: array items: type: object properties: type: type: string example: parking enum: - parking - storage - signage - fitout - promotional_charges - interest - other description: The type of the other income start_date: type: string example: '2022-03-02' end_date: type: string example: '2023-03-02' amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' description: Value of other income that will be paid to landlord by the tenant quantity: type: number example: '1' description: The quantity of parking description: type: string example: My description nullable: true description: Other income description free_rents: type: array items: type: object properties: start_date: type: string example: '2022-03-02' end_date: type: string example: '2023-03-02' amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' description: This is the amount to be discounted from the base rent base_rents: type: array items: type: object properties: start_date: type: string format: date example: '2022-03-02' end_date: type: string format: date example: '2023-03-02' amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' description: This is the per unit rent due over the select duration commissions: $ref: '#/components/schemas/commissions' costs: type: array items: type: object properties: type: type: string enum: - tenant_improvement - building_improvement - other_fee example: tenant_improvement description: The type of the cost occurrence_month: type: number example: 1 description: The occurrence month of the cost. Possible values are between 1 and the number of months in the term amount: oneOf: - $ref: '#/components/schemas/measure_money' - $ref: '#/components/schemas/measure_money_period' description: The amount, with units, of the cost description: type: string example: Description description: The description of the cost relationships: type: object properties: lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri spaces: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: self: type: string example: https://api.vts.com/api/v1/lease_terms prev: type: string example: https://api.vts.com/api/v1/lease_terms?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/lease_terms?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-lease-terms /api/v1/lease_terms/{id}: get: summary: Retrieves specific lease term description: Contains attributes of a given lease term including possession date, lease type, and calculated rents tags: - Lease Terms security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested lease_term if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: lease_terms id: type: string example: '1' attributes: type: object properties: calculated_rents: type: object properties: expiring_base_rent: $ref: '#/components/schemas/measure_money_area_period' expiring_gross_rent: $ref: '#/components/schemas/measure_money_area_period' in_place_base_rent: $ref: '#/components/schemas/measure_money_area_period' in_place_gross_rent: $ref: '#/components/schemas/measure_money_area_period' reimbursable_expenses: type: array items: type: object properties: type: type: string example: OperationalExpense enum: - OperationalExpense - RealEstateTax - ReimbursableExpenseCleaning - ReimbursableExpenseInsurance - ReimbursableExpenseMarketing - ReimbursableExpenseOm - ReimbursableExpenseOther - ReimbursableExpenseRepairsAndMaintenance - ReimbursableExpenseSecurity - ReimbursableExpenseUtility - ReimbursableExpenseCam - ReimbursableExpenseElectric - ReimbursableExpenseLandscaping - ReimbursableExpenseManagementFee description: The type of the reimbursable expense start_date: type: string example: '2022-03-02' end_date: type: string example: '2023-03-02' amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' commencement_date: type: string format: date created_at: type: string format: date-time term_type: type: string example: Renewal nullable: true description: The purpose of the deal (new, renewal, expansion) entered_date: type: string format: date description: Date the Lease was added to VTS execution_date: type: string format: date description: The date the Lease is executed—usually the same as the commencement date. structure: type: string enum: - full service - triple net - modified gross example: full service description: Type of the lease the lease term belongs to deal_type: type: string example: new enum: - new - original - renewal - renewal_two - renewal_three - extension - expansion - termination - modification - sublease - license_agreement - storage - specialty - short_term_lease - other - relocation - rent_review - break - fixed_option description: type: string nullable: true example: This is a lease term. downtime: allOf: - $ref: '#/components/schemas/measure_period' - type: object nullable: true properties: magnitude: example: 2 unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M description: Months from previous tenant move-out to commencement date of replacement tenant expiration_date: type: string format: date gaap_rent: $ref: '#/components/schemas/measure_money' is_month_to_month: type: boolean lease_type: type: string example: full service move_out_date: type: string format: date nullable: true possession_date: type: string format: date nullable: true rent_commencement_date: type: string format: date nullable: true rentable_size: $ref: '#/components/schemas/measure_size' lock_in_end_date: type: string format: date nullable: true retail: type: object properties: description: type: string nullable: true growth_rate: type: number percent_rent: type: number estimated_sales: $ref: '#/components/schemas/measure_money_period' natural_breakpoint: $ref: '#/components/schemas/measure_money_period' unnatural_breakpoint: $ref: '#/components/schemas/measure_money_period' percentage_rents: type: array items: type: object properties: start_date: type: string format: date example: '2022-03-13' description: The start date in which the percentage rent revenue applies end_date: type: string format: date example: '2022-04-13' description: The end date in which the percentage rent revenue applies amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' description: The amount of the percentage rent revenue description: Amount of the tenant's sales that must be paid as rent to the landlord sourceid: type: string nullable: true example: '000004353' tenant_buildout_period: $ref: '#/components/schemas/measure_period' term_duration: $ref: '#/components/schemas/measure_period' updated_at: type: string format: date-time lease_infos: type: array items: type: object properties: type: type: string example: guarantor enum: - guarantor - tenant notice info - lease drafter - certificate of insurance - development impact - other description: The type of the lease info description: type: string example: My description nullable: true description: Lease info description other_incomes: type: array items: type: object properties: type: type: string example: parking enum: - parking - storage - signage - fitout - promotional_charges - interest - other description: The type of the other income start_date: type: string example: '2022-03-02' end_date: type: string example: '2023-03-02' amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' description: Value of other income that will be paid to landlord by the tenant quantity: type: number example: '1' description: The quantity of parking description: type: string example: My description nullable: true description: Other income description free_rents: type: array items: type: object properties: start_date: type: string example: '2022-03-02' end_date: type: string example: '2023-03-02' amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' description: This is the amount to be discounted from the base rent base_rents: type: array items: type: object properties: start_date: type: string format: date example: '2022-03-02' end_date: type: string format: date example: '2023-03-02' amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' description: This is the per unit rent due over the select duration commissions: $ref: '#/components/schemas/commissions' costs: type: array items: type: object properties: type: type: string enum: - tenant_improvement - building_improvement - other_fee example: tenant_improvement description: The type of the cost occurrence_month: type: number example: 1 description: The occurrence month of the cost. Possible values are between 1 and the number of months in the term amount: oneOf: - $ref: '#/components/schemas/measure_money' - $ref: '#/components/schemas/measure_money_period' description: The amount, with units, of the cost description: type: string example: Description description: The description of the cost relationships: type: object properties: lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri spaces: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested lease_term does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-lease-terms-id /api/v1/lease_terms/{lease_term_id}/financials: get: summary: Fetches Financials for a given lease term description: Contains the corresponding financials for a lease or deal term tags: - Financials security: - basic_auth: [] parameters: - name: lease_term_id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Financials content: application/json: schema: type: object properties: data: type: array items: oneOf: - type: object properties: type: type: string pattern: base_rents example: base_rents id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this base rent was created updated_at: type: string format: date-time description: The timestamp when this base rent was last updated relationships: type: object properties: lease_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: lease_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: free_rents example: free_rents id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this free rent was created updated_at: type: string format: date-time description: The timestamp when this free rent was last updated structure: type: string nullable: true enum: - net - gross - null example: net relationships: type: object properties: lease_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: lease_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: percentage_rents example: percentage_rents id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this base rent was created updated_at: type: string format: date-time description: The timestamp when this base rent was last updated relationships: type: object properties: lease_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: lease_terms links: type: object properties: related: type: string format: uri created_at: type: string format: date-time description: The timestamp when this percentage rent was created updated_at: type: string format: date-time description: The timestamp when this percentage rent was last updated - type: object properties: type: type: string pattern: other_revenues example: other_revenues id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this other revenue was created updated_at: type: string format: date-time description: The timestamp when this other revenue was last updated revenue_type: type: string nullable: true example: other relationships: type: object properties: lease_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: lease_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: reimbursable_expenses example: reimbursable_expenses id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' ends: type: object properties: date: type: string format: date duration: allOf: - $ref: '#/components/schemas/measure_period' - description: The number of months that this revenue / expense is applicable for properties: unit: enum: - mo unit_components: properties: period: enum: - mo iso8601: example: P2M starts: type: object properties: date: type: string format: date month: $ref: '#/components/schemas/month' created_at: type: string format: date-time description: The timestamp when this reimbursable expense was created updated_at: type: string format: date-time description: The timestamp when this reimbursable expense was last updated base_year: type: object properties: start: type: integer nullable: true example: 2009 end: type: integer nullable: true example: 2010 description: type: string nullable: true example: real estate tax recovery_amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' recovery_type: type: string enum: - Opex - Real Estate Taxes - CAM - Cleaning - Electric - Insurance - Landscaping - Repairs and Maintenance - Management Fee - Marketing - Other - Security - Utilities reimbursed: type: boolean nullable: true stop_amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' structure: type: string nullable: true enum: - gross - net - amount - modified_gross - null relationships: type: object properties: lease_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: lease_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string enum: - lease_incentives - other_credits example: lease_incentives id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_area' - $ref: '#/components/schemas/measure_money' occurrence_month: type: integer minimum: 0 nullable: true description: type: string nullable: true improvement_type: type: string enum: - tenant - building created_at: type: string format: date-time description: The timestamp when this lease incentive was created updated_at: type: string format: date-time description: The timestamp when this lease incentive was last updated relationships: type: object properties: lease_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: lease_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string enum: - improvements example: improvements pattern: improvements id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_area' - $ref: '#/components/schemas/measure_money' occurrence_month: type: integer minimum: 0 nullable: true description: type: string nullable: true improvement_type: type: string enum: - tenant - building created_at: type: string format: date-time description: The timestamp when this improvement was created updated_at: type: string format: date-time description: The timestamp when this improvement was last updated relationships: type: object properties: lease_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: lease_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: commissions example: commissions id: type: string example: '1' attributes: type: object properties: structure: type: string nullable: true example: gross broker: type: string nullable: true example: Ensemble commission_date: type: string nullable: true example: '2020-01-01' commission_type: type: string nullable: true example: Tenant created_at: type: string format: date-time description: The timestamp when this commission was created updated_at: type: string format: date-time description: The timestamp when this commission was last updated periods: type: array items: type: object properties: amount: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money' - $ref: '#/components/schemas/measure_period' - $ref: '#/components/schemas/measure_percentage' starts: type: object properties: date: type: string nullable: true format: date example: '2020-01-01' month: type: integer nullable: true example: 1 minimum: 1 relationships: type: object properties: lease_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: lease_terms links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: other_credits example: other_credits id: type: string example: '1' attributes: type: object properties: amount: anyOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' occurrence_month: type: integer minimum: 0 nullable: true description: type: string nullable: true created_at: type: string format: date-time description: The timestamp when this other credit was created updated_at: type: string format: date-time description: The timestamp when this other credit was last updated relationships: type: object properties: lease_term: type: object properties: data: type: object properties: id: type: string type: type: string pattern: lease_terms links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string prev: type: string next: type: string required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-lease-terms-lease-term-id-financials /api/v1/lease_terms/{lease_term_id}/options: get: summary: Fetches options for Lease Term description: Contains all options for a given deal term or lease term. Examples include encumbrances, renewals, and termination options tags: - Options security: - basic_auth: [] parameters: - name: lease_term_id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Options content: application/json: schema: type: object properties: data: type: array items: anyOf: - type: object properties: type: type: string pattern: options_miscellaneous example: options_miscellaneous id: type: string example: '1' attributes: type: object properties: option_type: type: string enum: - audit rights - cap on rates - generator rights - go dark - landlord & tenant act 1954 - make good - must lease - other - parking - radius - relocation - set off rights - signage - special provisions - storage - sublease - use description: 'The type of option. Possible values: audit rights, cap on rates, generator rights, go dark, landlord & tenant act 1954, make good, must lease, other, parking, radius, relocation, set off rights, signage, special provisions, storage, sublease, use.' description: type: string nullable: true example: This is a description. description: A description of the option relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_co_tenancy example: options_co_tenancy id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: co-tenancy example: co-tenancy description: 'The type of option. Possible values: co-tenancy' co_tenancy_type: type: string enum: - named - occupied - null nullable: true description: 'The type of co-tenancy option. Possible values: named, occupied, null' who_can_exercise: type: string enum: - tenant - landlord - mutual - null nullable: true description: 'Who is allowed to exercise the co-tenancy option. Possible values: tenant, landlord, mutual, null' description: type: string nullable: true example: This is a description. description: A description of the option relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_contraction example: options_contraction id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: contraction example: contraction description: 'The type of option. Possible values: contraction.' description: type: string nullable: true example: This is a description. description: A description of the option minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum (smallest) size down to which the right-holder can contract the space effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right type: type: string enum: - tenant - landlord - mutual - null nullable: true description: Identifies who is holding the right - who owns and benefits from the contraction right fee: allOf: - $ref: '#/components/schemas/measure_money' - description: Fee associated with exercising the right — if the right-holder chooses to do so relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_encumberance example: options_encumberance id: type: string example: '1' attributes: type: object properties: option_type: type: string enum: - rofo - rofn - rofr description: 'The type of option. Possible values: rofo, rofn, rofr' description: type: string nullable: true example: This is a description. description: A description of the option minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum size of the space under the purview of the ROFO clause effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right rate_note: type: string nullable: true description: Free text field to further explain the nature of the rate type rate_type: type: string enum: - variable - fixed - null nullable: true description: 'Describes the unit/rate for the cost of the next term. Possible values: variable, fixed' relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_exclusive_use example: options_exclusive_use id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: exclusive use example: exclusive use description: 'The type of option. Possible values: exclusive use' description: type: string nullable: true example: This is a description. description: A description of the option trigger_details: type: string nullable: true description: A custom message detailing the nature of this tenant's exclusive use right that will appear elsewhere in VTS remedy_details: type: string nullable: true description: A custom message detailing how a new tenant might be able to negotiate or remedy potentially breaking an existing tenant's exclusive use right in VTS relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_purchase example: options_purchase id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: purchase example: purchase description: 'The type of option. Possible values: purchase' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_rent_review example: options_rent_review id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: rent review example: rent review description: 'The type of option. Possible values: rent review.' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_renewal example: options_renewal id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: renewal example: renewal description: 'The type of option. Possible values: renewal.' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum size of the space under the purview of the renewal clause term: allOf: - $ref: '#/components/schemas/measure_size' - description: Number of months notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right number_of_options: type: integer nullable: true example: 1 description: Number of renewal options available rate_note: type: string nullable: true description: Free text field to further explain the nature of the rate type rate_type: type: string nullable: true description: 'Describes the unit/rate for the cost of the next term. Possible values: variable, fixed' relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_expansion example: options_expansion id: type: string example: '1' attributes: type: object properties: option_type: type: string pattern: expansion example: expansion description: 'The type of option. Possible values: expansion' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right maximum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The maximum size to which the tenant can expand per the clause minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum size to which the tenant can expand per the clause notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right rate_note: type: string nullable: true description: Free text field to further explain the nature of the rate type rate_type: type: string nullable: true description: 'Describes the unit/rate for the cost of the next term. Possible values: variable, fixed' tenant_improvements: allOf: - $ref: '#/components/schemas/measure_money' - description: The amount of tenant improvements alloted by the landlord in the expansion relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_termination example: options_termination id: type: string example: '1' attributes: type: object properties: option_type: type: string enum: - break - kick out - rights to terminate description: 'The type of option. Possible values: break, kick out, rights to terminate' description: type: string nullable: true example: This is a description. description: A description of the option termination_fee: allOf: - $ref: '#/components/schemas/measure_money' - description: The fee associated with exercising the early termination effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right rights_holder: type: string enum: - tenant - landlord - mutual - null nullable: true description: 'Possible values: tenant, landlord, mutual' relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string prev: type: string next: type: string required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-lease-terms-lease-term-id-options /api/v1/leases: get: summary: Gets leases description: Contains all leases in your portfolio. Supports interacting with all leases, or specifying a particular lease ID tags: - Leases security: - basic_auth: [] parameters: - name: filter[sourceid] in: query required: false schema: type: string - name: filter[delinquent] in: query required: false schema: type: boolean - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns a possibly empty list of leases that match the provided parameters content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string example: '1' type: type: string example: leases attributes: type: object properties: commencement_date: type: string nullable: true format: date created_at: type: string nullable: true format: date-time execution_date: type: string nullable: true format: date expiration_date: type: string nullable: true format: date renewal_status: type: string nullable: true enum: - renewing - not_renewing - unknown - negotiating sourceid: type: string nullable: true example: '000004353' structure: type: string nullable: true enum: - full service - modified gross - triple net updated_at: type: string nullable: true format: date-time industry: type: string nullable: true example: wound care & hyperbaric relationships: type: object properties: tenant: type: object properties: data: type: object properties: id: type: string example: '1' type: type: string example: tenants nullable: true links: type: object properties: related: type: string contacts: type: object properties: data: type: array items: type: object properties: id: type: string example: '1' type: type: string example: tenant_contacts links: type: object properties: related: type: string links: type: object properties: self: type: string example: https://api.vts.com/api/v1/leases prev: type: string example: https://api.vts.com/api/v1/leases?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/leases?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-leases /api/v1/leases/{id}: get: summary: Retrieves specific lease description: Contains all leases in your portfolio. Supports interacting with all leases, or specifying a particular lease ID tags: - Leases security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested lease if it exists content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: '1' type: type: string example: leases attributes: type: object properties: commencement_date: type: string nullable: true format: date created_at: type: string nullable: true format: date-time execution_date: type: string nullable: true format: date expiration_date: type: string nullable: true format: date renewal_status: type: string nullable: true enum: - renewing - not_renewing - unknown - negotiating sourceid: type: string nullable: true example: '000004353' structure: type: string nullable: true enum: - full service - modified gross - triple net updated_at: type: string nullable: true format: date-time industry: type: string nullable: true example: wound care & hyperbaric relationships: type: object properties: tenant: type: object properties: data: type: object properties: id: type: string example: '1' type: type: string example: tenants nullable: true links: type: object properties: related: type: string contacts: type: object properties: data: type: array items: type: object properties: id: type: string example: '1' type: type: string example: tenant_contacts links: type: object properties: related: type: string '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested lease does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-leases-id /api/v1/leases/{lease_id}/delinquencies: post: summary: Creates delinquency tags: - Delinquencies description: Creates a delinquency record on the lease security: - basic_auth: [] parameters: - name: lease_id in: path required: true schema: type: string responses: '201': description: Delinquency successfully created content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: delinquencies id: type: string example: '1' attributes: type: object properties: lease_id: type: string example: '1' deprecated: true description: This attribute is deprecated, please use lease from the `relationships` object instead current_amount: type: number total_amount: type: number charge_date: type: string format: date charge_type: type: string example: late payment_date: type: string nullable: true format: date created_at: type: string format: date-time updated_at: type: string format: date-time relationships: description: The objects linked to a delinquency type: object properties: lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri '400': description: Parameters are invalid content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Referenced lease not found content: application/json: schema: $ref: '#/components/schemas/errors_object' '409': description: Duplicate record content: application/json: schema: $ref: '#/components/schemas/errors_object' requestBody: content: application/json: schema: type: object properties: data: type: object properties: attributes: type: object required: - total_amount - current_amount - charge_date - charge_type properties: total_amount: type: number current_amount: type: number charge_date: type: string format: date charge_type: type: string example: late payment_date: type: string nullable: true format: date required: true operationId: post_api-v1-leases-lease-id-delinquencies get: summary: Fetches delinquencies description: Contains the delinquent leases in your portfolio tags: - Delinquencies security: - basic_auth: [] parameters: - name: lease_id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[status] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Delinquencies for the Lease content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: delinquencies id: type: string example: '1' attributes: type: object properties: lease_id: type: string example: '1' deprecated: true description: This attribute is deprecated, please use lease from the `relationships` object instead current_amount: type: number total_amount: type: number charge_date: type: string format: date charge_type: type: string example: late payment_date: type: string nullable: true format: date created_at: type: string format: date-time updated_at: type: string format: date-time relationships: description: The objects linked to a delinquency type: object properties: lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri '404': description: Referenced lease not found content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-leases-lease-id-delinquencies /api/v1/leases/{lease_id}/delinquencies/{id}: patch: summary: Updates delinquency tags: - Delinquencies description: Updates a delinquency record on the lease security: - basic_auth: [] parameters: - name: lease_id in: path required: true schema: type: string - name: id in: path required: true schema: type: integer responses: '200': description: Delinquency successfully updated content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: delinquencies id: type: string example: '1' attributes: type: object properties: lease_id: type: string example: '1' deprecated: true description: This attribute is deprecated, please use lease from the `relationships` object instead current_amount: type: number total_amount: type: number charge_date: type: string format: date charge_type: type: string example: late payment_date: type: string nullable: true format: date created_at: type: string format: date-time updated_at: type: string format: date-time relationships: description: The objects linked to a delinquency type: object properties: lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri '400': description: Parameters are invalid content: application/json: schema: $ref: '#/components/schemas/errors_object' '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Referenced lease not found content: application/json: schema: $ref: '#/components/schemas/errors_object' requestBody: content: application/json: schema: type: object properties: data: type: object properties: attributes: type: object properties: total_amount: type: number current_amount: type: number charge_date: type: string format: date charge_type: type: string example: late payment_date: type: string nullable: true format: date required: true operationId: patch_api-v1-leases-lease-id-delinquencies-id /api/v1/leases/{lease_id}/retail_sales: post: summary: Creates retail sale tags: - Retail Sales description: Creates the retail sale amounts for a given lease ID security: - basic_auth: [] parameters: - name: lease_id in: path required: true schema: type: string responses: '201': description: Retail sale successfully created content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: retail_sales id: type: string example: '1' attributes: type: object required: - amount - start_date - end_date properties: lease_id: type: string example: '11' deprecated: true description: This attribute is deprecated, please use lease from the `relationships` object instead amount: type: number example: 1000 start_date: type: string format: date end_date: type: string format: date created_at: type: string format: date-time updated_at: type: string format: date-time relationships: type: object properties: lease: type: object properties: data: type: object properties: id: type: string example: '1' type: type: string example: leases links: type: object properties: related: type: string '400': description: Parameters are invalid content: application/json: schema: $ref: '#/components/schemas/errors_object' '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Referenced lease not found content: application/json: schema: $ref: '#/components/schemas/errors_object' requestBody: content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: retail_sales id: type: string example: '1' attributes: type: object required: - amount - start_date - end_date properties: lease_id: type: string example: '11' deprecated: true description: This attribute is deprecated, please use lease from the `relationships` object instead amount: type: number example: 1000 start_date: type: string format: date end_date: type: string format: date created_at: type: string format: date-time updated_at: type: string format: date-time relationships: type: object properties: lease: type: object properties: data: type: object properties: id: type: string example: '1' type: type: string example: leases links: type: object properties: related: type: string required: true operationId: post_api-v1-leases-lease-id-retail-sales get: summary: Fetches retail sales description: Contains the retail sale amounts for a given lease ID tags: - Retail Sales security: - basic_auth: [] parameters: - name: lease_id in: path required: true schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of retails sales content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: retail_sales id: type: string example: '1' attributes: type: object required: - amount - start_date - end_date properties: lease_id: type: string example: '11' deprecated: true description: This attribute is deprecated, please use lease from the `relationships` object instead amount: type: number example: 1000 start_date: type: string format: date end_date: type: string format: date created_at: type: string format: date-time updated_at: type: string format: date-time relationships: type: object properties: lease: type: object properties: data: type: object properties: id: type: string example: '1' type: type: string example: leases links: type: object properties: related: type: string '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Referenced lease not found content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-leases-lease-id-retail-sales /api/v1/listings/{id}: get: summary: Fetches a specific listing description: Part of the Leasing Availability API, this fetches a specific listing on VTS Market with information about the listing. Expected usage would be to make a webpage about the listing tags: - Leasing Availability security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested listing if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: listings id: type: string example: 20be22bd-7d79-47f6-a267-fc3492c5d90b attributes: type: object description: A Listing properties: area: allOf: - $ref: '#/components/schemas/measure_area' - description: Area of the space of the listing asking_rent: type: object nullable: true properties: magnitude: type: number example: 10000 type: type: string example: area units: type: object properties: area: type: string example: SquareFoot currency: type: string example: USD period: type: string example: month amenities: type: object properties: break_out_space: type: boolean nullable: true example: true key_card_space_entry: type: boolean nullable: true example: true phone_booths: type: boolean nullable: true example: true private_outdoor_space: type: boolean nullable: true example: true shared_pantry: type: boolean nullable: true example: true passenger_elevator_count: type: integer nullable: true example: 1 service_elevator_count: type: integer nullable: true example: 1 furnished: type: string nullable: true example: partial condition: type: string nullable: true example: white_box contacts: type: array items: type: object properties: id: type: integer example: 1 first_name: type: string example: John last_name: type: string nullable: true example: Doe email: type: string example: whatever@whever.com role: type: string nullable: true example: CEO phone: type: string nullable: true example: 123-456-7890 phone_extension: type: string nullable: true example: '1234' photo_url: type: string nullable: true example: https://media.truva.com/path company_logo_url: type: string nullable: true example: https://media.truva.com/path broker_licence_number: type: string nullable: true example: 'RC #192017' images: type: array items: type: object properties: path: type: string example: https://media.truva.com/path small_path: type: string example: https://media.truva.com/t_small_image/path description: type: string example: Building Photo nullable: false available: type: boolean example: true available_date: type: string nullable: true example: '2021-01-01' listing_brochure: type: object example: name: Brochure-name.pdf url: https://download.link/whatever.pdf id: 2 description: type: string example: This is a listing floor: type: string example: '1' floor_plan: type: object properties: path: type: string example: https://media.truva.com/path small_path: type: string example: https://media.truva.com/t_small_image/path description: type: string example: Building Photo nullable: true marketplace_url: type: string example: https://marketplace.vts.com/market_listings/:id listing_name: type: string example: 1st Floor, Room 101 status: type: string example: on_market suite: type: string example: '101' suite_type: type: string example: room video_url: type: string example: https://marketplace.vts.com/listing/abc/video virtual_tour_url: type: string example: https://marketplace.vts.com/listing/abc/3dtour area_maximum_contiguous: allOf: - $ref: '#/components/schemas/measure_area' - description: Maximum contiguous area of the space of the listing area_minimum_divisible: allOf: - $ref: '#/components/schemas/measure_area' - description: Minimum divisible area of the space of the listing ceiling_height_finished: allOf: - $ref: '#/components/schemas/measure_area' - description: Minimum divisible area of the space of the listing ceiling_height_slab_to_slab: allOf: - $ref: '#/components/schemas/measure_area' - description: Minimum divisible area of the space of the listing building_id: type: string example: 20be22bd-7d79-47f6-a267-fc3492c5d90b floor_composition: type: string nullable: true example: entire vts_space_id: type: integer nullable: true example: 1 lease_type: type: string example: direct '403': description: authenticated but does not have access to requested listing content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested listing does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-listings-id /api/v1/options: get: summary: Fetches options description: Contains all options for a given deal term or lease term. Examples include encumbrances, renewals, and termination options tags: - Options security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' - name: filter[term_type] in: query schema: type: string required: false description: 'Only display options belonging to the specific parent object. Possible values: ''deal_term'', ''lease_term''' example: deal_term responses: '200': description: Returns list of Options content: application/json: schema: type: object properties: data: type: array items: anyOf: - type: object properties: type: type: string pattern: options_miscellaneous example: options_miscellaneous id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string enum: - audit rights - cap on rates - generator rights - go dark - landlord & tenant act 1954 - make good - must lease - other - parking - radius - relocation - set off rights - signage - special provisions - storage - sublease - use description: 'The type of option. Possible values: audit rights, cap on rates, generator rights, go dark, landlord & tenant act 1954, make good, must lease, other, parking, radius, relocation, set off rights, signage, special provisions, storage, sublease, use.' description: type: string nullable: true example: This is a description. description: A description of the option relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_co_tenancy example: options_co_tenancy id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: co-tenancy example: co-tenancy description: 'The type of option. Possible values: co-tenancy' co_tenancy_type: type: string enum: - named - occupied - null nullable: true description: 'The type of co-tenancy option. Possible values: named, occupied, null' who_can_exercise: type: string enum: - tenant - landlord - mutual - null nullable: true description: 'Who is allowed to exercise the co-tenancy option. Possible values: tenant, landlord, mutual, null' description: type: string nullable: true example: This is a description. description: A description of the option relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_contraction example: options_contraction id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: contraction example: contraction description: 'The type of option. Possible values: contraction.' description: type: string nullable: true example: This is a description. description: A description of the option minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum (smallest) size down to which the right-holder can contract the space effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right type: type: string enum: - tenant - landlord - mutual - null nullable: true description: Identifies who is holding the right - who owns and benefits from the contraction right fee: allOf: - $ref: '#/components/schemas/measure_money' - description: Fee associated with exercising the right — if the right-holder chooses to do so relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_encumberance example: options_encumberance id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string enum: - rofo - rofn - rofr description: 'The type of option. Possible values: rofo, rofn, rofr' description: type: string nullable: true example: This is a description. description: A description of the option minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum size of the space under the purview of the ROFO clause effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right rate_note: type: string nullable: true description: Free text field to further explain the nature of the rate type rate_type: type: string enum: - variable - fixed - null nullable: true description: 'Describes the unit/rate for the cost of the next term. Possible values: variable, fixed' relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_exclusive_use example: options_exclusive_use id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: exclusive use example: exclusive use description: 'The type of option. Possible values: exclusive use' description: type: string nullable: true example: This is a description. description: A description of the option trigger_details: type: string nullable: true description: A custom message detailing the nature of this tenant's exclusive use right that will appear elsewhere in VTS remedy_details: type: string nullable: true description: A custom message detailing how a new tenant might be able to negotiate or remedy potentially breaking an existing tenant's exclusive use right in VTS relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_purchase example: options_purchase id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: purchase example: purchase description: 'The type of option. Possible values: purchase' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_rent_review example: options_rent_review id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: rent review example: rent review description: 'The type of option. Possible values: rent review.' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_renewal example: options_renewal id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: renewal example: renewal description: 'The type of option. Possible values: renewal.' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum size of the space under the purview of the renewal clause term: allOf: - $ref: '#/components/schemas/measure_size' - description: Number of months notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right number_of_options: type: integer nullable: true example: 1 description: Number of renewal options available rate_note: type: string nullable: true description: Free text field to further explain the nature of the rate type rate_type: type: string nullable: true description: 'Describes the unit/rate for the cost of the next term. Possible values: variable, fixed' relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_expansion example: options_expansion id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: expansion example: expansion description: 'The type of option. Possible values: expansion' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right maximum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The maximum size to which the tenant can expand per the clause minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum size to which the tenant can expand per the clause notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right rate_note: type: string nullable: true description: Free text field to further explain the nature of the rate type rate_type: type: string nullable: true description: 'Describes the unit/rate for the cost of the next term. Possible values: variable, fixed' tenant_improvements: allOf: - $ref: '#/components/schemas/measure_money_area' - description: The amount of tenant improvements alloted by the landlord in the expansion relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_termination example: options_termination id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string enum: - break - kick out - rights to terminate description: 'The type of option. Possible values: break, kick out, rights to terminate' description: type: string nullable: true example: This is a description. description: A description of the option termination_fee: allOf: - $ref: '#/components/schemas/measure_money' - description: The fee associated with exercising the early termination effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right rights_holder: type: string enum: - tenant - landlord - mutual - null nullable: true description: 'Possible values: tenant, landlord, mutual' relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string prev: type: string next: type: string required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-options /api/v1/options/{id}: get: summary: Retrieves Options for Specific Account description: Contains all options for a given deal term or lease term. Examples include encumbrances, renewals, and termination options tags: - Options security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested account option if it exists content: application/json: schema: type: object properties: data: anyOf: - type: object properties: type: type: string pattern: options_miscellaneous example: options_miscellaneous id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string enum: - audit rights - cap on rates - generator rights - go dark - landlord & tenant act 1954 - make good - must lease - other - parking - radius - relocation - set off rights - signage - special provisions - storage - sublease - use description: 'The type of option. Possible values: audit rights, cap on rates, generator rights, go dark, landlord & tenant act 1954, make good, must lease, other, parking, radius, relocation, set off rights, signage, special provisions, storage, sublease, use.' description: type: string nullable: true example: This is a description. description: A description of the option relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_co_tenancy example: options_co_tenancy id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: co-tenancy example: co-tenancy description: 'The type of option. Possible values: co-tenancy' co_tenancy_type: type: string enum: - named - occupied - null nullable: true description: 'The type of co-tenancy option. Possible values: named, occupied, null' who_can_exercise: type: string enum: - tenant - landlord - mutual - null nullable: true description: 'Who is allowed to exercise the co-tenancy option. Possible values: tenant, landlord, mutual, null' description: type: string nullable: true example: This is a description. description: A description of the option relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_contraction example: options_contraction id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: contraction example: contraction description: 'The type of option. Possible values: contraction.' description: type: string nullable: true example: This is a description. description: A description of the option minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum (smallest) size down to which the right-holder can contract the space effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right type: type: string enum: - tenant - landlord - mutual - null nullable: true description: Identifies who is holding the right - who owns and benefits from the contraction right fee: allOf: - $ref: '#/components/schemas/measure_money' - description: Fee associated with exercising the right — if the right-holder chooses to do so relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_encumberance example: options_encumberance id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string enum: - rofo - rofn - rofr description: 'The type of option. Possible values: rofo, rofn, rofr' description: type: string nullable: true example: This is a description. description: A description of the option minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum size of the space under the purview of the ROFO clause effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right rate_note: type: string nullable: true description: Free text field to further explain the nature of the rate type rate_type: type: string enum: - variable - fixed - null nullable: true description: 'Describes the unit/rate for the cost of the next term. Possible values: variable, fixed' relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_exclusive_use example: options_exclusive_use id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: exclusive use example: exclusive use description: 'The type of option. Possible values: exclusive use' description: type: string nullable: true example: This is a description. description: A description of the option trigger_details: type: string nullable: true description: A custom message detailing the nature of this tenant's exclusive use right that will appear elsewhere in VTS remedy_details: type: string nullable: true description: A custom message detailing how a new tenant might be able to negotiate or remedy potentially breaking an existing tenant's exclusive use right in VTS relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_purchase example: options_purchase id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: purchase example: purchase description: 'The type of option. Possible values: purchase' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_rent_review example: options_rent_review id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: rent review example: rent review description: 'The type of option. Possible values: rent review.' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_renewal example: options_renewal id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: renewal example: renewal description: 'The type of option. Possible values: renewal.' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum size of the space under the purview of the renewal clause term: allOf: - $ref: '#/components/schemas/measure_size' - description: Number of months notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right number_of_options: type: integer nullable: true example: 1 description: Number of renewal options available rate_note: type: string nullable: true description: Free text field to further explain the nature of the rate type rate_type: type: string nullable: true description: 'Describes the unit/rate for the cost of the next term. Possible values: variable, fixed' relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_expansion example: options_expansion id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string pattern: expansion example: expansion description: 'The type of option. Possible values: expansion' description: type: string nullable: true example: This is a description. description: A description of the option effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right maximum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The maximum size to which the tenant can expand per the clause minimum_size: allOf: - $ref: '#/components/schemas/measure_size' - description: The minimum size to which the tenant can expand per the clause notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right rate_note: type: string nullable: true description: Free text field to further explain the nature of the rate type rate_type: type: string nullable: true description: 'Describes the unit/rate for the cost of the next term. Possible values: variable, fixed' tenant_improvements: allOf: - $ref: '#/components/schemas/measure_money_area' - description: The amount of tenant improvements alloted by the landlord in the expansion relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: options_termination example: options_termination id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this option was created updated_at: type: string format: date-time description: The timestamp when this option last updated option_type: type: string enum: - break - kick out - rights to terminate description: 'The type of option. Possible values: break, kick out, rights to terminate' description: type: string nullable: true example: This is a description. description: A description of the option termination_fee: allOf: - $ref: '#/components/schemas/measure_money' - description: The fee associated with exercising the early termination effective_date: type: string nullable: true format: date description: The date on which the right-holder chooses to exercise the right notice_start_date: type: string nullable: true format: date description: The earliest date upon which the right-holder can exercise the right notice_end_date: type: string nullable: true format: date description: The latest date on which the right-holder can exercise the right rights_holder: type: string enum: - tenant - landlord - mutual - null nullable: true description: 'Possible values: tenant, landlord, mutual' relationships: type: object properties: targets: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - spaces_office example: spaces_office links: type: object properties: related: type: string format: uri lease_term: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - lease_terms example: lease_terms links: type: object properties: related: type: string format: uri proposal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - proposals example: proposals links: type: object properties: related: type: string format: uri '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested option does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-options-id /api/v1/proposals: get: summary: Fetches proposals description: Contains details of a given proposal, including discount rate, proposal type, and description tags: - Proposals security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string responses: '200': description: Returns list of Proposals content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: proposals id: type: string example: '1' attributes: type: object properties: proposal_label: type: string example: Proposal Name nullable: true description: The name of the proposal calculated_metrics: type: object properties: net_effective_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: "The normalized value a tenant will pay per period to the landlord over the\ \ length of a\n lease considering Net Present Value.\ \ Returned in money/area/month units" ner_to_termination: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: The NER in light of a termination right added to the proposal. Returned in money/area/month units ner_with_downtime: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: The NER in light of a downtime included in the proposal. Returned in money/area/month units ner_vs_budget: type: number nullable: true example: 1 description: Net Effective Rent as a percent of NER of budget ner_to_termination_vs_budget: type: number nullable: true example: 1 description: '"NER to termination" as a percent of NER of the budget' net_present_value: allOf: - $ref: '#/components/schemas/measure_money' - description: The present value of the net cash flow given the time value of money net_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: Total cash received from base rent + escalation - free rent. Returned in money/area/year units total_capital: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash being paid out as part of costs associated with TI + BI + Other Fees + Commissions total_net_cash_flow: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash inflows minus outflows per the terms over the lifetime of the lease total_base_rent: allOf: - $ref: '#/components/schemas/measure_money' - description: Total base rent over the lifetime of the lease deprecated: true total_escalated_rent_before_abatement: allOf: - $ref: '#/components/schemas/measure_money' - description: Total base rent before abatement over the lifetime of the lease which includes the sum of base_rent + rent_escalation created_at: type: string format: date-time updated_at: type: string format: date-time entered_date: type: string format: date latest: type: boolean discount_rate: type: number nullable: true example: 0.08 description: type: string nullable: true example: This is a proposal. proposal_date: type: string format: date proposal_type: type: string example: final relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri deal_terms: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deal_terms example: deal_terms links: type: object properties: related: type: string format: uri options: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - options_miscellaneous - options_co_tenancy - options_contraction - options_encumberance - options_exclusive_use - options_purchase - options_rent_review - options_renewal - options_expansion - options_termination example: options_miscellaneous '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-proposals /api/v1/proposals/{id}: get: summary: Retrieves specific proposal description: Contains details of a given proposal, including discount rate, proposal type, and description tags: - Proposals security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested proposal if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: proposals id: type: string example: '1' attributes: type: object properties: proposal_label: type: string example: Proposal Name nullable: true description: The name of the proposal calculated_metrics: type: object properties: net_effective_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: "The normalized value a tenant will pay per period to the landlord over the\ \ length of a\n lease considering Net Present Value. Returned\ \ in money/area/month units" ner_to_termination: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: The NER in light of a termination right added to the proposal. Returned in money/area/month units ner_with_downtime: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/mo unit_components: properties: period: enum: - mo description: 'Possible values: ''mo''' description: The NER in light of a downtime included in the proposal. Returned in money/area/month units ner_vs_budget: type: number nullable: true example: 1 description: Net Effective Rent as a percent of NER of budget ner_to_termination_vs_budget: type: number nullable: true example: 1 description: '"NER to termination" as a percent of NER of the budget' net_present_value: allOf: - $ref: '#/components/schemas/measure_money' - description: The present value of the net cash flow given the time value of money net_rent: allOf: - $ref: '#/components/schemas/measure_money_area_period' - properties: magnitude: example: 35 unit: example: USD/sf/yr unit_components: properties: period: enum: - yr description: 'Possible values: ''yr''' description: Total cash received from base rent + escalation - free rent. Returned in money/area/year units total_capital: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash being paid out as part of costs associated with TI + BI + Other Fees + Commissions total_net_cash_flow: allOf: - $ref: '#/components/schemas/measure_money' - description: Total cash inflows minus outflows per the terms over the lifetime of the lease total_base_rent: allOf: - $ref: '#/components/schemas/measure_money' - description: Total base rent over the lifetime of the lease deprecated: true total_escalated_rent_before_abatement: allOf: - $ref: '#/components/schemas/measure_money' - description: Total base rent before abatement over the lifetime of the lease which includes the sum of base_rent + rent_escalation created_at: type: string format: date-time updated_at: type: string format: date-time entered_date: type: string format: date latest: type: boolean discount_rate: type: number nullable: true example: 0.08 description: type: string nullable: true example: This is a proposal. proposal_date: type: string format: date proposal_type: type: string example: final relationships: type: object properties: deal: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deals example: deals links: type: object properties: related: type: string format: uri deal_terms: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - deal_terms example: deal_terms links: type: object properties: related: type: string format: uri options: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - options_miscellaneous - options_co_tenancy - options_contraction - options_encumberance - options_exclusive_use - options_purchase - options_rent_review - options_renewal - options_expansion - options_termination example: options_miscellaneous '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested proposal does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-proposals-id /api/v1/spaces: get: summary: Fetches spaces description: Contains the spaces in your portfolio. Spaces are sub-components of assets tags: - Spaces security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[deal_id] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of Spaces content: application/json: schema: type: object properties: data: type: array items: oneOf: - type: object properties: type: type: string pattern: spaces_industrial example: spaces_industrial id: type: string example: '1' attributes: type: object properties: archived_date: type: string nullable: true format: date availability_date: type: string format: date nullable: true availability_type: type: string example: arranged enum: - arranged - immediate - month to month - not available - specified description: 'The Availability Type for this Space. Possible Values: arranged, immediate, month to month, not available, specified' created_at: type: string nullable: true format: date-time current_size: $ref: '#/components/schemas/measure_size' description: type: string nullable: true external_ids: type: array items: type: object properties: system_id: type: string nullable: true system_name: type: string nullable: true floor: type: object properties: composition: type: string nullable: true name: type: string position: type: number hypothetical_space: type: boolean lease_type: type: string enum: - direct - renewal - sublease listing_date: type: string nullable: true format: date market_rent: $ref: '#/components/schemas/measure_money' maximum_contiguous_size: $ref: '#/components/schemas/measure_size' minimum_divisible_size: $ref: '#/components/schemas/measure_size' occupancy_status: type: string nullable: true position: type: number nullable: true price_is_negotiable: type: boolean public: type: boolean remeasured_space_available: type: string nullable: true rental_pay_type: type: string enum: - amt_month - amt_year - psf_month - psf_year nullable: true rental_rate_max: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' rental_rate_min: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' sale_price: $ref: '#/components/schemas/measure_money' sourceid: type: string nullable: true space_condition: type: string enum: - 2nd generation - category a+ - challenged - core and shell - floor and shell - pre-built - pre-existing - raw - turnkey - under construction - white box nullable: true space_type: type: string nullable: true enum: - office - retail - industrial_warehouse - telecom - storage - flex - parking - amenities - rooftop - other - lab - manufacturing - residential - medical_office - education - restaurant - leisure - unspecified - null subtitle: type: string nullable: true suite: type: string nullable: true term_duration: type: string nullable: true transaction_type: type: string enum: - lease - sale nullable: true updated_at: type: string nullable: true format: date vacant_on_date: type: string nullable: true format: date internal_notes: type: string nullable: true example: Notes description: Internal notes visible only within the VTS platform for users with access to the Space. clear_height: type: string nullable: true depth: type: string nullable: true dock_height: type: string nullable: true ground_level_doors: type: string nullable: true office_portion: type: string nullable: true trailer_parking: type: string nullable: true yard: type: string nullable: true ceiling_height: type: string nullable: true column_spacing: type: string nullable: true electrical: type: string nullable: true hvac: type: string nullable: true parking: type: string nullable: true roof: type: string nullable: true sprinklers: type: string nullable: true relationships: type: object properties: in_place_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri committed_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri last_expired_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri asset: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets example: assets links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: spaces_office example: spaces_office id: type: string example: '1' attributes: type: object properties: archived_date: type: string nullable: true format: date availability_date: type: string format: date nullable: true availability_type: type: string example: arranged enum: - arranged - immediate - month to month - not available - specified description: 'The Availability Type for this Space. Possible Values: arranged, immediate, month to month, not available, specified' created_at: type: string nullable: true format: date-time current_size: $ref: '#/components/schemas/measure_size' description: type: string nullable: true external_ids: type: array items: type: object properties: system_id: type: string nullable: true system_name: type: string nullable: true floor: type: object properties: composition: type: string nullable: true name: type: string position: type: number hypothetical_space: type: boolean lease_type: type: string enum: - direct - renewal - sublease listing_date: type: string nullable: true format: date market_rent: $ref: '#/components/schemas/measure_money' maximum_contiguous_size: $ref: '#/components/schemas/measure_size' minimum_divisible_size: $ref: '#/components/schemas/measure_size' occupancy_status: type: string nullable: true position: type: number nullable: true price_is_negotiable: type: boolean public: type: boolean remeasured_space_available: type: string nullable: true rental_pay_type: type: string enum: - amt_month - amt_year - psf_month - psf_year nullable: true rental_rate_max: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' rental_rate_min: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' sale_price: $ref: '#/components/schemas/measure_money' sourceid: type: string nullable: true space_condition: type: string enum: - 2nd generation - category a+ - challenged - core and shell - floor and shell - pre-built - pre-existing - raw - turnkey - under construction - white box nullable: true space_type: type: string nullable: true enum: - office - retail - industrial_warehouse - telecom - storage - flex - parking - amenities - rooftop - other - lab - manufacturing - residential - medical_office - education - restaurant - leisure - unspecified - null subtitle: type: string nullable: true suite: type: string nullable: true term_duration: type: string nullable: true transaction_type: type: string enum: - lease - sale nullable: true updated_at: type: string nullable: true format: date vacant_on_date: type: string nullable: true format: date internal_notes: type: string nullable: true example: Notes description: Internal notes visible only within the VTS platform for users with access to the Space. ceiling_height: type: string nullable: true column_spacing: type: string nullable: true electrical: type: string nullable: true hvac: type: string nullable: true parking: type: string nullable: true roof: type: string nullable: true sprinklers: type: string nullable: true relationships: type: object properties: in_place_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri committed_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri last_expired_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri asset: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets example: assets links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: spaces_retail example: spaces_retail id: type: string example: '1' attributes: type: object properties: archived_date: type: string nullable: true format: date availability_date: type: string format: date nullable: true availability_type: type: string example: arranged enum: - arranged - immediate - month to month - not available - specified description: 'The Availability Type for this Space. Possible Values: arranged, immediate, month to month, not available, specified' created_at: type: string nullable: true format: date-time current_size: $ref: '#/components/schemas/measure_size' description: type: string nullable: true external_ids: type: array items: type: object properties: system_id: type: string nullable: true system_name: type: string nullable: true floor: type: object properties: composition: type: string nullable: true name: type: string position: type: number hypothetical_space: type: boolean lease_type: type: string enum: - direct - renewal - sublease listing_date: type: string nullable: true format: date market_rent: $ref: '#/components/schemas/measure_money' maximum_contiguous_size: $ref: '#/components/schemas/measure_size' minimum_divisible_size: $ref: '#/components/schemas/measure_size' occupancy_status: type: string nullable: true position: type: number nullable: true price_is_negotiable: type: boolean public: type: boolean remeasured_space_available: type: string nullable: true rental_pay_type: type: string enum: - amt_month - amt_year - psf_month - psf_year nullable: true rental_rate_max: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' rental_rate_min: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' sale_price: $ref: '#/components/schemas/measure_money' sourceid: type: string nullable: true space_condition: type: string enum: - 2nd generation - category a+ - challenged - core and shell - floor and shell - pre-built - pre-existing - raw - turnkey - under construction - white box nullable: true space_type: type: string nullable: true enum: - office - retail - industrial_warehouse - telecom - storage - flex - parking - amenities - rooftop - other - lab - manufacturing - residential - medical_office - education - restaurant - leisure - unspecified - null subtitle: type: string nullable: true suite: type: string nullable: true term_duration: type: string nullable: true transaction_type: type: string enum: - lease - sale nullable: true updated_at: type: string nullable: true format: date vacant_on_date: type: string nullable: true format: date internal_notes: type: string nullable: true example: Notes description: Internal notes visible only within the VTS platform for users with access to the Space. depth: type: string nullable: true frontage: type: number nullable: true retail_space_type: type: object nullable: true ceiling_height: type: string nullable: true column_spacing: type: string nullable: true electrical: type: string nullable: true hvac: type: string nullable: true parking: type: string nullable: true roof: type: string nullable: true sprinklers: type: string nullable: true relationships: type: object properties: in_place_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri committed_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri last_expired_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri asset: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets example: assets links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: spaces_miscellaneous example: spaces_miscellaneous id: type: string example: '1' attributes: type: object properties: archived_date: type: string nullable: true format: date availability_date: type: string format: date nullable: true availability_type: type: string example: arranged enum: - arranged - immediate - month to month - not available - specified description: 'The Availability Type for this Space. Possible Values: arranged, immediate, month to month, not available, specified' created_at: type: string nullable: true format: date-time current_size: $ref: '#/components/schemas/measure_size' description: type: string nullable: true external_ids: type: array items: type: object properties: system_id: type: string nullable: true system_name: type: string nullable: true floor: type: object properties: composition: type: string nullable: true name: type: string position: type: number hypothetical_space: type: boolean lease_type: type: string enum: - direct - renewal - sublease listing_date: type: string nullable: true format: date market_rent: $ref: '#/components/schemas/measure_money' maximum_contiguous_size: $ref: '#/components/schemas/measure_size' minimum_divisible_size: $ref: '#/components/schemas/measure_size' occupancy_status: type: string nullable: true position: type: number nullable: true price_is_negotiable: type: boolean public: type: boolean remeasured_space_available: type: string nullable: true rental_pay_type: type: string enum: - amt_month - amt_year - psf_month - psf_year nullable: true rental_rate_max: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' rental_rate_min: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' sale_price: $ref: '#/components/schemas/measure_money' sourceid: type: string nullable: true space_condition: type: string enum: - 2nd generation - category a+ - challenged - core and shell - floor and shell - pre-built - pre-existing - raw - turnkey - under construction - white box nullable: true space_type: type: string nullable: true enum: - office - retail - industrial_warehouse - telecom - storage - flex - parking - amenities - rooftop - other - lab - manufacturing - residential - medical_office - education - restaurant - leisure - unspecified - null subtitle: type: string nullable: true suite: type: string nullable: true term_duration: type: string nullable: true transaction_type: type: string enum: - lease - sale nullable: true updated_at: type: string nullable: true format: date vacant_on_date: type: string nullable: true format: date internal_notes: type: string nullable: true example: Notes description: Internal notes visible only within the VTS platform for users with access to the Space. relationships: type: object properties: in_place_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri committed_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri last_expired_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri asset: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets example: assets links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string example: https://api.vts.com/api/v1/spaces prev: type: string example: https://api.vts.com/api/v1/spaces?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/spaces?page%5Bafter%5D=MzE2NjQ%253D required: - self '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-spaces /api/v1/spaces/{id}: get: summary: Retrieves specific space description: Contains the spaces in your portfolio. Spaces are sub-components of assets tags: - Spaces security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested space if it exists content: application/json: schema: type: object properties: data: oneOf: - type: object properties: type: type: string pattern: spaces_industrial example: spaces_industrial id: type: string example: '1' attributes: type: object properties: archived_date: type: string nullable: true format: date availability_date: type: string format: date nullable: true availability_type: type: string example: arranged enum: - arranged - immediate - month to month - not available - specified description: 'The Availability Type for this Space. Possible Values: arranged, immediate, month to month, not available, specified' created_at: type: string nullable: true format: date-time current_size: $ref: '#/components/schemas/measure_size' description: type: string nullable: true external_ids: type: array items: type: object properties: system_id: type: string nullable: true system_name: type: string nullable: true floor: type: object properties: composition: type: string nullable: true name: type: string position: type: number hypothetical_space: type: boolean lease_type: type: string enum: - direct - renewal - sublease listing_date: type: string nullable: true format: date market_rent: $ref: '#/components/schemas/measure_money' maximum_contiguous_size: $ref: '#/components/schemas/measure_size' minimum_divisible_size: $ref: '#/components/schemas/measure_size' occupancy_status: type: string nullable: true position: type: number nullable: true price_is_negotiable: type: boolean public: type: boolean remeasured_space_available: type: string nullable: true rental_pay_type: type: string enum: - amt_month - amt_year - psf_month - psf_year nullable: true rental_rate_max: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' rental_rate_min: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' sale_price: $ref: '#/components/schemas/measure_money' sourceid: type: string nullable: true space_condition: type: string enum: - 2nd generation - category a+ - challenged - core and shell - floor and shell - pre-built - pre-existing - raw - turnkey - under construction - white box nullable: true space_type: type: string nullable: true enum: - office - retail - industrial_warehouse - telecom - storage - flex - parking - amenities - rooftop - other - lab - manufacturing - residential - medical_office - education - restaurant - leisure - unspecified - null subtitle: type: string nullable: true suite: type: string nullable: true term_duration: type: string nullable: true transaction_type: type: string enum: - lease - sale nullable: true updated_at: type: string nullable: true format: date vacant_on_date: type: string nullable: true format: date internal_notes: type: string nullable: true example: Notes description: Internal notes visible only within the VTS platform for users with access to the Space. clear_height: type: string nullable: true depth: type: string nullable: true dock_height: type: string nullable: true ground_level_doors: type: string nullable: true office_portion: type: string nullable: true trailer_parking: type: string nullable: true yard: type: string nullable: true ceiling_height: type: string nullable: true column_spacing: type: string nullable: true electrical: type: string nullable: true hvac: type: string nullable: true parking: type: string nullable: true roof: type: string nullable: true sprinklers: type: string nullable: true relationships: type: object properties: in_place_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri committed_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri last_expired_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri asset: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets example: assets links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: spaces_office example: spaces_office id: type: string example: '1' attributes: type: object properties: archived_date: type: string nullable: true format: date availability_date: type: string format: date nullable: true availability_type: type: string example: arranged enum: - arranged - immediate - month to month - not available - specified description: 'The Availability Type for this Space. Possible Values: arranged, immediate, month to month, not available, specified' created_at: type: string nullable: true format: date-time current_size: $ref: '#/components/schemas/measure_size' description: type: string nullable: true external_ids: type: array items: type: object properties: system_id: type: string nullable: true system_name: type: string nullable: true floor: type: object properties: composition: type: string nullable: true name: type: string position: type: number hypothetical_space: type: boolean lease_type: type: string enum: - direct - renewal - sublease listing_date: type: string nullable: true format: date market_rent: $ref: '#/components/schemas/measure_money' maximum_contiguous_size: $ref: '#/components/schemas/measure_size' minimum_divisible_size: $ref: '#/components/schemas/measure_size' occupancy_status: type: string nullable: true position: type: number nullable: true price_is_negotiable: type: boolean public: type: boolean remeasured_space_available: type: string nullable: true rental_pay_type: type: string enum: - amt_month - amt_year - psf_month - psf_year nullable: true rental_rate_max: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' rental_rate_min: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' sale_price: $ref: '#/components/schemas/measure_money' sourceid: type: string nullable: true space_condition: type: string enum: - 2nd generation - category a+ - challenged - core and shell - floor and shell - pre-built - pre-existing - raw - turnkey - under construction - white box nullable: true space_type: type: string nullable: true enum: - office - retail - industrial_warehouse - telecom - storage - flex - parking - amenities - rooftop - other - lab - manufacturing - residential - medical_office - education - restaurant - leisure - unspecified - null subtitle: type: string nullable: true suite: type: string nullable: true term_duration: type: string nullable: true transaction_type: type: string enum: - lease - sale nullable: true updated_at: type: string nullable: true format: date vacant_on_date: type: string nullable: true format: date internal_notes: type: string nullable: true example: Notes description: Internal notes visible only within the VTS platform for users with access to the Space. ceiling_height: type: string nullable: true column_spacing: type: string nullable: true electrical: type: string nullable: true hvac: type: string nullable: true parking: type: string nullable: true roof: type: string nullable: true sprinklers: type: string nullable: true relationships: type: object properties: in_place_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri committed_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri last_expired_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri asset: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets example: assets links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: spaces_retail example: spaces_retail id: type: string example: '1' attributes: type: object properties: archived_date: type: string nullable: true format: date availability_date: type: string format: date nullable: true availability_type: type: string example: arranged enum: - arranged - immediate - month to month - not available - specified description: 'The Availability Type for this Space. Possible Values: arranged, immediate, month to month, not available, specified' created_at: type: string nullable: true format: date-time current_size: $ref: '#/components/schemas/measure_size' description: type: string nullable: true external_ids: type: array items: type: object properties: system_id: type: string nullable: true system_name: type: string nullable: true floor: type: object properties: composition: type: string nullable: true name: type: string position: type: number hypothetical_space: type: boolean lease_type: type: string enum: - direct - renewal - sublease listing_date: type: string nullable: true format: date market_rent: $ref: '#/components/schemas/measure_money' maximum_contiguous_size: $ref: '#/components/schemas/measure_size' minimum_divisible_size: $ref: '#/components/schemas/measure_size' occupancy_status: type: string nullable: true position: type: number nullable: true price_is_negotiable: type: boolean public: type: boolean remeasured_space_available: type: string nullable: true rental_pay_type: type: string enum: - amt_month - amt_year - psf_month - psf_year nullable: true rental_rate_max: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' rental_rate_min: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' sale_price: $ref: '#/components/schemas/measure_money' sourceid: type: string nullable: true space_condition: type: string enum: - 2nd generation - category a+ - challenged - core and shell - floor and shell - pre-built - pre-existing - raw - turnkey - under construction - white box nullable: true space_type: type: string nullable: true enum: - office - retail - industrial_warehouse - telecom - storage - flex - parking - amenities - rooftop - other - lab - manufacturing - residential - medical_office - education - restaurant - leisure - unspecified - null subtitle: type: string nullable: true suite: type: string nullable: true term_duration: type: string nullable: true transaction_type: type: string enum: - lease - sale nullable: true updated_at: type: string nullable: true format: date vacant_on_date: type: string nullable: true format: date internal_notes: type: string nullable: true example: Notes description: Internal notes visible only within the VTS platform for users with access to the Space. depth: type: string nullable: true frontage: type: number nullable: true retail_space_type: type: object nullable: true ceiling_height: type: string nullable: true column_spacing: type: string nullable: true electrical: type: string nullable: true hvac: type: string nullable: true parking: type: string nullable: true roof: type: string nullable: true sprinklers: type: string nullable: true relationships: type: object properties: in_place_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri committed_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri last_expired_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri asset: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets example: assets links: type: object properties: related: type: string format: uri - type: object properties: type: type: string pattern: spaces_miscellaneous example: spaces_miscellaneous id: type: string example: '1' attributes: type: object properties: archived_date: type: string nullable: true format: date availability_date: type: string format: date nullable: true availability_type: type: string example: arranged enum: - arranged - immediate - month to month - not available - specified description: 'The Availability Type for this Space. Possible Values: arranged, immediate, month to month, not available, specified' created_at: type: string nullable: true format: date-time current_size: $ref: '#/components/schemas/measure_size' description: type: string nullable: true external_ids: type: array items: type: object properties: system_id: type: string nullable: true system_name: type: string nullable: true floor: type: object properties: composition: type: string nullable: true name: type: string position: type: number hypothetical_space: type: boolean lease_type: type: string enum: - direct - renewal - sublease listing_date: type: string nullable: true format: date market_rent: $ref: '#/components/schemas/measure_money' maximum_contiguous_size: $ref: '#/components/schemas/measure_size' minimum_divisible_size: $ref: '#/components/schemas/measure_size' occupancy_status: type: string nullable: true position: type: number nullable: true price_is_negotiable: type: boolean public: type: boolean remeasured_space_available: type: string nullable: true rental_pay_type: type: string enum: - amt_month - amt_year - psf_month - psf_year nullable: true rental_rate_max: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' rental_rate_min: oneOf: - $ref: '#/components/schemas/measure_money_period' - $ref: '#/components/schemas/measure_money_area_period' sale_price: $ref: '#/components/schemas/measure_money' sourceid: type: string nullable: true space_condition: type: string enum: - 2nd generation - category a+ - challenged - core and shell - floor and shell - pre-built - pre-existing - raw - turnkey - under construction - white box nullable: true space_type: type: string nullable: true enum: - office - retail - industrial_warehouse - telecom - storage - flex - parking - amenities - rooftop - other - lab - manufacturing - residential - medical_office - education - restaurant - leisure - unspecified - null subtitle: type: string nullable: true suite: type: string nullable: true term_duration: type: string nullable: true transaction_type: type: string enum: - lease - sale nullable: true updated_at: type: string nullable: true format: date vacant_on_date: type: string nullable: true format: date internal_notes: type: string nullable: true example: Notes description: Internal notes visible only within the VTS platform for users with access to the Space. relationships: type: object properties: in_place_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri committed_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri last_expired_lease: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - leases example: leases links: type: object properties: related: type: string format: uri asset: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets example: assets links: type: object properties: related: type: string format: uri '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested space does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-spaces-id /api/v1/tenant_contacts: get: summary: Fetches Tenant Contacts for a Specific Account tags: - Tenant Contacts security: - basic_auth: [] parameters: - name: filter[lease_id] in: query required: false schema: type: integer - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns List of Tenant Contacts content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: tenant_contacts id: type: string example: '1' attributes: type: object properties: first_name: type: string example: John description: First name of the contact last_name: type: string example: Doe description: Last name of the contact phone: type: string nullable: true example: '1234567890' description: Phone number of the contact phone_extension: type: string nullable: true example: '1234' description: Phone extension of the contact email: type: string example: johndoe@example.com description: Email of the contact company_name: type: string nullable: true example: VTS description: Name of the company the contact belongs to title: type: string nullable: true example: Broker description: The title of the contact created_at: type: string format: date-time description: The timestamp when this tenant contact was created updated_at: type: string format: date-time description: The timestamp when this tenant contact was last updated phone_type: type: string nullable: true description: The type of phone number type: type: string example: tenant enum: - tenant - tenant_rep - broker - personal - vendor - colleague - partner nullable: true description: The type of tenant contact role: type: string example: admin enum: - c_suite - leasing - facilities_operations - admin - construction - sustainability nullable: true description: The role of the tenant contact is_decision_maker: type: boolean description: Whether the contact is a decision maker note: type: string nullable: true description: A note about the contact relationships: type: object properties: tenant: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - tenants example: tenants '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-tenant-contacts /api/v1/tenant_contacts/{id}: get: summary: Retrieves specific tenant contacts description: Contains the tenant contact from your account tags: - Tenant Contacts security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: returns requested account tenant contact if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: tenant_contacts id: type: string example: '1' attributes: type: object properties: first_name: type: string example: John description: First name of the contact last_name: type: string example: Doe description: Last name of the contact phone: type: string nullable: true example: '1234567890' description: Phone number of the contact phone_extension: type: string nullable: true example: '1234' description: Phone extension of the contact email: type: string example: johndoe@example.com description: Email of the contact company_name: type: string nullable: true example: VTS description: Name of the company the contact belongs to title: type: string nullable: true example: Broker description: The title of the contact created_at: type: string format: date-time description: The timestamp when this tenant contact was created updated_at: type: string format: date-time description: The timestamp when this tenant contact was last updated phone_type: type: string nullable: true description: The type of phone number type: type: string example: tenant enum: - tenant - tenant_rep - broker - personal - vendor - colleague - partner nullable: true description: The type of tenant contact role: type: string example: admin enum: - c_suite - leasing - facilities_operations - admin - construction - sustainability nullable: true description: The role of the tenant contact is_decision_maker: type: boolean description: Whether the contact is a decision maker note: type: string nullable: true description: A note about the contact relationships: type: object properties: tenant: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - tenants example: tenants '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested tenant contact does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-tenant-contacts-id /api/v1/tenant_industries: get: summary: Fetches tenant industries description: Contains more details on a given tenant's industry, including industry name and sector tags: - Tenant Industries security: - basic_auth: [] parameters: - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string responses: '200': description: Returns list of TenantIndustries content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: tenant_industries id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this tenant industry was created updated_at: type: string format: date-time description: The timestamp when this tenant industry was last updated name: type: string example: apparel & accessories sector: type: string nullable: true example: retail links: type: object properties: self: type: string example: https://api.vts.com/api/v1/tenant_industries prev: type: string example: https://api.vts.com/api/v1/tenant_industries?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/tenant_industries?page%5Bafter%5D=MzE2NjQ%253D required: - self operationId: get_api-v1-tenant-industries /api/v1/tenant_industries/{id}: get: summary: Retrieves specific tenant industry description: Contains more details on a given tenant's industry, including industry name and sector tags: - Tenant Industries security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested tenant_industry if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: tenant_industries id: type: string example: '1' attributes: type: object properties: created_at: type: string format: date-time description: The timestamp when this tenant industry was created updated_at: type: string format: date-time description: The timestamp when this tenant industry was last updated name: type: string example: apparel & accessories sector: type: string nullable: true example: retail '404': description: Requested tenant_industry does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-tenant-industries-id /api/v1/tenant_updates: get: summary: Fetches tenant updates description: Contains updates to a given tenant. Examples include comments, update type, and relationship updates tags: - Tenant Updates security: - basic_auth: [] parameters: - name: filter[property_id] in: query required: false schema: type: string - name: filter[tenant_id] in: query required: false schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns a possibly empty list of tenant_updates that match the provided parameters content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string example: '1' type: type: string example: tenant_updates attributes: type: object properties: created_at: type: string nullable: false format: date-time updated_at: type: string nullable: false format: date-time important: type: boolean nullable: false comment: type: string nullable: false example: This is a comment. interaction_type: type: string nullable: false enum: - email - phone_call - meeting - other - event_entertainment - rent_relief - renewal_discussion - sustainability_conversation description: The medium/circumstance behind a tenant update — phone call, meeting, etc. interaction_date: type: string format: date example: '2021-03-01' description: The date interaction took place sentiment: type: string nullable: true enum: - negative - neutral - positive - null relationships: type: object properties: owner: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri tenant: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - tenants example: tenants links: type: object properties: related: type: string format: uri asset: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - assets example: assets links: type: object properties: related: type: string format: uri contact: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - tenant_contacts example: tenant_contacts links: type: object properties: related: type: string format: uri deprecated: true contacts: type: object properties: data: type: array items: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - tenant_contacts example: tenant_contacts created_by: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - users example: users links: type: object properties: related: type: string format: uri links: type: object properties: self: type: string example: https://api.vts.com/api/v1/tenant_updates prev: type: string example: https://api.vts.com/api/v1/tenant_updates?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/tenant_updates?page%5Bafter%5D=MzE2NjQ%253D required: - self included: type: array items: allOf: - type: object properties: type: type: string example: users id: type: string example: '1' description: The ID of the user attributes: type: object properties: first_name: type: string example: John description: First name of user last_name: type: string example: Doe description: Last name of user email: type: string example: johndoe@example.com description: Email of the user phone: type: string nullable: true example: '1234567890' description: Phone number of the user phone_extension: type: string nullable: true example: '1234' description: Phone extension of the user - type: object properties: id: type: string example: '1' type: type: string example: tenant_contact attributes: type: object description: Refer to https://readme.vts.com/reference/get_api-v1-tenant-contacts for a description of the resources returned here '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-tenant-updates /api/v1/tenants: get: summary: Fetches tenants description: Contains details for a tenant entity based on lease- or deal-inputted tenant information. Links to the Global Tenants endpoint tags: - Tenants security: - basic_auth: [] parameters: - name: filter[primary_tenant_id] in: query required: false schema: type: string - name: filter[global_tenant_id] in: query required: false schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of tenants content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: tenants id: type: string example: '1' attributes: type: object properties: name: type: string example: ACME description: The reported name of the tenant global_tenant_name: type: string nullable: true example: ACME Corporation description: The name of the global tenant or null if it doesn't exist created_at: type: string format: date-time example: '2021-10-28T20:42:36.401Z' updated_at: type: string format: date-time example: '2021-10-28T20:42:36.401Z' relationships: type: object properties: primary_tenant: type: object properties: data: type: object properties: type: type: string example: tenants id: type: string example: '1' links: type: object properties: related: type: string tenant_industry: type: object properties: data: type: object properties: type: type: string example: tenant_industries id: type: string example: '1' links: type: object properties: related: type: string global_tenant: type: object properties: data: type: object properties: type: type: string example: global_tenants id: type: string example: 19dbe413-442a-4fd1-afe4-9b12dc2c02ce nullable: true links: type: object properties: related: type: string example: https://api.vts.com/api/v1/global_tenants/19dbe413-442a-4fd1-afe4-9b12dc2c02ce relationship_owners: type: object properties: data: type: array items: type: object properties: type: type: string example: users id: type: string example: 1 nullable: true links: type: object properties: related: type: string example: https://api.vts.com/api/v1/users?tenant_id=1 included: type: array items: type: object properties: id: type: string type: type: string format: global_tenants attributes: type: object properties: name: type: string industry: type: string '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-tenants /api/v1/tenants/{id}: get: summary: Retrieves specific tenant description: Contains details for a tenant entity based on lease- or deal-inputted tenant information. Links to the Global Tenants endpoint tags: - Tenants security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string - name: filter[primary_tenant_id] in: query required: false schema: type: string - name: filter[global_tenant_id] in: query required: false schema: type: string responses: '200': description: Returns requested tenant if it exists content: application/json: schema: type: object properties: data: type: object properties: type: type: string example: tenants id: type: string example: '1' attributes: type: object properties: name: type: string example: ACME description: The reported name of the tenant global_tenant_name: type: string nullable: true example: ACME Corporation description: The name of the global tenant or null if it doesn't exist created_at: type: string format: date-time example: '2021-10-28T20:42:36.401Z' updated_at: type: string format: date-time example: '2021-10-28T20:42:36.401Z' relationships: type: object properties: primary_tenant: type: object properties: data: type: object properties: type: type: string example: tenants id: type: string example: '1' links: type: object properties: related: type: string tenant_industry: type: object properties: data: type: object properties: type: type: string example: tenant_industries id: type: string example: '1' links: type: object properties: related: type: string global_tenant: type: object properties: data: type: object properties: type: type: string example: global_tenants id: type: string example: 19dbe413-442a-4fd1-afe4-9b12dc2c02ce nullable: true links: type: object properties: related: type: string example: https://api.vts.com/api/v1/global_tenants/19dbe413-442a-4fd1-afe4-9b12dc2c02ce relationship_owners: type: object properties: data: type: array items: type: object properties: type: type: string example: users id: type: string example: 1 nullable: true links: type: object properties: related: type: string example: https://api.vts.com/api/v1/users?tenant_id=1 included: type: array items: type: object properties: id: type: string type: type: string format: global_tenants attributes: type: object properties: name: type: string industry: type: string '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested tenant does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-tenants-id /api/v1/tenants/{tenant_id}/contacts: get: summary: Fetches tenant contacts tags: - Tenant Contacts security: - basic_auth: [] parameters: - name: tenant_id in: path required: true schema: type: string - name: filter[lease_id] in: query required: false schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns list of contacts for the tenant content: application/json: schema: type: object properties: data: type: array items: type: object properties: type: type: string example: tenant_contacts id: type: string example: '1' attributes: type: object properties: first_name: type: string example: John description: First name of the contact last_name: type: string example: Doe description: Last name of the contact phone: type: string nullable: true example: '1234567890' description: Phone number of the contact phone_extension: type: string nullable: true example: '1234' description: Phone extension of the contact email: type: string example: johndoe@example.com description: Email of the contact company_name: type: string nullable: true example: VTS description: Name of the company the contact belongs to title: type: string nullable: true example: Broker description: The title of the contact created_at: type: string format: date-time description: The timestamp when this tenant contact was created updated_at: type: string format: date-time description: The timestamp when this tenant contact was last updated phone_type: type: string nullable: true description: The type of phone number type: type: string example: tenant enum: - tenant - tenant_rep - broker - personal - vendor - colleague - partner nullable: true description: The type of tenant contact role: type: string example: admin enum: - c_suite - leasing - facilities_operations - admin - construction - sustainability nullable: true description: The role of the tenant contact is_decision_maker: type: boolean description: Whether the contact is a decision maker note: type: string nullable: true description: A note about the contact relationships: type: object properties: tenant: type: object properties: data: type: object nullable: true properties: id: type: string example: '12345' type: type: string enum: - tenants example: tenants '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Referenced tenant not found content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-tenants-tenant-id-contacts /api/v1/users: get: summary: Fetches users description: Contains your VTS user details such as name on account, user level, and user contact information tags: - Users security: - basic_auth: [] parameters: - name: tenant_id in: query required: false schema: type: string - name: page[size] in: query required: false schema: type: integer - name: page[before] in: query required: false schema: type: string - name: page[after] in: query required: false schema: type: string - name: filter[updated_since] in: query schema: type: string format: date-time required: false description: Only display records that have been modified after the given date/timestamp. Should be in `YYYY-MM-DD HH:MM:SS` (ISO8601) format. (Hours, minutes, and seconds are optional.) example: '2021-03-15' responses: '200': description: Returns a list of users associated with the current account content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string example: '1' type: type: string example: users attributes: type: object properties: first_name: type: string example: John last_name: type: string example: Doe email: type: string example: johndoe@example.com current_sign_in_at: type: string nullable: true format: date-time is_account_user: type: boolean is_company_admin: type: boolean phone: type: string example: '1234567890' phone_extension: type: string example: '1234' title: type: string example: Vice President description: Title can refer to their job position, formal honorific, or title of respect links: type: object properties: self: type: string example: https://api.vts.com/api/v1/users prev: type: string example: https://api.vts.com/api/v1/users?page%5Bbefore%5D=MzE2NTI%253D next: type: string example: https://api.vts.com/api/v1/users?page%5Bafter%5D=MzE2NjQ%253D required: - self '401': description: Bad API Credentials content: application/json: schema: $ref: '#/components/schemas/errors_object' '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-users /api/v1/users/{id}: get: summary: Retrieves specific user description: Contains your VTS user details such as name on account, user level, and user contact information tags: - Users security: - basic_auth: [] parameters: - name: id in: path required: true schema: type: string responses: '200': description: Returns requested user if it exists content: application/json: schema: type: object properties: data: type: object properties: id: type: string type: type: string attributes: type: object properties: first_name: type: string last_name: type: string current_sign_in_at: type: string nullable: true disabled: type: boolean nullable: true is_account_user: type: boolean is_company_admin: type: boolean title: type: string example: Vice President description: Title can refer to their job position, formal honorific, or title of respect '401': description: Bad API Credentials content: application/json: schema: $ref: '#/components/schemas/errors_object' '403': description: API not authorized for use content: application/json: schema: $ref: '#/components/schemas/errors_object' '404': description: Requested user does not exist content: application/json: schema: $ref: '#/components/schemas/errors_object' operationId: get_api-v1-users-id /oauth/v1/token: post: description: Get access token tags: - Auth2.0 Access Token summary: Get access token requestBody: content: application/json: schema: $ref: '#/components/schemas/models_api.AuthRequest' description: Auth request object required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/models_api.AuthResponse' operationId: post_oauth-v1-token-1 components: schemas: errors_object: type: object properties: errors: type: array items: type: object properties: detail: type: string nullable: true measure_money: type: object nullable: true properties: magnitude: type: number format: float example: 1000 unit: type: string pattern: '...' description: ISO 4217 currency code example: USD unit_components: type: object properties: money: type: string pattern: '...' example: USD type: type: string pattern: money example: money measure_money_period: type: object nullable: true properties: magnitude: type: number format: float example: 1000 unit: type: string example: USD/yr unit_components: type: object properties: money: type: string pattern: '...' description: ISO 4217 currency code example: USD period: type: string enum: - yr - mo - day type: type: string pattern: money/period example: money/period measure_money_area_period: type: object nullable: true properties: magnitude: type: number format: float example: 1000 unit: type: string example: USD/sf/yr unit_components: type: object properties: money: type: string pattern: '...' description: ISO 4217 currency code example: USD area: type: string enum: - sf - sm period: type: string enum: - yr - mo - day type: type: string pattern: money/area/period example: money/area/period measure_money_area: type: object nullable: true properties: magnitude: type: number format: float example: 1000 unit: type: string example: USD/sf unit_components: type: object properties: money: type: string pattern: '...' description: ISO 4217 currency code example: USD area: type: string enum: - sf - sm type: type: string pattern: money/area example: money/area measure_area: type: object nullable: true properties: magnitude: type: number format: float example: 1000 unit: type: string enum: - sf - sm example: sf description: 'Possible values: ''sf'' for square feet, ''sm'' for square meters' unit_components: type: object properties: area: type: string enum: - sf - sm type: type: string pattern: area example: area measure_period: type: object nullable: true properties: magnitude: type: number format: float example: 2 unit: type: string enum: - yr - mo - day unit_components: type: object properties: period: type: string enum: - yr - mo - day type: type: string pattern: period example: period iso8601: type: string example: P2Y description: Period represented by ISO8601 format nullable: true measure_percentage: type: object nullable: true properties: magnitude: type: number format: float example: 1000 unit: type: string pattern: '%' example: '%' unit_components: type: object properties: period: type: string pattern: '%' example: '%' type: type: string pattern: percentage example: percentage commissions: type: array items: type: object properties: created_at: type: string example: '2021-12-08T16:28:22.179486Z' format: date-time description: The timestamp when this budget commission was created deprecated: true updated_at: type: string example: '2021-12-08T16:28:22.187979Z' description: The timestamp when this budget commission was last updated deprecated: true net_or_gross: type: string enum: - gross - net example: gross description: The calculation method of the commission amount. nullable: true broker: type: string example: VTS description: Broker/Company name commission_date: type: string example: '2021-12-08' format: date description: The start date when commissions will start counting for. commission_type: type: string enum: - landlord - tenant_rep example: landlord description: Commissions Value paid to landlord or tenant brokers on the deal description: type: string example: Description description: The description of commission free_rent: type: string enum: - amortize_over_term - occurs_in_month - exclude_free_rent example: amortize_over_term description: How commission rent should handle free rent periods: type: array items: type: object properties: starts: type: object properties: date: type: string example: '2021-12-08' format: date description: The date of the commissions to be paid out. This doesn't impact any calculations. month: type: number example: 1 description: The start month when commissions will start counting for. amount: oneOf: - $ref: '#/components/schemas/measure_percentage' - $ref: '#/components/schemas/measure_money' - $ref: '#/components/schemas/measure_money_area' - $ref: '#/components/schemas/measure_money_period' rent_escalations: type: array items: type: object properties: start_month: type: number example: 1 description: Month number in which to begin rent escalations amount: anyOf: - $ref: '#/components/schemas/measure_percentage' - $ref: '#/components/schemas/measure_money_area_period' description: Value of the escalation occurs: type: string enum: - One Time - Annual example: One Time description: How often escalations recurs base_rents: type: array items: type: object properties: start_month: type: number example: 1 description: The numeric month in which the base rent starts (i.e. base rent begins in month 4) amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' free_rents: type: array items: type: object properties: type: type: string enum: - net - gross example: gross description: 'net: percent of net base rent; gross: percent of gross base rent and recoveries.' start_month: type: number example: 1 description: Month that rent step goes into effect, relative to lease commencement date amount_free: allOf: - $ref: '#/components/schemas/measure_percentage' - description: Discount as a percentage value of rent duration_with_units: allOf: - $ref: '#/components/schemas/measure_period' - description: The amount of time in which the free rent applies (including amount of time units) percentage_rents: type: array items: type: object properties: start_month: type: number example: 1 description: The numeric month in which the base rent starts (i.e. base rent begins in month 4) minimum_guarantee: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' sales_overage_breakpoints_type: type: string enum: - Natural - Unnatural example: Natural description: Type of Sales Overage Breakpoints Natural/Unnatural sales_overage_breakpoints: type: array items: type: object properties: breakpoint: $ref: '#/components/schemas/measure_money_period' percent_rent: $ref: '#/components/schemas/measure_percentage' other_incomes: type: array items: type: object properties: type: type: string enum: - parking - storage - signage - fitout - promotional_charges - interest - other example: storage description: The classification of the other income start_month: type: number example: 1 description: Month number in which income begins to apply amount: oneOf: - $ref: '#/components/schemas/measure_money_area_period' - $ref: '#/components/schemas/measure_money_period' description: Per unit amount paid to landlord quantity: type: number example: 1 description: The quantity of the entity providing income (only applies to parking) costs: type: array items: type: object properties: type: type: string enum: - tenant_improvement - building_improvement - lease_incentive - other_fee example: tenant_improvement description: The type of the cost occurrence_month: type: number example: 1 description: Tenant improvements occurrence month. Possible values are between 1 and the number of months in the term amount: oneOf: - $ref: '#/components/schemas/measure_money' - $ref: '#/components/schemas/measure_money_period' description: The amount, with units, of the cost description: type: string example: Description description: The description of the cost measure_size: type: object nullable: true properties: magnitude: type: number format: float example: 1000 unit: type: string enum: - sf - sm unit_components: type: object properties: area: type: string enum: - sf - sm type: type: string pattern: area example: area month: type: integer minimum: 1 maximum: 12 example: 3 nullable: true reimbursable_expenses: type: array items: type: object properties: expense_type: type: string example: OperationalExpense enum: - OperationalExpense - RealEstateTax - ReimbursableExpenseCleaning - ReimbursableExpenseInsurance - ReimbursableExpenseMarketing - ReimbursableExpenseOm - ReimbursableExpenseOther - ReimbursableExpenseRepairsAndMaintenance - ReimbursableExpenseSecurity - ReimbursableExpenseUtility - ReimbursableExpenseCam - ReimbursableExpenseElectric - ReimbursableExpenseLandscaping - ReimbursableExpenseManagementFee description: The type of the reimbursable expense recovery_method: type: string example: gross enum: - gross - net - amount - modified_gross description: The calculation method of the recovery amount for the reimbursable expense expense_growth_rate: allOf: - $ref: '#/components/schemas/measure_percentage' - description: The expenses will grow by this rate every 12 months after the lease commencement date. expense_amount_with_units: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The amount of the reimbursable expense recovery_amount_with_units: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The amount of reimbursable expense that will be paid to landlord by the tenant with recovery type modified_gross expense_stop: allOf: - $ref: '#/components/schemas/measure_money_area_period' - description: The expense stop of the reimbursable expense. Only applies for expenses with recovery type modified_gross description: type: string example: Description description: The description of reimbursable expense models_api.DataEntity: type: object properties: attributes: $ref: '#/components/schemas/models_api.UriEntity' id: type: string example: e8a6be19-9676-4bb2-9c5d-8d76cf8dcc23 type: type: string example: download_link models_api.DownloadLinksResponse: type: object properties: data: $ref: '#/components/schemas/models_api.DataEntity' models_api.ErrorResponse: type: object properties: error: type: string example: error description models_api.UriEntity: type: object properties: error: type: string example: explanation of the error uri: type: string example: https://example.vts.com models_api.AuthRequest: type: object properties: client_id: type: string description: client_id client_secret: type: string description: client_secret audience: type: string description: client_secret example: download-links default: download-links grant_type: type: string description: grant_type example: client_credentials default: client_credentials models_api.AuthResponse: type: object properties: access_token: type: string description: 'Json Web Token. Use as ''authorization: Bearer '' header' scope: type: string description: application scope expires_in: type: integer description: expiration duration token_type: type: string description: token_type default: Bearer securitySchemes: basic_auth: type: http scheme: basic oauth2: type: oauth2 description: OAuth 2.0 Authorization Code flow with PKCE (VTS Activate / OIDC). flows: authorizationCode: authorizationUrl: https://sandbox.vts.com/oauth/authorize tokenUrl: https://sandbox.vts.com/oauth/token refreshUrl: https://sandbox.vts.com/oauth/token scopes: read_write: Read and write access openid: OpenID Connect profile: Profile claims email: Email claim x-apis-json: generated: '2026-07-21' method: searched source: https://readme.vts.com/reference (per-operation OpenAPI fragments, harvested & merged)