XML Integration With AE 11 0 5 For Import and Export Schemas

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 106

XML Integration ARGUS Enterprise

XML Integration for Import and


Export Schemas
ARGUS Enterprise 11.0.5

7/26/2016
ARGUS Software – An Altus Group Company
XML Integration ARGUS Enterprise

XML Integration
7/26/2016

Published by:
ARGUS Software, Inc.
750 Town and Country Blvd
Suite 800
Houston, TX 77024
Telephone (713) 621-4343
Facsimile (713) 621-2787
www.argussoftware.com

Information in this document is subject to change without notice and represents no commitment on the part of
ARGUS Software, Inc.

This document is copyright 2016, ARGUS Software, Inc. All rights reserved. This document is a confidential and
proprietary trade secret of ARGUS Software, made available only under a license agreement and or other
agreements containing obligations of confidentiality.

"ARGUS" and “ARGUS Enterprise” are trademarks of ARGUS Software, Inc. All other trademarks and registered
trademarks are property of their respective companies.

ARGUS Software Confidential


XML Integration ARGUS Enterprise

Table of Contents
Purpose ..........................................................................................................................................................................7
Users ..............................................................................................................................................................................1
Overview ........................................................................................................................................................................2
AEIX Formatted Data .....................................................................................................................................................3
AEEX Formatted Data ....................................................................................................................................................4
General Import Rules ................................................................................................................................................4
Validation Actions Table .......................................................................................................................................6
AEIX XML Data Structure ...............................................................................................................................................9
Property Data ............................................................................................................................................................9
Classification Data ...................................................................................................................................................11
Budget Data.............................................................................................................................................................11
Actuals Data ............................................................................................................................................................12
Forecast Data ..........................................................................................................................................................12
Recovery Structure Data .........................................................................................................................................13
Recovery Method Data ...........................................................................................................................................13
Tenant Data .............................................................................................................................................................15
Lease Type ...............................................................................................................................................................16
Actual Type of Lease................................................................................................................................................17
Upon Expiration.......................................................................................................................................................17
Lease Break Data .....................................................................................................................................................18
Base Rent Data ........................................................................................................................................................18
Fixed Steps Data ......................................................................................................................................................19
Free Rent Data.........................................................................................................................................................19
Percentage Rent Data .............................................................................................................................................19
Tenant Improvements Data ....................................................................................................................................20
Leasing Commissions Data ......................................................................................................................................21
Miscellaneous Rent Data .........................................................................................................................................21
Incentive Data .........................................................................................................................................................22
Recovery Data .........................................................................................................................................................22
OptionTenant Data ..................................................................................................................................................23
Operating Expense Data ..........................................................................................................................................24
Non-Operating Expense Data ..................................................................................................................................24
Capital Expense Data ...............................................................................................................................................24
Other Debt Data ......................................................................................................................................................25

ARGUS Software Confidential


XML Integration ARGUS Enterprise

Expense Group Data ................................................................................................................................................25


Expense Group Item Data .......................................................................................................................................25
Tenant Group Data ..................................................................................................................................................27
Tenant Group Item Data .........................................................................................................................................27
Rent Schedule Data .................................................................................................................................................27
Initial Rent Schedule Entry Data ..............................................................................................................................27
Rent Schedule Entry Data........................................................................................................................................28
Rent Schedule Entry Unit Basis ...............................................................................................................................29
Rent Review Uplift Basis ..........................................................................................................................................29
AEEX XML Data Structure ............................................................................................................................................30
Property Data ..........................................................................................................................................................30
Actuals Export .........................................................................................................................................................31
Budget Export..........................................................................................................................................................32
Results Export..........................................................................................................................................................32
Classifications Export...............................................................................................................................................33
Operating Expense Export .......................................................................................................................................33
Capital Expense Export ............................................................................................................................................33
Expense Basis ..........................................................................................................................................................34
Common XML Data Structure ......................................................................................................................................35
Date Amount Pair ....................................................................................................................................................35
Date Amount Array .................................................................................................................................................35
Custom Data ............................................................................................................................................................35
ARGUS Data Service .....................................................................................................................................................36
Web Service Data Structures and methods ............................................................................................................36
General Contract Features ......................................................................................................................................36
Property Asset Contract ......................................................................................................................................36
Data Integration Contract ...................................................................................................................................39
Sensitivity Analysis Contract ...............................................................................................................................41
Data Request/Response Messages .........................................................................................................................42
RequestBase .......................................................................................................................................................42
ResponseBase .....................................................................................................................................................43
Request Outcome enumeration .........................................................................................................................43
Property Asset Contract Messages .........................................................................................................................43
Data Integration Contract Messages .......................................................................................................................46
Sensitivity Analysis Contract Messages ...................................................................................................................52

ARGUS Software Confidential


XML Integration ARGUS Enterprise

Data Structures .......................................................................................................................................................58


Portfolio ..............................................................................................................................................................58
Scenario ..............................................................................................................................................................59
PropertyAsset .....................................................................................................................................................60
PropertyAssetChangeset.....................................................................................................................................61
MarketLeasingChangeItem .................................................................................................................................62
LeasingChangeItem .............................................................................................................................................62
VacancyChangeItem ...........................................................................................................................................63
CreditLossChangeItem ........................................................................................................................................63
InflationChangeItem ...........................................................................................................................................63
ValuationChangeItem .........................................................................................................................................63
ExpenseChangeItem ...........................................................................................................................................63
HotelRevenueChangeItem ..................................................................................................................................64
HotelRoomChangeItem ......................................................................................................................................64
TraditionalValuationChangeItem ........................................................................................................................64
PropertyAssetChangesetResult...........................................................................................................................64
MarketLeasing ....................................................................................................................................................65
Vacancy ...............................................................................................................................................................66
CreditLoss............................................................................................................................................................66
Inflation ...............................................................................................................................................................67
Leasing ................................................................................................................................................................68
Valuation .............................................................................................................................................................69
Expense ...............................................................................................................................................................69
HotelRevenue .....................................................................................................................................................70
HotelRoom ..........................................................................................................................................................70
TraditionalValuation ...........................................................................................................................................71
DateAmountPair .................................................................................................................................................72
QueuedJobsSummary .........................................................................................................................................73
QueuedJobTasks .................................................................................................................................................73
ExportAeexProcessingOptions ............................................................................................................................74
ExportAeixProcessingOptions .............................................................................................................................75
ImportAeixProcessingOptions ............................................................................................................................76
ImportAeixPropertyDataValidationResult ..........................................................................................................76
ValidationResultDefinition ..................................................................................................................................77
ValidationResultItem ..........................................................................................................................................79

ARGUS Software Confidential


XML Integration ARGUS Enterprise

ValidationRuleOverride .......................................................................................................................................80
ChartOfAccounts .................................................................................................................................................81
Account ...............................................................................................................................................................82
ImportAccountResult ..........................................................................................................................................83
ImportChartOptions ............................................................................................................................................84
ExportChartOptions ............................................................................................................................................84
Accessing the Data Service Interface ......................................................................................................................84
Using the Data Integration Service..........................................................................................................................89
Line Item Types for Chart of Accounts Import ........................................................................................................92

ARGUS Software Confidential


XML Integration ARGUS Enterprise

Purpose
The purpose of this document is to communicate the data elements of XML Integration within ARGUS Enterprise
11.0.5 for the purposes for importing and exporting data. See ARGUS Enterprise 11.0.5 Help Documentation for
additional information regarding the importing and exporting process.
XML Integration ARGUS Enterprise

Users
Users who import data should have a basic understanding of how the model will be updated by the data imported,
the basic validation messages which may occur during an import, and how to handle these validation warning
messages.

1 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Overview
The import and export of data is achieved either through the application user interface or programmatically via a
web service interface.
Supported formats are:
• ARGUS Enterprise Import XML format (AEIX). This data format is used to import property data from third party
systems and other AE systems. ARGUS Enterprise 11.0.5 can also export existing property data into an AEIX
format for importing into other systems.
• ARGUS Enterprise Export XML format (AEEX). This data format is used to export data from ARGUS Enterprise
11.0.5 for the purposes of providing reporting information to external sources.

2 ARGUS Software Confidential


XML Integration ARGUS Enterprise

AEIX Formatted Data


This format is used primarily for the import of property data into ARGUS Enterprise 11.0.5 for use during the
budget and reforecast processes. Although less common, it can also be used for creating a property for valuation
purposes.
The XML data format contains the following categories of data:
• Basic property address, currency, area measure, chart of accounts, and analysis dates.
• Actuals data – monthly amounts summarized by account number of revenues and expenses actually realized.
This data can be used to substitute actuals data into model calculations through a specific date defined by the
user.
• Budget Data – monthly amounts summarized by account number of revenues and expenses for a prior budget.
This data can be used to substitute budget data into model calculations through a specific date defined by the
user.
• Forecast Data – monthly amounts summarized by account number of revenues and expenses that represent the
forecasted results either from an external system or another AE system. This data permanently overwrites
revenue and expense modeled entries and thus should be treated with care.
• Operating Expense Data – input data that represents a simplified version of the operating expense modeling
data. This data permanently overwrites revenue and expense modeled entries and thus should be treated with
care.

Note: This option is mutually exclusive to forecast data imports, as they provide similar functions that
could conflict if loaded to the same model.

• Capital Expense Data – input data that represents a simplified version of the capital expense modeling data. This
data permanently overwrites revenue and expense modeled entries and thus should be treated with care.

Note: This option is mutually exclusive to forecast data imports, as they provide similar functions that
could conflict if loaded at the same time.

• Tenant Data – input data that represents a simplified version of the tenant modeling data. This data permanently
overwrites lease modeled entries and thus should be treated with care.
• Classification Data – property classifications can be used to filter and categorize properties.

3 ARGUS Software Confidential


XML Integration ARGUS Enterprise

AEEX Formatted Data


This format of property data is used primarily for the export of such data from ARGUS Enterprise 11.0.5 as is used
by external reporting facilities.
In overview, the XML data format contains the following categories of data:
• Basic property address, currency, area measure, chart of account identity, and analysis dates.
• Actuals data – monthly amounts summarized by account number of revenues and expenses actually realized.
• Budget Data – monthly amounts summarized by account number of revenues and expenses for a prior budget.
• Result Data – monthly amounts summarized by account number of revenues and expenses that are the
calculated output of a property model. This data contains both summary cash flow lines as well as detailed
tenant information.
• Operating Expense Data – represents a simplified version of the operating expense modeling data.
• Capital Expense Data – represents a simplified version of the capital expense modeling data.
• Classification Data – property classifications used to filter and categorize properties.

General Import Rules


There are general assumptions made when importing data into ARGUS Enterprise 11.0.5. The following details the
general rules from the technical perspective. Any user selections are documented in the online help for ARGUS
Enterprise 11.0.5.
1. If the property exists, the property level data will not be applied to the existing property model. This data
is specifically for creation of new properties from the import property data.

2. If the property data references a chart of accounts other than the chart of accounts assigned to the
scenario into which you are importing, the property data is converted to the scenario chart if a conversion
mapping exists.

3. If a matching lease ID is found in the tenant data and the lease data of the model, the tenant data is used
to update the lease; otherwise, a new unit/lease combination is created.

4. If a matching account number is found in the operating expense data and the operating expenses in the
model, then the model operating expense is updated; otherwise, a new operating expense is created.

5. If a matching account number is found in the capital expense data and the operating expenses in the
model, then the model capital expense is updated; otherwise, a new capital expense is created.

6. If the capital expense group code matches an existing expense group, and the capital expense in not a
member of the expense group, then the capital expense is added to the expense group. Otherwise, an
expense group is created, and the capital expense is added to the group.

7. If an account number matches an existing actual data item in the model, the actuals data will update the
existing model record; otherwise, a new record will be created. The status of the record will be changed
to imported if it was previously set to manual entry and further manual entry will be prohibited for this
record.

8. If an account number matches an existing budget data item in the model, the budget data will update the
existing model record; otherwise, a new record will be created. The status of the record will be changed
to imported if it was previously set to manual entry, and further manual entry will be prohibited for this
record.

9. If a forecast data records account number matches an account definition in the property asset chart of
accounts, and the account line item type is an operating expense, capital expense, or other revenue, then
the forecast record will be processed as one of these types. Otherwise, if no match is found, and the
GLAccountType is set in the Forecast Data Record, this type will be used to process the record as a specific
operating expense, capital expense, or other revenue.

4 ARGUS Software Confidential


XML Integration ARGUS Enterprise

10. Revenue and Expense data should be imported with a positive sign for the resulting entries to be
calculated correctly by the system. The exceptions to this rule are items which are generally treated as
contra accounts. The following revenue contra accounts should be imported with a negative sign:

Line Item Type Line Item Number

TotalLostAbsorptionAndTurnover 5012

RentAbatement 2003

StraightLineRentAdjustment 2021

FreeCPI 2063

FreePercentageRent 2064

FreeRecovery 2065

FreeMiscellaneousRent 3041

PercentageRentOffset 2124

CollectionLoss 7001

GeneralVacancy 6001

MultiFamilyRevenueLossToLease 3201

MultiFamilyVacancyAllowance 3205

MultiFamilyRevenueFreeRent 3203

MultiFamilyCreditLossAmt 3213

MultiFamilyAdditionalConcessionsAmt 3210

SecurityDeposits 2163

DistributedDepositInvestments 2167

MultiFamilySecurityDeposits 3218

MultiFamilyDistributedDepositInvestments 3222

5 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Validation Actions Table


The following Validations will be applied (default action in italics):

Record Type Result Type Action

Actuals Missing account number Skip property

Actuals Duplicate account number Use last account entry


Net account entries
Skip property

Actuals Missing name Skip record


Skip property

Budget Missing account number Skip property

Budget Duplicate account number Use last account entry


Net account entries
Skip property

Budget Missing name Skip record


Skip property

Capital Expense Missing name Skip record


Skip property

Capital Expense Missing account number Skip property

Forecast Missing account number Skip property

Forecast Duplicate account number Use last account entry


Net account entries
Skip property

Forecast Missing name Skip record


Skip property

Non-Operating Expense Missing name Skip record


Skip property

Non-Operating Expense Missing account number Skip property

Operating Expense Missing name Skip record


Skip property

Operating Expense Missing account number Skip property

Other debt Missing name Skip Record


Skip Property

Other debt Missing Account Number Skip Property

Property Missing ID Add property


Skip property

6 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Record Type Result Type Action

Property Property does not exist in scenario Add property


Skip property

Property Property exists in scenario Update property


Skip property

Property Property is locked by another user or task Skip property

Property Duplicate ID Skip property

Property Property exists in scenario – pending deletion Skip property

Property Missing name Skip property

Property Property currency code has changed Update property

Property No permissions to overwrite property asset Skip property

Tenant Missing ID Skip record


Skip property
Add record

Tenant Duplicate ID Skip record


Skip property

Tenant Missing name Skip record


Skip property

Tenant Invalid rent entry type Skip record


Skip property

Tenant Invalid rent entry unit Skip record


Skip property

Expense Group Missing name Skip record


Skip property

Expense Group Missing group code Skip record


Skip property
Add record

Tenant Group Missing name Skip record


Skip property

Tenant Group Missing group code Skip record


Skip property
Add record

Recovery Structure Missing name Skip record


Skip property

7 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Record Type Result Type Action

Recovery Structure Missing ID Skip record


Skip property
Add record

Xml Import Data Invalid Xml Abort process

8 ARGUS Software Confidential


XML Integration ARGUS Enterprise

AEIX XML Data Structure


This section describes the AEIX format data structure and data types for importing into ARGUS Enterprise 11.0.5.

Property Data
The following information is for importing a single property and associated sections of data.

Property Name Data Type Comments

PropertyID String The external ID used to identify the property asset.

ChartOfAccountExternalID String Optional external ID used to identify the chart of


accounts.

PropertyName String The human readable name for the property asset.

EntityID String The entity ID of the property.

Address String The address of the property.

City String The city.

State String The state.

ZipOrPostalCode String The zip or postal code for the property.

Country String Country name.

CurrencyCode String The 3 digit ANSI standard currency code.

