Skip to main content

​
Intro

Entrata is property management software for property owners, managers, and residents. Using the Entrata API to pull data into Domo, you will get a consistent and reliable data connection that you can use to monitor the income and expenses of properties, number of properties by region, and more so that you can get the most out of your Entrata platform. You can connect to your Entrata Via API Key account in the Data Center. This topic discusses the fields and menus specific to the Entrata Via API Key connector user interface. To add DataSets, set update schedules, and edit DataSet information, see Adding a DataSet Using a Connector.

​
Prerequisites

To connect to your Entrata Via API Key Connector account and create a DataSet, you need the following:
  • Your Entrata account’s subdomain
  • API Key
This connector requires an API key that has access to specific web services in Entrata. To obtain this key, do the following:
  1. Request an Internal API User from Entrata: Contact your Entrata CSM to request an Internal API User. Once this user has been provisioned, you will receive an API key from Entrata.
  2. Enable the appropriate web services on the internal API user: Once you have received your internal API user, edit the user in Entrata and add the appropriate web services to the profile. Below is the list of web services required:
getARCodes
getARPayments
getPaymentTypes
getArInvoices
getLeaseArTransactions
getMistLeaseArTransactions
getApCodes  
getFinancialPickList
getJobCostBudgets
getBudgetActuals
getGITransactions
getJobs
getGITrees
getTransactionTagLists
getLeads
getMitsLeads
getLeadEvents
getQuotes
getLeaseDetails
getLeases
getRentersInsurancePolicies
getEvictedLeases
getLeaseDocuments
getMitsCollections
getExpiringLeases
getLeaseDocumentsList
getMitsLeases
getProperties
getPropertyPickLists
getPropertyUnits
getSpecials
getResponse
getDependentFilter
getReportInfo
getReportData
getReportlist

​
Connecting to Your Entrata Via API Key Connector Account

This section enumerates the options in the Credentials and Details panes on the Entrata Via API Key Connector page. The components of the other panes on this page, Scheduling, and Name & Describe Your DataSet, are universal across most connector types and are discussed in great detail in Adding a DataSet Using a Connector.

​
Credentials Pane

This pane contains fields for entering credentials to connect to your Entrata Via API Key account. The following table describes what is needed for each field:

Field

Description

Domain Enter your Entrata account subdomain. For example, if you logged into Entrata using domo.entrata.com , you need to enter ‘domo’ here.
API Key Login to https://developer.entrata.com , and select Catalog > My Subscriptions .
Once you have entered valid Entrata Via API Key credentials, you can use the same account at any time to create a new Entrata Via API Key DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Manage Connector Accounts.

​
Details Pane

Menu

Description

Report

Select the Entrata Via API Key report you want to run. The following reports are available:

Report Name Description

Lease Details

Retrieves the charge details information for all leases for the selected property.

Leases Expiring

Returns the list of expiring leases.

Report Data

Retrieves the data about a report based on the user-supplied filters.

Financial PickList

Retrieves the financial picklist.

Invoices

Retrieves the invoice batch.

Lead Events

Retrieves the lead events for the selected property.

Leads

Retrieves the leads for the selected property.

Leases

Retrieves the lease information for a selected property.

Property PickList

Retrieves a pick list for properties.

Specials

Retrieves specials/concessions for the selected property.
Select Properties Specify whether you want to retrieve all properties or a specific property.
Property Select the property you want to view.
Picklist Select the property picklist you want to view.
Date Filter Type Select the Date Type to filter.
Lease Details Sub Report Select the sub-report data you would like to include for lease details. As per your selection, the connector will create a new row of data per record. For example, if a lease has 5 charges, you will see 5 rows of data for that lease.
Report Name Select the name of the Entrata report for which you want to retrieve the data.
Report Version Select the version of the Entrata report for which you would like to retrieve the data.
Report Filters

Enter that the user-customized report filters to limit the returned data. Available filters can be found in the Report Filters report. Filters must be in JSON format, and any date fields in the filters must have the m/d/Y value replaced with an appropriate date string.


For example, if you find daterange-start, daterange-end, or date parameters, replace m/d/Y with a string formatted like the following: 3/1/2022. If you are replacing the date parameter, this will select reports on the date of March 1st, 2022.


Ensure to only include the inner filters and not the filters key. So, instead of "filters": {"Filter_One": {"name": "property", "required": null},"Filter_Two":{"name": "property_stats", "required": true}} you would supply the following inner JSON objects "Filter_One":{"name": "property", "required": null},"Filter_Two": {"name": "property_stats", "required": true}

Field To Flatten

Enter the column name for Entrata Data that you would like to parse and flatten to retrieve the data that is normally returned as a List. You may only enter one column at a time.

Select Dates

Select dates.

​
Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Connector.