Yardi Common Data API

openapi: 3.1.0
info:
  title: Yardi Voyager Billing and Payments Common Data API
  description: Core property management platform API providing access to accounting, operations, and reporting functionality for real estate portfolios. Yardi Voyager uses SOAP-based web services defined via WSDL, with interfaces for billing and payments, common data, service requests, vendor invoicing, job cost, and commercial data export. This OpenAPI specification documents the primary web service operations available through the Voyager Standard Interface Partnership Program.
  version: '20.0'
  contact:
    name: Yardi Systems
    url: https://www.yardi.com/support/
  termsOfService: https://www.yardi.com/about-us/legal/terms-of-use/
servers:
- url: https://{server}.yardi.com/{clientUrl}/webservices
  description: Yardi Voyager Web Services Server
  variables:
    server:
      default: www.yardiasp13
      description: Yardi hosting server. Specific server varies by client deployment.
    clientUrl:
      default: '{client}'
      description: Client-specific URL path. Obtain from Yardi representative or check in Voyager under Administration > About > URL.
security:
- soapAuth: []
tags:
- name: Common Data
  description: Operations for retrieving shared property management data including properties, units, tenants, and chart of accounts. Accessed via the ItfCommonData web service interface.
paths:
  /ItfCommonData.asmx/GetPropertyConfigurations_Login:
    post:
      operationId: getPropertyConfigurationsLogin
      summary: Yardi Get property configurations
      description: Retrieves property configuration data including property details, unit types, amenities, and management settings. Used for synchronizing property master data with external systems.
      tags:
      - Common Data
      requestBody:
        required: true
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/GetPropertyConfigurationsRequest'
      responses:
        '200':
          description: Successful response with property configuration data
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PropertyConfigurationsResponse'
        '401':
          description: Authentication failed
        '500':
          description: Server error processing the SOAP request
  /ItfCommonData.asmx/GetUnitInformation_Login:
    post:
      operationId: getUnitInformationLogin
      summary: Yardi Get unit information
      description: Retrieves detailed unit information for a specified property including unit numbers, types, square footage, bedroom and bathroom counts, occupancy status, and market rents.
      tags:
      - Common Data
      requestBody:
        required: true
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/GetUnitInformationRequest'
      responses:
        '200':
          description: Successful response with unit information
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UnitInformationResponse'
        '401':
          description: Authentication failed
        '500':
          description: Server error processing the SOAP request
  /ItfCommonData.asmx/GetTenants_Login:
    post:
      operationId: getTenantsLogin
      summary: Yardi Get tenant data
      description: Retrieves tenant records for a specified property, including tenant contact information, lease details, move-in dates, and account status.
      tags:
      - Common Data
      requestBody:
        required: true
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/GetTenantsRequest'
      responses:
        '200':
          description: Successful response with tenant data
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/TenantsResponse'
        '401':
          description: Authentication failed
        '500':
          description: Server error processing the SOAP request
  /ItfCommonData.asmx/GetChartOfAccounts_Login:
    post:
      operationId: getChartOfAccountsLogin
      summary: Yardi Get chart of accounts
      description: Retrieves the chart of accounts for a specified property or entity, including account numbers, descriptions, types, and hierarchy.
      tags:
      - Common Data
      requestBody:
        required: true
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/GetChartOfAccountsRequest'
      responses:
        '200':
          description: Successful response with chart of accounts
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ChartOfAccountsResponse'
        '401':
          description: Authentication failed
        '500':
          description: Server error processing the SOAP request
components:
  schemas:
    GetPropertyConfigurationsRequest:
      type: object
      description: SOAP request for retrieving property configuration data.
      properties:
        UserName:
          type: string
          description: Yardi API user name
        Password:
          type: string
          description: Yardi API password
        ServerName:
          type: string
          description: Yardi database server name
        Database:
          type: string
          description: Yardi database name
        Platform:
          type: string
          description: Database platform identifier
        YardiPropertyId:
          type: string
          description: Yardi property identifier
        InterfaceEntity:
          type: string
          description: Interface entity code
        InterfaceLicense:
          type: string
          description: Interface license key
      required:
      - UserName
      - Password
      - ServerName
      - Database
      - Platform
      - YardiPropertyId
      - InterfaceEntity
      - InterfaceLicense
    ChartOfAccountsResponse:
      type: object
      description: SOAP response containing chart of accounts data.
      properties:
        ChartOfAccountsXmlResponse:
          type: string
          description: XML response containing account records
    TenantsResponse:
      type: object
      description: SOAP response containing tenant data.
      properties:
        TenantsXmlResponse:
          type: string
          description: XML response containing tenant records
    GetUnitInformationRequest:
      type: object
      description: SOAP request for retrieving unit information for a property.
      properties:
        UserName:
          type: string
          description: Yardi API user name
        Password:
          type: string
          description: Yardi API password
        ServerName:
          type: string
          description: Yardi database server name
        Database:
          type: string
          description: Yardi database name
        Platform:
          type: string
          description: Database platform identifier
        YardiPropertyId:
          type: string
          description: Yardi property identifier
        InterfaceEntity:
          type: string
          description: Interface entity code
        InterfaceLicense:
          type: string
          description: Interface license key
      required:
      - UserName
      - Password
      - ServerName
      - Database
      - Platform
      - YardiPropertyId
      - InterfaceEntity
      - InterfaceLicense
    UnitInformationResponse:
      type: object
      description: SOAP response containing unit information data.
      properties:
        UnitInformationXmlResponse:
          type: string
          description: XML response containing unit records
    GetTenantsRequest:
      type: object
      description: SOAP request for retrieving tenant data for a property.
      properties:
        UserName:
          type: string
          description: Yardi API user name
        Password:
          type: string
          description: Yardi API password
        ServerName:
          type: string
          description: Yardi database server name
        Database:
          type: string
          description: Yardi database name
        Platform:
          type: string
          description: Database platform identifier
        YardiPropertyId:
          type: string
          description: Yardi property identifier
        InterfaceEntity:
          type: string
          description: Interface entity code
        InterfaceLicense:
          type: string
          description: Interface license key
      required:
      - UserName
      - Password
      - ServerName
      - Database
      - Platform
      - YardiPropertyId
      - InterfaceEntity
      - InterfaceLicense
    PropertyConfigurationsResponse:
      type: object
      description: SOAP response containing property configuration data.
      properties:
        PropertyConfigurationsXmlResponse:
          type: string
          description: XML response containing property configuration records
    GetChartOfAccountsRequest:
      type: object
      description: SOAP request for retrieving the chart of accounts.
      properties:
        UserName:
          type: string
          description: Yardi API user name
        Password:
          type: string
          description: Yardi API password
        ServerName:
          type: string
          description: Yardi database server name
        Database:
          type: string
          description: Yardi database name
        Platform:
          type: string
          description: Database platform identifier
        YardiPropertyId:
          type: string
          description: Yardi property identifier
        InterfaceEntity:
          type: string
          description: Interface entity code
        InterfaceLicense:
          type: string
          description: Interface license key
      required:
      - UserName
      - Password
      - ServerName
      - Database
      - Platform
      - YardiPropertyId
      - InterfaceEntity
      - InterfaceLicense
  securitySchemes:
    soapAuth:
      type: http
      scheme: basic
      description: SOAP authentication using UserName, Password, and ServerName parameters passed within the SOAP request body. Credentials are provided by the Yardi Standard Interface Partnership Program.
externalDocs:
  description: Yardi Platform API Documentation
  url: https://www.yardi.com/platform/api/