PropertyType String/PropertyType enum Fixed set of values


• Office
• Retail
• Industrial
• MixedUseOfficeRetail
• MixedUseOfficeIndustrial
• MixedUseOfficeMultiFamily
• MixedUseRetailMultiFamily
• MultiFamily
• Hotel

AreaMeasure String/AreaMeasureBasis enum Fixed set of values


• SF
• SM
• Tsubo
• Pyung

Description String Property description.

PurchasePrice Double Optional purchase price for the property.

9 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

PortfolioName String Optional name for the portfolio to which this property
belongs.

ClassificationData ClassificationData Zero or more property classifications. See the


ClassificationData structure.

AnalysisBegin DateTime The begin date for the analysis.

NetRentableArea DateAmountPair list Net rentable area over time. See DateAmountPair
structure.

Budgets BudgetData list A list of monthly budget amounts for specific accounts.
See BudgetData structure.

Actuals ActualsData list A list of monthly actuals amounts for specific accounts.
See ActualsData structure.

Forecasts ForecastData list A list of monthly forecast amounts for specific


accounts. See ForecastData structure.

RecoveryStructures RecoveryStructureData list A list of basic recovery structure data input


assumptions. See RecoveryStructureData structure.

Tenants TenantData list A list of basic tenant lease data input assumptions. See
TenantData structure.

OperatingExpenses OperatingExpenseData list A list of basic operating expense data input


assumptions. See OperatingExpenseData structure.

NonOperatingExpenses NonOperatingExpensesData list A list of basic non-operating expense data input


assumptions. See NonOperatingExpenseData structure.

CapitalExpenses CapitalExpenseData list A list of basic capital expense data input assumptions.
See CapitalExpenseData structure.

OtherDebt OtherDebtData list A list of basic other debt data input assumptions. See
OtherDebtData structure.

ExpenseGroups ExpenseGroupData list A list of basic expense group data input assumptions.
See ExpenseGroupData structure.

TenantGroups TenantGroupData list A list of basic tenant group data input assumptions.
See TenantGroupData structure.

PropertyAssetTemplateId String Used for importing data into a template when using
the ARGUS Data Service. This field is not used when
importing by a user within the AE application, as a
template is selected at the time of import.

OwnershipPercentage Double Represents a simple equity ownership percentage at a


property level.

10 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Classification Data
This data represents a property classification.

Property Name Data Type Comments

Type String Classification type.

Name String The name (value) of the classification for this particular
property. Chosen from a list of system classifications
that are available and user configurable within AE.

Budget Data
This data represents budget data for a single expense or revenue account for a contiguous period of months
beginning on a specified date. This is also referred to as Prior Budget Data.

Property Name Data Type Comments

AccountNumber String Account for which the monthly amounts are


summarized.

DetailAccountNumber String Optional. The detail account to further segregate the


monthly data.

Description String Textual description of the expense/revenue amounts.

MonthlyAmounts DateAmountArray The monthly amounts from a specified date. See


DateAmountArray structure.

AccountType String/GLAccountType enum Optional. Fixed set of values identifying the type of
revenue/expense.
• MiscellaneousRevenue
• ReimbursableExpense
• NonreimbursableExpense
• CapitalExpense
• NonOperatingExpense
• OtherDebt

11 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Actuals Data
This data represents the historical data for a single expense or revenue account for a contiguous period of months
beginning on a specified date.

Property Name Data Type Comments

AccountNumber String Account for which the monthly amounts are


summarized.

DetailAccountNumber String Optional. The detail account to further segregate the


monthly data.

Description String Textual description of the expense/revenue amounts.

MonthlyAmounts DateAmountArray The monthly amounts from a specified date. See


DateAmountArray structure.

AccountType String/GLAccountType enum Optional. Fixed set of values identifying the type of
revenue/expense.
• MiscellaneousRevenue
• ReimbursableExpense
• NonreimbursableExpense
• CapitalExpense
• NonOperatingExpense
• OtherDebt

Forecast Data
This data represents forecast data for a single expense or revenue account for a contiguous period of months
beginning on a specified date.

Property Name Data Type Comments

AccountNumber String Account for which the monthly amounts are


summarized.

DetailAccountNumber String Optional. The detail account to further segregate the


monthly data.

Description String Textual description of the expense/revenue amounts.

MonthlyAmounts DateAmountArray The monthly amounts from a specified date. See


DateAmountArray structure.

AccountType String/GLAccountType enum Optional. Fixed set of values identifying the type of
revenue/expense.
• MiscellaneousRevenue
• ReimbursableExpense
• NonreimbursableExpense
• CapitalExpense
• NonOperatingExpense
• OtherDebt

12 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Recovery Structure Data


This data represents the recovery structure data.

Property Name Data Type Comments

Name String Name of the custom recovery structure.

StructureID String Custom recovery structure ID.

GrossUpPct Double Gross up % input.

RecoveryMethods RecoveryMethodData A structure that defines recovery methods. See


RecoveryMethodData structure.

Recovery Method Data


This data represents the recovery method data.

Property Name Data Type Comments

ExpenseID String Expense account number or expense group code.

ExpenseType String/ExpenseType enum Fixed set of values identifying the included expense
item or group:
• ExpenseGroup
• OperatingExpense
• CapitalExpense

AccountNumber String Optional. Account number of the recovery method.

PayDuringFreeRent Boolean Optional. Are recoveries for the specific recovery


method paid during free rent periods or not?

RecoveryType String/RecoveryType enum Optional. Fixed set of values identifying the recovery
calculation type:
• Net
• BaseYearStop
• BaseYearStopMinus1
• BaseYearStopPlus1
• StopAmount
• StopAmountPerArea
• FixedAmount
• FixedAmountPerArea
• None

Amount DateAmountPair list Optional. Recovery amounts over time. See


DateAmountPair structure.

TenantAreaType String/ TenantAreaType enum Optional. Fixed set of values:


• StandardArea
• AlternateArea

13 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

RecoveryAllocation String/RecoveryAllocation enum Optional. Fixed set of values:


• FixedPct
• ProRateOnNRA
• ProRateOnTOA
• SpecifiedArea

RecoveryAreaMeasure String Optional. Area Measure name used in pro-rata share


calculation.

DenominatedArea DateAmountPair list Optional. Building area used in pro-rata share


calculation if RecoveryAllocation is DenominatedArea.
See DateAmountPair structure.

AllocationPercent Double Optional. Pro-rata share percentage used if


RecoveryAllocation is FixedPercentage.

AnchorTenantGroup String Optional. Tenant Group ID of anchor tenants –


(Reimburse After)

AdminFee Double Optional. Administration fees amount.

MinimumAmountUnit String/LimitsBasis enum Optional. Minimum increase unit of measure. Fixed set
of values:
• AmountPerArea
• Amount
• None

MinimumAmount DateAmountPair list Optional. Minimum amounts over time. See


DateAmountPair structure.

MaximumAmountUnit String/LimitsBasis enum Optional. Maximum amount unit of measure. Fixed set
of values:
• AmountPerArea
• Amount
• None

MaximumAmount DateAmountPair list Optional. Maximum amounts over time. See


DateAmountPair structure.

MaximumIncreaseUnit String/CapBasis enum Optional. Maximum Increase Unit of Measure. Fixed set
of values:
• AmountPerArea
• Amount
• Pct
• None

MaximumIncreaseAmount DateAmountPair list Optional. Cap amounts over time. See DateAmountPair
structure.

14 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Tenant Data
This data represents the tenant lease data.

Property Name Data Type Comments

Name String Name of the lease/tenant.

Suite String Suite number.

LeaseID String The external lease ID used to match imported data to the
existing record for the purposes of importing updated
information.

LeaseStatus String/LeaseType enum Fixed set of values. See LeaseType.

CustomLeaseStatus String Optional. Custom lease status.

CustomLeaseType String Optional. Custom lease type.

LeaseType String/ActualTypeOfLease enum Fixed set of values. See ActualTypeOfLease.

AvailableDate DateTime Optional. Date when the lease/tenant is available for


leasing.

StartDate DateTime Optional. Start of lease.

ExpirationDate DateTime Optional. Expiration Date of lease.

RentScheduleData RentScheduleData Optional. A structure that defines the lease rent schedule.
See RentScheduleData structure.

ExecutionDate DateTime Optional. Execution Date of lease.

Size DateAmountPair Optional. The area of the lease. A list that can change over
time. See DateAmountPair structure.

LeaseBreaks LeaseBreakData Optional. A structure that defines the Lease Breaks. See
LeaseBreakData structure.

BaseRent BaseRentData Optional. A structure that defines base rent. See


BaseRentData structure.

UponExpiration String/UponExpiration enum Optional. Fixed set of values. See UponExpiration.

OptionTenant OptionTenantData Optional. A structure that defines the child lease. See
OptionTenantData structure.

FixedSteps FixedStepsData Optional. A structure that defines fixed step rent


increases. See FixedStepsData structure.

FreeRent FreeRentData Optional. A structure that defines free rent months. See
FreeRentData structure.

15 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

PercentageRent PercentageRentData Optional. A structure that defines the percentage rent.


See PercentageRentData structure.

Improvements Improvements Optional. A structure that defines tenant improvements.


See Improvements structure.

Commissions Commissions Optional. A structure that defines leasing commissions.


See Commissions structure.

MiscellaneousRents MiscellaneousRentData Optional. A structure that defines miscellaneous rents.


See MiscellaneousRentData structure.

Incentives IncentiveData Optional. A structure that defines incentives. See


IncentiveData structure.

Recoveries RecoveryData Optional. A structure that defines the recoveries. See


RecoveryData structure.

MarketLeasing String Optional. Market leasing profile name associated with


current lease/tenant.

Lease Type
This data represents the lease status enumeration.

Property Name Data Type Comments

LeaseType String Fixed set of values


• Custom
• Contract
• Speculative
• Option
• ContractRenewal
• MonthtoMonth
• HoldOver

16 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Actual Type of Lease


This data represents the lease type enumeration.

Property Name Data Type Comments

ActualTypeOfLease String Fixed set of values


• Custom
• Office
• Retail
• Industrial
• Storage
• Antenna
• Billboard
• DropBox
• ATM
• Other
• Residential

Upon Expiration
This data represents the lease Upon Expiration basis enumeration.

Property Name Data Type Comments

UponExpiration String Fixed set of values.


• Market
• Reabsorb
• Renew
• Vacate
• Option
• ContractRenewal
• MonthtoMonth
• Holdover

17 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Lease Break Data


This data represents the lease break data.

Property Name Data Type Comments

BreakDate DateTime Lease break date.

Active Boolean Flag to indicate if the current lease break will be


exercised or not.

Options String/LeaseBreakOption enum Fixed set of values identifying which party or parties
have the right to exercise the break:
• Landlord
• Tenant
• LandlordAndTenant
• None

ActionedBy String/LeaseBreakActionedBy enum Fixed set of values identifying which party is assumed
to actually exercise the break:
• Landlord
• Tenant
• None

LandlordPenalty Double Optional. The amount paid to the tenant if the landlord
breaks the lease.

TenantPenalty Double Optional. The amount paid to the tenant if the landlord
breaks the lease.

Base Rent Data


This data represents base rent unit of measurement and data.

Property Name Data Type Comments

BaseRentUnit String/BaseRentBasis enum Optional. Fixed set of values


• AmtPerAreaPerMonth
• AmtPerAreaPerAnnum
• AmtPerMonth
• AmtPerYear
• PctOfMarket
• PctIncrease
• PctOfMarketWithStepAmount

BaseRentValues DateAmountPair list Optional. Base Rent over time. See DateAmountPair
structure.

18 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Fixed Steps Data


This data represents fixed step unit of measurement and data.

Property Name Data Type Comments

FixedStepsUnit String/SteppedIncreaseBasis enum Optional. Fixed set of values


• None
• AmountPerAreaPerMonth
• AmountPerAreaPerYear
• AmountPerMonth
• AmountPerYear
• Percentage

FixedStepsValues DateAmountPair list Optional. Base Rent over time. See DateAmountPair
structure.

Free Rent Data


This data represents number of months of free rent for a tenant.

Property Name Data Type Comments

FreeRentValues DateAmountPair list Optional. Free Rent Months. See DateAmountPair


structure.

Percentage Rent Data


This data represents the percentage rent data.

Property Name Data Type Comments

SalesPercentBasis String/SalesPercentBasis enum Optional. Fixed set of values:


• ContinuePrior
• None
• Percent
• Market
• DetailedOrMultiple

SalesPercent DateAmountPair Optional. Sales Percent over time. See


DateAmountPair structure.

SalesAmountBasis String/SalesAmountBasis enum Optional. Fixed set of values:


• AmountPerArea
• AnnualAmount
• ContinuePrior

SalesAmount DateAmountPair Optional. Sales Amount over time. See


DateAmountPair structure.

19 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

BreakpointBasis String/BreakpointBasis enum Optional. Fixed set of values:


• AmountPerArea
• AnnualAmount
• ContinuePrior
• Natural
• Zero

BreakpointAmount DateAmountPair Optional. Breakpoint Basis over time. See


DateAmountPair structure.

Note: Detailed/Multiple input is supported as a valid selection for SalesPercentBasis field but Tenant Sales
Categories input/structure is not supported.

Tenant Improvements Data


This data represents tenant improvement unit of measurement and payment data.

Property Name Data Type Comments

ImprovementsUnit String/TIBasis enum Optional. Fixed set of values


• None
• Amount
• AmountPerArea
• PctOfYear1Rent

ImprovementsValues DateAmountPair list Optional. Tenant Improvement amounts over time.


See DateAmountPair structure.

ImprovementsTimings DateAmountPair list Optional. Tenant Improvement timing over time. See
DateAmountPair structure.

IsMarketBasis Bool Flag to indicate whether or not based on Market.

SingleAmount Double The single amount value.

20 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Leasing Commissions Data


This data represents leasing commission unit of measurement and payment data.

Property Name Data Type Comments

CommissionsUnit String/LCBasis enum Optional. Fixed set of values


• None
• Amount
• AmountPerArea
• FixedPerc
• LeaseYearPerc
• FirstMonthPlusPerc
• NumberOfMonths

CommissionsValues DateAmountPair list Optional. Leasing Commissions over time. See


DateAmountPair structure.

CommissionsTimings DateAmountPair list Optional. Leasing Commissions timing over time. See
DateAmountPair structure.

IsMarketBasis Bool Flag to indicate whether or not based on Market.

SingleAmount Double The single amount value.

Miscellaneous Rent Data


This data represents miscellaneous rent data.

Property Name Data Type Comments

AccountNumber String Account number of the miscellaneous rent.

Name String Name of the miscellaneous rent.

MiscellaneousRentUnit String/MiscellaneousRentUnit Fixed set of values identifying the unit of measure of


enum the current item
• Amt1
• AmtPerArea
• PctRent

MonthlyValues DateAmountPair list Amounts over time. See DateAmountPair structure.

RentComponents String Name of Rent Components if MiscellaneousRentUnit is


PctRent.

StraightLineRent Boolean Include in Straight Line Rent Calculation Flag

21 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Incentive Data
This data represents incentive data.

Property Name Data Type Comments

AccountNumber String Account number of the incentives

Name String Name of the incentive.

ProjectID String Project ID assigned to the incentive.

IncentiveUnit String/IncentiveUnit enum Fixed set of values identifying the unit of measure of
the current item
• Amt1
• AmtPerArea

MonthlyValues DateAmountPair list Amounts over time. See DateAmountPair structure.

Timing DateAmountPair list Percent allocation/distribution over time. See


DateAmountPair structure.

Amortize Boolean Amortize Calculation Flag

RecoverablePct Double Recoverable Percent

Recovery Data
This data represents the recovery data.

Property Name Data Type Comments

RecoveryStructureType String/RecoveryStructureType enum Fixed set of values:


• Net
• BaseYearStop
• BaseYearStopMinus1
• BaseYearStopPlus1
• StopAmount
• StopAmountPerArea
• FixedAmount
• FixedAmountPerArea
• None
• Market
• Custom

CustomStructureID String Structure ID of custom recovery structure.

