APIs with Entrata
The API employs a communication protocol known as RPC (Remote Procedure Call). To access the APIs, you will provide the base URL and credentials to Vizibly, which you can generate through the Entrata platform. Instructions on how you can generate these credentials can be found below.
How To Activate Vizibly as A User Account
Please note, Entrata may need 24 to 48 hours to set up Vizibly in the system. Once complete, you may add Vizibly using the following steps:
Admin User Account Activation
Log in as an "admin" level user in Entrata.
Navigate to "Apps" and select "API Access."
Click the "Add API User" button to create a new Vendor API user.
Enable Access to Vendor
Use the search feature to find "Vizibly"
Click on "Vizibly" to enable API access.
Property Permissions
Select the properties to grant permission for accessing Vendor API - see below Property Permissions For Vizibly Budgeting
Copy Credentials
Click the "Copy Credentials" button to obtain the Vendor API user's credentials.
Provide these credentials to your Vizibly contact for integration by emailing integrations@vizibly.io
Deep Dive into Entrata APIs
For a comprehensive look at the Entrata offering, you can delve into their API documentation: Entrata API Documentation.
Entrata limits the number of API requests at three intervals: per minute, per hour, and per day. Entrata recommends that Vizibly not run concurrent calls as this may adversely impact the performance of your Entrata instance. Vizibly structures the API requests to minimize performance issues by running during off-hours.
Testing Against Test Database
Before implementing the API in a live environment, Vizibly may test the APIs against your test database for a seamless integration experience.
Support
Vizibly partners with clients to determine business requirements and will review expectations as to how the integration will impact your business.
For technical questions about our API requests, please reach out to our API support team for assistance at support@vizibly.io
We're excited to have your organization use the Vizibly platform and look forward to you being part of the Vizibly ecosystem!
Property Permissions for Vizibly Budgeting
Module | API |
Financial | getApCodes |
Financial | getBudgetActuals |
Financial | getBudgets |
Financial | getFinancialPickList |
Financial | getGlTransactions |
Financial | getGlTrees |
AR Codes | getArCodes |
AR Transactions | getArInvoices |
AR Transactions | getLeaseArTransactions |
Reports | getDependentFilter |
Reports | getReportData |
Reports | getReportInfo |
Reports | getReportList |
Vendors | getInvoices |
Leads | getLeadEvents |
Leads | getLeadPickLists |
Leads | getLeads |
Leases | getLeaseDetails |
Leases | getLeases |
Properties | getProperties |
Property Units | getPropertyUnits |
Property Units | getUnitTypes |
Queue | getResponse |
Maintenance | getWorkOrder |
Getting your Instance Live with your Chart of Accounts
In order to get your instance live, Vizibly needs to know your chart of accounts structure and internal Entrata ID. In order to configure Vizibly properly, do the following:
Running your first report
Navigate to Data & Reports
Click on Reporting
Run an Income Statement - Budget vs Actual report
Generate report with Parameters
Save to XLS
Email to your Customer Success Manager
Copy API request
Navigate to Data & Reports
Click on Reporting
Run an Income Statement - Budget vs Actual report
Generate report with Parameters
Download API format JSON
Once API request is displayed on screen, copy the API request and email it to your Customer Success Manager