Operations for managing resident transactions, charges, payments, credits, and billing data. Accessed via the ItfResidentTransactions20 web service interface.
openapi: 3.1.0
info:
title: Yardi Voyager Billing and Payments 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: Billing and Payments
description: Operations for managing resident transactions, charges, payments, credits, and billing data. Accessed via the ItfResidentTransactions20 web service interface.
paths:
/ItfResidentTransactions20.asmx/GetResidentTransactions_Login:
post:
operationId: getResidentTransactionsLogin
summary: Yardi Get resident transactions with login
description: Retrieves resident transaction records for a specified property and date range. Requires authentication credentials passed in the SOAP request body. Returns billing, payment, and charge history for residents.
tags:
- Billing and Payments
requestBody:
required: true
content:
text/xml:
schema:
$ref: '#/components/schemas/GetResidentTransactionsRequest'
responses:
'200':
description: Successful response with resident transaction data
content:
text/xml:
schema:
$ref: '#/components/schemas/TransactionResponse'
'401':
description: Authentication failed
'500':
description: Server error processing the SOAP request
/ItfResidentTransactions20.asmx/GetResidentTransactions_ByChargeDate_Login:
post:
operationId: getResidentTransactionsByChargeDateLogin
summary: Yardi Get resident transactions by charge date
description: Retrieves resident transaction records filtered by charge date for a specified property. Returns billing and payment records within the specified charge date range.
tags:
- Billing and Payments
requestBody:
required: true
content:
text/xml:
schema:
$ref: '#/components/schemas/GetResidentTransactionsByChargeDateRequest'
responses:
'200':
description: Successful response with filtered transaction data
content:
text/xml:
schema:
$ref: '#/components/schemas/TransactionResponse'
'401':
description: Authentication failed
'500':
description: Server error processing the SOAP request
/ItfResidentTransactions20.asmx/ImportResidentTransactions_Login:
post:
operationId: importResidentTransactionsLogin
summary: Yardi Import resident transactions
description: Imports resident transaction records including charges, payments, and credits into the Voyager system for a specified property. Used for batch processing of financial transactions from external systems.
tags:
- Billing and Payments
requestBody:
required: true
content:
text/xml:
schema:
$ref: '#/components/schemas/ImportResidentTransactionsRequest'
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
/ItfResidentTransactions20.asmx/GetBudgetData_Login:
post:
operationId: getBudgetDataLogin
summary: Yardi Get budget data
description: Retrieves budget data for a specified property, including approved budgets, actual vs. budget comparisons, and variance data for accounting periods.
tags:
- Billing and Payments
requestBody:
required: true
content:
text/xml:
schema:
$ref: '#/components/schemas/GetBudgetDataRequest'
responses:
'200':
description: Successful response with budget data
content:
text/xml:
schema:
$ref: '#/components/schemas/BudgetDataResponse'
'401':
description: Authentication failed
'500':
description: Server error processing the SOAP request
components:
schemas:
BudgetDataResponse:
type: object
description: SOAP response containing budget data in XML format.
properties:
BudgetDataXmlResponse:
type: string
description: XML response containing budget records
GetResidentTransactionsRequest:
type: object
description: SOAP request for retrieving resident transactions within a date range.
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
enum:
- SQL Server
- Oracle
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 transaction query
ToDate:
type: string
format: date
description: End date for transaction query
required:
- UserName
- Password
- ServerName
- Database
- Platform
- YardiPropertyId
- InterfaceEntity
- InterfaceLicense
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
TransactionResponse:
type: object
description: SOAP response containing resident transaction data in XML format.
properties:
TransactionXmlResponse:
type: string
description: XML response containing transaction records
GetResidentTransactionsByChargeDateRequest:
type: object
description: SOAP request for retrieving resident transactions filtered by charge date.
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
ChargeFromDate:
type: string
format: date
description: Start charge date for filtering
ChargeToDate:
type: string
format: date
description: End charge date for filtering
required:
- UserName
- Password
- ServerName
- Database
- Platform
- YardiPropertyId
- InterfaceEntity
- InterfaceLicense
ImportResidentTransactionsRequest:
type: object
description: SOAP request for importing resident transactions into Voyager.
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
TransactionXml:
type: string
description: XML payload containing transaction data to import
required:
- UserName
- Password
- ServerName
- Database
- Platform
- YardiPropertyId
- InterfaceEntity
- InterfaceLicense
- TransactionXml
GetBudgetDataRequest:
type: object
description: SOAP request for retrieving budget 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
BudgetName:
type: string
description: Name of the budget to retrieve
FiscalYear:
type: string
description: Fiscal year for budget data
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/