RecoveryAmount DateAmountPair list Recovery amounts over time. See DateAmountPair


structure.

22 ARGUS Software Confidential


XML Integration ARGUS Enterprise

OptionTenant Data
This data represents the option tenant data.

Property Name Data Type Comments

Suite String Suite number.

LeaseID String The external lease ID used to match imported


data to the existing record for the purposes of
importing updated information.

LeaseType String/ActualTypeOfLease enum Fixed set of values. See ActualTypeOfLease.

ExpirationDate DateTime Optional. Expiration Date of lease.

RentScheduleData RentScheduleData Optional. A structure that defines the lease rent


schedule. See RentScheduleData structure.

ExecutionDate DateTime Optional. Execution Date of lease.

Size DateAmountPair Optional. The area of the lease. A list that can change
over time. See DateAmountPair structure.

LeaseBreaks LeaseBreakData Optional. A structure that defines the Lease Breaks. See
LeaseBreakData structure.

BaseRent BaseRentData Optional. A structure that defines base rent. See


BaseRentData structure.

FixedSteps FixedStepsData Optional. A structure that defines fixed step rent


increases. See FixedStepsData structure.

FreeRent FreeRentData Optional. A structure that defines free rent months. See
FreeRentData structure.

Improvements Improvements Optional. A structure that defines free rent months. See
Improvements structure.

Commissions Commissions Optional. A structure that defines free rent months. See
Commissions structure.

MiscellaneousRents MiscellaneousRentData Optional. A structure that defines miscellaneous rents.


See MiscellaneousRentData structure.

Incentives IncentiveData Optional. A structure that defines incentives. See


IncentiveData structure.

Recoveries RecoveryData Optional. A structure that defines recovery structures.


See RecoveryData structure.

PercentageRent PercentageRentData Optional. A structure that defines percentage rent. See


PercentageRentData structure.

UponExpiration String/UponExpiration enum Optional. Fixed set of values. See UponExpiration.

OptionTenant OptionTenantData Optional. A structure that defines the child lease. See
OptionTenantData structure.

23 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

MarketLeasing String Optional. Market Leasing Profile Name associated with


current lease/tenant.

Operating Expense Data


This data represents the operating expense data for a single account.

Property Name Data Type Comments

AccountNumber String Account number of the expense.

Name String Name of the expense.

Amount1 DateAmountPair list Amount 1 values over time. See DateAmountPair


structure.

Memo Bool Is the expense a memo?

Comment String Additional comments.

Non-Operating Expense Data


This data represents the non-operating expense data for a single account.

Property Name Data Type Comments

AccountNumber String Account number of the expense.

Name String Name of the expense.

Amount1 DateAmountPair list Amount 1 values over time. See DateAmountPair


structure.

Memo Bool Is the expense a memo?

Comment String Additional comments.

Capital Expense Data


This data represents capital expense data for a single account.

Property Name Data Type Comments

AccountNumber String Account number of the expense.

Name String Name of the expense.

Amount1 DateAmountPair list Amount 1 values over time. See DateAmountPair


structure.

Memo Bool Is the expense a memo?

24 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

ProjectID String The External Project ID used to match imported data to


the existing record for the purposes of importing
updated information.

Comment String Additional comments.

GroupCode String Used to add the capital expense to an expense group.

VATRate Double The VAT rate for the capital expense.

Other Debt Data


This data represents the other debt data for a single account.

Property Name Data Type Comments

AccountNumber String Account number of the debt item.

Name String Name of the other debt.

Amount1 DateAmountPair list Amount 1 values over time. See DateAmountPair


structure.

Comment String Additional comments.

Expense Group Data


This data represents the expense group data.

Property Name Data Type Comments

Name String Name of the Expense Group.

GroupCode String Group Code of the Expense Group.

Members ExpenseGroupItemData Optional. A structure that defines the included


expenses. See ExpenseGroupItemData structure.

Expense Group Item Data


This data represents the expense group item - the included expenses and its recoverable percent.

Property Name Data Type Comments

AccountNumber String Account number of expense included in the group.

ExpenseType String/ExpenseType enum Fixed set of values identifying the expense type of the
included item:
• OperatingExpense
• CapitalExpense

25 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

RecoverablePercent Double Optional. Percentage Recoverable input for the


included item.

26 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Tenant Group Data


This data represents the tenant group data.

Property Name Data Type Comments

Name String Name of the Tenant Group.

GroupCode String Group Code of the Tenant Group.

Members TenantGroupItemData Optional. A structure that defines the included tenants.


See TenantGroupItemData structure.

Tenant Group Item Data


This data represents the included tenant in a tenant group.

Property Name Data Type Comments

LeaseID String Lease ID of the tenant included in the group.

Rent Schedule Data


This data represents the rent schedule entries for tenants.

Property Name Data Type Comments

InitialRentScheduleEntry InitialRentScheduleEntryData The first entry in a rent schedule structure.


See InitialRentScheduleEntryData structure.

RentScheduleEntries RentScheduleEntryData Subsequent (to the initial) entries in a rent schedule


structure.
See RentScheduleEntryData structure.

Initial Rent Schedule Entry Data


This data represents the first entry in a rent schedule entry structure.

Property Name Data Type Comments

RentScheduleUnit RentScheduleEntryUnitBasis enum Fixed set of values identifying the basis type used for
the Rent Schedule Unit. See
RentScheduleEntryUnitBasis structure.

RentScheduleAmount Double The amount for the initial rent schedule entry.

27 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Rent Schedule Entry Data


This data represents the first entry in a rent schedule entry structure.

Property Name Data Type Comments

EntryStart DateTime The start date of the rent schedule entry.

RentScheduleType RentScheduleEntryType enum Fixed set of values


• Base
• Step
• RentReview
• OutstandingReview
Fixed set of values identifying the basis type used for
RentScheduleUnit RentScheduleEntryUnitBasis enum
the Rent Schedule Unit. See
RentScheduleEntryUnitBasis structure.

RentScheduleAmount Double The amount for the initial rent schedule entry.

RentScheduleReviewType RentReviewAdjustmentType enum Fixed set of values


• UpwardOnly
• UpwardAndDownward

ReviewMinimumUpliftType RentReviewUpliftBasis enum Fixed set of values identifying the basis type used for
the minimum uplift of the rent schedule entry. See
RentReviewUpliftBasis structure.

ReviewMinimumUpliftAmount Double The rent schedule review minimum uplift basis.

ReviewMaximumUpliftType RentReviewUpliftBasis enum Fixed set of values identifying the basis type used for
the maximum uplift of the rent schedule entry. See
RentReviewUpliftBasis structure.

ReviewMaximumUpliftAmount Double The rent schedule review maximum uplift amount.

AdjustExpenseStops RentReviewStopAdjustmentBasis Fixed set of values


enum
• No
• Yes
• IfRentChanges

AdjustedStopYear RentReviewStopAdjustmentStopY Fixed set of values


earBasis enum
• CurrentYear
• PriorYear
• SubsequentYear

28 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Rent Schedule Entry Unit Basis


This data represents the Rent Schedule Entry Unit basis enumeration.

Property Name Data Type Comments

RentScheduleUnit String Fixed set of values


• AmtPerAreaPerMonth
• AmtPerAreaPerYear
• AmtPerMonth
• AmtPerYear
• PctOfMarket
• PctIncrease
• IndexedReview
• PctOfSales
• PartialRatchetHigher
• PartialRatchetLower
• FullRatchetHigher
• FullRatchetLower
• AveragePriorRent

Rent Review Uplift Basis


This data represents the Rent Review Uplift basis enumeration.

Property Name Data Type Comments

RentReviewUpliftBasis String Fixed set of values


• None
• AmtPerYear
• AmtPerAreaPerYear
• PctIncrease
• AnnualizedPctIncrease
• Indexation

29 ARGUS Software Confidential


XML Integration ARGUS Enterprise

AEEX XML Data Structure


This section describes the AEEX format data structure and data types for exporting from ARGUS Enterprise 11.0.5.

Property Data
The following information represents exporting a single property and associated sections of data.

Property Name Data Type Comments

PropertyID String The external ID used to identify the property asset.

ChartOfAccountExternalID String Optional external ID used to identify the chart of


account.

PropertyName String The human readable name for the property asset.

EntityID String The Entity ID of the property.

Address String The Address of the property.

City String The City.

State String The State.

ZipOrPostalCode String The Zip or postal code for the property.

Country String Country name.

CurrencyCode String The 3 digit ANSI standard currency code.

PropertyType PropertyType enum Fixed set of values


• Office
• Retail
• Industrial
• MixedUseOfficeRetail
• MixedUseOfficeIndustrial
• MixedUseOfficeMultiFamily
• MixedUseRetailMultiFamily
• MultiFamily
• Hotel

AreaMeasure AreaMeasureBasis enum Fixed set of values


• SF
• SM
• Tsubo
• Pyung

Description String Property description.

PurchasePrice Double Optional Purchase Price for the property.

30 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

PortfolioName String Optional name for the portfolio to which this property
belongs.

PropertyAssetID bigint ID for Property asset.

Classifications ClassificationExport Zero or more property classifications. See the


ClassificationExport structure

AnalysisBegin DateTime The begin date for the analysis

NetRentableArea DateAmountPair list Net rentable area over time. See DateAmountPair
structure.

Budgets BudgetExport list A list of monthly budget amounts for specific accounts.
See BudgetExport structure.

Actuals ActualsExport list A list of monthly actuals amounts for specific accounts.
See ActualsExport structure.

Results ResultsExport list A list of monthly forecast amounts for specific


accounts. See ResultsExport structure.

OperatingExpenses OperatingExpenseExport list A list of basic operating expense data input


assumptions. See OperatingExpenseExport structure.

CapitalExpenses CapitalExpenseExport list A list of basic capital expense data input assumptions.
See CapitalExpenseExport structure.

ActualsEnd DateTime The Actuals End Date for the property, if applicable.

BudgetEnd DateTime The Budget End Date for the property, if applicable.

Actuals Export
This data represents the historical data for a single expense or revenue account for a contiguous period of months
beginning on a specified date.

Property Name Data Type Comments

AccountNumber String Account for which the monthly amounts are


summarized.

Description String Textual description of the expense/revenue amounts.

MonthlyAmounts DateAmountArray The monthly amounts from a specified date. See


DateAmountArray structure.

31 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Budget Export
This data represents budget data for a single expense or revenue account for a contiguous period of months
beginning on a specified date.

Property Name Data Type Comments

AccountNumber String Account for which the monthly amounts are summarized.

Description String Textual description of the expense/revenue amounts.

MonthlyAmounts DateAmountArray The monthly amounts from a specified date. See


DateAmountArray structure.

Results Export
This data represents calculated result data for a single expense or revenue account for a contiguous period of
months beginning on a specified date.

Property Name Data Type Comments

AccountNumber String Account for which the monthly amounts are summarized.

EntityType String Optional.

AdditionalId String Optional. The Lease ID for lease related expense/revenue


amounts or capital expense Project ID.

Description String Textual description of the expense/revenue amounts.

LineItemTypeId Int ID for those line item types exported as results.

AccountType String/AccountClassType enum Textual description of the class of account.


• Undefined
• Revenue
• Expense
• Asset
• Liability
• Equity

MonthlyAmounts DateAmountArray The monthly amounts from a specified date. See


DateAmountArray structure.

32 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Classifications Export
This data represents a property classification.

Property Name Data Type Comments

Type String Classification type

Name String The name (value) of the classification for this particular
property. Chosen from a list of system classifications for a
particular type. System classifications are available and
user configurable within AE.

Operating Expense Export


This data represents operating expense data for a single account.

Property Name Data Type Comments

AccountNumber String Account number of the expense.

Name String Name of the expense.

How Input Enum ExpenseBasis See ExpenseBasis.

Amount1 DateAmountPair list Amount 1 values over time. See DateAmountPair


structure.

Memo Bool A value indicating whether the expense is a memo.

Comment String Additional comments.

Capital Expense Export


This data represents capital expense data for a single account.

Property Name Data Type Comments

AccountNumber String Account number of the expense.

Name String Name of the expense.

How Input Enum ExpenseBasis See ExpenseBasis.

Amount1 DateAmountPair list Amount 1 values over time. See DateAmountPair


structure.

Memo Bool A value indicating whether the expense is a memo.

ProjectID String The External Project ID used to match imported data to


the existing record for the purposes of importing updated
information.

Comment String Additional comments.

33 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

GroupCode String Used to add the capital expense to an expense group.

VATRate Double The VAT rate for the capital expense.

Expense Basis
This represents a list of values for How Input.

Property Name Data Type Comments

How Input Enum Select from list:


• Amt1
• Amt1XAmt2
• AmtPerBldArea
• AmtPerOccArea
• AmtPerVacArea
• PctRentRev
• PctEffRent
• PctTotlInc
• PctOfOther
• AmtPerUnit
• PctSchdMultFamRev
• PctEffMultFamRev
• Sublines
• PctOfOtherXAmt2
• Prop13A
• Prop13B
• AmtPerOccRoomNt
• AmtPerUnOccRoomNt
• AmtPerRoom
• AmtPerArea
• PctOfRoomRev
• AmtPerAvailRoomNt

34 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Common XML Data Structure


This section describes the common structures used in both AEIX and AEEX formatted data.

Date Amount Pair


This represents a piece of data on a specific date.

Property Name Data Type Comments

Date DateTime The date the value applies from.

Amount Double The amount that applies to the date.

Date Amount Array


This represents a series of monthly data beginning on a specified date.

Property Name Data Type Comments

StartDate DateTime The date the amounts apply from.

Amounts Double list A list of consecutive monthly amounts from the start
date.

Custom Data
This represents custom data.

Property Name Data Type Comments

CustomType String Custom category type

CustomValue String Custom category value

35 ARGUS Software Confidential


XML Integration ARGUS Enterprise

ARGUS Data Service


The Data Service provides the ability to import and export property data and perform sensitivity analysis.

Web Service Data Structures and methods


The Data Integration Web Service contains a number of main contract interfaces:
1. Property Asset – Basic navigation calls for accessing Portfolios, Scenarios, and Property Assets.
2. Data Integration – Basic property data import and export in AEIX and AEEX formatted data.
3. Sensitivity Analysis – Calls that perform the same data retrieval and updates as the Sensitivity Analysis module of
ARGUS Enterprise 11.0.5.

General Contract Features


All contract method calls (operations) follow a set pattern. Each call takes one input structure and returns a single
output structure. The following sections will describe the method (operation) signatures, request and response
message structures, and data entity structures.

General Contract Features

Call Get<Operation>
e.g. GetPortfolios

Input Request parameter of data structure type Get<Operation>Request


e.g. GetPortfoliosRequest

Output Returns the data structure Get<Operation>Response


e.g. GetPortfolioResponse

Comments e.g. Does not take any parameters. Retrieves an array of Portfolio objects that represent the portfolios in the
system.

Property Asset Contract


This is the basic navigation calls for accessing Portfolios, Scenarios, and Property Assets.

Property Asset Contract

Call GetPortfolios

Input Request parameter of data structure type GetPortfolioRequest

Output Returns the data structure GetPortfolioResponse

Comments Does not take any parameters. Retrieves an array of Portfolio objects that represent the portfolios in the
system.

Call GetPortfolioScenarios

Input Request parameter of data structure type GetPortfolioScenariosRequest

Output Returns the data structure GetPortfolioScenariosResponse

36 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Asset Contract

Comments Takes a portfolio ID and retrieves an array of Scenario objects that represent the scenarios within that
portfolio.

Call GetScenariosWithPropertyAsset

Input Request parameter of data structure type GetScenariosWithPropertyAssetRequest

Output Returns the data structure GetScenariosWithPropertyAssetResponse

Comments Takes the external ID of a property asset and returns an array of Scenario objects that represent the
scenarios that contain that property.

Call GetScenarioProperties

Input Request parameter of data structure type GetScenarioPropertiesRequest

Output Returns the data structure GetScenarioPropertiesResponse

Comments Takes a scenario ID and retrieves an array of PropertyAsset objects that represent the property assets within
that scenario.

