VTS Deal Terms API
The Deal Terms API from VTS — 2 operation(s) for deal terms.
OpenAPI Specification
openapi: 3.0.2
info:
title: VTS Lease Account Admin Deal Terms 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: Deal Terms
paths:
/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/{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: T
# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vts/refs/heads/main/openapi/vts-deal-terms-api-openapi.yml