Yardi MCP server

Prebuilt SnapLogic agentic-tool pipelines that let an LLM read from and act on Yardi, callable as MCP tools via Pipeline Execute. Published in the SnapLogic pattern catalog.

Overview

This pack gives an agent full access to a Yardi Voyager portfolio through twenty tools, covering property and unit configuration, rent rolls, leases, residents and their ledgers, prospect guest cards, maintenance work orders, and the AP/AR side for posting charges and vendor invoices. All tools share the same connection credentials, and most read tools are scoped to a single Yardi property ID.

For setup instructions, see SnapLogic MCP Server quickstart.

Example Prompts

  • Create a guest card for John Smith, wants a 2BR at p001 from 1 March
  • Add this new lead to Yardi — email [email protected], phone 555-0123
  • Log a prospect at Riverside Apartments looking for a one-bedroom in April
  • Put the enquiry we just took into the leasing system
  • Raise a work order for a leaking kitchen faucet in unit 101 at p001, high priority
  • Log a plumbing service request for this unit
  • Create a maintenance ticket for the broken heating in 204 at Riverside
  • Submit an urgent work order for the lobby door at this property
  • What charge codes are set up in Yardi?
  • Is there a charge type for parking?

Tools

Tool Name Functions
YardiCreateGuestCard Create a prospect guest card at a property from guest-card XML.
YardiCreateWorkOrder Create or edit a maintenance service request at a property.
YardiGetChargeTypes List the configured charge-type codes on the Yardi database.
YardiGetChartOfAccounts Export the GL chart of accounts, optionally scoped to one property.
YardiGetExpiringLeases List scheduled lease renewals (upcoming expiries) for a property.
YardiGetGuestActivity Fetch prospect / guest-card activity for a property.
YardiGetLeaseInfo Fetch lease records and their lease charges for a property.
YardiGetPayables List AP invoices for a property, unpaid by default, by post month.
YardiGetProperties List the Yardi property configurations available on the connection.
YardiGetRentRoll Return the unit-by-unit rent roll for a property.
YardiGetResidentBalances Return current resident balances owed at a property.
YardiGetResidentData Fetch a resident's full record and ledger, optionally by tenant code.
YardiGetResidents List the residents at a Yardi property.
YardiGetUnitAvailability Fetch currently available units and marketed pricing for a property.
YardiGetUnits List the unit inventory for a Yardi property.
YardiGetVendors List vendors configured for a property.
YardiGetWorkOrders Search a property's work orders by status and date range.
YardiPostCharge Post a charge to a resident's ledger from transaction XML.
YardiRecordPayment Record a resident payment receipt from receipt XML.
YardiSubmitInvoice Submit a vendor invoice into AP from payable XML.

Set up the MCP Server tools

  1. Download yardi_tools.zip.
  2. In SnapLogic Designer, open the target project space (or create one), then choose Import Project / Import Pipelines and select the downloaded yardi_tools.zip. Designer unpacks each pipeline into the project.
  3. Attach the required account to the connectivity snaps (see Connection Setup).
  4. Expose the project as an MCP server — each pipeline becomes a tool named after its label. New to this? Start with the MCP quickstart, then use the MCP Server Pipeline Builder to generate the server from the imported pipelines.

Configure account

Attach an API Suite account (OAuth 2.0 or Bearer token) to the HTTP Client snap in Designer after import.

These pipelines ship without credentials by design — attach a valid account in Designer before the tools will execute.

See the SnapLogic account documentation for this connector: API Suite Account Configuration.

Important: These pipelines ship without credentials by design — attach a valid account in Designer before the tools will execute. Credentials live in the SnapLogic account store, never in the pipeline JSON.

YardiCreateGuestCard

Creates a prospect guest card in Yardi from a guest-card XML document, adding the lead to the leasing funnel. Use this when a new enquiry comes in from outside Yardi; read the result back with YardiGetGuestActivity.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
guest_xml* string —

Yardi guest-card XML document, sent as <XmlDoc>, e.g. <GuestCard><PropertyId>p001</PropertyId><FirstName>...</FirstName><Email>...</Email><DesiredMoveIn>2026-03-01</DesiredMoveIn><UnitType>2BR</UnitType></GuestCard>.

* Required parameter.