Call GetPropertyAssets

Input Request parameter of data structure type GetPropertyAssetsRequest

Output Returns the data structure GetPropertyAssetsResponse

Comments Takes an array of property asset IDs and retrieves an array of PropertyAsset objects.

Call CopyScenario

Input Request parameter of data structure type CopyScenarioRequest

Output Returns the data structure CopyScenarioResponse

Comments Takes the ID of the scenario to copy and the name of the new scenario to create, and queues a job to copy all
of the property assets from the given scenario into a new scenario with the given name. Returns the ID of the
newly created scenario, and the Id of the queued job that will process this request.

Call GetQueuedJobsSummariesForIntegration

Input Request parameter of data structure type GetQueuedJobsSummariesForIntegrationRequest

Output Returns the data structure GetQueuedJobsSummariesForIntegrationResponse

Comments Returns an array of QueuedJobsSummary objects that represent the set of queued jobs that meet the criteria
specified by the request parameters: the user who submitted the job, the status of the job, and a date range
within which the job was submitted.

Call GetQueuedJobsSummaryForIntegration

Input Request parameter of data structure type GetQueuedJobsSummaryForIntegrationRequest

37 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Asset Contract

Output Returns the data structure GetQueuedJobsSummaryForIntegrationResponse

Comments Takes the ID of a queued job and returns the corresponding QueuedJobsSummary object that represents that
job.

Call GetQueuedJobTasksForIntegration

Input Request parameter of data structure type GetQueuedJobTasksForIntegrationRequest

Output Returns the data structure GetQueuedJobTasksForIntegrationResponse

Comments Takes the ID of a queued job and returns an array of QueuedJobTask objects that represent the queued tasks
within that job.

Call GetFailedQueuedJobTasksForIntegration

Input Request parameter of data structure type GetFailedQueuedJobTasksForIntegrationRequest

Output Returns the data structure GetFailedQueuedJobTasksForIntegrationResponse

Comments Takes the ID of a queued job and returns an array of QueuedJobTask objects that represent the queued tasks
within that job that are in a failed state.

Call SaveCustomData

Input Request parameter of data structure type SaveCustomDataRequest

Output Returns the data structure SaveCustomDataResponse

Comments Imports custom data structure information into ARGUS Enterprise 11.0.5

Call ImportAVUXAssumptions

Input Request parameter of data structure type ImportAVUXAssumptionsDataRequest

Output Returns the data structure ImportAVUXAssumptionsDataResponse

Comments Imports a property asset input assumptions model and, optionally, the calculated results.

Call ExportAVUXAssumptions

Input Request parameter of data structure type ExportAVUXAssumptionsDataRequest

Output Returns the data structure ExportAVUXAssumptionsDataResponse

Comments Exports a property asset input assumptions model and, optionally, the calculated results.

38 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Data Integration Contract


This contract provides the ability for automated property data import and export which allow the same data to be
exchanged as can be exchanged via the ARGUS Enterprise 11.0.5 Import and Export ribbon options for AEIX and
AEEX formatted data.

Data Integration Contract

Call ExportAeexPropertyData

Input Request parameter of data structure type ExportAeexPropertyDataRequest

Output Returns the data structure ExportAeexPropertyDataResponse

Comments Exports data for specified property assets in the AEEX format. The AEEX format data structures described in a
previous section of this document provide a description of the property asset data that is exportable using
this data structure.

Call ExportAeixPropertyData

Input Request parameter of data structure type ExportAeixPropertyDataRequest

Output Returns the data structure ExportAeixPropertyDataResponse

Comments Exports data for specified property assets in the AEIX format. The AEEX format data structures described in a
previous section of this document provide a description of the property asset data that is exportable using
this data structure.

Call ImportAeixPropertyData

Input Request parameter of data structure type ImportAeixPropertyDataRequest

Output Returns the data structure ImportAeixPropertyDataResponse

Comments Imports data for specified property assets in the AEIX format. The AEIX format data structures described in a
previous section of this document provide a description of the property asset data that is importable using
this data structure.

Call ImportCustomData

Input Request parameter of data structure type ImportCustomDataRequest

Output Returns the data structure ImportCustomDataResponse

Comments Imports a simple custom data structure used by Argus Professional Services for storing asset related custom
data.

Call ValidateImportAeixPropertyData

Input Request parameter of data structure type ValidateImportAeixPropertyDataRequest

Output Returns the data structure ValidateImportAeixPropertyDataResponse

Comments Provides validation about a specific AEIX format ted structure to determine if there will be any problems
found when importing the data.

39 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Data Integration Contract

Call GetValidationRules

Input Request parameter of data structure type GetValidationRuleRequest

Output Returns the data structure GetValidationRulesResponse

Comments Does not take any parameters. Retrieves an array of ValidationResultDefinition objects that represent the
validation rules for import in the system.

Call GetChartsOfAccounts

Input Request parameter of data structure type GetChartsOfAccountsRequest

Output Returns the data structure GetChartsOfAccountsResponse

Comments Does not take any parameters. Retrieves an array of ChartOfAccounts objects that represents all the chart of
accounts in the system.

Call ValidateImportChartOfAccounts

Input Request parameter of data structure type ValidateImportChartOfAccountsRequest

Output Returns the data structure ValidateImportChartOfAccountsResponse

Comments Provides validation about a specific chart of account structure to determine if there will be any problems
found when importing the data.

Call ImportChartOfAccounts

Input Request parameter of data structure type ImportChartDataRequest

Output Returns the data structure ImportChartDataResponse

Comments Imports data for specified chart of account.

Call ExportChartOfAccounts

Input Request parameter of data structure type ExportChartDataRequest

Output Returns the data structure ExportChartDataResponse

Comments Export data for specified chart of account.

40 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Sensitivity Analysis Contract


These are calls that perform the same data retrieval and updates as the Sensitivity Analysis module of ARGUS
Enterprise 11.0.5.

Sensitivity Analysis Contract

Call ApplySensitivityChanges

Input Request parameter of data structure type ApplySensitivityChanges Request

Output Returns the data structure ApplySensitivityChangesResponse

Comments Takes an array of PropertyAssetChangeset objects that represent changes to be applied for sensitivity
analysis. Returns a collection of PropertyAssetChangesetResult objects that represent the result of each
property asset change request.

Call GetMarketLeasingForSenstivity

Input Request parameter of data structure type GetMarketLeasingForSenstivityRequest

Output Returns the data structure GetMarketLeasingForSenstivityResponse

Comments Takes an array of property asset IDs and retrieves an array of MarketLeasing objects that represent the
market leasing profiles.

Call GetLeasingForSensitivity

Input Request parameter of data structure type GetLeasingForSensitivity Request

Output Returns the data structure GetLeasingForSensitivityResponse

Comments Takes an array of property asset IDs and retrieves an array of Leasing objects that represent the tenant leases.

Call GetVacancyForSensitivity

Input Request parameter of data structure type GetVacancyForSensitivityRequest

Output Returns the data structure GetVacancyForSensitivityResponse

Comments Takes an array of property asset IDs and retrieves an array of Vacancy objects that represent the vacancy
allowances.

Call GetCreditLossForSensitivity

Input Request parameter of data structure type GetCreditLossForSensitivityRequest

Output Returns the data structure GetCreditLossForSensitivityResponse

Comments Takes an array of property asset IDs and retrieves an array of CreditLoss objects that represent the credit
losses.

Call GetInflationForSensitivity

Input Request parameter of data structure type GetInflationForSensitivityRequest

41 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Sensitivity Analysis Contract

Output Returns the data structure GetInflationForSensitivityResponse

Comments Takes an array of property asset IDs and retrieves an array of Inflation objects that represent the inflation
rates.

Call GetValuationForSensitivity

Input Request parameter of data structure type GetValuationForSensitivityRequest

Output Returns the data structure GetValuationForSensitivityResponse

Comments Takes an array of property asset IDs and retrieves an array of Valuation objects that represent the valuation
data.

Call GetExpenseForSensitivity

Input Request parameter of data structure type GetExpenseForSensitivityRequest

Output Returns the data structure GetExpenseForSensitivityResponse

Comments Takes an array of property asset IDs and retrieves an array of Expense objects that represent the capital
expenses.

Data Request/Response Messages


This section describes the request and response message structures provided by the Data Integration contracts.

RequestBase
The following base information is provided in all Request message structures.

Property Name Data Type Comments

Build string Expected Build number of currently executing web service. This should only be filled out
if the build number of ARGUS Enterprise 11.0.5 is known when the client interface
was built and deployed. It is a troubleshooting piece of information.

RequestId string A unique identifier (ideally a Guid) issued by the client representing the instance of the
request. Avoids rapid-fire processing of the same request over and over in denial-of-
service type attacks. Also used to troubleshoot by identifying specific messages in the
service log files.

Version string Minimum version number that client request is required to run under. This facilitates a
certain level of backward compatibility for when the web service API evolves.

42 ARGUS Software Confidential


XML Integration ARGUS Enterprise

ResponseBase
The following base information is provided in all Response message structures.

Property Name Data Type Comments

Build String Build number of currently executing web service. Used as an indicator to client
whether certain code fixes are included or not.

CorrelationId String CorrelationId returns the RequestId back to client.

Version String Version number (in major.minor format) of currently executing web service. Used to
offer a level of understanding (related to compatibility issues) between the client and
the web service as the web services evolve over time. Ebay.com uses this in their API.

Request Outcome enumeration

Member name Value Description

Failure 0 Represents a failed response.

Success 1 Represents a successful response.

Property Asset Contract Messages


This section describes the request and response message structures provided by the Property Asset contract
messages.
GetPortfoliosRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

This request does not contain any exposed properties.

GetPortfoliosResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

Portfolios Portfolio The list of portfolios

GetPortfolioScenariosRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PortfolioId Long The ID of the portfolio to retrieve scenarios for.

43 ARGUS Software Confidential


XML Integration ARGUS Enterprise

GetPortfolioScenariosResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

Scenarios Scenario The list of Scenario structures for the selected portfolio

GetScenariosWithPropertyAssetRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssetExternalId String The External ID for a Property Asset

GetScenariosWithPropertyAssetResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

Scenarios Scenario The list of Scenario structures that contain the PropertyAsset with the
requested External ID

GetScenarioPropertiesRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

ScenarioId Long The ID of the scenario to retrieve property assets for.

GetScenarioPropertiesResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssets PropertyAsset The list of PropertyAsset structures contained by the selected Scenario Id.

GetPropertyAssetsRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssetIds Long The list of PropertyAssetId’s to retrieve property assets for.

GetPropertyAssetsResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssets PropertyAsset The list of PropertyAsset returned

44 ARGUS Software Confidential


XML Integration ARGUS Enterprise

GetPropertyAssetsRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

ScenarioId Long The list of PropertyAssetId’s to retrieve property assets for.

GetPropertyAssetsResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssets PropertyAsset The list of PropertyAsset returned

ImportAVUXAssumptionsDataRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

ScenarioId Long The Scenario to import into

Data Byte The binary representation of the Avux data.

Overwrite OverwriteOptions The following enumerated values


NoOverwrite – Fail the import if a property asset with the same External
Id already exists in the target scenario.
Overwrite – Proceed with the import and overwrite.

ImportAVUXAssumptionsDataResponse
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

Overwrite OverwriteOptions The following enumerated values


NoOverwrite – Fail the import if a property asset with the same
External Id already exists in the target scenario.
Overwrite – Proceed with the import and overwrite.

QueuedJobId Int Id of the Queued Job that will apply the changes to the property asset
and re-calculate it.

QueuedTaskId Int Id of the Queued Task that will apply the changes to the property
asset and re-calculate it.

ResultMessage String The overall result message of the request to import property data.

45 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

SubmissionStatus ImportSubmissionStatus The following enumerated values


Submitted – Submitted for import
FailedValidation – Failed validation
Failed – Failed to submit due to a problem

ExportAVUXAssumptionsDataRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

ExportResults Bool The flag indicating whether calculated results are included in the export.

ExternalID String The ID used by external systems to identify the entity.

PropertyID Long The External ID (key) of the property asset.

ScenarioID Long The ID of the scenario that the property asset is related to.

ExportAVUXAssumptionsDataResponse
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

Data Byte The binary representation of the Avux data.

ResultMessage String The overall result message of the request to import property data.

Data Integration Contract Messages


This section describes the request and response message structures provided by the Data Integration contract
messages.
ExportAeexPropertyDataRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

Options ExportAeexProcessingOptions The Export Processing Options.

46 ARGUS Software Confidential


XML Integration ARGUS Enterprise

ExportAeexPropertyDataResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

ResultMessage String Overall result message of the request to export property


data.

Data XmlExportData The Aeex data being exported

ExportAeixPropertyDataRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

Options ExportAeixProcessingOptions The Export Processing Options.

ExportAeixPropertyDataResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

ResultMessage String Overall result message of the request to export property


data.

Data XmlImportData The Aeix data being exported

ImportAeixPropertyDataRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

ScenarioId Long The Scenario to import into

Data XmlImportData The Aeix data being imported

Options ImportAeixProcessingOptions The Import Processing Options.

ImportAeixPropertyDataResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyDataResults ImportAeixPropertyDataValidationResult The property data validation results for each


property data item that fails a validation check.

ResultMessage string The overall result message of the request to import


property data.

SubmissionStatus ImportSubmissionStatus The following enumerated values

47 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

Submitted – successfully submitted for processing


FailedValidation – failed validation
Failed - Failed to submit due a problem

ValidationRules ValidationResultDefinition A list of validation rules that help to interpret the


PropertyDataResults collection.

ValidateImportAeixPropertyDataRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

ScenarioId Long The Scenario to import into

Data XmlImportData The Aeix data being validated

Options ImportAeixProcessingOptions The Import Processing Options.

ValidateImportAeixPropertyDataResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyDataResults ImportAeixPropertyDataValidationResult The property data validation results for each


property data item that fails a validation check.

ResultMessage string The overall result message of the request to import


property data.

SubmissionStatus ImportSubmissionStatus The following enumerated values


Submitted – successfully submitted for processing
FailedValidation – failed validation
Failed - Failed to submit due a problem

ValidationRules ValidationResultDefinition A list of validation rules that help to interpret the


PropertyDataResults collection.

ImportCustomDataRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

CustomData CustomData The list of custom data items to be imported

ExternalId String External Property ID of the Property asset

48 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

PortfolioId Long Portfolio ID of the property [Obsolete – not


required]

Source Long Category Source

ImportCustomDataResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

RowCount Int Row Count of the custom data saved.

GetValidationRulesRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

This request does not contain any exposed


properties.

GetValidationRulesResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

Rules ValidationresultDefinition The list of default Validation rules for import.

GetChartsOfAccountsRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

This request does not contain any exposed properties.

GetChartsOfAccountsResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

Charts ChartOfAccounts The list of all the charts of accounts in the system.

49 ARGUS Software Confidential


XML Integration ARGUS Enterprise

ValidateImportChartOfAccountsRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

Options ImportChartOptions Import chart options are as follows:


- ImportAsOrderedList: If set to true it will use the
order in the collection to determine parent child
relationships. If False it will ignore the order in the
collection and instead use ParentAccount.
- AllowCreateChart: If set to true allows a new chart
of accounts to be created when the COA external id
does not match any existing COA external id in the
database. If set to false it will skip importing the chart
if it does NOT already exists.
- AllowUpdatechart: If set to true it will allow
overwriting an existing COA. If set to false and the
COA external id already exists in the database it will
skip importing the chart.
- ImportAccountPermissions: If set to true it will
import any permissions in the import data and
overwrite any existing permissions. If set to false it
will NOT be imported and existing permissions will be
left as is.

Data ChartOfAccounts Chart of accounts data to import.

ValidateImportChartOfAccountsResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

Action String Action that was taken for the overall chart of
accounts:
- Skip: nothing was imported. Check ActionText for
reason.
- Create: New chart of account was created
- Overwrite: Existing chart of account was
overwritten.

ActionText String If action was Skip this will provide the reason why.

ImportChartResults ImportAccountResult Provides detailed result Action and ActionText on


