openapi: 3.1.0
info:
  title: Yardi Voyager Billing and Payments Vendor Invoicing 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: Vendor Invoicing
  description: Operations for managing vendor invoices, purchase orders, and accounts payable transactions. Accessed via the ItfVendorInvoice web service interface.
paths:
  /ItfVendorInvoice.asmx/GetVendorInvoices_Login:
    post:
      operationId: getVendorInvoicesLogin
      summary: Yardi Get vendor invoices
      description: Retrieves vendor invoice records for a specified property or entity, including invoice amounts, dates, approval status, and payment information.
      tags:
      - Vendor Invoicing
      requestBody:
        required: true
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/GetVendorInvoicesRequest'
      responses:
        '200':
          description: Successful response with vendor invoice data
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/VendorInvoicesResponse'
        '401':
          description: Authentication failed
        '500':
          description: Server error processing the SOAP request
  /ItfVendorInvoice.asmx/ImportVendorInvoices_Login:
    post:
      operationId: importVendorInvoicesLogin
      summary: Yardi Import vendor invoices
      description: Imports vendor invoice records into the Voyager accounts payable system. Supports creating new invoices and updating existing ones for batch processing from external procurement systems.
      tags:
      - Vendor Invoicing
      requestBody:
        required: true
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/ImportVendorInvoicesRequest'
      responses:
        '200':
          description: Successful import confirmation
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ImportResponse'
        '401':
          description: Authentication failed
        '500':
          description: Server error processing the SOAP request
components:
  schemas:
    ImportResponse:
      type: object
      description: SOAP response confirming successful import of data.
      properties:
        ImportResult:
          type: string
          description: Import result status message
        ErrorMessages:
          type: array
          description: List of error messages if any records failed to import
          items:
            type: string
    ImportVendorInvoicesRequest:
      type: object
      description: SOAP request for importing vendor invoices into Voyager accounts payable.
      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
        InvoiceXml:
          type: string
          description: XML payload containing vendor invoice data to import
      required:
      - UserName
      - Password
      - ServerName
      - Database
      - Platform
      - YardiPropertyId
      - InterfaceEntity
      - InterfaceLicense
      - InvoiceXml
    VendorInvoicesResponse:
      type: object
      description: SOAP response containing vendor invoice data.
      properties:
        VendorInvoicesXmlResponse:
          type: string
          description: XML response containing vendor invoice records
    GetVendorInvoicesRequest:
      type: object
      description: SOAP request for retrieving vendor invoice records.
      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
        FromDate:
          type: string
          format: date
          description: Start date for invoice query
        ToDate:
          type: string
          format: date
          description: End date for invoice query
      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/