Yardi · Schema

GetResidentTransactionsRequest

SOAP request for retrieving resident transactions within a date range.

AccountingCommercial Real EstateCoworkingInvestment ManagementMultifamilyProperty ManagementReal EstateResidentialSelf StorageSenior Living

Properties

Name	Type	Description
UserName	string	Yardi API user name
Password	string	Yardi API password
ServerName	string	Yardi database server name
Database	string	Yardi database name
Platform	string	Database platform identifier
YardiPropertyId	string	Yardi property identifier
InterfaceEntity	string	Interface entity code
InterfaceLicense	string	Interface license key
FromDate	string	Start date for transaction query
ToDate	string	End date for transaction query

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetResidentTransactionsRequest",
  "title": "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"
  ]
}