each individual account in the chart of accounts to be
imported. ActionText will be populated with the
reason an account would be skipped.

50 ARGUS Software Confidential


XML Integration ARGUS Enterprise

ImportChartDataRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

Options ImportChartOptions Import chart options are as follows:


- ImportAsOrderedList: If set to true it will use the
order in the collection to determine parent child
relationships. If False it will ignore the order in the
collection and instead use ParentAccount.
- AllowCreateChart: If set to true allows a new chart
of accounts to be created when the COA external id
does not match any existing COA external id in the
database. If set to false it will skip importing the
chart if it does NOT already exists.
- AllowUpdatechart: If set to true it will allow
overwriting an existing COA. If set to false and the
COA external id already exists in the database it will
skip importing the chart.
- ImportAccountPermissions: If set to true it will
import any permissions in the import data and
overwrite any existing permissions. If set to false it
will NOT be imported and existing permissions will
be left as is.

Data ChartOfAccounts Chart of accounts data to import.

ImportChartDataResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

Action String Action that was taken for the overall chart of
accounts:
- Skip: nothing was imported. Check ActionText for
reason.
- Create: New chart of account was created
- Overwrite: Existing chart of account was
overwritten.

ActionText String If action was Skip this will provide the reason why.

ImportChartResults ImportAccountResult Provides detailed result Action and ActionText on


each individual account in the chart of accounts to be
imported. ActionText will be populated with the
reason an account would be skipped.

51 ARGUS Software Confidential


XML Integration ARGUS Enterprise

ExportChartDataRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

Options ExportChartOptions Export chart options are as follows:


- ChartExternalID (optional): If populated it will be
used to find the chart of accounts to export.
- PortfolioID (optional): Will export the chart of
accounts associated with the PortfolioID.
Note: At least one of the above two values must be
provided. If both are provided then ChartExternalID
will be used.

ExportChartDataResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

Data ChartOfAccounts Chart of accounts export data.

Sensitivity Analysis Contract Messages


This section describes the request and response message structures provided by the Sensitivity Analysis contract
messages.
GetCreditLossForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssetIds Long The list of PropertyAssetId’s to retrieve credit loss data for.

GetCreditLossForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

CreditLossData CreditLoss The list of credit loss structures for the selected property
asset IDs.

GetExpenseForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssetIds Long The list of PropertyAssetId’s to retrieve expense data for.

52 ARGUS Software Confidential


XML Integration ARGUS Enterprise

GetExpenseForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

ExpenseData Expense The list of expense structures for the selected property
asset IDs.

GetInflationForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssetIds Long The list of PropertyAssetId’s to retrieve Inflation data for.

GetInflationForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

InflationData Inflation The list of Inflation structures for the selected property
asset IDs.

GetLeaseForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssetIds Long The list of PropertyAssetId’s to retrieve Lease data for.

GetLeaseForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

Lease Data Lease The list of Lease structures for the selected property asset
IDs.

GetMarketLeasingForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssetIds Long The list of PropertyAssetId’s to retrieve Market Leasing


data for.

53 ARGUS Software Confidential


XML Integration ARGUS Enterprise

GetMarketLeasingForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

MarketLeasing Data MarketLeasing The list of Market Leasing structures for the selected
property asset IDs.

GetVacancyForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssetIds Long The list of PropertyAssetId’s to retrieve Vacancy data for.

GetVacancyForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

Vacancy Data Vacancy The list of Vacancy structures for the selected property
asset IDs.

GetValuationForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssetIds Long The list of PropertyAssetId’s to retrieve Valuation data for.

GetValuationForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

ValuationData Valuation The list of Valuation structures for the selected property
asset IDs.

GetQueuedJobsSummariesForIntegrationRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

UserName String The name of the user who submitted the job. Used to
filter the queued jobs to return only the jobs submitted
by this user.

Statuses StatusTypes An array that contains the statuses of the jobs. Used to
filter the queued jobs to return only the jobs that are in
one of these statuses.

54 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

SubmittedStart DateTime The start date used to filter the queued jobs.

SubmittedEnd DateTime The end date used to filter the queued jobs.

GetQueuedJobsSummariesForIntegrationResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

JobSummaries QueuedJobsSummary The list of QueuedJobSummary structures for jobs that


matched the request filter criteria.

GetQueuedJobSummaryForIntegrationRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

JobId Int The ID of the specific queued job to retrieve.

GetQueuedJobSummaryForIntegrationResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

QueuedJobSummary QueuedJobsSummary The QueuedJobSummary structure that represents the


requested queued job.

GetQueuedJobTasksForIntegrationRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

JobId Int The ID of the specific queued job to retrieve the task
details for.

GetQueuedJobTasksForIntegrationResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

QueuedJobTasks QueuedJobTask The list of QueuedJobTask structures that represent the


tasks within the requested queued job.

55 ARGUS Software Confidential


XML Integration ARGUS Enterprise

GetFailedQueuedJobTasksForIntegrationRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

JobId Int The ID of the specific queued job to retrieve the failed task
details for.

GetFailedQueuedJobTasksForIntegrationResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

FailedTasks QueuedJobTask The list of QueuedJobTask structures that represent the


failed tasks within the requested queued job.

GetTraditionalValuationForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssetIds Long The list of PropertyAssetId’s to retrieve Traditional


Valuation data for.

GetTradtionalValuationForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

TraditionalValuation TraditionalValuation The list of Traditional Valuation structures for the selected
property asset IDs.

GetHotelRoomsForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssetIds Long The list of PropertyAssetId’s to retrieve Hotel Room data


for.

GetHotelRoomsForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

HotelRooms HotelRoom The list of Hotel Room structures for the selected property
asset IDs.

56 ARGUS Software Confidential


XML Integration ARGUS Enterprise

GetHotelRevenuesForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:

Property Name Data Type Comments

PropertyAssetIds Long The list of PropertyAssetId’s to retrieve Hotel Revenue


data for.

GetHotelRevenuesForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:

Property Name Data Type Comments

Revenues HotelRevenue The list of Hotel Revenue structures for the selected
property asset IDs.

57 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Data Structures
These are the data structures and sub structures used to construct the details of the request and response
messages described above.
NOTE: See the sections on AEIX Xml Data Structures and AEEX Xml Data Structure in the previous section of this
document for a description of the data being exchanged via these calls.

Portfolio
This Data structure represents the basic information associated with a Portfolio.

Editable via 3rd


Property Name Data Type party interface Comments

Id Long No The internal system ID of the portfolio.

Name String No The name of the portfolio.

Description String No The description of the portfolio.

BaseScenarioId Long No The internal system ID of this portfolio’s base


scenario.

ChartOfAccountExternalID String No External ID of the chart of account associated to


this portfolio. Can be empty.

ChartOfAccountName String No The name of the chart of account associated to


this portfolio. Can be empty.

IsDeleted Bool No Whether or not this portfolio has been marked


for deletion from the system.

LockType Enum (LockTypes) No The type of lock placed on this portfolio.

LockedByUser String No The name of the user who currently has a lock on
this portfolio. Null if the portfolio is not locked.

LockedTime DateTime No The date/time this portfolio was locked. Null if no


lock exists on the portfolio.

QueuedJobId Int No The ID of the queued job that has this portfolio
locked. Null if this portfolio is not locked for a job.

QueuedTaskId Int No The ID of the queued task that has this portfolio
locked. Null if this portfolio is not locked for a
task.

QueuedTaskType Enum No The type of the queued task that has this
(QueuedTaskTypes) portfolio locked. Null if this portfolio is not locked
for a task.

QueuedTaskDescription String No The description of the queued task that has this
portfolio locked. Null if this portfolio is not locked
for a task.

58 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Scenario
This Data structure represents the basic information associated with a Scenario.

Editable via 3rd


Property Name Data Type party interface Comments

Id Long No The internal system ID of the scenario.

PortfolioId Long No The internal system ID of the portfolio that


contains this scenario.

Name String No The name of the scenario.

Description String No The description of the scenario.

DefaultCurrencyCode String No The default currency code for the scenario.

DefaultAreaMeasure Enum (AreaMeasureBasis) No The default area measure for the scenario.

Category Enum No The category for the scenario. Can be null or


(ScenarioCategoryTypes) None if no category is set.

FXCurrencyScenarioName String No The name of the FX currency scenario


assigned to this scenario.

PropertyAssetCount Int No The number of property assets within this


scenario.

IsDeleted Bool No Whether or not this scenario has been


marked for deletion from the system.

LockType Enum (LockTypes) No The type of lock placed on this scenario.

LockedByUser String No The name of the user who currently has a lock
on this scenario. Null if the scenario is not
locked.

LockedTime DateTime No The date/time this scenario was locked. Null if


no lock exists on the scenario.

QueuedJobId Int No The ID of the queued job that has this


scenario locked. Null if this scenario is not
locked for a job.

QueuedTaskId Int No The ID of the queued task that has this


scenario locked. Null if this scenario is not
locked for a task.

QueuedTaskType Enum (QueuedTaskTypes) No The type of the queued task that has this
scenario locked. Null if this scenario is not
locked for a task.

QueuedTaskDescription String No The description of the queued task that has


this scenario locked. Null if this scenario is not
locked for a task.

59 ARGUS Software Confidential


XML Integration ARGUS Enterprise

PropertyAsset
This Data structure represents the basic information associated with a Property Asset.

Editable via 3rd


Property Name Data Type party interface Comments

Id Long No The internal system ID of the property asset.

ScenarioId Long No The internal system ID of the scenario that this


property asset belongs to.

Key Int No A unique identifier for this property asset defined


by the internal system.

ExternalID String No A unique identifier for this property asset defined


by external systems.

Name String No The name of the property asset.

Description String No The description of the property asset.

PropertyType Enum (PropertyType) No The property type of this property asset.

AnalysisBegin DateTime No The analysis begin date for this property asset.

AnalysisYears Int No The number of years in the analysis period for


this property asset.

AnalysisMonths Int No The number of months in the analysis period for


this property asset in addition to the number of
whole analysis years.

CurrencyCode String No The currency code used for this property asset.

ScenarioCurrency String No The default currency code set on this property’s


scenario.

AddressLine1 String No The first line of the address for this property
asset.

AddressLine2 String No The second line of the address for this property
asset.

City String No The city of the address for this property asset.

StateOrTerritory String No The state or territory of the address for this


property asset.

ZipOrPostalCode String No The zip or postal code of the address for this
property asset.

Country String No The country of the address for this property


asset.

60 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Editable via 3rd


Property Name Data Type party interface Comments

Comments String No The comments associated with this property


asset.

AreaMeasure Enum (AreaMeasureBasis) No The area measure type for this property asset.

ScenarioAreaMeasure Enum (AreaMeasureBasis) No The default area measure set on this property’s
scenario.

LockType Enum (LockTypes) No The type of lock placed on this property asset.

LockedByUser String No The name of the user who currently has a lock on
this property asset. Null if the property asset is
not locked.

LockedTime DateTime No The date/time this property asset was locked.


Null if no lock exists on the property asset.

QueuedJobId Int No The ID of the queued job that has this property
asset locked. Null if this property asset is not
locked for a job.

QueuedTaskId Int No The ID of the queued task that has this property
asset locked. Null if this property asset is not
locked for a task.

QueuedTaskType Enum (QueuedTaskTypes) No The type of the queued task that has this
property asset locked. Null if this property asset is
not locked for a task.

QueuedTaskDescription String No The description of the queued task that has this
property asset locked. Null if this property asset is
not locked for a task.

IsDeleted Bool No Whether or not this property asset has been


market for deletion from the system.

PropertyAssetChangeset
This data structure represents a collection of changes to a single property asset

Property Name Data Type Comments

PropertyAssetId Long The internal system ID of the property asset.

MarketLeasingChanges Array (MarketLeasingChangeItem) The collection of changes to make to the market


leasing profiles for this property asset.

LeasingChanges Array (LeasingChangeItem) The collection of changes to make to the leases for
this property asset.

61 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

VacancyChanges Array (VacancyChangeItem) The collection of changes to make to the vacancy


allowance for this property asset.

CreditLossChanges Array (CreditLossChangeItem) The collection of changes to make to the credit loss
for this property asset.

InflationChanges Array (InflationChangeItem) The collection of changes to make to the inflation


rates for this property asset.

ValuationChanges Array (ValuationChangeItem) The collection of changes to make to the valuation


data for this property asset.

ExpenseChanges Array (ExpenseChangeItem) The collection of changes to make to the capital


expenses for this property asset.

HotelRevenuesChanges Array (HotelRevenueChangeItem) The collection of changes to make to the hotel


revenue for the property asset.

HotelRoomsChanges Array (HotelRoomChangeItem) The collection of changes to make to the hotel rooms
for the property asset.

TradtionalValuationCha Array (TradtionalValuationChangeItem) The collection of changes to make to traditional


nges valuation for the property asset.

MarketLeasingChangeItem

Property Name Data Type Comments

Key Object The unique identifier that represents the item that
was changed.

Property Enum (MarketLeasingChangeItemProperty) The type of the property that was changed.

Value Object The new value.

LeasingChangeItem

Property Name Data Type Comments

Key Object The unique identifier that represents the item that
was changed.

Property Enum (LeasingChangeItemProperty) The type of the property that was changed.

Value Object The new value.

62 ARGUS Software Confidential


XML Integration ARGUS Enterprise

VacancyChangeItem

Property Name Data Type Comments

Key Object The unique identifier that represents the item that
was changed.

Property Enum (VacancyChangeItemProperty) The type of the property that was changed.

Value Array (DateAmountPair) The new value. See DateAmountPair structure.

CreditLossChangeItem

Property Name Data Type Comments

Key Object The unique identifier that represents the item that
was changed.

Property Enum (CreditLossChangeItemProperty) The type of the property that was changed.

Value Array (DateAmountPair) The new value. See DateAmountPair structure.

InflationChangeItem

Property Name Data Type Comments

Key Object The unique identifier that represents the item that
was changed.

Property Enum (InflationChangeItemProperty) The type of the property that was changed.

Value Array (DateAmountPair) The new value. See DateAmountPair structure.

ValuationChangeItem

Property Name Data Type Comments

Key Object The unique identifier that represents the item that
was changed.

Property Enum (ValuationChangeItemProperty) The type of the property that was changed.

Value Object The new value.

ExpenseChangeItem

Property Name Data Type Comments

Key Object The unique identifier that represents the item that
was changed.

Property Enum (ExpenseChangeItemProperty) The type of the property that was changed.

Value Object The new value.

63 ARGUS Software Confidential


XML Integration ARGUS Enterprise

HotelRevenueChangeItem

Property Name Data Type Comments

Key Object The unique identifier that represents the item that
was changed.

Property Enum (HotelRevenuesChangeItemProperty) The type of the property that was changed.

Value Object The new value.

HotelRoomChangeItem

Property Name Data Type Comments

Key Object The unique identifier that represents the item that
was changed.

Property Enum (HotelRoomChangeItemProperty) The type of the property that was changed.

Value Object The new value.

TraditionalValuationChangeItem

Property Name Data Type Comments

Key Object The unique identifier that represents the item that
was changed.

Property Enum The type of the property that was changed.


(TraditionalValuationChangeItemProperty)

Value Object The new value.

RowType Enum The type of the row that was changed.


(TradtionalValuationSensitivityRowType)

PropertyAssetChangesetResult

Property Name Data Type Comments

PropertyAssetId Long The internal system ID of the property asset.

QueuedJobId Long The ID of the queued job that is processing the


change request.

QueuedTaskId Long The ID of the queued task that is processing the


change request.

Result Enum (OperationResult) The type of the result of this change request.

ResultMessage String The message of the result of this change request.

64 ARGUS Software Confidential


XML Integration ARGUS Enterprise

MarketLeasing
Represents a single market leasing profile for a single property asset.

Editable via 3rd


Property Name Data Type party interface Comments

Key Int No A unique identifier used to locate this record


for update purposes.

PropertyAssetId Long No The internal system ID of the property asset.

PropertyAssetName String No The name of the property asset.

