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