Try asking:

  • Create a guest card for John Smith, wants a 2BR at p001 from 1 March
  • Add this new lead to Yardi — email [email protected], phone 555-0123
  • Log a prospect at Riverside Apartments looking for a one-bedroom in April
  • Put the enquiry we just took into the leasing system

YardiCreateWorkOrder

Raises or updates a maintenance service request at a property from a service-request XML document. The underlying call is create-or-edit, so the same tool handles both new requests and amendments; confirm results with YardiGetWorkOrders.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to raise or edit the service request against, sent as <YardiPropertyId>, e.g. p001.
service_request_xml* string —

Yardi service-request XML document, sent as <ServiceRequestXml>, e.g. <ServiceRequest><UnitCode>101</UnitCode><Category>Plumbing</Category><Priority>High</Priority><Description>...</Description></ServiceRequest>.

* Required parameter.

Try asking:

  • Raise a work order for a leaking kitchen faucet in unit 101 at p001, high priority
  • Log a plumbing service request for this unit
  • Create a maintenance ticket for the broken heating in 204 at Riverside
  • Submit an urgent work order for the lobby door at this property

YardiGetChargeTypes

Returns the charge-type codes configured on the Yardi database. Call this before YardiPostCharge to confirm the charge code you plan to use, or to translate a code from a ledger into a human-readable label.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.

* Required parameter.

Try asking:

  • What charge codes are set up in Yardi?
  • Is there a charge type for parking?
  • What does charge code RENT map to?
  • Show me the valid charge types before I post this charge

YardiGetChartOfAccounts

Exports the GL chart of accounts, scoped to one property or across the whole database if no property is supplied. Use this to look up a valid GL account before submitting an invoice with YardiSubmitInvoice, or to decode account numbers on payables.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id string —

Yardi property id to scope the export to, sent as <PropertyId>, e.g. p001. Omit to export the chart of accounts for the whole database.

* Required parameter.

Try asking:

  • Show me the chart of accounts in Yardi
  • What GL accounts exist for property p001?
  • Which account should maintenance expenses be coded to?
  • What is GL account 6100?

YardiGetExpiringLeases

Returns the scheduled lease renewals for a property, showing the leases coming up for expiry and the renewal offers attached to them. Use this for retention and renewal-campaign questions; filter the returned dates yourself if you need a specific window.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to return scheduled lease renewals for, sent as <YardiPropertyId>, e.g. p001.

* Required parameter.

Try asking:

  • Which leases are expiring at property p001?
  • Show me the scheduled renewals for Riverside Apartments
  • Who's up for renewal in the next quarter at this property?
  • Pull the renewal pipeline so I can plan outreach

YardiGetGuestActivity

Returns prospect and guest-card activity for a property, showing who has enquired and how their cards have progressed through the leasing funnel. Use this for traffic and conversion questions; to add a new prospect, use YardiCreateGuestCard.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to return guest-card activity for, sent as <YardiPropertyId>, e.g. p001.

* Required parameter.

Try asking:

  • What prospect activity have we had at property p001?
  • Show me the guest cards for Riverside Apartments
  • How much leasing traffic did this property get?
  • Which enquiries are still open at this property?

YardiGetLeaseInfo

Returns lease records and their charge lines for a property, focused on lease terms and dates. Use this for questions about lease commercials; for resident identity and ledger detail, use YardiGetResidents or YardiGetResidentData.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to return lease information for, sent as <YardiPropertyId>, e.g. p001.

* Required parameter.

Try asking:

  • Show me the lease details for property p001
  • What lease charges are on the leases at Riverside Apartments?
  • List the lease start and end dates for this property
  • What are the lease terms currently in place here?

YardiGetPayables

Lists AP invoices for a property, filtered by post-month window and an unpaid-only flag that defaults to true. Use this for AP review and vendor-spend questions; pass unpaid_only as false to include settled invoices.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to list payables for, sent as <YardiPropertyId>, e.g. p001.
from_date string —

Start of the invoice post-month window, sent as <InvoicePostMonthFrom>. Omit to leave the lower bound open.
to_date string —

End of the invoice post-month window, sent as <InvoicePostMonthTo>. Omit to leave the upper bound open.
unpaid_only string —