PropertyAssetExternalId String No A unique identifier for this property asset


defined by external systems.

AnalysisBeginDate DateTime No The analysis begin date for this property


asset.

Description String No The name of the market lease profile.

MarketRate Double Yes The value of the new market rate at the time
of the property’s analysis begin date.

MarketRateType Enum (BaseRentBasis) No The type of the market rate.

RentSteps Double Yes The first non-zero rent step defined in this
market lease profile.

StepType Enum (SteppedIncreaseBasis) Yes The type of the rent steps.

FreeRentNew Double Yes The number of free rent months for new
tenants at the time of the property’s analysis
begin date.

FreeRentRenew Double Yes The number of free rent months for renewing
tenants at the time of the property’s analysis
begin date.

TINew Double Yes The tenant improvement amount for new


tenants at the time of the property’s analysis
begin date.

TIRenew Double Yes The tenant improvement amount for


renewing tenants at the time of the
property’s analysis begin date.

LeaseTerm Int Yes The lease term, in months.

MonthsVacant Double Yes The number of vacant months.

RenewalPercent Double Yes The probability that the lease will be


renewed.

65 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Vacancy
Represents the vacancy allowance for a single property asset.

Editable via 3rd


Property Name Data Type party interface Comments

Key Long No A unique identifier used to locate this


record for update purposes.

PropertyAssetId Long No The internal system ID of the property


asset.

PropertyAssetName String No The name of the property asset.

PropertyAssetExternalId String No A unique identifier for this property


asset defined by external systems.

AnalysisBeginDate DateTime No The analysis begin date for this property


asset.

AnalysisYears Int No The number of years in the analysis


period for this property asset.

CalculationMethod Enum (VacancyOrCreditLossBasis) No The calculation method for this vacancy


item.

Input Array (DateAmountPair) Yes The annual vacancy amounts. See


DateAmountPair structure.

CreditLoss
Represents the credit loss for a single property asset.

Editable via 3rd


Property Name Data Type party interface Comments

Key Long No A unique identifier used to locate this


record for update purposes.

PropertyAssetId Long No The internal system ID of the property


asset.

PropertyAssetName String No The name of the property asset.

PropertyAssetExternalId String No A unique identifier for this property asset


defined by external systems.

AnalysisBeginDate DateTime No The analysis begin date for this property


asset.

AnalysisYears Int No The number of years in the analysis


period for this property asset.

CalculationMethod Enum (VacancyOrCreditLossBasis) No The calculation method for this credit


loss item.

66 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Editable via 3rd


Property Name Data Type party interface Comments

Input Array (DateAmountPair) Yes The annual credit loss amounts. See
DateAmountPair structure.

Inflation
Represents a single inflation rate for a single property asset.

Editable via 3rd


Property Name Data Type party interface Comments

Key Int No A unique identifier used to locate this


record for update purposes.

PropertyAssetId Long No The internal system ID of the property


asset.

PropertyAssetName String No The name of the property asset.

PropertyAssetExternalId String No A unique identifier for this property asset


defined by external systems.

AnalysisBeginDate DateTime No The analysis begin date for this property


asset.

AnalysisYears Int No The number of years in the analysis


period for this property asset.

Name String No The name of this inflation rate item.

SortOrder Int No The system sort order for this inflation


rate item.

Rates Array (DateAmountPair) Yes The annual inflation rate amounts. See
DateAmountPair structure.

67 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Leasing
Represents a single tenant lease for a single property asset.

Editable via 3rd


Property Name Data Type party interface Comments

Key Int No A unique identifier used to locate this


record for update purposes.

PropertyAssetId Long No The internal system ID of the property


asset.

PropertyName String No The name of the property asset.

ExternalId String No A unique identifier for this property


asset defined by external systems.

AnalysisBeginDate DateTime No The analysis begin date for this property


asset.

Suite String No The suite identifier of the leased space.

TenantName String No The name of the tenant.

Area Double No The area of the leased space.

TenantType Enum (TenantType) No The type of the tenant lease.

LeaseBeginDate DateTime Yes The begin date of the lease.

LeaseTerm Int Yes The term of the lease in months.

TermMode Enum (LeaseTermMode) No The method of determining the lease


end date.

InitialRent Double Yes The initial rent at the time of the


property’s analysis begin date.

InitialRentType Enum (BaseRentBasis) No The unit of the defined base rent.

FreeRent Double Yes The number of free rent months at the


time of the property’s analysis begin
date.

RentSteps Double Yes The first non-zero rent step defined in


this lease.

StepType Enum (SteppedIncreaseBasis) Yes The type of the rent steps.

TI Double Yes The tenant improvement at the time of


the property’s analysis begin date.

TIType Enum (TIBasis) No The unit of the defined tenant


improvement.

68 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Valuation
Represents the valuation for a single property asset.

Editable via 3rd


Property Name Data Type party interface Comments

PropertyAssetId Long No The internal system ID of the property


asset.

PropertyName String No The name of the property asset.

PropertyId String No A unique identifier for this property asset


defined by external systems.

SaleCalculationMethod Enum (SaleCalcBasis) No How the sale price will be determined.

SaleCalculationMethodPercent Double Yes Percent value applied to the selected sale


calculation method.

CapMultiplier Double Yes A value representing the capitalization


multiplier.

SellingCostPct Double Yes Selling cost percentage of valuation.

ValuationDate DateTime Yes Date of valuation for the property.

SaleDate DateTime Yes Sale Date of the property for valuation.

HoldPeriod Double No Number of years this property is held.

DiscountRate Double Yes Discount Rate of the valuation.

Expense
Represents a single capital expense for a single property asset.

Editable via 3rd


Property Name Data Type party interface Comments

Key Int No A unique identifier used to locate this


record for update purposes.

PropertyAssetId Long No The internal system ID of the property


asset.

PropertyName String No The name of the property asset.

PropertyId String No A unique identifier for this property asset


defined by external systems.

ExpenseName String No The name of the expense.

HowInput Enum (ExpenseBasis) No How the expense is incurred.

69 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Editable via 3rd


Property Name Data Type party interface Comments

Amount1 String No A single expense amount, or “Varies” if


the expense amount changes over time.

PeriodBasis Enum (PeriodBasis) No The frequency period of the expense.

HotelRevenue
Represents the hotel revenue for a single property asset.

Editable via 3rd


Property Name Data Type party interface Comments

PropertyAssetId Long No The internal system ID of the property


asset.

PropertyName String No The name of the property asset.

PropertyId String No A unique identifier for this property asset


defined by external systems.

Key Int No A unique identifier used to locate this


record for update purposes.

RevenueName String No The name of the revenue.

HowInput Enum (RevenueBasis) No How the revenue is incurred.

Amount1 String No A single revenue amount, or “Varies” if


the revenue amount changes over time.

PeriodBasis Enum (PeriodBasis) No The frequency period of the revenue.

Category Enum No Specifies the revenue type.


(RevenueCategoryType)

HotelRoom
Represents the hotel room for a single property asset.

Editable via 3rd


Property Name Data Type party interface Comments

PropertyAssetId Long No The internal system ID of the property


asset.

PropertyName String No The name of the property asset.

PropertyId String No A unique identifier for this property


asset defined by external systems.

70 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Editable via 3rd


Property Name Data Type party interface Comments

Key Int No A unique identifier used to locate this


record for update purposes.

RoomTypeDescription String No Description of the room type.

AverageDailyRate String No The average daily rate for the room.

AdrAmtAdjustmentBasis Enum (HotelRoomADRBasis) No Describes the different ways that


average daily rate can be
input/calculated.

AdrAdjustAmt Double No The adjustment amount for the


average daily rate.

Occupancy String No The occupancy for the room.

OccupancyAmtAdjustmentBasis Enum No Describes the different ways that


(HotelRoomOccupancyBasis) occupancy can be input/calculated.

OccupancyAmtAdjustment Double No The occupancy adjustment amount.

TraditionalValuation
Represents the traditional valuation for a single property asset.

Editable via 3rd


Property Name Data Type party interface Comments

PropertyAssetId Long No The internal system ID of the property


asset.

Identifier Int No A unique identifier used to locate this


record for update purposes.

PropertyName String No The name of the property asset.

ExternalId String No A unique identifier for this property


asset defined by external systems.

Suite String No The suite identifier of the leased


space.

DisplayedName String No The displayed name.

YieldKey Int No The yield key.

CapGroupCategories String No A list representing the different cap


group categories.

ResaleCapGroupCategories String No A list representing the different resale


cap group categories.

71 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Editable via 3rd


Property Name Data Type party interface Comments

YieldName String No The yield name.

CapGroup String No A value representing a cap group.

CapGroupId Int No A value representing the cap group id.

RowType Enum No Defines the basis for the traditional


(TraditionalValuationSensitiv valuation row type.
ityRowType)

Method Enum No Defines the basis for Capitalization


(CapitalizationMethodBasis) Method.

HardcoreTermRate Double No The hardcore term rate.

MarginalReversionRate Double No A value representing a marginal


reversion rate.

FrothRate Double No A value representing a marginal froth


rate.

YieldIsPrivate Bool No A value representing whether the yield


is private or not.

FutureCostsDiscRate Double No A value representing the future


dicounted costs.

FutureCostsDiscRateBasis Enum No Defines the property level 'traditional


(TradValFutureCostsDiscRate valuation future costs' discount rate
Basis) basis.

ResaleCapGroup String No A value representing a resale cap


group.

ResaleCapGroupId Int No A value representing a resale cap


group id.

DateAmountPair
Represents an amount as of a date.

Editable via 3rd


Property Name Data Type party interface Comments

Date DateTime Yes The date on which the associated value


occurs.

Amount Double Yes The value on the associated date.

72 ARGUS Software Confidential


XML Integration ARGUS Enterprise

QueuedJobsSummary
Represents a summary view of a queued job.

Editable via 3rd


Property Name Data Type party interface Comments

Id Int No The ID of the queued job.

Description String No The description of the queued job.

JobStatus Enum (StatusTypes) No The current status of the job.

SubmissionTime DateTime No The time at which the job was submitted.

SubmittedByUser String No The name of the user who submitted the


job.

TaskCount Int No The total number of tasks in the job.

CreatedCount Int No The number of tasks in the job that are in


a Created state.

QueuedCount Int No The number of tasks in the job that are in


a Queued state.

ProcessingCount Int No The number of tasks in the job that are in


a Processing state.

CompleteCount Int No The number of tasks in the job that are in


a Complete state.

WarningCount Int No The number of tasks in the job that are in


a Warning state.

ErrorCount Int No The number of tasks in the job that are in


an Error state.

FailedCount Int No The number of tasks in the job that are in


a Failed state.

ExpiredCount Int No The number of tasks in the job that are in


an expired state.

QueuedJobTasks
Represents a single task within a queued job.

Editable via 3rd


Property Name Data Type party interface Comments

Id Int No The ID of the queued task.

QueuedJobId Int No The ID of the queued job that this task


belongs to.

73 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Editable via 3rd


Property Name Data Type party interface Comments

TaskType Enum No The type of the task.


(QueuedTaskTypes)

Description String No The description of the task.

Status Enum (StatusTypes) No The current status of the task.

Order Byte No The order in which this task should be


performed, respective to all other tasks
in the job.

StartProcessingTime DateTime No The time at which the job was picked up


for processing.

EndProcessingTime DateTime No The time at which the job completed


processing.

ExportAeexProcessingOptions
Represents the processing options selected when exporting AEEX formatted data.

Property Name Data Type Comments

PropertyAssetIds PropertyAsset The property assets to export.

ProcessUsingScenarioSettings bool Use the scenario or property currency and area measures.

ProcessActualsData bool Process or ignore the actuals data.

ProcessBudgetData bool Process or ignore the budget data.

ProcessResultData bool Process or ignore the forecast data.

ProcessOperatingExpenseData bool Process or ignore the operating expense data.

ProcessCapitalExpenseData bool Process or ignore the capital expense data.

ProcessClassificationData bool Process or ignore the classifications data.

UsePropertyDates bool Use the property dates when exporting data ranges or use
the provided begin date and number of months.

DataBeginDate bool The begin date if data is to be exported using common dates.

NumMonths bool The number of months of data to export when exporting a


common date range of data.

ProcessingData bool Ignore. Future use.

74 ARGUS Software Confidential


XML Integration ARGUS Enterprise

ExportAeixProcessingOptions
Represents the processing options selected when exporting AEIX formatted data.

Property Name Data Type Comments

PropertyAssetIds PropertyAsset The property assets to export.

ProcessUsingScenarioSettings bool Use the scenario or property currency and area measures.

ProcessActualsData bool Process or ignore the actuals data.

ProcessBudgetData bool Process or ignore the budget data.

ProcessForecastData bool Process or ignore the forecast data.

ProcessOperatingExpenseData bool Process or ignore the operating expense data.

ProcessCapitalExpenseData bool Process or ignore the Tenant data.

ProcessTenantData bool Process or ignore the classifications data.

ProcessClassificationData bool Process or ignore the classifications data.

UsePropertyDates bool Use the property dates when exporting data ranges or use
the provided begin date and number of months.

DataBeginDate bool The begin date if data is to be exported using common


dates.

NumMonths bool The number of months of data to export when exporting a


common date range of data.

ProcessingData bool Ignore. Future use.

ProcessNonOperatingExpenseData bool Process or ignore the non-operating expense data.

ProcessOtherDebtData bool Process or ignore the other debt data.

ProcessExpenseGroupData bool Process or ignore the expense group data.

ProcessTenantGroupData bool Process or ignore the tenant group data.

ProcessRecoveryStructureData bool Process or ignore the tenant group data.

BaseRentDataExportBasis Enum Process rent schedule entries using the legacy export or not.
(BaseRentDataExportBasis)

75 ARGUS Software Confidential


XML Integration ARGUS Enterprise

ImportAeixProcessingOptions
Represents the processing options selected when importing AEIX formatted data.

Property Name Data Type Comments

ProcessActualsData bool Process or ignore the actuals data.

ProcessBudgetData bool Process or ignore the budget data.

ProcessForecastData bool Process or ignore the forecast data.

ProcessOperatingExpenseData bool Process or ignore the operating expense data.

ProcessCapitalExpenseData bool Process or ignore the Tenant data.

ProcessTenantData bool Process or ignore the classifications data.

ProcessClassificationData bool Process or ignore the classifications data.

ProcessNonOperatingExpenseData bool Process or ignore the non-operating expense data.

ProcessOtherDebtData bool Process or ignore the other debt data.

ProcessExpenseGroupsData bool Process or ignore the expense groups data.

ProcessTenantGroupsData bool Process or ignore the tenant groups data.

ProcessRecoveryStructuresData bool Process or ignore the recovery structures data.

MissingReferenceError Enum Determines how the system will handle missing reference
(MissingReferenceError) errors.

DoCalcOnComplete bool Whether to perform a calculation when the import is


complete.

ImportAeixPropertyDataValidationResult
Provides the validation results for a single property data import request.

Property Name Data Type Comments

PropertyDataIndex int The index into the original XmlImportData message to match
the response with the request.

PropertyId string The external ID to match the response with the request.

PropertyName string The property name to match the response with the request.

QueuedJobId long The ID of the Queued Job that will apply the changes to the
property asset and re-calculate it.

QueuedTaskId long The ID of the Queued Task that will apply the changes to the
property asset and re-calculate it.

76 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

ResultMessage string The overall result message of the request to import property
data.

SubmissionStatus ImportSubmissionStatus The following enumerated values


Submitted – successfully submitted for processing
FailedValidation – failed validation
Failed - Failed to submit due a problem

ValidationResults ValidationResultItem The validation results for this property data item.

ValidationResultDefinition
Represents a validation definition for an AEIX formatted import data item.

Property Name Data Type Comments

DataType ImportValidationResultDataType Data type the validation definition applies to


• XmlImportData
• Property
• Actuals
• Budget
• Forecast
• Tenant
• OperatingExpense
• CapitalExpense
• NonOperatingExpense
• OtherDebt
• ExpenseGroup
• TenantGroup
• RecoveryStructure

DataTypeText String Textual representation of the data type.