Whether to return only unpaid invoices, sent as <UnpaidOnly>; defaults to true when omitted. Pass false to include settled invoices.

* Required parameter.

Try asking:

  • What unpaid invoices are outstanding at property p001?
  • Show me payables posted between January and March for this property
  • Include paid invoices too — what did we spend at Riverside last quarter?
  • How much do we owe vendors right now at this property?

YardiGetProperties

Lists the Yardi property configurations visible to the connection, requiring no additional parameters. Call this first when the user names a property in words rather than by code, since nearly every other tool in this pack is scoped by a property ID.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.

* Required parameter.

Try asking:

  • What properties do we have in Yardi?
  • List all the property codes on this database
  • Which property is 'Riverside Apartments' — what's its Yardi id?
  • Show me the property configuration for the whole portfolio

YardiGetRentRoll

Returns the rent roll for a property, showing unit-by-unit occupancy and scheduled rent. Use this when the user wants a snapshot of who occupies what, or wants to reason about occupancy and vacancy across a property.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to run the rent roll for, sent as <YardiPropertyId>, e.g. p001.

* Required parameter.

Try asking:

  • Give me the rent roll for property p001
  • What's the current occupancy at Riverside Apartments?
  • Which units are vacant according to the rent roll?
  • What's total scheduled rent across this property?

YardiGetResidentBalances

Returns the current balance owed by each resident at a property. Use this for collections and delinquency questions when you need totals quickly, rather than the full ledger detail that YardiGetResidentData provides.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to return resident balances for, sent as <YardiPropertyId>, e.g. p001.

* Required parameter.

Try asking:

  • Who owes money at property p001?
  • Show me outstanding resident balances for Riverside Apartments
  • What's the total delinquency at this property?
  • List residents with a balance so I can start collections

YardiGetResidentData

Returns resident records with their full transaction ledger, optionally narrowed to a single resident by tenant code. Use this when the question is about a specific resident's charges, payments, and history, rather than a property roster or balance-only view.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to return resident data for, sent as <YardiPropertyId>, e.g. p001.
tenant_code string —

Yardi tenant code to narrow the response to a single resident, sent as <TenantCode>, e.g. t001. Omit to return every resident at the property.

* Required parameter.

Try asking:

  • Show me the full ledger for tenant t001 at property p001
  • What charges and payments are on this resident's account?
  • Pull everything we have on the resident in unit 204
  • Give me the resident detail with ledger for property p001
  • Has tenant t001 been charged late fees recently?

YardiGetResidents

Lists the residents at a Yardi property, giving a roster of who lives there. Use this to find or enumerate residents; for full ledger detail on one resident, use YardiGetResidentData, or for balance totals only, use YardiGetResidentBalances.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to list residents for, sent as <YardiPropertyId>, e.g. p001.

* Required parameter.

Try asking:

  • Who are the current residents at property p001?
  • List everyone living at Riverside Apartments
  • Find the tenant code for the resident in unit 204
  • How many residents are on file at this property?

YardiGetUnitAvailability

Returns the currently leasable units and their marketed pricing for a property. Use this when the question is about what can be shown to a prospect; for the full unit inventory, use YardiGetUnits.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to return available units for, sent as <YardiPropertyId>, e.g. p001.

* Required parameter.

Try asking:

  • What units are available right now at p001?
  • Show me availability and asking rents for Riverside Apartments
  • Do we have any two-bedrooms coming available at this property?
  • What's on the market at the downtown property this month?

YardiGetUnits

Returns the unit inventory for a property, showing what units exist and how they are configured. Use this when the question is about the physical building; for leasing availability use YardiGetUnitAvailability, and for occupancy and rent use YardiGetRentRoll.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to list units for, sent as <YardiPropertyId>, e.g. p001.

* Required parameter.

Try asking:

  • How many units are there at property p001?
  • Show me the unit list for Riverside Apartments
  • What unit types exist at this property?
  • Pull the unit information for the property we just looked up

YardiGetVendors

Lists the vendors configured for a property. Use this to find a vendor ID before submitting a payable with YardiSubmitInvoice, or to check who is approved to do work at a site.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to list vendors for, sent as <YardiPropertyId>, e.g. p001.

* Required parameter.