DefaultAction ImportValidationResultAction The default action to be taken if this type of validation


condition is met
• NoAction
• AbortProcess
• SkipProperty
• AddProperty
• UpdateProperty
• SkipRecord
• AddRecord
• UpdateRecord
• NetAccountEntries
• UseLastAccountEntry
• UpdatePropertyName
• IgnoreChange

77 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

DefaultActionText String Textual representation of the action.

ResultType ImportValidationResultType Result type of validation


• HeaderRow
• InvalidXml
• PropertyDoesNotExistInScenario
• PropertyExistsInScenario
• PropertyIsLocked
• MissingID
• DuplicateID
• MissingName
• MissingAccountNumber
• DuplicateAccountNumber
• CurrencyCodeChanged
• DuplicateIDPendingDelete
• NoEditPermissionsToAsset
• MissingCode
• InvalidRentEntryType
• InvalidRentEntryUnit

ResultTypeText String Textual representation of the result type.

ValidActions ImportValidationResultAction List of valid actions that apply to this type of


validation.

ValidActionText String Textual representation of the valid actions.

Visible Bool Whether the validation is active/visible.

78 ARGUS Software Confidential


XML Integration ARGUS Enterprise

ValidationResultItem

Property Name Data Type Comments

Action ImportValidationResultAction The import action that will be taken as a result of the
validation
• NoAction
• AbortProcess
• SkipProperty
• AddProperty
• UpdateProperty
• SkipRecord
• AddRecord
• UpdateRecord
• NetAccountEntries
• UseLastAccountEntry
• UpdatePropertyName
• IgnoreChange

ActionText string Textual representation of the action.

DataType ImportValidationResultDataType The data type of the validated item


• XmlImportData
• Property
• Actuals
• Budget
• Forecast
• Tenant
• OperatingExpense
• CapitalExpense
• NonOperatingExpense
• OtherDebt
• ExpenseGroup
• TenantGroup
• RecoveryStructure

DataTypeText string Textual representation of the data type.

PropertyId string The External ID for the property.

PropertyIndex Int The index of the property data in the XmlImportData


properties collection. Used to tie the validation
results item back to a specific Property Data.

PropertyName string The human readable name for the property asset.

RecordId String An identification of the record validated e.g. Lease ID,


Account Number, etc.

RecordId2 String A secondary identification e.g. External ID, Suite.

79 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

RecordIndex Int The index of the validated record within a sub


structure of the Property Data.

RecordName String The name of the record validated e.g. Tenant Name,
Property Name, etc.

ResultType ImportValidationResultType The result type of the validation


• HeaderRow
• InvalidXml
• PropertyDoesNotExistInScenario
• PropertyExistsInScenario
• PropertyIsLocked
• MissingID
• DuplicateID
• MissingName
• MissingAccountNumber
• DuplicateAccountNumber
• CurrencyCodeChanged
• DuplicateIDPendingDelete
• NoEditPermissionsToAsset
• MissingCode
• InvalidRentEntryType
• InvalidRentEntryUnit

ResultTypeText String Textual representation of the result type.

ValidationRuleOverride
Represents a validation rule override for an AEIX formatted import data item.

Property Name Data Type Comments

DataType ImportValidationResultDataType Data type the validation definition applies to


• XmlImportData
• Property
• Actuals
• Budget
• Forecast
• Tenant
• OperatingExpense
• CapitalExpense
• NonOperatingExpense
• OtherDebt
• ExpenseGroup
• TenantGroup
• RecoveryStructure

80 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

DefaultAction ImportValidationResultAction The default action to be taken if this type of


validation condition is met
• NoAction
• AbortProcess
• SkipProperty
• AddProperty
• UpdateProperty
• SkipRecord
• AddRecord
• UpdateRecord
• NetAccountEntries
• UseLastAccountEntry
• UpdatePropertyName
• IgnoreChange

ResultType ImportValidationResultType Result type of validation


• HeaderRow
• InvalidXml
• PropertyDoesNotExistInScenario
• PropertyExistsInScenario
• PropertyIsLocked
• MissingID
• DuplicateID
• MissingName
• MissingAccountNumber
• DuplicateAccountNumber
• CurrencyCodeChanged
• DuplicateIDPendingDelete
• NoEditPermissionsToAsset
• MissingCode
• InvalidRentEntryType
• InvalidRentEntryUnit

ChartOfAccounts
Represents a chart of accounts for import/export.

Property Name Data Type Comments

Name String Name of the chart of accounts

ExternalID String External ID for the chart of accounts

Description String Description for the chart of accounts

81 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

IsActive Bool Determines if the chart of accounts is


active/inactive

LastModifiedTime DateTime Last modified date/time. For informational


purposes only. I cannot be updated.

Accounts Account List of accounts on this chart of accounts

Account
Represents an account on a chart of accounts.

Property Name Data Type Comments

AccountNumber String Account Number

ParentAccountNumber String • Parent account number of this account


• If this account is an Account or Detail level
account AND you are importing with
ImportAsOrderedList option set to True
then you MUST provide this value.
Otherwise it is optional.

AccountLevel String Valid values:


• Header
• Account
• Detail

Header has no parents.


Account is expected to have a Header parent.
Detail is expected to have a Detail parent.
Detail cannot have any children.

Description String Account description

Class String Class of account.


• Undefined
• Revenue
• Expense
• Asset
• Liability
• Equity

82 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Property Name Data Type Comments

LineItemType String See the end of this document for the list.

CostCodeType String Cost Code Types:


• Undefined
• OpEx
• CapEx
• Revenue
• Tenant
• Recovery
• Miscellaneous
• Property
• NonOpEx
• OtherDebt
• GroundLease

Permission String Must be a user or group already defined in AE.

Status String Status:


• Active
• Inactive

Result ImportAccountResult Specific import result for this account.

ImportAccountResult
Represents an import account result on a chart of accounts.

Property Name Data Type Comments

AccountNumber String Account Number

AccountDescription String Description of the account

Action String Actions:


• Skip
• Create
• Overwrite

ActionText String Why action was skip.

83 ARGUS Software Confidential


XML Integration ARGUS Enterprise

ImportChartOptions
Represents import chart options

Property Name Data Type Comments

ImportAsOrderedList Bool If set to true it will use the order in the


collection to determine parent child
relationships. If False it will ignore the order in
the collection and instead use ParentAccount.

AllowCreateChart Bool If set to true allows a new chart of accounts to


be created when the COA external id does not
match any existing COA external id in the
database. If set to false it will skip importing
the chart if it does NOT already exists.

AllowUpdateChart Bool If set to true it will allow overwriting an


existing COA. If set to false and the COA
external id already exists in the database it will
skip importing the chart.

ImportAccountPermissions Bool If set to true it will import any permissions in


the import data and overwrite any existing
permissions. If set to false it will NOT be
imported and existing permissions will be left
as is.

ExportChartOptions
Represents export chart options

Property Name Data Type Comments

ChartExternalID string External ID for the chart of accounts to export.

PortfolioID Long Export the chart of accounts associated with


this Portfolio ID.

Accessing the Data Service Interface


This section describes how to discover and make use of the web service interface, referred to as the “Data
Integration Service”.
Installing the Data Integration Service
The Data Integration Service is installed as part of the Argus Enterprise Server installation components.

84 ARGUS Software Confidential


XML Integration ARGUS Enterprise

As with the Argus Enterprise Application Service, the Data Integration Service is installed as a Windows Service by
default. It can be configured using the Argus Enterprise Configuration Utility in the same way as the Application
Service.
Data Integration Service Versions
As Argus Enterprise evolves there will be times where changes will be made that breaks the existing data service
contracts. When this happens a new version of the data service will be exposed at a new endpoint. The existing
endpoints of the older deprecated contracts will continue to work for at least one additional release of AE, but it is
encouraged that you upgrade your application that is consuming these services to the latest version to take
advantage of the latest features. You will have to update any service references (if using a dot net client) pointing
to the new endpoint. Also, be careful of any entity changes and especially enumeration changes.
The naming convention for the endpoints are as follows:
http://yourservername:port/dataservice.svc
http://yourservername:port/dataserviceV2.svc
etc.
http://yourservername:port/dataserviceVX.svc (where X = future versions)
Examples:
For Argus Enterprise 10.5.x: http://localhost:8203/dataservice.svc
For Argus Enterprise 10.6.x and up: http://localhost:8203/dataserviceV2.svc
We also expose mex endpoints. As a best practice you should remove these endpoints from your production
environment:
For Argus Enterprise 10.5.x: http://localhost:8203/dataservice.svc/mex
For Argus Enterprise 10.6.x and up: http://localhost:8203/dataserviceV2.svc/mex
For WSDL please make sure you first manually change the httpGetEnabled=”true” in the configuration file in your
development environment.
<behaviors>
<serviceBehaviors>
<behavior name="behaviorAction">
<!-- for HTTP, set this to true in dev environment -->
<serviceMetadata httpGetEnabled="true" />

85 ARGUS Software Confidential


XML Integration ARGUS Enterprise

<serviceDebug includeExceptionDetailInFaults="true" />


<dataContractSerializer maxItemsInObjectGraph="2147483647" />
</behavior>
</serviceBehaviors>
</behaviors>
For Argus Enterprise 10.5.x: http://localhost:8203/dataservice.svc?wsdl
For Argus Enterprise 10.6.x and up: http://localhost:8203/dataserviceV2.svc?wsdl
Aeix and Aeex xml files are not guaranteed to work with other data service versions other than the version used to
generate those files. Ensure version consistency when working with these files. The Argus Enterprise client
application will always be using the latest version.
NOTE: The rest of the documentation and screenshots will refer to the latest version of the data services
(dataserviceV2.svc) but it applies to all previous versions; just substitute the endpoint address with an earlier
version.

86 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Connecting to the Data Integration Service


There are two protocols available for connecting to the Data Integration Service: HTTP and TCP. Use the Argus
Enterprise Configuration Utility to select the desired connection protocol.
Note that ports can be shared for the same protocol across different versions of the service as noted by the
defaults used in the configuration utility:

Discovering the Data Integration Service


The Data Integration Service provides a WSDL and set of XSD files that define its operations and structure. To
access this information, the Data Integration Service will need to have the server endpoint set to HTTP. This can be
done using the Argus Enterprise Configuration Utility.
Also, the HttpGetEnabled property under the Data Integration Service configuration file will need to be set to true.
The configuration file - Argus.DataService.WinSvcHost.exe.config, is typically saved in C:\Program Files
(x86)\ARGUS Software\ARGUS Enterprise 10.x.x.x\Data Service depending on what path was selected during the
installation.

87 ARGUS Software Confidential


XML Integration ARGUS Enterprise

You can then navigate to the web service using a browser. The URL will be
http://yourservername:port/dataservice.svc. For example, http://localhost:8203/dataservice.svc. You should see a
screen similar to:

To access the WSDL, add ?wsdl to the end of the URL, for example http://localhost:8203/dataservice.svc?wsdl.
Within the resulting WSDL file, there is a section labeled wsdl:types. This section contains the links to the
associated XSDs.

You can follow each of the links defined in the schemaLocation to retrieve the XSD file. For example,
http://localhost:8203/dataservice.svc?xsd=xsd0.

88 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Using the Data Integration Service


This example assumes the Data Integration Service will be consumed by a .NET Windows Application. In your .NET
project, right-click on the References folder and select Add Service Reference…

In the Address bar, type in the URL of the installed Data Integration Service, for example
http://localhost:8203/dataservice.svc. Click the Go button. The service will appear in the Services list. Set the
Namespace to something appropriate for your project, and then click OK.

Note: If unable to find the service, make sure the HttpGetEnabled property under the Data Integration Service
configuration file is set to true. See Discovering the Data Integration Service section above for more information.

This will automatically discover the web service and generate the necessary files. In the References folder, you will
now see a Service References subfolder that contains the reference to the Data Integration Service.

89 ARGUS Software Confidential


XML Integration ARGUS Enterprise

The Data Integration Service is now ready to be accessed in the application code. For example:

DataIntegrationService.DataServiceClient svcClient = null;

public void OpenDataService()


{
svcClient = new DataIntegrationService.DataServiceClient();
svcClient.Open();
}

public void CloseDataService()


{
svcClient.Close();
}

public DataIntegrationService.Scenario[] GetScenariosInPortfolio(string portfolioName)


{
DataIntegrationService.GetPortfoliosRequest pRequest = new DataIntegrationService.GetPortfoliosRequest();
pRequest.RequestId = Guid.NewGuid().ToString();

DataIntegrationService.GetPortfoliosResponse pResponse = svcClient.GetPortfolios(pRequest);


DataIntegrationService.Portfolio[] allPortfolios = pResponse.Portfolios;

if (allPortfolios.Length > 0)
{
long portfolioId = allPortfolios.Where(x => x.Name == portfolioName).First().Id;

DataIntegrationService.GetPortfolioScenariosRequest sRequest = new


DataIntegrationService.GetPortfolioScenariosRequest();
sRequest.RequestId = Guid.NewGuid().ToString();
sRequest.PortfolioId = portfolioId;

90 ARGUS Software Confidential


XML Integration ARGUS Enterprise

DataIntegrationService.GetPortfolioScenariosResponse sResponse = svcClient.GetPortfolioScenarios(sRequest);


DataIntegrationService.Scenario[] scenarios = sResponse.Scenarios;
return scenarios;
}
else
return new DataIntegrationService.Scenario[0];
}

Some suggested configuration changes to improve performance and ability to handle larger data transfers:

1. Replace the wsHttpBinding binding element with the settings below


<bindings>
<wsHttpBinding>
<binding name="ServiceHTTP" closeTimeout="00:01:00" openTimeout="00:01:00" receiveTimeout="01:10:00"
sendTimeout="00:01:00" bypassProxyOnLocal="false" transactionFlow="false"
hostNameComparisonMode="StrongWildcard" maxBufferPoolSize="2147483647"
maxReceivedMessageSize="2147483647" messageEncoding="Text" useDefaultWebProxy="true"
allowCookies="false">
<reliableSession ordered="true" inactivityTimeout="00:10:00" enabled="true"/>
<security mode="Message">
<transport clientCredentialType="Windows" proxyCredentialType="None" realm=""/>
<message clientCredentialType="Windows" negotiateServiceCredential="true" algorithmSuite="Default"/>
</security>
</binding>
</wsHttpBinding>
</bindings>
2. Add an endpointBehaviors element under the system.serviceModel section

<behaviors>
<endpointBehaviors>
<behavior name="ServiceViewEventBehavior">
<dataContractSerializer maxItemsInObjectGraph="2147483647"/>
</behavior>
</endpointBehaviors>
</behaviors>

91 ARGUS Software Confidential


XML Integration ARGUS Enterprise

Line Item Types for Chart of Accounts Import


• Adjusted Gross Sale Price
• All Financing
• Annualized Base + Step + CPI
• Annualized Free Rent
• Applied Capital Expense
• Applied Non-Operating Expense
• Applied Operating Expense
• Applied Other Revenue
• Applied Parking Revenue
• Applied Storage Revenue
• Asset Net Financing
• Assured Absorption And Turnover
• Assured CapEx Total
• Assured CPI
• Assured Deposit Refund
• Assured Distributed Deposit Investments
• Assured Earned Deposit Interest Capital Receipt
• Assured Earned Deposit Interest Operating Revenue
• Assured Expense Recovery
• Assured Free CPI
• Assured Free Miscellaneous Rent
• Assured Free Percentage Rent
• Assured Free Recovery
• Assured Invested Security Deposits
• Assured Lease Break
• Assured Leasing And Capital Costs
• Assured Leasing Commissions
• Assured Miscellaneous Rent
• Assured Non-Refundable Deposits
• Assured Percentage Rent
• Assured Percentage Rent Intermediate
• Assured Percentage Rent Offset
• Assured Potential Base Rent
• Assured Potential Base Rent Turnover
• Assured Rent Abatement
• Assured Scheduled Base Rent
• Assured Security Deposits
• Assured Straight Line Rent Adjustment
• Assured Tenant And Leasing Cost Proportion
• Assured Tenant And Leasing Cost Proportion
• Assured Tenant And Leasing Cost Proportion - Actuals
• Assured Tenant Improvements
• Assured Tenant Incentive
• Assured Tenant Incentive Amortization
• Assured Tenant Incentive Recovery
• Assured Tenant Incentive Straight Line Adjustment
• Assured Tenant Income
• Assured Tenant Income Proportion
• Assured Tenant Income Proportion
• Assured Tenant Income Proportion - Actuals
• Assured Tenant Non Op Ex And Leasing Cost Proportion
• Assured Tenant Non Op Ex And Leasing Cost Proportion
• Assured Tenant Non Op Ex And Leasing Cost Proportion - Actuals
• Assured Tenant Other Income
• Assured Total Leasing Cost
• Assured Total Leasing Cost IncIncentives
• Assured Total Rental Income
• Average Daily Rate
• Average Daily Rate Uninflated
• Average Monthly Recovered Amount

92 ARGUS Software Confidential


XML Integration ARGUS Enterprise

• Base Plus Step Rent


• Base Rent
• Base Rent For Reporting
• Blended Market Rent
• Breakpoint Amount
• Building Area
• Calculated
• Calculated Break
• Capital Employed
• Capital Expense
• Capital Growth
• Capitalization Rate
• CapVal Downtime
• Cash Flow
• Cash Flow
• Cash Flow After Debt Service
• Cash Flow After Debt Service
• Cash Flow After Debt Service Including Non Opex With No Straight Rent
• Cash Flow After Debt Service With No Straight Rent
• Cash Flow Before Debt Service
• Cash Flow Before Debt Service Incl Non Opex With No Straight Rent
• Cash Flow Before Debt With No Straight Rent
• Cash Flow Including Non Opex With No Straight Rent
• Cash Flow With No Straight Rent
• Closing Cost
• Collection Loss Excluded Rental Income
• Collection Loss Excluded Tenant Income
• Compounded Mean Average Capital Growth
• Compounded Mean Average Income Return
• Compounded Mean Average Total Return
• Continue Prior Market Rent Amount
• Continue Prior Market Rent Basis
• Continue Prior New Market Rent Amount
• Continue Prior New Market Rent Basis
• Continue Prior Renew Market Rent Amount
• Continue Prior Renew Market Rent Basis
• Continue Prior Renew Rent Override Amount
• Cpi Basis Line
• CPI Increases
• Credit Loss
• Credit Loss Before Override Tenants
• Credit Loss Override
• Deposit Refund
• Difference of Passing and Market Rent
• Difference of Passing and Market Rent for Reversion
• Discounted Exit Capital Costs
• Distributed Deposit Investments
• Earned Deposit Interest Capital Receipt
• Earned Deposit Interest Operating Revenue
• Effective Rent
• Effective Multi-Family Rental Income
• Equivalent Yield
• Erv Gross Yield
• Excluded Passing Recoveries
• Expenses
• Five Year Unleveraged IRR
• Free CPI Increases
• Free Miscellaneous Rent
• Free Percentage Rent
• Free Recovery
• Free Rent
• Free Rent Factors

93 ARGUS Software Confidential


XML Integration ARGUS Enterprise

• Gross Sale Price


• Ground Lease Base Plus Step Rent
• Ground Lease Base Rent
• Ground Lease Expense
• Ground Lease Expense
• Ground Lease Rental Value
• Ground Lease Step Rent
• Hotel Operating Expenses
• Hotel Revenue
• Hotels: Departmental Expenses
• Hotels: Departmental Revenue
• Hotels: Fixed Expenses
• Hotels: Miscellaneous Expenses
• Hotels: Miscellaneous Revenue
• Hotels: Potential Room Revenue
• Hotels: Room Revenue
• Hotels: Room Revenue
• Hotels: Room Revenue Uninflated
• Hotels: Rooms Expenses
• Hotels: Undistributed Expenses
• Incentive Amortization
• Incentive Amortization
• Incentive Straight Line Adjustment
• Incentives
• Incentives
• Incentives Recovery
• Incentives Recovery
• Income Return
• Initial Yield
• Intelligent Renewal Correction Amount
• Intelligent Renewal Correction Amount Negated
• Intelligent Renewal Market Rent Amount
• Intelligent Renewal Market Rent Basis
• Intelligent Renewal Prior Rent Amount
• Intelligent Renewal Prior Rent Amount Negated
• Intelligent Renewal Prior Rent Basis
• Intelligent Renewal Prior Rent Override Amount
• Intelligent Renewal Resolved Amount
• Invested Security Deposits
• KPI Purchase Cost
• KPI Purchase Cost All Periods
• KPI Total Purchase Cost All Periods
• Lease Break
• Leasing Commissions
• Leasing Commissions First Month
• Leasing Commissions Remaining Months
• Leveraged Cash Flow
• Leveraged IRR
• Leveraged PV CashFlow Incl. Resale As Of Date
• Leveraged PV CashFlow Incl. Resale Fixed Hold
• Leveraged PV of Resale As Of Date
• Leveraged PV of Resale Fixed Hold
• Leveraged Sale Proceeds
• Loan Additional Principal
• Loan Balloon Payments
• Loan Begin Balance
• Loan Costs
• Loan Deficit Funding
• Loan Ending Balance
• Loan Interest
• Loan Principal
• Loan Proceeds

94 ARGUS Software Confidential


XML Integration ARGUS Enterprise

• Loss Absorption
• Loss To Lease
• Lost Absorption / Turnover Rent
• Lost Absorption / Turnover Rent (Negated)
• Market Comparison Incentive
• Market Comparison LC
• Market Comparison TI
• Market Inflation In Period
• Market Miscellaneous Rent
• Market Percentage Rent
• Market Recoveries
• Market Rent
• Market Rent
• Miscellaneous Rent
• Miscellaneous Rent
• Months Vacant
• Multi-Family Additional Concessions
• Multi-Family Credit Loss
• Multi-Family Deposit Refund
• Multi-Family Distributed Deposit Investments
• Multi-Family Earned Deposit Interest Capital Receipt
• Multi-Family Earned Deposit Interest Operating Revenue
• Multi-Family Free Rent
• Multi-Family Improvements
• Multi-Family Improvements Operating Expenses
• Multi-Family Initial Rent
• Multi-Family Invested Security Deposits
• Multi-Family Leasing Costs
• Multi-Family Leasing Costs Operating Expenses
• Multi-Family Non-Refundable Deposits
• Multi-Family Occupied Area
• Multi-Family Revenue Potential Per Unit
• Multi-Family Revenue Total Costs
• Multi-Family Security Deposits
• Multi-Family Total Revenue
• Multi-Family Total Unit Area
• Multi-Family Units Absorbed
• Multi-Family Units At Market
• Multi-Family Units Expiring
• Multi-Family Units Rolled To Market
• Multi-Family Vacancy
• Net Operating Income
• Net Recoverable Amount
• Net Rent Over Initial Value
• Net Rent Value
• Net Sale Price Change Amount
• Net Sale Price Change Percentage
• New Deposit Refund
• New Distributed Deposit Investments
• New Earned Deposit Interest Capita Receipt
• New Earned Deposit Interest Operating Revenue
• New Invested Security Deposits
• New Leasing Commission
• New Leasing Commissions
• New Market Rent
• New Market Rent
• New Non Refundable Deposits
• New Security Deposits
• New Tenant Improvement
• Non Recoverable Amount
• Non-Operating Expense
• Non-Operating Expense Not Summed

95 ARGUS Software Confidential


XML Integration ARGUS Enterprise

• Non-Refundable Deposits
• Not Defined
• Not Recovered During Free Rent
• Occupied Area
• Occupied Area
• Operating Expense
• Operating Expense Percent Of Line Item
• Other Debt
• Other Period Unleveraged IRR
• Other Revenue
• Parking Revenue
• Passing CPI
• Passing Miscellaneous Rent
• Passing Percentage Rent
• Passing Recoveries
• Passing Rent
• Percentage Rent
• Percentage Rent
• Percentage Rent Offset
• Potential Base Rent
• Potential Multi-Family Mkt. Rent
• Potential Rent After Loss to Lease
• Property Recoveries
• Purchase Price
• PV of Leveraged Cash Flow
• PV of Leveraged Cash Flow As Of Date
• PV of Leveraged Cash Flow Fixed Hold
• PV of Leveraged Sale Proceeds
• PV of Unleveraged Cash Flow
• PV of Unleveraged Cash Flow As Of Date
• PV of Unleveraged Cash Flow Fixed Hold
• PV of Unleveraged Sale Proceeds
• Recoverable Amount
• Recoverable Fixed
• Recovered Amount Before Free Rent
• Recovered Amount Before Limits
• Recovered By Method
• Recovery Allocation Percentage
• Recovery Gross Up
• Recovery Increase Amount
• Recovery Inflated Input Amount
• Recovery Max Per Increase Limit
• Recovery Maximum Limit
• Recovery Method Area
• Recovery Method Base Lease Line
• Recovery Method Lease Line
• Recovery Method Total
• Recovery Method Unit Line
• Recovery Minimum Limit
• Recovery Stop Amount
• Recovery Stop Free Rent
• Renew Deposit Refund
• Renew Distributed Deposit Investments
• Renew Earned Deposit Interest Capital Receipt
• Renew Earned Deposit Interest Operating Revenue
• Renew Invested Security Deposits
• Renew Leasing Commission
• Renew Leasing Commissions
• Renew Market Rent
• Renew Non Refundable Deposits
• Renew Security Deposits
• Renew Tenant Improvement

96 ARGUS Software Confidential


XML Integration ARGUS Enterprise

• Renewal Percentage
• Rentable Area
• Rental Income Before CPI
• Rental Income Before CPI Average
• Rental Value
• Revenue
• Revenue Per Available Room
• Revenue Per Available Room Uninflated
• Reversion
• Reversionary Yield
• RevEx Before Fixed Percent
• RevEx Fixed Part
• RevEx Fixed Part for CapVal
• RevEx for CapVal
• RevEx Variable Part
• Sales Amount
• Scheduled Base Rent
• Scheduled Multi-Family Rent
• Scheduled Rent
• Security Deposits
• Selling Cost
• Selling Costs + VendorCosts
• Speculative Absorption And Turnover
• Speculative CapEx Total
• Speculative CPI
• Speculative Deposit Refund
• Speculative Distributed Deposit Investments
• Speculative Earned Deposit Interest Capital Receipt
• Speculative Earned Deposit Interest Operating Revenue
• Speculative Expense Recovery
• Speculative Free CPI
• Speculative Free Miscellaneous Rent
• Speculative Free Percentage Rent
• Speculative Free Recovery
• Speculative Invested Security Deposits
• Speculative Lease Break
• Speculative Leasing And Capital Costs
• Speculative Leasing Commissions
• Speculative Miscellaneous Rent
• Speculative Non-Refundable Deposits
• Speculative Percentage Rent
• Speculative Percentage Rent Intermediate
• Speculative Percentage Rent Offset
• Speculative Potential Base Rent
• Speculative Rent Abatement
• Speculative Scheduled Base Rent
• Speculative Security Deposits
• Speculative Straight Line Rent Adjustment
• Speculative Tenant Improvements
• Speculative Tenant Incentive
• Speculative Tenant Incentive Amortization
• Speculative Tenant Incentive Recovery
• Speculative Tenant Incentive Straight Line Adjustment
• Speculative Tenant Income
• Speculative Tenant Other Income
• Speculative Total Leasing Cost
• Speculative Total Leasing Cost IncIncentives
• Speculative Total Rental Income
• Step Rent
• Storage Revenue
• Straight Line Incentive Adjustment
• Straight Line Rent

97 ARGUS Software Confidential


XML Integration ARGUS Enterprise

• Straight Line Rent Adjustment


• Ten Year Unleveraged IRR
• Tenant Improvements
• Total Applied Capital Expense
• Total Applied Non-Operating Expense
• Total Applied Operating Expense
• Total Applied Other Revenue
• Total Applied Parking Revenue
• Total Applied Reference Capital Expense
• Total Applied Reference Non-Operating Expense
• Total Applied Reference Operating Expense
• Total Applied Reference Other Revenue
• Total Applied Reference Parking Revenue
• Total Applied Reference Storage Revenue
• Total Applied Storage Revenue
• Total Asset Net Financing
• Total Available Rooms Nights
• Total Capital Expenditures
• Total Closing Costs
• Total Debt Service
• Total Departmental Expenses
• Total Departmental Revenue
• Total Effective Gross Revenue
• Total Effective Revenue
• Total Financing
• Total Fixed Expenses
• Total Ground Lease Base Plus Step Rent
• Total Ground Lease Base Rent
• Total Ground Lease Rental Value
• Total Ground Lease Step Rent
• Total Hotel And Non-Hotel Operating Expenses
• Total Hotel Departmental Revenue Uncategorized
• Total Hotel Miscellaneous Expenses
• Total Hotel Miscellaneous Revenue
• Total Hotel Parking Revenue Uncategorized
• Total Hotel Room and Departmental and Miscellaneous Expenses
• Total Hotel Room and Departmental and Miscellaneous Revenue
• Total Incentives With No Straight Rent
• Total Income Grossed Up By Loss Absorption
• Total Leasing Commissions
• Total Leasing Costs
• Total Leasing Costs & Capital Expenditures
• Total Leasing Costs & Capital Expenditures With No Straight Rent
• Total Leasing Costs and Incentives
• Total Leasing Costs and Incentives With No Straight Rent
• Total Loan Costs Not Included In Loan
• Total Loans Balance
• Total Lost Absorption And Turnover For Vacancy
• Total Lost Absorption And Turnover For Vacancy Override
• Total Market Rent
• Total Market Rent Negated
• Total Miscellaneous Rent Straight Line Adjustment
• Total Miscellaneous Rent Using Straight Line
• Total Multi-Family Available Units
• Total Multi-Family Occupied Units
• Total Multifamily Leasing Costs
• Total Non Reimbursable Expenses
• Total Non-Operating Expenses
• Total Non-Recoverable Amount
• Total NonRecoverable Expenses
• Total Occupancy Percent
• Total Occupied Alternate Area

98 ARGUS Software Confidential


XML Integration ARGUS Enterprise

• Total Occupied Area


• Total Occupied Leased Area
• Total Occupied Rooms Nights
• Total Occupied Rooms Nights Percent
• Total Operating Expenses
• Total Other Debt
• Total Other Income
• Total Other Revenue
• Total Other Tenant Revenue
• Total Parking Revenue
• Total Passing Rent
• Total Potential Gross Revenue
• Total Potential Room Revenue
• Total Purchase Cost
• Total Purchasing Leasing Capital Costs
• Total Purchasing Leasing Capital Costs
• Total Recoverable Amount
• Total Recoverable Amount
• Total Reimbursable Expenses
• Total Rental Revenue
• Total Return
• Total Revenue
• Total Room Expenses
• Total Room Revenue Uninflated
• Total Rooms
• Total Storage Revenue
• Total Tenant Other Income Less Free Rent
• Total Tenant Revenue
• Total Undistributed Expenses
• Total Vacancy and Credit Loss
• Total Vacant Rooms Nights
• True Equivalent Yield
• Turnover Rent
• Unit Alternate Area Measure
• Unit Area Measure
• Unit Leased Area Measure
• Unleveraged Cash Flow
• Unleveraged IRR
• Unleveraged Present Value
• Unleveraged PV CashFlow Incl. Resale As Of Date
• Unleveraged PV CashFlow Incl. Resale Fixed Hold
• Unleveraged PV of Resale As Of Date
• Unleveraged PV of Resale Fixed Hold
• Unleveraged Sale Proceeds
• Vacancy Absorption Correction
• Vacancy Allowance
• Vacancy Allowance Before Adjust
• Vacancy Allowance Before Adjust Override
• Vacancy Allowance Before Override Tenants
• Vacancy Allowance Override
• Vacancy Excluded Income Correction
• Vacancy Excluded Rental Income
• Vacant Area
• Val IRR Apr Unleveraged
• Val PV Cash Flow Incl Residual Unleveraged

99 ARGUS Software Confidential

You might also like