Try asking:

  • Which vendors are set up at property p001?
  • Find the vendor id for our plumbing contractor
  • Who are the approved vendors for Riverside Apartments?
  • Do we have a landscaping vendor on file at this property?

YardiGetWorkOrders

Searches maintenance service requests at a property, filterable by status and date range. Use this for backlog and turnaround questions; to raise new work, use YardiCreateWorkOrder.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
property_id* string —

Yardi property id to search service requests for, sent as <YardiPropertyId>, e.g. p001.
status string —

Service-request status to filter on, sent as <Status> only when supplied, e.g. Open.
from_date string —

Start of the service-request date window, sent as <FromDate> only when supplied, e.g. 2026-01-01.
to_date string —

End of the service-request date window, sent as <ToDate> only when supplied, e.g. 2026-03-31.

* Required parameter.

Try asking:

  • What work orders are open at property p001?
  • Show me maintenance requests raised at Riverside between 1 January and 31 March
  • Are there any outstanding service requests at this property?
  • List completed work orders for this property last month
  • How big is the maintenance backlog at p001?

YardiPostCharge

Posts a charge to a resident's ledger from a transaction XML document covering rent, fees, or any billable item. Verify the charge code with YardiGetChargeTypes first, and confirm the amount and tenant with the user before calling, as this writes directly to the resident's financial record.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
transaction_xml* string —

Yardi charge transaction XML document, sent as <TransactionXml>, e.g. <Charge><PropertyId>p001</PropertyId><TenantId>t001</TenantId><ChargeCode>RENT</ChargeCode><Amount>2500.00</Amount><Date>2026-02-01</Date></Charge>.

* Required parameter.

Try asking:

  • Post a $2,500 rent charge to tenant t001 at property p001 for 1 February
  • Add a late fee to this resident's account
  • Charge the pet fee to the tenant in unit 204
  • Bill the parking charge for February to t001

YardiRecordPayment

Applies a resident payment to the ledger from a receipt XML document. Use this when a payment has been taken outside Yardi and needs recording; confirm the updated balance with YardiGetResidentBalances.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
transaction_xml* string —

Yardi receipt XML document, sent as <TransactionXml>, e.g. <Receipt><PropertyId>p001</PropertyId><TenantId>t001</TenantId><Amount>2500.00</Amount><PaymentMethod>Check</PaymentMethod><Date>2026-02-01</Date></Receipt>.

* Required parameter.

Try asking:

  • Record a $2,500 check payment from tenant t001 at p001 dated 1 February
  • Apply this resident's rent payment to their account
  • Log the payment we received for unit 204 and show me the new balance
  • Post a partial payment against t001's outstanding balance

YardiSubmitInvoice

Submits a vendor invoice into AP from a payable XML document identifying the vendor, property, amount, date, and GL account. Look up the vendor and GL account codes with YardiGetVendors and YardiGetChartOfAccounts before calling; confirm the result with YardiGetPayables.

Parameter Type Default Description
wsdl_url* string —

Base URL of the Yardi Voyager web services; the interface name and .asmx are appended to build the endpoint, e.g. https://host/Voyager/Webservices/.
username* string —

Yardi web-service username, sent as <UserName> in the SOAP authentication block.
password* string —

Password for that Yardi web-service user, sent as <Password> in the SOAP authentication block.
server_name* string —

Yardi server name, sent as <ServerName>; the platform is fixed to SQL Server.
database* string —

Yardi Voyager database to run against, sent as <Database>.
interface_entity* string —

Yardi interface entity for the licensed integration, sent as <InterfaceEntity>.
interface_license* string —

Yardi interface licence key authorising the interface, sent as <InterfaceLicense>.
payable_xml* string —

Yardi payable XML document, sent as <PayableDoc>, e.g. <Payable><VendorId>V001</VendorId><PropertyId>p001</PropertyId><Amount>1500.00</Amount><InvoiceDate>2026-01-15</InvoiceDate><GLAccount>6100</GLAccount></Payable>.

* Required parameter.

Try asking:

  • Submit a $1,500 invoice from vendor V001 for property p001, coded to GL 6100
  • Enter this contractor invoice into Yardi payables
  • Book the January landscaping invoice against the maintenance account
  • Create a payable for the plumbing work at Riverside Apartments